Skip to content

Commit

Permalink
finishes some sections
Browse files Browse the repository at this point in the history
  • Loading branch information
hamza-m-masood committed Dec 12, 2024
1 parent 93e0c60 commit 221a59b
Showing 1 changed file with 60 additions and 6 deletions.
66 changes: 60 additions & 6 deletions docs/self-managed/operational-guides/production-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,71 @@ Below is the high-level architecture diagram for the base production setup _(cli

## Step-by-Step Installation Guide

### TLS (terminated at ingress)
### TLS setup with your DNS (terminated at ingress)

### DNS setup (exposing your domain)
In order to access the Camunda Platform through HTTPS ingress, you have to enable TLS. To do that, you must also specify a TLS secret. Here is an example values.yaml configuration:

### Deploying with OIDC
```yaml
global:
ingress:
host: "camunda.example.com"
tls:
enabled: true
secretName: camunda-platform
```
### External Elasticsearch
There is a separate ingress configuration for the core based on REST or GRPC:
### External PostgreSQL
Here is an example GRPC Ingress setup for the Core Camunda component.
(all external charts should be disabled)
```yaml
core:
ingress:
grpc:
enabled: true
className: nginx
host: "zeebe-grpc.camunda.example.com"
tls:
enabled: true
secretName: camunda-platform-core-grpc
```
Here is an example REST Ingress setup for the Core Camunda component.
```yaml
core:
ingress:
grpc:
enabled: true
className: nginx
host: "zeebe-rest.camunda.example.com"
tls:
enabled: true
secretName: camunda-platform-core-rest
```
Please refer to the [kuberntes documentation](https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets) on how to make a TLS secret
The certificate must be an X.509 certificate, issued by a trusted Certificate Authority.
Also, the certificate must include the correct domain names (Common Name or Subject Alternative Names) to secure ingress resources.
Please 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.
For more information on Ingress setup, please refer to our [ingress setup guide](http://localhost:3000/docs/next/self-managed/setup/guides/ingress-setup/)
### Deploying with OpenID Connect Provider
Please refer to the [Connect to an OpenID Connect provider](http://localhost:3000/docs/next/self-managed/setup/guides/connect-to-an-oidc-provider/)
### External Databases
To make it easy for testing, the Camunda Helm Chart provides external charts for Databases such as Elasticsearch and PostgresQL. Within a production setting, these dependency charts should be disabled and production databases should be used instead. For example, instead of the Elasticsearch dependency chart, elasti-cloud on GCP may be used, and instead of the PostgresQL dependency chart, you could use the Amazon Aurora PostgreSQL.
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/)
- [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)
### Upgrading the chart (disable secret generation on upgrades)
Expand Down

0 comments on commit 221a59b

Please sign in to comment.