From e193003552ab59c22da67af8c5d7aba1a8b3996c Mon Sep 17 00:00:00 2001 From: Diego Marangoni Date: Wed, 21 Apr 2021 17:38:31 +0200 Subject: [PATCH 1/7] Update README.md --- charts/kangal/README.md | 129 ++++++++++++++++++++-------------------- 1 file changed, 65 insertions(+), 64 deletions(-) diff --git a/charts/kangal/README.md b/charts/kangal/README.md index 851a4d5f..df031f8a 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 | |--------------------------------------|-----------------------------------------------------------------------------------------------------|---------------------------------------| +| `environment` | The name that identifies the environment installation | `dev` | | `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 | `` | +| `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-openapi.example.com` | +| `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.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 | From 20b770f27205e39ef35fb4b6cabbae8086ef57ba Mon Sep 17 00:00:00 2001 From: Diego Marangoni Date: Wed, 21 Apr 2021 17:41:46 +0200 Subject: [PATCH 2/7] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8b292ba5..b6f92dec 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.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/). From 63d6d28cf60ac8405c39e350162bb02cbae6567b Mon Sep 17 00:00:00 2001 From: Diego Marangoni Date: Wed, 21 Apr 2021 17:49:19 +0200 Subject: [PATCH 3/7] Update Chart.yaml --- charts/kangal/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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: From aa92b533668c29b62d9cf31b2102e8a75020e545 Mon Sep 17 00:00:00 2001 From: Diego Marangoni Date: Wed, 21 Apr 2021 17:55:28 +0200 Subject: [PATCH 4/7] Update README.md --- charts/kangal/README.md | 48 ++++++++++++++++++++--------------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/charts/kangal/README.md b/charts/kangal/README.md index df031f8a..318da927 100644 --- a/charts/kangal/README.md +++ b/charts/kangal/README.md @@ -85,30 +85,30 @@ 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.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-openapi.example.com` | -| `proxy.env.OPEN_API_UI_URL` | A URL to the OpenAPI UI | `https://kangal-openapi-ui.example.com` | +| 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 | From 5b3a101be73c5986c779ebf71253420f65a4575c Mon Sep 17 00:00:00 2001 From: Diego Marangoni Date: Wed, 21 Apr 2021 17:59:45 +0200 Subject: [PATCH 5/7] Update README.md --- charts/kangal/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/charts/kangal/README.md b/charts/kangal/README.md index 318da927..18c977e1 100644 --- a/charts/kangal/README.md +++ b/charts/kangal/README.md @@ -68,8 +68,8 @@ The following table lists the common configurable parameters for `Kangal` chart: | Parameter | Description | Default | |--------------------------------------|-----------------------------------------------------------------------------------------------------|---------------------------------------| | `environment` | The name that identifies the environment installation | `dev` | -| `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` | +| `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` | From a5db5dc80f60ad456e5321d8e5d96d3e1e15b2f8 Mon Sep 17 00:00:00 2001 From: Diego Marangoni Date: Wed, 21 Apr 2021 18:02:07 +0200 Subject: [PATCH 6/7] Update README.md --- charts/kangal/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/kangal/README.md b/charts/kangal/README.md index 18c977e1..18caa9d8 100644 --- a/charts/kangal/README.md +++ b/charts/kangal/README.md @@ -125,7 +125,7 @@ Deployment specific configurations: | `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.example.com` | +| `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 | `[]` | From 25ead3d40d62d7cb79ac95928d8bb5f48b361361 Mon Sep 17 00:00:00 2001 From: Diego Marangoni Date: Wed, 21 Apr 2021 18:30:08 +0200 Subject: [PATCH 7/7] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b6f92dec..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.example.com localhost 80 5m48s -kangal-proxy kangal-proxy.example.com 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/).