feat(aks): evolve from bitnami to k8s operators for ref arch#8114
feat(aks): evolve from bitnami to k8s operators for ref arch#8114marcel-dias wants to merge 8 commits intomainfrom
Conversation
Signed-off-by: Marcel Dias <[email protected]>
|
👋 🤖 🤔 Hello, @marcel-dias! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.8/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
Updated wording for clarity in deployment instructions.
giorgionaps
left a comment
There was a problem hiding this comment.
Committed some minor edits, LGTM
Signed-off-by: Marcel Dias <[email protected]>
docs/self-managed/deployment/helm/cloud-providers/azure/microsoft-aks/aks-helm.md
Outdated
Show resolved
Hide resolved
|
@leiicamundi I moved the |
Signed-off-by: Marcel Dias <[email protected]>
leiicamundi
left a comment
There was a problem hiding this comment.
Good PR! Few suggestions on top of left comments:
- As per discussed, the ES section in terraform-setup.md numbered "4." but placed before the Terraform execution section (
### Execution).
ES is optional and deployed manually (not via Terraform), which may be confusing since sections 1-3 are Terraform-based and section 4 is a kubectl/script step.
Suggestion: we move it to the helm file.
- No "Merge operator overlays into values" section in the AKS helm doc: The OpenShift guide (
redhat-openshift.md) has an explicit section "Merge operator overlays into values" (after deploying operators, beforehelm install) that documents mergingcamunda-elastic-values.yml(and PostgreSQL overlays) intovalues.ymlusingyq. The AKS guide is missing this entirely.
Current state:
values-domain.ymlhaselasticsearch.enabled: true(Bitnami subchart) — this should be overridden by the ECK overlay that setselasticsearch.enabled: falseand configures the external ECK-managed ES connection.- The OpenShift
base.ymldocuments all overlay files in its header comments and the doc has the merge step. - The AKS
values-domain.ymlheader only mentions Keycloak/OIDC overlays, not the ES overlay.
Suggested fix — Add a section in aks-helm.md between "Fill your deployment with actual values" and "Install Camunda 8", aligned with OpenShift:
#### Merge operator overlays into values
Once the operator-managed services are running, merge the corresponding Helm values overlays
into your `values.yml` file. These overlays configure Camunda components to use the external
operator-managed services instead of embedded subcharts.
Merge the **Elasticsearch** overlay:
ˋˋˋbash
yq '. *+ load("generic/kubernetes/operator-based/elasticsearch/camunda-elastic-values.yml")' \
values.yml > values-merged.yml && mv values-merged.yml values.yml
ˋˋˋAlso update the values-domain.yml header comment to list the ES overlay (like OpenShift's base.yml does).
docs/self-managed/deployment/helm/cloud-providers/azure/microsoft-aks/aks-helm.md
Outdated
Show resolved
Hide resolved
docs/self-managed/deployment/helm/cloud-providers/azure/microsoft-aks/aks-helm.md
Show resolved
Hide resolved
Signed-off-by: Marcel Dias <[email protected]>
|
Addressed the comments suggestions:
A would say PR is ready for re-review and merge |
Signed-off-by: Marcel Dias <[email protected]>
|
The preview environment relating to the commit 8d57c82 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-8114/ |
|
|
||
| Once you've prepared the `values.yml` file, run the following `envsubst` command to substitute the environment variables with their actual values: | ||
| :::warning Production Elasticsearch recommendation | ||
| 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. |
| Merge the **Elasticsearch** overlay: | ||
|
|
||
| ```bash | ||
| yq '. *+ load("generic/kubernetes/operator-based/elasticsearch/camunda-elastic-values.yml")' values.yml > values-merged.yml && mv values-merged.yml values.yml |
There was a problem hiding this comment.
This command relies on values.yml, but at this stage, the final values files has been updated by the previous step #2-configure-your-deployment which generates a final values file named generated-values.yml
Inverting the steps would solve this:
- Create initial values.yml
- Install ECK (which will merges values.yml)
- Configure the deployment (envsubt generating
generated-values.yml) - Install Camunda 8 with helm
In the OpenShift guide, step 3 (envsubt) is included in Deploy prerequisite services at the end, which may be an error as it should be in a dedicated chapter, so maybe we should move it to the Install Camunda 8 with helm chapter; making it more "readable".
wdyt @marcel-dias
|
lgtm, thanks for the modifications @marcel-dias - I only spotted an ordering issue which can be solved by integrating the envsubt in the install camunda 8 step (also applicable to OpenShift), see my comment #8114 (comment) |
Description
This PR documents the Elasticsearch and PostgreSQL deployment using Kubernetes operators. Removes the helm values files mentions using 'internal bitnami' helm charts.
references: https://github.com/camunda/team-infrastructure-experience/issues/1029
When should this change go live?
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
{type}(scope): {description}commit message(s)/docsdirectory (version 8.9)./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.