Kangal Chart

Kangal is a tool to spin up an isolated environment in a Kubernetes cluster to run performance tests using different load test providers.

Introduction

This chart bootstraps a kangal deployment using the Helm package manager.

Prerequisites

Helm 3+
Kubernetes 1.12+

Installing the Chart

To add the repository to Helm:

 helm repo add kangal https://hellofresh.github.io/kangal

To install the chart with the release name kangal:

 helm install kangal kangal/kangal

Tip: You can provide values on the command line with --set or using the values file with -f my-values-file.yaml. Eg.: To set AWS credentials using command line you can use the following flags:

  --set secrets.AWS_ACCESS_KEY_ID="my-aws-key-id" \
  --set secrets.AWS_SECRET_ACCESS_KEY="my-aws-secret-access-key" \

or using setting this into your values file:

secrets:
  AWS_ACCESS_KEY_ID: my-aws-key-id
  AWS_SECRET_ACCESS_KEY: my-aws-secret-access-key

To install the chart with the release name kangal and use an specific version:

 helm install \
  --set proxy.image.tag=1.0.3 \
  --set controller.image.tag=1.0.3 \
  kangal kangal/kangal

The command deploys Kangal on the Kubernetes cluster in the default configuration. It also applies the latest version of Custom Resource Definition (CRD) to the cluster.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the kangal deployment:

 helm delete kangal

Note: Helm does not handle CRD deletion, so you have to manually remove it by running:
$ kubectl delete crd loadtests.kangal.hellofresh.com

Configuration

To install Kangal to your infrastructure you need 3 deployments: Kangal-Proxy, Kangal-Controller and Kangal-openapi-UI

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
`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.AWS_USE_HTTPS`	Set to "true" to use HTTPS	`false`
`configMap.AWS_PRESIGNED_EXPIRES`	Expiration time for Presigned URLs	`30m`
`configMap.GHZ_IMAGE_NAME`	Default ghz docker image name/repository if none is provided when creating a new loadtest	`hellofresh/kangal-ghz`
`configMap.GHZ_IMAGE_TAG`	Tag of the ghz docker image	`latest`
`configMap.JMETER_MASTER_IMAGE_NAME`	Default JMeter master docker 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 docker image	`latest`
`configMap.JMETER_WORKER_IMAGE_NAME`	Default JMeter worker docker 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 docker image	`latest`
`configMap.LOCUST_IMAGE_NAME`	Default Locust docker image name/repository if none is provided when creating a new loadtest	`locustio/locust`
`configMap.LOCUST_IMAGE_TAG`	Tag of the Locust docker image	`1.3.0`
`configMap.K6_IMAGE_NAME`	Default k6 docker image name/repository if none is provided when creating a new loadtest	`grafana/k6`
`configMap.K6_IMAGE_TAG`	Tag of the k6 docker image above	`latest`

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-proxy.example.com/openapi`
`proxy.env.OPEN_API_UI_URL`	A URL to the OpenAPI UI	`https://kangal-openapi-ui.example.com`
`proxy.env.ALLOWED_CUSTOM_IMAGES`	Allow to use custom backend images specified in the request	`false`

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.http`	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.example.com`

Kangal Controller (JMeter specific)

Parameter	Description	Default
`controller.env.JMETER_MASTER_CPU_LIMITS`	Master container CPU limits
`controller.env.JMETER_MASTER_CPU_REQUESTS`	Master CPU requests
`controller.env.JMETER_MASTER_MEMORY_LIMITS`	Master memory limits
`controller.env.JMETER_MASTER_MEMORY_REQUESTS`	Master memory requests
`controller.env.JMETER_WORKER_CPU_LIMITS`	Master container CPU limits
`controller.env.JMETER_WORKER_CPU_REQUESTS`	Master CPU requests
`controller.env.JMETER_WORKER_MEMORY_LIMITS`	Master memory limits
`controller.env.JMETER_WORKER_MEMORY_REQUESTS`	Master memory requests

Kangal Controller (Locust specific)

Parameter	Description	Default
`controller.env.LOCUST_MASTER_CPU_LIMITS`	Master container CPU limits
`controller.env.LOCUST_MASTER_CPU_REQUESTS`	Master CPU requests
`controller.env.LOCUST_MASTER_MEMORY_LIMITS`	Master memory limits
`controller.env.LOCUST_MASTER_MEMORY_REQUESTS`	Master memory requests
`controller.env.LOCUST_WORKER_CPU_LIMITS`	Master container CPU limits
`controller.env.LOCUST_WORKER_CPU_REQUESTS`	Master CPU requests
`controller.env.LOCUST_WORKER_MEMORY_LIMITS`	Master memory limits
`controller.env.LOCUST_WORKER_MEMORY_REQUESTS`	Master memory requests

Kangal Controller (`ghz` specific)

Parameter	Description	Default
`controller.env.GHZ_MASTER_CPU_LIMITS`	CPU limits
`controller.env.GHZ_MASTER_CPU_REQUESTS`	CPU requests
`controller.env.GHZ_MASTER_MEMORY_LIMITS`	Memory limits
`controller.env.GHZ_MASTER_MEMORY_REQUESTS`	Memory requests

Kangal Controller (`k6` specific)

Parameter	Description	Default
`controller.env.K6_CPU_LIMITS`	CPU limits
`controller.env.K6_CPU_REQUESTS`	CPU requests
`controller.env.K6_MEMORY_LIMITS`	Memory limits
`controller.env.K6_MEMORY_REQUESTS`	Memory requests

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Kangal Chart

Introduction

Prerequisites

Installing the Chart

Uninstalling the Chart

Configuration

Kangal Proxy

OpenAPI UI

Kangal Controller

Kangal Controller (JMeter specific)

Kangal Controller (Locust specific)

Kangal Controller (`ghz` specific)

Kangal Controller (`k6` specific)

Files

README.md

Latest commit

History

README.md

File metadata and controls

Kangal Chart

Introduction

Prerequisites

Installing the Chart

Uninstalling the Chart

Configuration

Kangal Proxy

OpenAPI UI

Kangal Controller

Kangal Controller (JMeter specific)

Kangal Controller (Locust specific)

Kangal Controller (ghz specific)

Kangal Controller (k6 specific)

Kangal Controller (`ghz` specific)

Kangal Controller (`k6` specific)