docs(self-managed): add Opensearch support to elasticsearch prefix indices page

docs/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md

@@ -0,0 +1,197 @@
+---
+id: prefix-elasticsearch-opensearch-indices
+title: "Prefix Elasticsearch and OpenSearch indices"
+sidebar_label: "Prefix Elasticsearch and OpenSearch indices"
+description: "Configure Elasticsearch and OpenSearch index prefixes to structure your data, and ensure data isolation."
+---
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
+## Overview
+
+Index prefixes allow you to append a unique identifier to each search index, such as in Elasticsearch or OpenSearch, making it easier to organize and retrieve relevant information by structuring your data. With a consistent prefix, all related indices are easily identifiable, simplifying queries and data management.
+
+Using index prefixes in Camunda ensures data isolation by allowing multiple Camunda instances to run on a shared cluster without accessing each other’s data. This is crucial for maintaining separation in multi-instance and multi-tenant environments, and when testing different configurations.
+
+:::note
+Changing the index prefix after a Camunda instance has been running will create new empty indices with the new prefix. There is no built-in migration support between old and new prefixes.
+:::
+
+## Prefix Elasticsearch indices
+
+<Tabs groupId="featured" defaultValue="envVars" queryString values={
+[
+{label: 'Environment variables', value: 'envVars' },
+{label: 'values.yaml', value: 'valuesYaml' },
+{label: 'application.yaml', value: 'applicationYaml' },
+]}>
+<TabItem value="envVars">
+
+```sh
+ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_INDEX_PREFIX=custom-zeebe
+
+CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX=custom
+CAMUNDA_OPERATE_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe
+
+CAMUNDA_TASKLIST_ELASTICSEARCH_INDEXPREFIX=custom
+CAMUNDA_TASKLIST_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe
+
+CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX=custom-optimize
+CAMUNDA_OPTIMIZE_ZEEBE_NAME=custom-zeebe
+```
+
+</TabItem>
+<TabItem value="valuesYaml">
+
+```yaml
+global:
+  elasticsearch:
+    prefix: custom-zeebe
+
+operate:
+  env:
+    - name: CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX
+      value: custom-webapp
+  migration:
+    env:
+      - name: CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX
+        value: custom-webapp
+
+tasklist:
+  env:
+    - name: CAMUNDA_TASKLIST_ELASTICSEARCH_INDEXPREFIX
+      value: custom-webapp
+
+optimize:
+  env:
+    - name: CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX
+      value: custom-optimize
+  migration:
+    env:
+      - name: CAMUNDA_OPTIMIZE_ZEEBE_NAME
+        value: custom-zeebe
+```
+
+</TabItem>
+<TabItem value="applicationYaml">
+
+```yaml
+zeebe:
+  broker:
+    exporters:
+      elasticsearch:
+        args:
+          index:
+            prefix: custom-zeebe
+camunda:
+  operate:
+    elasticsearch:
+      indexPrefix: custom
+    zeebeElasticsearch:
+      prefix: custom-zeebe
+  tasklist:
+    elasticsearch:
+      indexPrefix: custom
+    zeebeElasticsearch:
+      prefix: custom-zeebe
+  optimize:
+    elasticsearch:
+      settings:
+        index:
+          prefix: custom-optimize
+    zeebeElasticsearch:
+      prefix: custom-zeebe
+```
+
+</TabItem>
+
+</Tabs>
+
+## Prefix OpenSearch indices
+
+<Tabs groupId="searchEngineOps" defaultValue="envVars" values={[
+{ label: 'Environment variables', value: 'envVars' },
+{ label: 'values.yaml', value: 'valuesYaml' },
+{ label: 'application.yaml', value: 'applicationYaml' },
+]}>
+
+<TabItem value="envVars">
+```sh
+ZEEBE_BROKER_EXPORTERS_OPENSEARCH_ARGS_INDEX_PREFIX=custom-zeebe
+
+CAMUNDA_OPERATE_OPENSEARCH_INDEXPREFIX=custom
+CAMUNDA_OPERATE_ZEEBEOPENSEARCH_PREFIX=custom-zeebe
+
+CAMUNDA_TASKLIST_OPENSEARCH_INDEXPREFIX=custom
+CAMUNDA_TASKLIST_ZEEBEOPENSEARCH_PREFIX=custom-zeebe
+
+CAMUNDA_OPTIMIZE_OPENSEARCH_SETTINGS_INDEX_PREFIX=custom-optimize
+CAMUNDA_OPTIMIZE_ZEEBE_NAME=custom-zeebe
+
+````
+</TabItem>
+<TabItem value="valuesYaml">
+
+```yaml
+global:
+  opensearch:
+    prefix: custom-zeebe
+
+operate:
+  env:
+    - name: CAMUNDA_OPERATE_OPENSEARCH_INDEXPREFIX
+      value: custom-webapp
+  migration:
+    env:
+      - name: CAMUNDA_OPERATE_OPENSEARCH_INDEXPREFIX
+        value: custom-webapp
+
+tasklist:
+  env:
+    - name: CAMUNDA_TASKLIST_OPENSEARCH_INDEXPREFIX
+      value: custom-webapp
+
+optimize:
+  env:
+    - name: CAMUNDA_OPTIMIZE_OPENSEARCH_SETTINGS_INDEX_PREFIX
+      value: custom-optimize
+  migration:
+    env:
+      - name: CAMUNDA_OPTIMIZE_ZEEBE_NAME
+        value: custom-zeebe
+````
+
+</TabItem>
+
+<TabItem value="applicationYaml">
+```yaml
+zeebe:
+  broker:
+    exporters:
+      opensearch:
+        args:
+          index:
+            prefix: custom-zeebe
+camunda:
+  operate:
+    opensearch:
+      indexPrefix: custom
+    zeebeOpensearch:
+      prefix: custom-zeebe
+  tasklist:
+    opensearch:
+      indexPrefix: custom
+    zeebeOpensearch:
+      prefix: custom-zeebe
+  optimize:
+    opensearch:
+      settings:
+        index:
+          prefix: custom-optimize
+    zeebeOpensearch:
+      prefix: custom-zeebe
+```
+</TabItem>
+
+</Tabs>

