diff --git a/docs/self-managed/about-self-managed.md b/docs/self-managed/about-self-managed.md index a1d1f7eae1..d41b7986b9 100644 --- a/docs/self-managed/about-self-managed.md +++ b/docs/self-managed/about-self-managed.md @@ -22,20 +22,3 @@ The content in this section of the documentation includes: - Features specific to Camunda 8 Self-Managed. To get started with your Self-Managed installation, see our [installation overview](./setup/overview.md). - -## Components - - - -## Architecture - -Camunda 8 Self-Managed consists of multiple web applications and gRPC services. The following example architecture diagram uses two [Ingress objects](./setup/guides/ingress-setup.md#combined-ingress-setup) to access these services externally: an Ingress with HTTP(S) protocol for all web applications using a single domain, and another Ingress with gRPC protocol for the Zeebe workflow engine. - -![Camunda 8 Self-Managed Architecture Diagram - Combined Ingress](./assets/camunda-platform-8-self-managed-architecture-diagram-combined-ingress.png) - -In this configuration, Camunda 8 Self-Managed can be accessed as follows: - -- Identity, Operate, Optimize, Tasklist, Modeler: `https://camunda.example.com/[identity|operate|optimize|tasklist|modeler]` - - Web Modeler also exposes a WebSocket endpoint on `https://camunda.example.com/modeler-ws`. This is only used by the application itself and should not be accessed by users directly. -- Keycloak authentication: `https://camunda.example.com/auth` -- Zeebe Gateway: `grpc://zeebe.camunda.example.com` diff --git a/docs/self-managed/setup/install.md b/docs/self-managed/setup/install.md index 32d5c78c25..8df88d1c7e 100644 --- a/docs/self-managed/setup/install.md +++ b/docs/self-managed/setup/install.md @@ -1,7 +1,7 @@ --- id: install title: "Camunda 8 Helm installation" -sidebar_label: "Install" +sidebar_label: "Helm" description: "Camunda provides continuously improved Helm charts, of which are not cloud provider-specific so you can choose your Kubernetes provider." --- diff --git a/docs/self-managed/setup/overview.md b/docs/self-managed/setup/overview.md index 9ee1781553..1818675aa9 100644 --- a/docs/self-managed/setup/overview.md +++ b/docs/self-managed/setup/overview.md @@ -18,12 +18,13 @@ This guide contains information for users who want to install, deploy, and upgra For details on supported environments (e.g. Java or Elasticsearch versions), see [supported environments](/reference/supported-environments.md). -## Deployment options +## Production deployment - [**Helm/Kubernetes**](./install.md): We recommend using Kubernetes and Helm to deploy and run Camunda 8 Self-Managed in production. With the right configuration, Camunda 8 Self-Managed can be deployed on any Certified Kubernetes distribution (cloud or on-premises). We also officially support a variety of providers like [Red Hat OpenShift](./deploy/openshift/redhat-openshift.md) and [Amazon EKS](./deploy/amazon/amazon-eks/amazon-eks.md). - [**Docker**](./deploy/other/docker.md): Component [Docker images](https://hub.docker.com/u/camunda) are available for use in production on Linux systems. Windows or macOS are only supported for development environments. - [**Manual**](./deploy/local/manual.md): The Java applications can run on a local or virtual machine if it provides a supported Java Virtual Machine (JVM). This allows you to run Camunda on virtual machines or bare metal and offers a significant amount of flexibility. However, you will need to configure the details for the components to interact correctly yourself. We consider this a last resort. Note that Windows/Mac is **not** supported for production usage of Zeebe. -A **Docker Compose** configuration file is also provided for local development, and is **not** optimized for production usage. You can find setup instructions in the [camunda-platform](https://github.com/camunda/camunda-platform) repository. +## Local deployment -For more details on deployment, see [sizing your environment](../../components/best-practices/architecture/sizing-your-environment.md#camunda-8-self-managed). +- [**Docker Compose**](https://github.com/camunda/camunda-platform): A configuration file is also provided for local development, and is **not** optimized for production usage. +- [**Camunda 8 Run**](/self-managed/setup/deploy/local/c8run.md): Allows you to install and start a simplified, single-application Camunda configuration in a local development environment. diff --git a/docs/self-managed/setup/upgrade.md b/docs/self-managed/setup/upgrade.md index 70505ec522..0f96b0921d 100644 --- a/docs/self-managed/setup/upgrade.md +++ b/docs/self-managed/setup/upgrade.md @@ -1,7 +1,7 @@ --- id: upgrade title: "Camunda 8 Helm upgrade" -sidebar_label: "Upgrade" +sidebar_label: "Upgrade via Helm" description: "Upgrade to a more recent version of the Camunda Helm charts, and view configuration changes between versions." --- diff --git a/sidebars.js b/sidebars.js index cef1950a51..9e6c5657a6 100644 --- a/sidebars.js +++ b/sidebars.js @@ -935,81 +935,66 @@ module.exports = { "Self-Managed": [ "self-managed/about-self-managed", { - Setup: [ + Install: [ "self-managed/setup/overview", - "self-managed/setup/install", - "self-managed/setup/upgrade", + { + type: "doc", + label: "Helm", + id: "self-managed/setup/install", + }, + "self-managed/setup/deploy/other/docker", + "self-managed/setup/deploy/local/manual", { type: "category", - label: "Deploy", + label: "Local", items: [ + "self-managed/setup/deploy/local/c8run", + "self-managed/setup/deploy/local/local-kubernetes-cluster", + "self-managed/setup/deploy/local/docker-compose", + "self-managed/setup/deploy/local/manual", + ], + }, + ], + }, + { + type: "category", + label: "Deploy", + items: [ + { + "Amazon (AWS)": [ { - Local: [ - "self-managed/setup/deploy/local/c8run", - "self-managed/setup/deploy/local/local-kubernetes-cluster", - "self-managed/setup/deploy/local/docker-compose", - "self-managed/setup/deploy/local/manual", - ], - }, - { - "Amazon (AWS)": [ - { - type: "category", - label: "Amazon EKS", - link: { - type: "doc", - id: "self-managed/setup/deploy/amazon/amazon-eks/amazon-eks", - }, - items: [ - "self-managed/setup/deploy/amazon/amazon-eks/eks-eksctl", - "self-managed/setup/deploy/amazon/amazon-eks/eks-terraform", - "self-managed/setup/deploy/amazon/amazon-eks/eks-helm", - "self-managed/setup/deploy/amazon/amazon-eks/dual-region", - "self-managed/setup/deploy/amazon/amazon-eks/irsa", - ], - }, - "self-managed/setup/deploy/amazon/aws-marketplace", - ], - "Microsoft (Azure)": [ - "self-managed/setup/deploy/azure/microsoft-aks", - ], - "Google (GCP)": ["self-managed/setup/deploy/gcp/google-gke"], - "Red Hat (OpenShift)": [ - "self-managed/setup/deploy/openshift/redhat-openshift", - ], - Other: [ - "self-managed/setup/deploy/other/docker", - "self-managed/setup/deploy/local/manual", + type: "category", + label: "Amazon EKS", + link: { + type: "doc", + id: "self-managed/setup/deploy/amazon/amazon-eks/amazon-eks", + }, + items: [ + "self-managed/setup/deploy/amazon/amazon-eks/eks-eksctl", + "self-managed/setup/deploy/amazon/amazon-eks/eks-terraform", + "self-managed/setup/deploy/amazon/amazon-eks/eks-helm", + "self-managed/setup/deploy/amazon/amazon-eks/dual-region", + "self-managed/setup/deploy/amazon/amazon-eks/irsa", ], }, + "self-managed/setup/deploy/amazon/aws-marketplace", ], - }, - { - type: "category", - label: "Guides", - link: { - type: "doc", - id: "self-managed/setup/guides/guides", - }, - items: [ - "self-managed/setup/guides/accessing-components-without-ingress", - "self-managed/setup/guides/ingress-setup", - "self-managed/setup/guides/using-existing-keycloak", - "self-managed/setup/guides/using-existing-elasticsearch", - "self-managed/setup/guides/using-existing-opensearch", - "self-managed/setup/guides/configure-db-custom-headers", - "self-managed/setup/guides/connect-to-an-oidc-provider", - "self-managed/setup/guides/air-gapped-installation", - "self-managed/setup/guides/running-custom-connectors", - "self-managed/setup/guides/multi-namespace-deployment", - "self-managed/setup/guides/installing-payment-app-example", + "Microsoft (Azure)": [ + "self-managed/setup/deploy/azure/microsoft-aks", + ], + "Google (GCP)": ["self-managed/setup/deploy/gcp/google-gke"], + "Red Hat (OpenShift)": [ + "self-managed/setup/deploy/openshift/redhat-openshift", ], }, ], - "Operational guides": [ + }, + { + Upgrade: [ + "self-managed/setup/upgrade", { type: "category", - label: "Update guide", + label: "Update by version", link: { type: "doc", id: "self-managed/operational-guides/update-guide/introduction", @@ -1032,6 +1017,31 @@ module.exports = { }, ], }, + ], + }, + { + type: "category", + label: "Configure", + link: { + type: "doc", + id: "self-managed/setup/guides/guides", + }, + items: [ + "self-managed/setup/guides/accessing-components-without-ingress", + "self-managed/setup/guides/ingress-setup", + "self-managed/setup/guides/using-existing-keycloak", + "self-managed/setup/guides/using-existing-elasticsearch", + "self-managed/setup/guides/using-existing-opensearch", + "self-managed/setup/guides/configure-db-custom-headers", + "self-managed/setup/guides/connect-to-an-oidc-provider", + "self-managed/setup/guides/air-gapped-installation", + "self-managed/setup/guides/running-custom-connectors", + "self-managed/setup/guides/multi-namespace-deployment", + "self-managed/setup/guides/installing-payment-app-example", + ], + }, + { + "Operational guides": [ "self-managed/operational-guides/configure-multi-tenancy", { type: "category",