Skip to content

Commit ba1d97d

Browse files
committed
docs: apply review suggestion to move ES back to Helm page
Signed-off-by: Marcel Dias <[email protected]>
1 parent c061f9d commit ba1d97d

3 files changed

Lines changed: 31 additions & 50 deletions

File tree

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

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import NoDomainInfo from '../../\_partials/\_no-domain-info.md'
1515
import HelmUpgradeNote from '../../\_partials/\_helm-upgrade-note.md'
1616
import KubefwdTip from '../../\_partials/\_kubefwd-tip.md'
1717
import PortForwardServices from '../../\_partials/\_port-forward-services.md'
18+
import DeployECKElasticsearch from '../../\_partials/\_deploy-eck-elasticsearch.md'
1819

1920
This guide provides a comprehensive walkthrough for installing the Camunda 8 Helm chart on your existing Azure Kubernetes Service (AKS) cluster, and confirmation it is working as intended.
2021

@@ -28,7 +29,7 @@ This guide provides a comprehensive walkthrough for installing the Camunda 8 Hel
2829
- A namespace to host the Camunda Platform; in this guide we will reference `camunda` as the target namespace.
2930
- (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/).
3031
- (optional) Permissions to install Kubernetes operators (cluster-admin or equivalent) to deploy infrastructure services such as Elasticsearch, PostgreSQL, and Keycloak. You can also install these operators 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 to provide full control over versions and configuration.
31-
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.
32+
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.
3233

3334
## Architecture
3435

