Helm Chart Production Guide #4703
Conversation
hamza-m-masood
added
hold
|
👋 🤖 🤔 Hello, @hamza-m-masood! 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.6/.
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. |
hamza-m-masood
force-pushed
the
production-guide
branch
from
7f6254c to
aad795a
Compare
|
@conceptualshark, I wanted to add a link to the OpenSearch IRSA guide, but I am having a problem with the docs. I opened an issue here: #4754 |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| We have a number of guides on connecting to external databases with the Camunda Helm Chart: | ||
|
|
||
| - [Using existing Elasticsearch](/docs/self-managed/setup/guides/using-existing-elasticsearch/) |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'Using existing Elasticsearch'. Please specify the file extension.
| We have a number of guides on connecting to external databases with the Camunda Helm Chart: | ||
|
|
||
| - [Using existing Elasticsearch](/docs/self-managed/setup/guides/using-existing-elasticsearch/) | ||
| - [Using Amazon OpenSearch Service](/docs/self-managed/setup/guides/using-existing-opensearch/) |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'Using Amazon OpenSearch Service'. Please specify the file extension.
| - [Using existing Elasticsearch](/docs/self-managed/setup/guides/using-existing-elasticsearch/) | ||
| - [Using Amazon OpenSearch Service](/docs/self-managed/setup/guides/using-existing-opensearch/) | ||
| - [Using Amazon OpenSearch Service through IRSA (only applicable if you are running Camunda Platform on EKS)](/docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md#opensearch-module-setup) | ||
| - [Running Web Modeler on Amazon Aurora PostgreSQL](/docs/self-managed/modeler/web-modeler/configuration/database/#running-web-modeler-on-amazon-aurora-postgresql) |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'Running Web Modeler on Amazon Aurora PostgreSQL'. Please specify the file extension.
|
|
||
| - [Connect to an OpenID Connect provider](http://localhost:3000/docs/next/self-managed/setup/guides/connect-to-an-oidc-provider/) | ||
| - Connect to existing Keycloak: | ||
| - [Configuration of the Camunda Helm Chart](/docs/self-managed/setup/guides/using-existing-keycloak/) |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'Configuration of the Camunda Helm Chart'. Please specify the file extension.
| - [Connect to an OpenID Connect provider](http://localhost:3000/docs/next/self-managed/setup/guides/connect-to-an-oidc-provider/) | ||
| - Connect to existing Keycloak: | ||
| - [Configuration of the Camunda Helm Chart](/docs/self-managed/setup/guides/using-existing-keycloak/) | ||
| - [Configuration of Keycloak](/docs/next/self-managed/identity/user-guide/configuration/configure-external-identity-provider/) |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'Configuration of Keycloak'. Please specify the file extension.
|
|
||
| ### Multi-namespace Deployment | ||
|
|
||
| The next recommended step is to setup a multi-namespace deployemnt. A [guide](/docs/self-managed/setup/guides/multi-namespace-deployment/) for this is already available. This is the most recommended approach to allow you to setup various environments using the Camunda Orchestration Cluster. |
| replicationFactor: "3" | ||
| ``` | ||
|
|
||
| The `clusterSize` refers to the amount of borkers, the `partitionCount` refers to how each [partition](/docs/components/zeebe/technical-concepts/partitions/) is setup in the cluster, and the `replicationFactor` refers to the [number of nodes](/docs/components/zeebe/technical-concepts/partitions/#replication). |
| replicationFactor: "3" | ||
| ``` | ||
|
|
||
| The `clusterSize` refers to the amount of borkers, the `partitionCount` refers to how each [partition](/docs/components/zeebe/technical-concepts/partitions/) is setup in the cluster, and the `replicationFactor` refers to the [number of nodes](/docs/components/zeebe/technical-concepts/partitions/#replication). |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'number of nodes'. Please specify the file extension.
| replicationFactor: "3" | ||
| ``` | ||
|
|
||
| The `core.clusterSize` refers to the amount of borkers, the `core.partitionCount` refers to how each [partition](/docs/components/zeebe/technical-concepts/partitions/) is setup in the cluster, and the `core.replicationFactor` refers to the [number of nodes](/docs/components/zeebe/technical-concepts/partitions/#replication). |
| replicationFactor: "3" | ||
| ``` | ||
|
|
||
| The `core.clusterSize` refers to the amount of borkers, the `core.partitionCount` refers to how each [partition](/docs/components/zeebe/technical-concepts/partitions/) is setup in the cluster, and the `core.replicationFactor` refers to the [number of nodes](/docs/components/zeebe/technical-concepts/partitions/#replication). |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'number of nodes'. Please specify the file extension.
|
|
||
| We have a number of guides on connecting to external databases with the Camunda Helm Chart: | ||
|
|
||
| - [Using existing Elasticsearch](/docs/self-managed/setup/guides/using-existing-elasticsearch/) |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'Using existing Elasticsearch'. Please specify the file extension.
| We have a number of guides on connecting to external databases with the Camunda Helm Chart: | ||
|
|
||
| - [Using existing Elasticsearch](/docs/self-managed/setup/guides/using-existing-elasticsearch/) | ||
| - [Using Amazon OpenSearch Service](/docs/self-managed/setup/guides/using-existing-opensearch/) |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'Using Amazon OpenSearch Service'. Please specify the file extension.
| - [Using existing Elasticsearch](/docs/self-managed/setup/guides/using-existing-elasticsearch/) | ||
| - [Using Amazon OpenSearch Service](/docs/self-managed/setup/guides/using-existing-opensearch/) | ||
| - [Using Amazon OpenSearch Service through IRSA (only applicable if you are running Camunda Platform on EKS)](/docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md#opensearch-module-setup) | ||
| - [Running Web Modeler on Amazon Aurora PostgreSQL](/docs/self-managed/modeler/web-modeler/configuration/database/#running-web-modeler-on-amazon-aurora-postgresql) |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'Running Web Modeler on Amazon Aurora PostgreSQL'. Please specify the file extension.
|
|
||
| ### Multi-namespace Deployment | ||
|
|
||
| The next recommended step is to setup a multi-namespace deployemnt. A [guide](/docs/self-managed/setup/guides/multi-namespace-deployment/) for this is already available. This is the most recommended approach to allow you to setup various environments using the Camunda Orchestration Cluster. |
| ### Keycloak | ||
|
|
||
| - Connect to existing Keycloak: | ||
| - [Configuration of the Camunda Helm Chart](/docs/self-managed/setup/guides/using-existing-keycloak/) |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'Configuration of the Camunda Helm Chart'. Please specify the file extension.
|
|
||
| - Connect to existing Keycloak: | ||
| - [Configuration of the Camunda Helm Chart](/docs/self-managed/setup/guides/using-existing-keycloak/) | ||
| - [Configuration of Keycloak](/docs/next/self-managed/identity/user-guide/configuration/configure-external-identity-provider/) |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'Configuration of Keycloak'. Please specify the file extension.
| - **NGINX Ingress Controller**: Ensure the NGINX ingress controller is set up in the cluster. | ||
| - **Persistent Volumes**: Configure block storage persistent volumes for stateful components. | ||
| - **Namespace Configuration**: Plan and create namespaces with appropriate resource quotas and LimitRanges for the Camunda Helm Chart. | ||
| - **Resource Planning**: Evaluate sufficient CPU, memory, and storage necessary for the deployment. Have a look at our [sizing guide](/docs/next/components/best-practices/architecture/sizing-your-environment/#camunda-8-self-managed) for more information. |
There was a problem hiding this comment.
[docsInstance.hrefDocsToDocs] Improper link format: 'sizing guide'. Please specify the file extension.
| policyName: core-record-retention-policy | ||
| ``` | ||
|
|
||
| If you would like more information on configuring ILM policy. Please refer to [our guide](/docs/next/self-managed/operate-deployment/data-retention/). |
|
The preview environment relating to the commit d9445fa has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4703/index.html |
Description
closes: https://github.com/camunda/distribution/issues/344
When should this change go live?
holdlabel or convert to draft PR)PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).