diff --git a/docs/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md b/docs/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md new file mode 100644 index 00000000000..9d75c97e359 --- /dev/null +++ b/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 + + + + +```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 +``` + + + + +```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 +``` + + + + +```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 +``` + + + + + +## Prefix OpenSearch indices + + + + +```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 + +```` + + + +```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 +```` + + + + +```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 +``` + + + diff --git a/sidebars.js b/sidebars.js index e69992d4192..7ca8d07b914 100644 --- a/sidebars.js +++ b/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", diff --git a/static/.htaccess b/static/.htaccess index cc0395d9ce0..74e705a32dc 100644 --- a/static/.htaccess +++ b/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] diff --git a/versioned_docs/version-8.5/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md b/versioned_docs/version-8.5/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md deleted file mode 100644 index 3a3591dcba7..00000000000 --- a/versioned_docs/version-8.5/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -id: prefix-elasticsearch-indices -title: "Prefix Elasticsearch indices" -sidebar_label: "Prefix Elasticsearch indices" -description: "Configure Elasticsearch index prefixes to structure your data, and ensure data isolation." ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -## Overview - -Elasticsearch prefixes allow you to append a unique identifier to each Elasticsearch index, 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. -::: - -## Usage - - - - -```sh -ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_INDEX_PREFIX=custom-zeebe - -CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX=custom-operate -CAMUNDA_OPERATE_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe - -CAMUNDA_TASKLIST_ELASTICSEARCH_INDEXPREFIX=custom-tasklist -CAMUNDA_TASKLIST_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe - -CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX=custom-optimize -CAMUNDA_OPTIMIZE_ZEEBE_NAME=custom-zeebe -``` - - - - -```yaml -global: - elasticsearch: - prefix: custom-zeebe - -operate: - env: - - name: CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX - value: custom-operate - migration: - env: - - name: CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX - value: custom-operate - - name: CAMUNDA_OPERATE_ZEEBEELASTICSEARCH_PREFIX - value: custom-zeebe - -tasklist: - env: - - name: CAMUNDA_TASKLIST_ELASTICSEARCH_INDEXPREFIX - value: custom-tasklist - -optimize: - env: - - name: CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX - value: custom-optimize - migration: - env: - - name: CAMUNDA_OPTIMIZE_ZEEBE_NAME - value: custom-zeebe -``` - - - - -```yaml -zeebe: - broker: - exporters: - elasticsearch: - args: - index: - prefix: custom-zeebe -camunda: - operate: - elasticsearch: - indexPrefix: custom-operate - zeebeElasticsearch: - prefix: custom-zeebe - tasklist: - elasticsearch: - indexPrefix: custom-tasklist - zeebeElasticsearch: - prefix: custom-zeebe - optimize: - elasticsearch: - settings: - index: - prefix: custom-optimize - zeebeElasticsearch: - prefix: custom-zeebe -``` - - - - diff --git a/docs/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md b/versioned_docs/version-8.5/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md similarity index 54% rename from docs/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md rename to versioned_docs/version-8.5/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md index b2faf6fec53..12aa4e0cf1c 100644 --- a/docs/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md +++ b/versioned_docs/version-8.5/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md @@ -1,8 +1,8 @@ --- -id: prefix-elasticsearch-indices -title: "Prefix Elasticsearch indices" -sidebar_label: "Prefix Elasticsearch indices" -description: "Configure Elasticsearch index prefixes to structure your data, and ensure data isolation." +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"; @@ -10,7 +10,7 @@ import TabItem from "@theme/TabItem"; ## Overview -Elasticsearch prefixes allow you to append a unique identifier to each Elasticsearch index, 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. +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. @@ -18,7 +18,7 @@ Using index prefixes in Camunda ensures data isolation by allowing multiple Camu 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. ::: -## Usage +## Prefix Elasticsearch indices + +## Prefix OpenSearch indices + +:::note +Optimize is not supported in 8.5. +::: + + + + +```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 + +```` + + + +```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 + +```` + + + + +```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 +``` + + + diff --git a/versioned_docs/version-8.6/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md b/versioned_docs/version-8.6/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md deleted file mode 100644 index 3a3591dcba7..00000000000 --- a/versioned_docs/version-8.6/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -id: prefix-elasticsearch-indices -title: "Prefix Elasticsearch indices" -sidebar_label: "Prefix Elasticsearch indices" -description: "Configure Elasticsearch index prefixes to structure your data, and ensure data isolation." ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -## Overview - -Elasticsearch prefixes allow you to append a unique identifier to each Elasticsearch index, 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. -::: - -## Usage - - - - -```sh -ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_INDEX_PREFIX=custom-zeebe - -CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX=custom-operate -CAMUNDA_OPERATE_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe - -CAMUNDA_TASKLIST_ELASTICSEARCH_INDEXPREFIX=custom-tasklist -CAMUNDA_TASKLIST_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe - -CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX=custom-optimize -CAMUNDA_OPTIMIZE_ZEEBE_NAME=custom-zeebe -``` - - - - -```yaml -global: - elasticsearch: - prefix: custom-zeebe - -operate: - env: - - name: CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX - value: custom-operate - migration: - env: - - name: CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX - value: custom-operate - - name: CAMUNDA_OPERATE_ZEEBEELASTICSEARCH_PREFIX - value: custom-zeebe - -tasklist: - env: - - name: CAMUNDA_TASKLIST_ELASTICSEARCH_INDEXPREFIX - value: custom-tasklist - -optimize: - env: - - name: CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX - value: custom-optimize - migration: - env: - - name: CAMUNDA_OPTIMIZE_ZEEBE_NAME - value: custom-zeebe -``` - - - - -```yaml -zeebe: - broker: - exporters: - elasticsearch: - args: - index: - prefix: custom-zeebe -camunda: - operate: - elasticsearch: - indexPrefix: custom-operate - zeebeElasticsearch: - prefix: custom-zeebe - tasklist: - elasticsearch: - indexPrefix: custom-tasklist - zeebeElasticsearch: - prefix: custom-zeebe - optimize: - elasticsearch: - settings: - index: - prefix: custom-optimize - zeebeElasticsearch: - prefix: custom-zeebe -``` - - - - diff --git a/versioned_docs/version-8.6/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md b/versioned_docs/version-8.6/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md new file mode 100644 index 00000000000..28fda483aa0 --- /dev/null +++ b/versioned_docs/version-8.6/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 + + + + +```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 +``` + + + + +```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 +``` + + + + +```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 +``` + + + + + +## Prefix OpenSearch indices + + + + +```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 + +```` + + + +```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 +```` + + + + +```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 +``` + + + diff --git a/versioned_docs/version-8.7/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md b/versioned_docs/version-8.7/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md deleted file mode 100644 index 3a3591dcba7..00000000000 --- a/versioned_docs/version-8.7/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -id: prefix-elasticsearch-indices -title: "Prefix Elasticsearch indices" -sidebar_label: "Prefix Elasticsearch indices" -description: "Configure Elasticsearch index prefixes to structure your data, and ensure data isolation." ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -## Overview - -Elasticsearch prefixes allow you to append a unique identifier to each Elasticsearch index, 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. -::: - -## Usage - - - - -```sh -ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_INDEX_PREFIX=custom-zeebe - -CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX=custom-operate -CAMUNDA_OPERATE_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe - -CAMUNDA_TASKLIST_ELASTICSEARCH_INDEXPREFIX=custom-tasklist -CAMUNDA_TASKLIST_ZEEBEELASTICSEARCH_PREFIX=custom-zeebe - -CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX=custom-optimize -CAMUNDA_OPTIMIZE_ZEEBE_NAME=custom-zeebe -``` - - - - -```yaml -global: - elasticsearch: - prefix: custom-zeebe - -operate: - env: - - name: CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX - value: custom-operate - migration: - env: - - name: CAMUNDA_OPERATE_ELASTICSEARCH_INDEXPREFIX - value: custom-operate - - name: CAMUNDA_OPERATE_ZEEBEELASTICSEARCH_PREFIX - value: custom-zeebe - -tasklist: - env: - - name: CAMUNDA_TASKLIST_ELASTICSEARCH_INDEXPREFIX - value: custom-tasklist - -optimize: - env: - - name: CAMUNDA_OPTIMIZE_ELASTICSEARCH_SETTINGS_INDEX_PREFIX - value: custom-optimize - migration: - env: - - name: CAMUNDA_OPTIMIZE_ZEEBE_NAME - value: custom-zeebe -``` - - - - -```yaml -zeebe: - broker: - exporters: - elasticsearch: - args: - index: - prefix: custom-zeebe -camunda: - operate: - elasticsearch: - indexPrefix: custom-operate - zeebeElasticsearch: - prefix: custom-zeebe - tasklist: - elasticsearch: - indexPrefix: custom-tasklist - zeebeElasticsearch: - prefix: custom-zeebe - optimize: - elasticsearch: - settings: - index: - prefix: custom-optimize - zeebeElasticsearch: - prefix: custom-zeebe -``` - - - - diff --git a/versioned_docs/version-8.7/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md b/versioned_docs/version-8.7/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md new file mode 100644 index 00000000000..7218c5f75c0 --- /dev/null +++ b/versioned_docs/version-8.7/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 + + + + +```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 +``` + + + + +```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 +``` + + + + +```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 +``` + + + + + +## Prefix OpenSearch indices + + + + +```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 + +```` + + + +```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 +```` + + + + +```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 +``` + + + diff --git a/versioned_sidebars/version-8.5-sidebars.json b/versioned_sidebars/version-8.5-sidebars.json index 6d153dce05d..eb9f8ed7d40 100644 --- a/versioned_sidebars/version-8.5-sidebars.json +++ b/versioned_sidebars/version-8.5-sidebars.json @@ -1190,7 +1190,7 @@ "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/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" ] diff --git a/versioned_sidebars/version-8.6-sidebars.json b/versioned_sidebars/version-8.6-sidebars.json index 970a0bdec83..88500a6b315 100644 --- a/versioned_sidebars/version-8.6-sidebars.json +++ b/versioned_sidebars/version-8.6-sidebars.json @@ -1662,7 +1662,7 @@ "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" diff --git a/versioned_sidebars/version-8.7-sidebars.json b/versioned_sidebars/version-8.7-sidebars.json index fbc9334f66f..47edca58c40 100644 --- a/versioned_sidebars/version-8.7-sidebars.json +++ b/versioned_sidebars/version-8.7-sidebars.json @@ -1845,7 +1845,7 @@ "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/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"