Create separate gateway sub chart #145
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| apiVersion: v2 | ||
| appVersion: "1.3.1" | ||
| description: Zeebe Gateway Helm Chart for Kubernetes | ||
| name: zeebe-gateway | ||
| type: application | ||
| version: 0.0.1 | ||
| icon: https://helm.camunda.io/imgs/zeebe-logo.png | ||
| annotations: | ||
| artifacthub.io/changes: | | ||
| - add zeebe-gateway sub chart | ||
| artifacthub.io/containsSecurityUpdates: "false" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| [](https://github.com/camunda-community-hub/community)[](https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#incubating-)[](https://opensource.org/licenses/Apache-2.0) | ||
|
|
||
| # Camunda Cloud Self-Managed Helm Chart | ||
|
|
||
| This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. | ||
|
|
||
| ## Requirements | ||
|
|
||
| * [Helm](https://helm.sh/) >= 3.x + | ||
| * Kubernetes >= 1.20+ | ||
| * Minimum cluster requirements include the following to run this chart with default settings. All of these settings are configurable. | ||
| * Three Kubernetes nodes to respect the default "hard" affinity settings | ||
| * 2GB of RAM for the JVM heap | ||
|
|
||
|
|
||
| ## Installing | ||
|
|
||
| * Add the official CCSM helm charts repo | ||
|
|
||
| ```shell | ||
| helm repo add ccsm https://helm.camunda.io | ||
| ``` | ||
|
|
||
| * Install it | ||
|
|
||
| ```shell | ||
| helm install camunda-cloud ccsm/ccsm-helm | ||
| ``` | ||
|
|
||
| ## Configuration | ||
| | Section | Parameter | Description | Default | | ||
| |-|-|-|-| | ||
| | `global` | `elasticsearch.disableExporter` | Disable [Elasticsearch Exporter](https://github.com/camunda-cloud/zeebe/tree/develop/exporters/elasticsearch-exporter) in Zeebe | `false` | | ||
| | | `elasticsearch.host` | ElasticSearch host to use in Elasticsearch Exporter connection | `elasticsearch-master` | | ||
| | | `elasticsearch.port` | ElasticSearch port to use in Elasticsearch Exporter connection | `9200` | | ||
| | | `elasticsearch.url` | ElasticSearch full url to use in Elasticsearch Exporter connection. This config overrides the `host` and `port` above. | | | ||
| | `elasticsearch`| `enabled` | Enable ElasticSearch deployment as part of the Zeebe Cluster | `true` | | ||
| | `kibana`| `enabled` | Enable Kibana deployment as part of the Zeebe Cluster | `false` | | ||
| | `prometheus`| `enabled` | Enable Prometheus operator as part of the Zeebe Cluster | `false` | | ||
| | | `servicemonitor.enabled` | Deploy a `ServiceMonitor` for your Zeebe Cluster | `false` | | ||
| | `zeebe` |`labels` | labels to be applied to the StatefulSet and Service | `app: zeebe` | | ||
| | | `annotations`| annotations to be applied to the StatefulSet and Service | `{}`| | ||
| | |`podAnnotations`| annotations to be applied to the StatefulSet pod Template | `{}`| | ||
| | | `clusterSize` | Set the Zeebe Cluster Size and the number of replicas of the replica set | `3` | | ||
| | | `partitionCount` | Set the Zeebe Cluster partition count | `3` | | ||
| | | `replicationFactor` | Set the Zeebe Cluster replication factor | `3` | | ||
| | | `cpuThreadCount` | Set the Zeebe Cluster CPU thread count | `2` | | ||
| | | `ioThreadCount` | Set the Zeebe Cluster IO thread count | `2` | | ||
| | | `logLevel` | Sets the log level for io.zeebe packages; must be one of: ERROR, WARN, INFO, DEBUG, TRACE | `info` | | ||
| | | `log4j2` | Log4J 2.x XML configuration; if provided, the contents given will be written to file and will overwrite the distribution's default `/usr/local/zeebe/config/log4j2.xml` | `` | | ||
| | | `JavaOpts` | Set the Zeebe Cluster Broker JavaOpts. This is where you should configure the jvm heap size. | `-XX:MaxRAMPercentage=25.0 -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/usr/local/zeebe/data -XX:ErrorFile=/usr/local/zeebe/data/zeebe_error%p.log -XX:+ExitOnOutOfMemoryError` | | ||
| | | `resources` | Set the Zeebe Cluster Broker Kubernetes Resource Request and Limits | `requests:`<br> `cpu: 500m`<br> ` memory: 1Gi`<br>`limits:`<br> ` cpu: 1000m`<br> ` memory: 2Gi` | | ||
| | | `env` | Pass additional environment variables to the Zeebe broker pods; <br> variables should be specified using standard Kubernetes raw YAML format. See below for an example.| `[]` | | ||
| | | `podDisruptionBudget.enabled` | Create a podDisruptionBudget for the broker pods | `false` | | ||
| | | `podDisruptionBudget.minAvailable` | Minimum number of available broker pods for PodDisruptionBudget | | | ||
| | | `podDisruptionBudget.maxUnavailable` | Maximum number of unavailable broker pods for PodDisruptionBudget | `1` | | ||
| | | `podSecurityContext` | Sets the [securityContext](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) for the Zeebe pod. Can hold pod-level security attributes and common container settings. | {} | | ||
| | | `pvcSize`| Set the Zeebe Cluster Persistence Volume Claim Request storage size | `10Gi` | | ||
| | | `pvcAccessModes` | Set the Zeebe Cluster Persistence Volume Claim Request accessModes | `[ "ReadWriteOnce" ]` | | ||
| | | `pvcStorageClassName` | Set the Zeebe Cluster Persistence Volume Claim Request storageClassName | `` | | ||
| | | `extraInitContainers` | Add extra initContainers sections to the StatefulSet | `` | | ||
| | | `extraVolumes` | Add extra volumnes to the StatefulSet | `{}` | | ||
| | | `extraVolumeMounts` | Add extra volumne mounts to the StatefulSet | `{}` | | ||
| | | `nodeSelector` | Node selection constraint to schedule Zeebe on specific nodes | `{}` | | ||
| | | `priorityClassName` | Name of the priority class to assign on Zeebe pods | `` | | ||
| | | `tolerations` | Tolerations to allow Zeebe to run on dedicated nodes | `[]` | | ||
| | | `affinity` | Use affinity constraints to schedule Zeebe on specific nodes | `{}` | | ||
| | | `serviceType` | The type of cluster service | `ClusterIP` | | ||
| | | `serviceHttpPort` | The http port used by the brokers and the gateway| `9600` | | ||
| | | `serviceInternalPort` | The internal port used by the brokers and the gateway | `26502` | | ||
| | | `serviceCommandPort` | The command port used the brokers | `26501` | | ||
| | | `serviceHttpName` | The http port name used by the brokers and the gateway| `http` | | ||
| | | `serviceInternalName` | The internal port name used by the brokers and the gateway | `internal` | | ||
| | | `serviceCommandName` | The command port name used the brokers | `command` | ||
| | `gateway` | `replicas` | The number of standalone gateways that should be deployed, if zero the embedded gateway is used. | `1` | | ||
| | | `priorityClassName` | Name of the priority class to assign on Zeebe gateway pods | `` | | ||
| | | `logLevel` | The log level of the gateway, one of: ERROR, WARN, INFO, DEBUG, TRACE | `info` | | ||
| | | `log4j2` | Log4J 2.x XML configuration; if provided, the contents given will be written to file and will overwrite the distribution's default `/usr/local/zeebe/config/log4j2.xml` | `` | | ||
| | | `env` | Pass additional environment variables to the Zeebe broker pods; <br> variables should be specified using standard Kubernetes raw YAML format. See below for an example. | `[]` | | ||
| | | `podAnnotations` | Annotations to be applied to the gateway Deployment pod template | `` | | ||
| | | `podDisruptionBudget.enabled` | Create a PodDisruptionBudget for the gateway pods | `false` | | ||
| | | `podDisruptionBudget.minAvailable` | minimum number of available gateway pods for PodDisruptionBudget | `1` | | ||
| | | `podDisruptionBudget.maxUnavailable` | maximum number of unavailable gateway pods for PodDisruptionBudget | `` | | ||
| | | `serviceGatewayType` | The type of cluster gateway service | `ClusterIP` | | ||
| | | `serviceGatewayPort` | The gateway port used by the gateway | `26500` | | ||
| | | `serviceGatewayName` | The gateway port name used by the gateway | `gateway` | | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Env Example | ||
| ```yaml | ||
|
|
||
| env: | ||
| - name: ZEEBE_GATEWAY_MONITORING_ENABLED | ||
| value: "true" | ||
| ``` | ||
|
|
||
| ## Adding dynamic exporters to Zeebe Brokers | ||
|
|
||
| This chart supports the addition of Zeebe Exporters by using initContainer as shown in the following example: | ||
|
|
||
| ``` | ||
| extraInitContainers: | | ||
| - name: init-exporters-hazelcast | ||
| image: busybox:1.28 | ||
| command: ['/bin/sh', '-c'] | ||
| args: ['wget --no-check-certificate https://repo1.maven.org/maven2/io/zeebe/hazelcast/zeebe-hazelcast-exporter/0.8.0-alpha1/zeebe-hazelcast-exporter-0.8.0-alpha1-jar-with-dependencies.jar -O /exporters/zeebe-hazelcast-exporter.jar; ls -al'] | ||
| volumeMounts: | ||
| - name: exporters | ||
| mountPath: /exporters/ | ||
| - name: init-exporters-kafka | ||
| image: busybox:1.28 | ||
| command: ['/bin/sh', '-c'] | ||
| args: ['wget --no-check-certificate https://github.com/zeebe-io/zeebe-kafka-exporter/releases/download/1.1.0/zeebe-kafka-exporter-1.1.0-uber.jar -O /exporters/zeebe-kafka-exporter.jar; ls -al'] | ||
| volumeMounts: | ||
| - name: exporters | ||
| mountPath: /exporters/ | ||
| env: | ||
| ZEEBE_BROKER_EXPORTERS_HAZELCAST_JARPATH: exporters/zeebe-hazelcast-exporter.jar | ||
| ZEEBE_BROKER_EXPORTERS_HAZELCAST_CLASSNAME: io.zeebe.hazelcast.exporter.HazelcastExporter | ||
| ZEEBE_HAZELCAST_REMOTE_ADDRESS: "{{ .Release.Name }}-hazelcast" | ||
| ``` | ||
| This example is downloading the exporters Jar from a URL and adding the Jars to the `exporters` directory that will be scanned for jars and added to the zeebe broker classpath. Then with `environment variables` you can configure the exporter parameters. | ||
|
|
||
| ## Dependencies | ||
|
|
||
| This chart currently depends on the following charts: | ||
|
|
||
| * [ElasticSearch Helm Chart](https://github.com/elastic/helm-charts/blob/master/elasticsearch/README.md) | ||
| * [Kibana Helm Chart](https://github.com/elastic/helm-charts/tree/master/kibana) | ||
| * [Prometheus Operator Helm Chart](https://github.com/helm/charts/tree/master/stable/prometheus-operator) | ||
|
|
||
| These dependencies can be turned on or off and parameters can be overiden from these dependent charts by changing the `values.yaml` file. For example: | ||
|
|
||
| ```yaml | ||
| elasticsearch: | ||
| enabled: true | ||
| imageTag: <YOUR VERSION HERE> | ||
| kibana: | ||
| enabled: false | ||
| ``` | ||
|
|
||
| ## Development | ||
|
|
||
| For development purpose you might want to deploy and test the charts without creating a new release. In order to do this you can run the following: | ||
|
|
||
| ```sh | ||
| helm install <RELEASENAME> charts/ccsm-helm/ | ||
| ``` | ||
|
|
||
| If you see errors like: | ||
|
|
||
| ```sh | ||
| Error: found in Chart.yaml, but missing in charts/ directory: elasticsearch, kibana, kube-prometheus-stack | ||
| ``` | ||
|
|
||
| Then you need to download the dependencies first. You can do this via: | ||
|
|
||
| ```sh | ||
| $ helm dependency update charts/ccsm-helm/ | ||
| Getting updates for unmanaged Helm repositories... | ||
| ...Successfully got an update from the "https://helm.elastic.co" chart repository | ||
| ...Successfully got an update from the "https://helm.elastic.co" chart repository | ||
| ...Successfully got an update from the "https://prometheus-community.github.io/helm-charts" chart repository | ||
| Hang tight while we grab the latest from your chart repositories... | ||
| ...Successfully got an update from the "ccsm" chart repository | ||
| ...Successfully got an update from the "stable" chart repository | ||
| Update Complete. ⎈Happy Helming!⎈ | ||
| Saving 3 charts | ||
| Downloading elasticsearch from repo https://helm.elastic.co | ||
| Downloading kibana from repo https://helm.elastic.co | ||
| Downloading kube-prometheus-stack from repo https://prometheus-community.github.io/helm-charts | ||
| Deleting outdated charts | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,47 @@ | ||||||
| {{/* vim: set filetype=mustache: */}} | ||||||
|
|
||||||
| {{/* | ||||||
| Create a default fully qualified app name. | ||||||
| We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). | ||||||
| If release name contains chart name it will be used as a full name. | ||||||
| */}} | ||||||
| {{- define "zeebe-gateway.fullname" -}} | ||||||
| {{- if .Values.fullnameOverride -}} | ||||||
| {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} | ||||||
| {{- else -}} | ||||||
| {{- $name := default .Chart.Name .Values.nameOverride -}} | ||||||
| {{- if contains $name .Release.Name -}} | ||||||
| {{- .Release.Name | trunc 63 | trimSuffix "-" -}} | ||||||
| {{- else -}} | ||||||
| {{- printf "%s-%s-gateway" .Release.Name $name | trunc 63 | trimSuffix "-" -}} | ||||||
| {{- end -}} | ||||||
| {{- end -}} | ||||||
| {{- end -}} | ||||||
|
|
||||||
| {{- define "zeebe.version" -}} | ||||||
| {{- printf "%s:%s" .Values.global.image.repository .Values.global.image.tag -}} | ||||||
| {{- end -}} | ||||||
|
|
||||||
| {{- define "zeebe.labels.gateway" -}} | ||||||
| {{- template "zeebe.labels" . }} | ||||||
| app.kubernetes.io/component: gateway | ||||||
|
There was a problem hiding this comment.
Suggested change
Would this be more consistent? There was a problem hiding this comment. Not sure, for the brokers we have as label, There was a problem hiding this comment. I guess if we not look from a zeebe focused perspective but from a CCSM user perspective, I would expect prefixed labels with the component names, i.e. So yes personally I would expect There was a problem hiding this comment. Makes sense to me let me do that as part of #147 |
||||||
| {{- end -}} | ||||||
|
|
||||||
| {{/* | ||||||
| Creates a valid DNS name for the gateway | ||||||
| */}} | ||||||
| {{- define "zeebe.names.gateway" -}} | ||||||
| {{- $name := default .Release.Name (tpl .Values.global.zeebeClusterName .) -}} | ||||||
| {{- printf "%s-gateway" $name | trunc 63 | trimSuffix "-" | quote -}} | ||||||
| {{- end -}} | ||||||
|
|
||||||
| {{/* | ||||||
| [zeebe-gateway] Create the name of the service account to use | ||||||
| */}} | ||||||
| {{- define "zeebe-gateway.serviceAccountName" -}} | ||||||
| {{- if .Values.serviceAccount.enabled }} | ||||||
| {{- default (include "zeebe-gateway.fullname" .) .Values.serviceAccount.name }} | ||||||
| {{- else }} | ||||||
| {{- default "default" .Values.serviceAccount.name }} | ||||||
| {{- end }} | ||||||
| {{- end }} | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: {{ include "zeebe-gateway.fullname" . }} | ||
| labels: | ||
| {{- include "zeebe.labels.gateway" . | nindent 4 }} | ||
| apiVersion: v1 | ||
| data: | ||
| startup.sh: | | ||
| #!/usr/bin/env bash | ||
| set -eux -o pipefail | ||
|
|
||
| export ZEEBE_BROKER_NETWORK_ADVERTISEDHOST=${ZEEBE_BROKER_NETWORK_ADVERTISEDHOST:-$(hostname -f)} | ||
menski marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| export ZEEBE_BROKER_CLUSTER_NODEID=${ZEEBE_BROKER_CLUSTER_NODEID:-${K8S_POD_NAME##*-}} | ||
|
|
||
| # As the number of replicas or the DNS is not obtainable from the downward API yet, | ||
| # defined them here based on conventions | ||
| export ZEEBE_BROKER_CLUSTER_CLUSTERSIZE=${ZEEBE_BROKER_CLUSTER_CLUSTERSIZE:-1} | ||
| contactPointPrefix=${K8S_POD_NAME%-*} | ||
| contactPoints=${ZEEBE_BROKER_CLUSTER_INITIALCONTACTPOINTS:-""} | ||
| if [[ -z "${contactPoints}" ]]; then | ||
| for ((i=0; i<${ZEEBE_BROKER_CLUSTER_CLUSTERSIZE}; i++)) | ||
| do | ||
| contactPoints="${contactPoints},${contactPointPrefix}-$i.$(hostname -d):{{ .Values.service.internalPort }}" | ||
| done | ||
|
|
||
| export ZEEBE_BROKER_CLUSTER_INITIALCONTACTPOINTS="${contactPoints}" | ||
| fi | ||
|
|
||
| if [ "$(ls -A /exporters/)" ]; then | ||
| mkdir /usr/local/zeebe/exporters/ | ||
| cp -a /exporters/*.jar /usr/local/zeebe/exporters/ | ||
| else | ||
| echo "No exporters available." | ||
| fi | ||
|
|
||
| exec /usr/local/zeebe/bin/broker | ||
|
|
||
| gateway-log4j2.xml: | | ||
| {{- if .Values.log4j2 }} | ||
| {{ .Values.log4j2 | indent 4 | trim }} | ||
| {{- end }} | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file will be completely replaced later, when I iterate over the readmes.