diff --git a/README.md b/README.md index 8b292ba5..3528d1fc 100644 --- a/README.md +++ b/README.md @@ -124,9 +124,9 @@ To run a LoadTest you first need to find Kangal proxy endpoint. Use this command ```shell $ kubectl get ingress -NAME HOSTS ADDRESS PORTS AGE -kangal-openapi-ui kangal-openapi.local localhost 80 5m48s -kangal-proxy kangal-proxy.local localhost 80 5m48s +NAME HOSTS ADDRESS PORTS AGE +kangal-openapi-ui kangal-openapi-ui.example.com localhost 80 5m48s +kangal-proxy kangal-proxy.example.com localhost 80 5m48s ``` > This is assuming you have a properly configured [Ingress Controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/). If it is not the case you can use [Port Forwarding](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/). diff --git a/charts/kangal/Chart.yaml b/charts/kangal/Chart.yaml index 30f8004a..087faf59 100644 --- a/charts/kangal/Chart.yaml +++ b/charts/kangal/Chart.yaml @@ -6,7 +6,7 @@ keywords: - performance tests - tests runner name: kangal -version: 2.0.0 +version: 2.0.1 home: https://github.com/hellofresh/kangal icon: https://raw.githubusercontent.com/hellofresh/kangal/master/logo.svg maintainers: diff --git a/charts/kangal/README.md b/charts/kangal/README.md index 851a4d5f..18caa9d8 100644 --- a/charts/kangal/README.md +++ b/charts/kangal/README.md @@ -67,16 +67,17 @@ The following table lists the common configurable parameters for `Kangal` chart: | Parameter | Description | Default | |--------------------------------------|-----------------------------------------------------------------------------------------------------|---------------------------------------| -| `fullnameOverride` | String to fully override kangal.fullname template with a string | `nil` | -| `nameOverride` | String to partially override kangal.fullname template with a string (will prepend the release name) | `nil` | -| `secrets.AWS_ACCESS_KEY_ID` | AWS access key ID. If not defined report will not be stored | `` | -| `secrets.AWS_SECRET_ACCESS_KEY` | AWS secret access key | `` | +| `environment` | The name that identifies the environment installation | `dev` | +| `fullnameOverride` | String to fully override kangal.fullname template with a string | `` | +| `nameOverride` | String to partially override kangal.fullname template with a string (will prepend the release name) | `` | +| `secrets.AWS_ACCESS_KEY_ID` | AWS access key ID. If not defined report will not be stored | `my-access-key-id` | +| `secrets.AWS_SECRET_ACCESS_KEY` | AWS secret access key | `my-secret-access-key` | | `configmap.AWS_BUCKET_NAME` | The name of the bucket for saving reports | `my-bucket` | | `configmap.AWS_ENDPOINT_URL` | Storage connection parameter | `s3.us-east-1.amazonaws.com` | | `configmap.AWS_DEFAULT_REGION` | Storage connection parameter | `us-east-1` | -| `configmap.JMETER_MASTER_IMAGE_NAME` | Default JMeter master image name/repository if none is provided when creating a new loadtest | `hellofresh/kangal-jmeter-master` | +| `configmap.JMETER_MASTER_IMAGE_NAME` | Default JMeter master image name/repository if none is provided when creating a new loadtest | `hellofresh/kangal-jmeter-master` | | `configmap.JMETER_MASTER_IMAGE_TAG` | Tag of the JMeter master image above | `latest` | -| `configmap.JMETER_WORKER_IMAGE_NAME` | Default JMeter worker image name/repository if none is provided when creating a new loadtest | `hellofresh/kangal-jmeter-worker` | +| `configmap.JMETER_WORKER_IMAGE_NAME` | Default JMeter worker image name/repository if none is provided when creating a new loadtest | `hellofresh/kangal-jmeter-worker` | | `configmap.JMETER_WORKER_IMAGE_TAG` | Tag of the JMeter worker image above | `latest` | | `configmap.LOCUST_IMAGE_NAME` | Default Locust image name/repository if none is provided when creating a new loadtest | `locustio/locust` | | `configmap.LOCUST_IMAGE_TAG` | Tag of the Locust image above | `1.3.0` | @@ -84,70 +85,70 @@ The following table lists the common configurable parameters for `Kangal` chart: Deployment specific configurations: ### Kangal Proxy -| Parameter | Description | Default | -|-----------------------------------------|-------------------------------------------------------|----------------------------------------| -| `proxy.image.repository` | Repository of the image | `hellofresh/kangal` | -| `proxy.image.tag` | Tag of the image | `latest` | -| `proxy.image.pullPolicy` | Pull policy of the image | `Always` | -| `proxy.args` | Argument for `kangal` command | `["proxy"]` | -| `proxy.replicaCount` | Number of pod replicas | `2` | -| `proxy.service.enabled` | Service enabling flag | `true` | -| `proxy.service.enablePrometheus` | ServiceMonitor for Prometheus enabled flag | `false` | -| `proxy.service.type` | Service type | `ClusterIP` | -| `proxy.service.ports.http` | Service port | `80` | -| `proxy.ingress.enabled` | Ingress enabled flag | `true` | -| `proxy.ingress.annotations` | Ingress annotations | `kubernetes.io/ingress.class: "nginx"` | -| `proxy.ingress.path` | Ingress path | `/` | -| `proxy.ingress.hosts` | Ingress hosts. *Required* if ingress is enabled | `kangal-proxy.local` | -| `proxy.resources` | CPU/Memory resource requests/limits | Default values of the cluster | -| `proxy.nodeSelector` | Node labels for pod assignment | `{}` | -| `proxy.tolerations` | Tolerations for nodes that have taints on them | `[]` | -| `proxy.affinity` | Pod scheduling preferences | `{}` | -| `proxy.podAnnotations` | Annotation to be added to pod | `{}` | -| `proxy.containerPorts.http` | The ports that the container listens to | `8080` | -| `proxy.env.OPEN_API_SERVER_URL` | *Required.* A URL to the OpenAPI specification server | `https://kangal-openapi.local` | -| `proxy.env.OPEN_API_SERVER_DESCRIPTION` | *Required.* A Description to the OpenAPI server URL | `Kangal proxy default value` | -| `proxy.env.OPEN_API_UI_URL` | A URL to the OpenAPI UI | `https://kangal-openapi-ui.local` | +| Parameter | Description | Default | +|-----------------------------------------|-------------------------------------------------------|--------------------------------------------| +| `proxy.image.repository` | Repository of the image | `hellofresh/kangal` | +| `proxy.image.tag` | Tag of the image | `latest` | +| `proxy.image.pullPolicy` | Pull policy of the image | `Always` | +| `proxy.args` | Argument for `kangal` command | `[proxy]` | +| `proxy.replicaCount` | Number of pod replicas | `2` | +| `proxy.service.enabled` | Service enabling flag | `true` | +| `proxy.service.enablePrometheus` | ServiceMonitor for Prometheus enabled flag | `false` | +| `proxy.service.type` | Service type | `ClusterIP` | +| `proxy.service.ports.http` | Service port | `80` | +| `proxy.ingress.enabled` | Ingress enabled flag | `true` | +| `proxy.ingress.annotations` | Ingress annotations | `kubernetes.io/ingress.class: nginx` | +| `proxy.ingress.path` | Ingress path | `/` | +| `proxy.ingress.hosts.http` | Ingress hosts. *Required* if ingress is enabled | `kangal-proxy.example.com` | +| `proxy.resources` | CPU/Memory resource requests/limits | Default values of the cluster | +| `proxy.nodeSelector` | Node labels for pod assignment | `{}` | +| `proxy.tolerations` | Tolerations for nodes that have taints on them | `[]` | +| `proxy.affinity` | Pod scheduling preferences | `{}` | +| `proxy.podAnnotations` | Annotation to be added to pod | `{}` | +| `proxy.containerPorts.http` | The ports that the container listens to | `8080` | +| `proxy.env.OPEN_API_SERVER_DESCRIPTION` | *Required.* A Description to the OpenAPI server URL | `Kangal proxy default value` | +| `proxy.env.OPEN_API_SERVER_URL` | *Required.* A URL to the OpenAPI specification server | `https://kangal-proxy.example.com/openapi` | +| `proxy.env.OPEN_API_UI_URL` | A URL to the OpenAPI UI | `https://kangal-openapi-ui.example.com` | ### OpenAPI UI -| Parameter | Description | Default | -|---------------------------------------|-------------------------------------------------|----------------------------------------| -| `openapi-ui.enabled` | OpenAPI UI enabling flag | `true` | -| `openapi-ui.image.repository` | Repository of the image | `swaggerapi/swagger-ui` | -| `openapi-ui.image.tag` | Tag of the image | `latest` | -| `openapi-ui.image.pullPolicy` | Pull policy of the image | `Always` | -| `openapi-ui.replicaCount` | Number of pod replicas | `2` | -| `openapi-ui.service.enabled` | Service enabled flag | `true` | -| `openapi-ui.service.enablePrometheus` | ServiceMonitor for Prometheus enabled flag | `false` | -| `openapi-ui.service.type` | Service type | `ClusterIP` | -| `openapi-ui.service.ports.http` | Service port | `80` | -| `openapi-ui.ingress.enabled` | Ingress enabled flag | `true` | -| `openapi-ui.ingress.annotations` | Ingress annotations | `kubernetes.io/ingress.class: "nginx"` | -| `openapi-ui.ingress.path` | Ingress path | `/` | -| `openapi-ui.ingress.hosts` | Ingress hosts. *Required* if ingress is enabled | `kangal-openapi.local` | -| `openapi-ui.resources` | CPU/Memory resource requests/limits | Default values of the cluster | -| `openapi-ui.nodeSelector` | Node labels for pod assignment | `{}` | -| `openapi-ui.tolerations` | Tolerations for nodes that have taints on them | `[]` | -| `openapi-ui.affinity` | Pod scheduling preferences | `{}` | -| `openapi-ui.podAnnotations` | Annotation to be added to pod | `{}` | -| `openapi-ui.containerPorts.http` | The ports that the container listens to | `8080` | -| `openapi-ui.env.PORT` | The PORT of OpenAPI definition | `8080` | -| `openapi-ui.env.URL` | The URL pointing to OpenAPI definition | `https://kangal.local/openapi` | -| `openapi-ui.env.VALIDATOR_URL` | The URL to spec validator | `null` | +| Parameter | Description | Default | +|---------------------------------------|-------------------------------------------------|--------------------------------------------| +| `openapi-ui.enabled` | OpenAPI UI enabling flag | `true` | +| `openapi-ui.image.repository` | Repository of the image | `swaggerapi/swagger-ui` | +| `openapi-ui.image.tag` | Tag of the image | `latest` | +| `openapi-ui.image.pullPolicy` | Pull policy of the image | `Always` | +| `openapi-ui.replicaCount` | Number of pod replicas | `2` | +| `openapi-ui.service.enabled` | Service enabled flag | `true` | +| `openapi-ui.service.enablePrometheus` | ServiceMonitor for Prometheus enabled flag | `false` | +| `openapi-ui.service.type` | Service type | `ClusterIP` | +| `openapi-ui.service.ports.http` | Service port | `80` | +| `openapi-ui.ingress.enabled` | Ingress enabled flag | `true` | +| `openapi-ui.ingress.annotations` | Ingress annotations | `kubernetes.io/ingress.class: nginx` | +| `openapi-ui.ingress.path` | Ingress path | `/` | +| `openapi-ui.ingress.hosts` | Ingress hosts. *Required* if ingress is enabled | `kangal-openapi-ui.example.com` | +| `openapi-ui.resources` | CPU/Memory resource requests/limits | Default values of the cluster | +| `openapi-ui.nodeSelector` | Node labels for pod assignment | `{}` | +| `openapi-ui.tolerations` | Tolerations for nodes that have taints on them | `[]` | +| `openapi-ui.affinity` | Pod scheduling preferences | `{}` | +| `openapi-ui.podAnnotations` | Annotation to be added to pod | `{}` | +| `openapi-ui.containerPorts.http` | The ports that the container listens to | `8080` | +| `openapi-ui.env.PORT` | The PORT of OpenAPI definition | `8080` | +| `openapi-ui.env.URL` | The URL pointing to OpenAPI definition | `https://kangal-proxy.example.com/openapi` | +| `openapi-ui.env.VALIDATOR_URL` | The URL to spec validator | `null` | ### Kangal Controller -| Parameter | Description | Default | -|---------------------------------------|--------------------------------------------|------------------------------| -| `controller.image.repository` | Repository of the image | `hellofresh/kangal` | -| `controller.image.tag` | Tag of the image | `latest` | -| `controller.image.pullPolicy` | Pull policy of the image | `Always` | -| `controller.args` | Argument for `kangal` command | `["controller"]` | -| `controller.replicaCount` | Number of pod replicas | `1` | -| `controller.service.enabled` | Service enabled flag | `true` | -| `controller.service.enablePrometheus` | ServiceMonitor for Prometheus enabled flag | `false` | -| `controller.service.type` | Service type | `ClusterIP` | -| `controller.service.ports.http` | Service port | `80` | -| `controller.env.KANGAL_PROXY_URL` | Kangal Proxy URL used to persist reports | `https://kangal-proxy.local` | +| Parameter | Description | Default | +|---------------------------------------|--------------------------------------------|------------------------------------| +| `controller.image.repository` | Repository of the image | `hellofresh/kangal` | +| `controller.image.tag` | Tag of the image | `latest` | +| `controller.image.pullPolicy` | Pull policy of the image | `Always` | +| `controller.args` | Argument for `kangal` command | `[controller]` | +| `controller.replicaCount` | Number of pod replicas | `1` | +| `controller.service.enabled` | Service enabled flag | `true` | +| `controller.service.enablePrometheus` | ServiceMonitor for Prometheus enabled flag | `false` | +| `controller.service.type` | Service type | `ClusterIP` | +| `controller.service.ports.http` | Service port | `80` | +| `controller.env.KANGAL_PROXY_URL` | Kangal Proxy URL used to persist reports | `https://kangal-proxy.example.com` | ### Kangal Controller (JMeter specific) | Parameter | Description | Default |