@@ -184,7 +185,7 @@ For more configuration options, refer to the [Helm chart documentation](https://
184185
Depending on your installation path, you may use different settings.
185186
For easy and reproducible installations, we will use YAML files to configure the chart.
186187

187-
### 1. Create the `values.yml` file
188+
### Create the `values.yml` file
188189

189190
Start by creating a `values.yml` file to store the configuration for your environment. This file will contain key-value pairs that will be substituted using `envsubst`. You can find a reference example of this file here:
190191

@@ -248,7 +249,7 @@ https://github.com/camunda/camunda-deployment-references/blob/main/azure/kuberne
248249
</TabItem>
249250
</Tabs>
250251

251-
### 2. Configure your deployment
252+
### Configure your deployment
252253

253254
#### Enable Enterprise components
254255

@@ -271,7 +272,29 @@ https://github.com/camunda/camunda-deployment-references/blob/main/azure/kuberne
271272

272273
:::
273274

274-
### 3. Install Camunda 8 using Helm
275+
### Deploy prerequisite services
276+
277+
Before deploying Camunda, you need to deploy the infrastructure services it depends on. The core infrastructure (Elasticsearch and PostgreSQL) can be deployed using Kubernetes operators as described in [Deploy infrastructure with Kubernetes operators](/self-managed/deployment/helm/configure/operator-based-infrastructure.md). Keycloak can optionally be deployed as your OIDC provider:
278+
279+
- **Elasticsearch**: Deployed via [ECK (Elastic Cloud on Kubernetes)](https://www.elastic.co/guide/en/cloud-on-k8s/current/index.html)
280+
281+
All deploy scripts are located in `generic/kubernetes/operator-based/`. Review each script before executing to understand the deployment steps, and adapt the operator Custom Resource configurations for your specific requirements (resource limits, storage, replicas, etc.).
282+
283+
:::note Working directory
284+
All commands in this guide assume you are at the **repository root** (the directory created by `get-your-copy.sh`). The deploy commands below use subshells `(cd ... && ./deploy.sh)` to preserve your working directory.
285+
:::
286+
287+
#### Deploy Elasticsearch {#deploy-elasticsearch}
288+
289+
If your organization does not want to use a managed Elasticsearch service, ECK Operator is an option. This guide makes use of ECK Operator to the deploy Elasticsearch.
290+
291+
:::warning Production Elasticsearch recommendation
292+
For production workloads, we recommend using an externally managed Elasticsearch service (for example, [Elastic Cloud on Azure](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/elastic.ec-azure-pp)). Terraform support for Elastic Cloud on Azure can be restrictive but remains a viable option.
293+
:::
294+
295+
<DeployECKElasticsearch />
296+
297+
### Install Camunda 8 using Helm
275298

276299
Now that the `generated-values.yml` is ready, you can install Camunda 8 using Helm. Run the following command:
277300

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ description: "Deploy an Azure Kubernetes Service (AKS) cluster with a Terraform
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
import DeployECKElasticsearch from '../../\_partials/\_deploy-eck-elasticsearch.md'
11-
1210
This guide provides a detailed tutorial for deploying an Azure Kubernetes Service (AKS) cluster, tailored specifically for deploying Camunda 8 using Terraform, a popular Infrastructure as Code (IaC) tool.
1311

1412
This guide is designed to help you leverage the power of Infrastructure as Code (IaC) to streamline and reproduce your cloud infrastructure setup. By walking through the essentials of setting up an AKS cluster, and provisioning managed Azure resources such as Azure Database for PostgreSQL, this guide demonstrates how to use Terraform with Azure. It makes the process accessible even to those new to Terraform or IaC concepts. It utilizes Azure-managed services where available, offering these as optional components for added convenience and maintainability.
@@ -419,16 +417,6 @@ If your organization does not want to use a managed Azure Database for PostgreSQ
419417
For more details on the PostgreSQL deployment with CloudNativePG Operator, see [PostgreSQL deployment in the operator-based infrastructure guide](/self-managed/deployment/helm/configure/operator-based-infrastructure.md#postgresql-deployment) for a production-grade setup with automated scaling, upgrades, and built-in security.
420418
:::
421419

422-
#### 4. (Optional) Deploy Elasticsearch {#deploy-elasticsearch}
423-
424-
If your organization needs to use Elasticsearch as a data store and does not want to use a managed Elasticsearch service, the ECK operator is an option.
425-
426-
:::warning Production Elasticsearch recommendation
427-
For production workloads, we recommend using an externally managed Elasticsearch service (for example, [Elastic Cloud on Azure](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/elastic.ec-azure-pp)). Terraform support for Elastic Cloud on Azure can be restrictive but remains a viable option.
428-
:::
429-
430-
<DeployECKElasticsearch />
431-
432420
### Execution
433421

434422
:::note Secret management

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

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ import NoDomainInfo from '../\_partials/\_no-domain-info.md'
1717
import HelmUpgradeNote from '../\_partials/\_helm-upgrade-note.md'
1818
import KubefwdTip from '../\_partials/\_kubefwd-tip.md'
1919
import PortForwardServices from '../\_partials/\_port-forward-services.md'
20+
import DeployPrerequisiteServices from '../\_partials/\_deploy-prerequisite-services.md'
2021
import DeployECKElasticsearch from '../\_partials/\_deploy-eck-elasticsearch.md'
22+
import DeployCNPGPostgresql from '../\_partials/\_deploy-cnpg-postgresql.md'
2123

2224
Red Hat OpenShift, a Kubernetes distribution maintained by [Red Hat](https://www.redhat.com/en/technologies/cloud-computing/openshift), provides options for both managed and on-premises hosting.
2325

@@ -391,47 +393,15 @@ Some components are not enabled by default in this deployment. For more informat
391393

392394
### Deploy prerequisite services
393395

394-
Before deploying Camunda, you need to deploy the infrastructure services it depends on. The core infrastructure (Elasticsearch and PostgreSQL) is deployed using Kubernetes operators as described in [Deploy infrastructure with Kubernetes operators](/self-managed/deployment/helm/configure/operator-based-infrastructure.md). Keycloak can optionally be deployed as your OIDC provider:
395-
396-
- **Elasticsearch**: Deployed via [ECK (Elastic Cloud on Kubernetes)](https://www.elastic.co/guide/en/cloud-on-k8s/current/index.html)
397-
- **PostgreSQL**: Deployed via [CloudNativePG](https://cloudnative-pg.io/)
398-
- **Keycloak** _(optional)_: Deployed via the [Keycloak Operator](https://www.keycloak.org/operator/installation) — can be replaced with any OIDC-compatible IdP
399-
400-
All deploy scripts are located in `generic/kubernetes/operator-based/`. Review each script before executing to understand the deployment steps, and adapt the operator Custom Resource configurations for your specific requirements (resource limits, storage, replicas, etc.).
401-
402-
:::note Working directory
403-
All commands in this guide assume you are at the **repository root** (the directory created by `get-your-copy.sh`). The deploy commands below use subshells `(cd ... && ./deploy.sh)` to preserve your working directory.
404-
:::
396+
<DeployPrerequisiteServices />
405397

406398
#### Deploy Elasticsearch {#deploy-elasticsearch}
407399

408400
<DeployECKElasticsearch />
409401

410402
#### Deploy PostgreSQL {#deploy-postgresql}
411403

412-
Deploy PostgreSQL clusters using the CloudNativePG operator:
413-
414-
```bash
415-
CLUSTER_FILTER="pg-identity,pg-webmodeler" (cd generic/kubernetes/operator-based/postgresql && ./deploy.sh)
416-
```
417-
418-
This script installs the CNPG operator (auto-detecting OpenShift to apply SCC patches), creates secrets, deploys the specified PostgreSQL clusters, and waits for readiness.
419-
420-
The following PostgreSQL clusters are created:
421-
422-
- **pg-identity**: Database for Camunda Identity component
423-
- **pg-webmodeler**: Database for Web Modeler component (remove from configuration if not needed)
424-
425-
<details>
426-
<summary>Review the PostgreSQL cluster configuration</summary>
427-
428-
```yaml reference
429-
https://github.com/camunda/camunda-deployment-references/blob/main/generic/kubernetes/operator-based/postgresql/postgresql-clusters.yml
430-
```
431-
432-
</details>
433-
434-
For more details on the PostgreSQL deployment, see [PostgreSQL deployment in the operator-based infrastructure guide](/self-managed/deployment/helm/configure/operator-based-infrastructure.md#postgresql-deployment).
404+
<DeployCNPGPostgresql />
435405

436406
#### Deploy Keycloak (optional) {#deploy-keycloak}
437407

0 commit comments

Comments
 (0)