sidebars.js

@@ -1054,7 +1054,7 @@ module.exports = {
             "self-managed/setup/guides/add-extra-manifests",
             "self-managed/setup/guides/air-gapped-installation",
             "self-managed/setup/guides/running-custom-connectors",
-            "self-managed/setup/guides/prefix-elasticsearch-indices",
+            "self-managed/setup/guides/prefix-elasticsearch-opensearch-indices",
             "self-managed/setup/guides/multi-namespace-deployment",
             "self-managed/setup/guides/installing-payment-app-example",
             "self-managed/setup/guides/secret-management",

static/.htaccess

@@ -149,6 +149,16 @@ RewriteRule ^optimize/3.11.0/self-managed/(.*)$ /docs/8.3/self-managed/$1 [R=301
 #   8.8: content moves introduced prior to the release of version 8.8.
 #---------------------------------------------------------------------------------
 
+# Rename indices page
+RewriteRule ^docs/self-managed/setup/guides/prefix-elasticsearch-indices/(.*)$ /docs/
+self-managed/setup/guides/prefix-elasticsearch-opensearch-indices/ [R=301,L]
+RewriteRule ^docs/8.7/self-managed/setup/guides/prefix-elasticsearch-indices/(.*)$ /docs/8.7/
+self-managed/setup/guides/prefix-elasticsearch-opensearch-indices/ [R=301,L]
+RewriteRule ^docs/8.6/self-managed/setup/guides/prefix-elasticsearch-indices/(.*)$ /docs/8.6/
+self-managed/setup/guides/prefix-elasticsearch-opensearch-indices/ [R=301,L]
+RewriteRule ^docs/8.5/self-managed/setup/guides/prefix-elasticsearch-indices/(.*)$ /docs/8.5/
+self-managed/setup/guides/prefix-elasticsearch-opensearch-indices/ [R=301,L]
+
 # Remove Tasklist GraphQL API in 8.8
 RewriteRule ^docs/next/apis-tools/tasklist-api/(.*)$ /docs/next/apis-tools/camunda-api-rest/camunda-api-rest-overview/ [R=301,L]