Skip to content

Commit 360e30d

Browse files
authored
fix(sm): use env script reference instead of hardcoded Helm version
2 parents be50501 + 70f4a63 commit 360e30d

File tree

31 files changed

+85
-89
lines changed

31 files changed

+85
-89
lines changed

docs/self-managed/concepts/secondary-storage/no-secondary-storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ You should **only** disable/run without secondary storage in limited scenarios,
2323
- For Helm deployments, Optimize is also disabled by default when secondary storage is not configured.
2424
- For Docker or manual deployments, you must **explicitly disable Optimize** in your configuration, as it cannot function without secondary storage.
2525

26-
This setup provides core process execution and orchestration capabilities through Zeebe, but excludes the full Camunda platform experience, such as analytics, search, and human-task management.
26+
This setup provides core process execution and orchestration capabilities through Zeebe, but excludes the full Camunda experience, such as analytics, search, and human-task management.
2727

2828
## Enable **no secondary storage** mode
2929

docs/self-managed/deployment/helm/cloud-providers/amazon/amazon-eks/eks-helm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Lastly you'll verify that the connection to your Self-Managed Camunda 8 environm
3030
- [jq](https://jqlang.github.io/jq/download/) to interact with some variables.
3131
- [GNU envsubst](https://www.man7.org/linux/man-pages/man1/envsubst.1.html) to generate manifests.
3232
- (optional) Domain name/[hosted zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-working-with.html) in Route53. This allows you to expose Camunda 8 and connect via community-supported [zbctl](https://github.com/camunda-community-hub/zeebe-client-go/blob/main/cmd/zbctl/zbctl.md) or [Camunda Modeler](https://camunda.com/download/modeler/).
33-
- A namespace to host the Camunda Platform.
33+
- A namespace to host Camunda.
3434

3535
For the tool versions used, check the [.tool-versions](https://github.com/camunda/camunda-deployment-references/blob/main/.tool-versions) file in the repository. It contains an up-to-date list of versions that we also use for testing.
3636

@@ -118,7 +118,7 @@ https://github.com/camunda/camunda-deployment-references/blob/main/aws/kubernete
118118

119119
If you do not have a domain name, external access to Camunda 8 web endpoints from outside the AWS VPC will not be possible. In this case, you may skip the DNS setup and proceed directly to [deploying Camunda 8 via Helm charts](#deploy-camunda-8-via-helm-charts).
120120

121-
Alternatively, you can use `kubectl port-forward` to access the Camunda platform without a domain or Ingress configuration. For more information, see the [kubectl port-forward documentation](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/).
121+
Alternatively, you can use `kubectl port-forward` to access Camunda without a domain or Ingress configuration. For more information, see the [kubectl port-forward documentation](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/).
122122

123123
Throughout the rest of this installation guide, we will refer to configurations as **"With domain"** or **"Without domain"** depending on whether the application is exposed via a domain.
124124
:::
@@ -408,7 +408,7 @@ https://github.com/camunda/camunda-deployment-references/blob/main/generic/kuber
408408

409409
This command:
410410

411-
- Installs (or upgrades) the Camunda platform using the Helm chart.
411+
- Installs (or upgrades) Camunda using the Helm chart.
412412
- Substitutes the appropriate version using the `$CAMUNDA_HELM_CHART_VERSION` environment variable.
413413
- Applies the configuration from `generated-values.yml`.
414414

docs/self-managed/deployment/helm/cloud-providers/amazon/amazon-eks/eksctl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This guide results in the following:
4848
- An Amazon EKS Kubernetes cluster running the latest Kubernetes version with four nodes ready for Camunda 8 installation.
4949
- Installed and configured [EBS CSI driver](https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html), which is used by the Camunda 8 Helm chart to create [persistent volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/).
5050
- A [managed Aurora PostgreSQL 17.x](https://aws.amazon.com/rds/aurora/) instance that will be used by the Camunda 8 components.
51-
- A [managed OpenSearch domain](https://aws.amazon.com/opensearch-service/) created and configured as a secondary storage option for the Camunda platform.
51+
- A [managed OpenSearch domain](https://aws.amazon.com/opensearch-service/) created and configured as a secondary storage option for Camunda.
5252
Note: This guide’s example provisions a managed OpenSearch domain. Depending on the components you run and your requirements, you can instead configure an RDBMS-based secondary storage backend for supported components. See [configure RDBMS in Helm](/self-managed/deployment/helm/configure/database/rdbms.md) for details.
5353
- [IAM Roles for Service Accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) (IRSA) configured and [Pod Identities](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html).
5454
- This simplifies the setup by not relying on explicit credentials, but instead allows creating a mapping between IAM roles and Kubernetes service accounts based on a trust relationship. A [blog post](https://aws.amazon.com/blogs/containers/diving-into-iam-roles-for-service-accounts/) by AWS visualizes this on a technical level.
@@ -845,7 +845,7 @@ We will also use this step to verify connectivity to the database from the creat
845845

846846
Creating an OpenSearch domain can be accomplished through various methods, such as using the AWS Management Console or the AWS CLI. This guide focuses on providing a reproducible setup using the CLI. For information on creating an OpenSearch domain using the UI, refer to the [AWS OpenSearch documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/create-managed-domain.html).
847847

848-
The resulting OpenSearch domain is intended for use with the Camunda platform, the following components utilize OpenSearch:
848+
The resulting OpenSearch domain is intended for use with Camunda, the following components utilize OpenSearch:
849849

850850
- Orchestration Cluster (Zeebe, Operate, Tasklist, Identity)
851851
- Optimize

docs/self-managed/deployment/helm/cloud-providers/amazon/amazon-eks/terraform-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ After completing this guide, you will have:
114114
- An Amazon EKS Kubernetes cluster running with four nodes ready for Camunda 8 installation.
115115
- The [EBS CSI driver](https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html), installed and configured. This is used by the Camunda 8 Helm chart to create [persistent volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/).
116116
- (Optional) A managed [Aurora PostgreSQL](https://aws.amazon.com/rds/postgresql/) instance for Camunda.
117-
- (Optional) A managed [Amazon OpenSearch Service](https://aws.amazon.com/opensearch-service/) domain created and configured for use with the Camunda platform.
117+
- (Optional) A managed [Amazon OpenSearch Service](https://aws.amazon.com/opensearch-service/) domain created and configured for use with Camunda.
118118
- (Optional) [IRSA](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) configured so Kubernetes workloads can assume IAM roles without stored credentials.
119119

120120
## 1. Configure AWS and initialize Terraform
@@ -344,7 +344,7 @@ If you choose not to use this module, you'll need to either provide a managed El
344344
Additionally, you must delete the `opensearch.tf` file within the `terraform/cluster` directory of your chosen reference as it will otherwise create the resources.
345345
:::
346346

347-
The OpenSearch module creates an OpenSearch domain intended for Camunda platform. OpenSearch is a powerful alternative to Elasticsearch. For more information on using OpenSearch with Camunda, refer to the [Camunda documentation](/self-managed/deployment/helm/configure/database/using-external-opensearch.md).
347+
The OpenSearch module creates an OpenSearch domain intended for Camunda. OpenSearch is a powerful alternative to Elasticsearch. For more information on using OpenSearch with Camunda, refer to the [Camunda documentation](/self-managed/deployment/helm/configure/database/using-external-opensearch.md).
348348

349349
The secondary storage database (OpenSearch or Elasticsearch in this setup) is required to support the Orchestration Cluster components described in the [reference architecture](/self-managed/reference-architecture/reference-architecture.md): Zeebe (workflow data), Operate (monitoring), Tasklist (human tasks), Optimize (analytics), and Identity (user management, sessions, OIDC mappings).
350350

docs/self-managed/deployment/helm/cloud-providers/azure/microsoft-aks/aks-helm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This guide provides a comprehensive walkthrough for installing the Camunda 8 Hel
2626
- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) to interact with the cluster.
2727
- [jq](https://jqlang.github.io/jq/download/) to interact with some variables.
2828
- [GNU envsubst](https://www.man7.org/linux/man-pages/man1/envsubst.1.html) to generate manifests.
29-
- A namespace to host the Camunda Platform; in this guide we will reference `camunda` as the target namespace.
29+
- A namespace to host Camunda; in this guide we will reference `camunda` as the target namespace.
3030
- (optional) Custom domain name/[DNS zone](https://learn.microsoft.com/en-us/azure/dns/dns-zones-records) in Azure DNS. This allows you to expose Camunda 8 endpoints and connect via community-supported [zbctl](https://github.com/camunda-community-hub/zeebe-client-go/blob/main/cmd/zbctl/zbctl.md) or [Camunda Modeler](https://camunda.com/download/modeler/).
3131
- (optional) Permissions to install Kubernetes operators (cluster-admin or equivalent) to deploy infrastructure services such as Elasticsearch, PostgreSQL, and Keycloak. This guide installs them directly from source to provide full control over versions and configuration.
3232
For the tool versions used, check the [.tool-versions](https://github.com/camunda/camunda-deployment-references/blob/main/.tool-versions) file in the related repository. This contains an up-to-date list of versions we also use for testing.
@@ -84,7 +84,7 @@ https://github.com/camunda/camunda-deployment-references/blob/main/azure/kuberne
8484

8585
If you do not have a domain name, external access to Camunda 8 web endpoints from outside the Azure Virtual Network will not be possible. In this case, skip the DNS setup and proceed directly to [deploying Camunda 8 via Helm charts](#deploy-camunda-8-via-helm-charts).
8686

87-
Alternatively, you can use `kubectl port-forward` to access the Camunda platform without a domain or Ingress configuration. For more information, see the [kubectl port-forward documentation](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/).
87+
Alternatively, you can use `kubectl port-forward` to access Camunda without a domain or Ingress configuration. For more information, see the [kubectl port-forward documentation](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/).
8888

8989
Throughout the rest of this installation guide, we will refer to configurations as **"With domain"** or **"Without domain"** depending on whether the application is exposed via a domain.
9090
:::
@@ -314,7 +314,7 @@ https://github.com/camunda/camunda-deployment-references/blob/main/generic/kuber
314314

315315
This script:
316316

317-
- Installs (or upgrades) the Camunda platform using the Helm chart.
317+
- Installs (or upgrades) Camunda using the Helm chart.
318318
- Substitutes the appropriate version using the `$CAMUNDA_HELM_CHART_VERSION` environment variable.
319319
- Applies the configuration from `generated-values.yml`.
320320

docs/self-managed/deployment/helm/cloud-providers/openshift/dual-region.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,7 @@ https://github.com/camunda/camunda-deployment-references/blob/main/generic/opens
566566

567567
This command:
568568

569-
- Installs (or upgrades) the Camunda platform using the Helm chart on each cluster.
569+
- Installs (or upgrades) Camunda using the Helm chart on each cluster.
570570
- Substitutes the appropriate version using the `$CAMUNDA_HELM_CHART_VERSION` environment variable.
571571
- Applies the configuration from the value file.
572572

docs/self-managed/deployment/helm/cloud-providers/openshift/redhat-openshift.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Additional information and a high-level overview of Kubernetes as the upstream p
3434
- [jq](https://jqlang.github.io/jq/download/) to interact with some variables.
3535
- [GNU envsubst](https://www.man7.org/linux/man-pages/man1/envsubst.1.html) to generate manifests.
3636
- [oc (version supported by your OpenShift)](https://docs.openshift.com/container-platform/4.17/cli_reference/openshift_cli/getting-started-cli.html) to interact with OpenShift.
37-
- A namespace to host the Camunda Platform.
37+
- A namespace to host Camunda.
3838
- Permissions to install Kubernetes operators (cluster-admin or equivalent) for deploying the infrastructure services (Elasticsearch, PostgreSQL, Keycloak). These operators can also be installed via the [OpenShift OperatorHub](https://docs.openshift.com/container-platform/latest/operators/understanding/olm-understanding-operatorhub.html), but this guide installs them directly from source for full control over versions and configuration.
3939

4040
For the tool versions used, check the [.tool-versions](https://github.com/camunda/camunda-deployment-references/blob/main/.tool-versions) file in the repository. It contains an up-to-date list of versions that we also use for testing.
@@ -297,7 +297,7 @@ If you should decide to use the Red Hat endorsed [NGINX Ingress Controller](http
297297
<TabItem value="no-ingress" label="No Ingress">
298298
If you do not have a domain name or do not intend to use one for your Camunda 8 deployment, external access to Camunda 8 web endpoints from outside the OpenShift cluster will not be possible.
299299

300-
However, you can use `kubectl port-forward` to access the Camunda platform without a domain name or Ingress configuration. For more information, refer to the [kubectl port-forward documentation](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/).
300+
However, you can use `kubectl port-forward` to access Camunda without a domain name or Ingress configuration. For more information, refer to the [kubectl port-forward documentation](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/).
301301

302302
To make this work, you will need to configure the deployment to reference `localhost` with the forwarded port. Merge the no-domain overlay into your `values.yml` file:
303303

@@ -659,7 +659,7 @@ https://github.com/camunda/camunda-deployment-references/blob/main/generic/opens
659659

660660
This command:
661661

662-
- Installs (or upgrades) the Camunda platform using the Helm chart.
662+
- Installs (or upgrades) Camunda using the Helm chart.
663663
- Substitutes the appropriate version using the `$CAMUNDA_HELM_CHART_VERSION` environment variable.
664664
- Applies the configuration from `generated-values.yml`.
665665

docs/self-managed/deployment/helm/configure/operator-based-infrastructure.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Before proceeding with this guide, ensure you have:
5555
- **Cluster admin privileges**: Required to install Custom Resource Definitions (CRDs) and operators
5656
- **Command-line tools**:
5757
- `kubectl` configured to access your cluster
58-
- `helm` CLI for deploying Camunda Platform
58+
- `helm` CLI for deploying Camunda using the Helm chart
5959
- `openssl` for generating random passwords
6060
- `envsubst` command (part of `gettext` package) for environment variable substitution
6161

@@ -139,7 +139,7 @@ Each infrastructure component should be deployed individually in the following o
139139
| 1 | **[PostgreSQL](#postgresql-deployment)** | None | Database clusters for Keycloak, Management Identity, and Web Modeler |
140140
| 2 | **[Elasticsearch](#elasticsearch-deployment)** | None | Secondary storage for orchestration cluster components |
141141
| 3 | **[Keycloak](#keycloak-deployment)** | PostgreSQL | Authentication and identity management |
142-
| 4 | **[Camunda Platform](#camunda-deployment)** | All above | Deploy using Helm with operator-managed infrastructure |
142+
| 4 | **[Camunda](#camunda-deployment)** | All above | Deploy using Helm with operator-managed infrastructure |
143143

144144
:::tip Automation with GitOps
145145
While this guide demonstrates manual deployment using command-line tools, these same configurations can be automated using GitOps solutions like ArgoCD, Flux, or other Kubernetes deployment pipelines. All configuration files referenced in this guide are designed to work seamlessly with declarative deployment approaches.
@@ -514,7 +514,7 @@ With all infrastructure components deployed and configured, you can now deploy C
514514

515515
### Configuration files summary
516516

517-
Before deploying Camunda Platform, ensure you have saved all required configuration files locally. The files are organized by deployment phase:
517+
Before deploying Camunda, ensure you have saved all required configuration files locally. The files are organized by deployment phase:
518518

519519
#### Infrastructure deployment files (Custom Resources)
520520

@@ -538,27 +538,28 @@ Before deploying Camunda Platform, ensure you have saved all required configurat
538538

539539
### Pre-deployment checklist
540540

541-
Before deploying Camunda Platform:
541+
Before deploying Camunda, ensure you have completed the following:
542542

543543
- [ ] All infrastructure components deployed (PostgreSQL, Elasticsearch, Keycloak)
544544
- [ ] Configuration files saved locally from previous sections
545545
- [ ] Authentication secrets generated (previous section)
546546

547547
### Helm deployment
548548

549-
Deploy Camunda Platform using the infrastructure configuration files you saved from previous sections:
549+
First, source the environment setup script to set `HELM_CHART_VERSION` and other required variables. See the [Helm chart version matrix](https://helm.camunda.io/camunda-platform/version-matrix/) to choose the appropriate chart version for your deployment:
550550

551-
```bash
552-
# Set the desired Helm chart version - see https://helm.camunda.io/camunda-platform/version-matrix/
553-
export HELM_CHART_VERSION=13.0.0 # Replace with your desired version
551+
```bash reference
552+
https://github.com/camunda/camunda-deployment-references/blob/main/generic/kubernetes/operator-based/0-set-environment.sh
554553
```
555554

555+
Then, deploy Camunda using the infrastructure configuration files you saved from previous sections.
556+
556557
For end-to-end configuration patterns (OIDC-enabled "Full Cluster" including Optimize, Web Modeler, Console, and Identity), see the Full Cluster section of our [Helm installation guide](/self-managed/deployment/helm/install/quick-install.md#full-cluster).
557558

558559
<Tabs groupId="camunda-deployment">
559560
<TabItem value="with-domain" label="With external domain" default>
560561

561-
Deploy Camunda Platform with external domain configuration:
562+
Deploy Camunda with external domain configuration:
562563

563564
```bash
564565
helm install "$CAMUNDA_RELEASE_NAME" camunda/camunda-platform \
@@ -567,14 +568,13 @@ helm install "$CAMUNDA_RELEASE_NAME" camunda/camunda-platform \
567568
-f camunda-identity-values.yml \
568569
-f camunda-webmodeler-values.yml \
569570
-f camunda-keycloak-domain-values.yml \
570-
-f camunda-values-identity-secrets.yml \
571571
-n "$CAMUNDA_NAMESPACE"
572572
```
573573

574574
</TabItem>
575575
<TabItem value="no-domain" label="Local development">
576576

577-
Deploy Camunda Platform for local development:
577+
Deploy Camunda for local development:
578578

579579
```bash
580580
helm install "$CAMUNDA_RELEASE_NAME" camunda/camunda-platform \
@@ -583,7 +583,6 @@ helm install "$CAMUNDA_RELEASE_NAME" camunda/camunda-platform \
583583
-f camunda-identity-values.yml \
584584
-f camunda-webmodeler-values.yml \
585585
-f camunda-keycloak-no-domain-values.yml \
586-
-f camunda-values-identity-secrets.yml \
587586
-n "$CAMUNDA_NAMESPACE"
588587
```
589588

docs/self-managed/deployment/helm/install/production/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ helm install camunda camunda/camunda-platform --version $HELM_CHART_VERSION -n o
9292

9393
### Ingress TLS setup
9494

95-
In order to access the Camunda Platform through HTTPS with Ingress, TLS must be enabled. Enabling TLS requires the following:
95+
In order to access Camunda through HTTPS with Ingress, TLS must be enabled. Enabling TLS requires the following:
9696

9797
1. **Domain name**: A public registered domain that has configurable DNS records. This guide will use `camunda.example.com` as the domain.
9898
2. **TLS certificate**: A TLS certificate created for your domain. The certificate must be an X.509 certificate, issued by a trusted Certificate Authority. The certificate must include the correct domain names (Common Name or Subject Alternative Names) to secure Ingress resources. Reach out to your DNS provider if you are unsure on how to create a TLS certificate. It is not recommended to use self-signed certificates.

0 commit comments

Comments
 (0)