diff --git a/docs/components/zeebe/technical-concepts/batch-operations.md b/docs/components/zeebe/technical-concepts/batch-operations.md index 3c2f506a75d..a9a4a8dc923 100644 --- a/docs/components/zeebe/technical-concepts/batch-operations.md +++ b/docs/components/zeebe/technical-concepts/batch-operations.md @@ -381,9 +381,12 @@ For very large batches (100,000+ items), enabling this option causes a temporary ```yaml # In your broker configuration file (for example, broker.yaml) -exporters: - camundaexporter: - args: - batchOperation: - exportItemsOnCreation: false +zeebe: + broker: + ... + exporters: + camundaexporter: + args: + batchOperation: + exportItemsOnCreation: false ``` diff --git a/docs/self-managed/components/orchestration-cluster/zeebe/configuration/broker.md b/docs/self-managed/components/orchestration-cluster/zeebe/configuration/broker.md index d8fe788d050..b49fd634573 100644 --- a/docs/self-managed/components/orchestration-cluster/zeebe/configuration/broker.md +++ b/docs/self-managed/components/orchestration-cluster/zeebe/configuration/broker.md @@ -920,9 +920,12 @@ Each exporter should be configured following this template: #### YAML snippet ```yaml -exporters: - jarPath: - className: +zeebe: + broker: + ... + exporters: + jarPath: + className: ``` ### zeebe.broker.exporters.elasticsearch diff --git a/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/broker.md b/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/broker.md index cb3d14a3072..534988e138c 100644 --- a/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/broker.md +++ b/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/broker.md @@ -911,9 +911,12 @@ Each exporter should be configured following this template: #### YAML snippet ```yaml -exporters: - jarPath: - className: +zeebe: + broker: + ... + exporters: + jarPath: + className: ``` ### zeebe.broker.exporters.elasticsearch diff --git a/versioned_docs/version-8.6/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md b/versioned_docs/version-8.6/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md index 2ac9f31c835..0853b261fb5 100644 --- a/versioned_docs/version-8.6/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md +++ b/versioned_docs/version-8.6/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md @@ -43,11 +43,14 @@ The exporter can be enabled by configuring it with the `classpath` in the broker For example: ```yaml -exporters: - elasticsearch: - className: io.camunda.zeebe.exporter.ElasticsearchExporter - args: - # Refer to the table below for the available args options +zeebe: + broker: + ... + exporters: + elasticsearch: + className: io.camunda.zeebe.exporter.ElasticsearchExporter + args: + # Refer to the table below for the available args options ``` The exporter can be configured by providing `args`. The table below explains all the different @@ -172,75 +175,78 @@ Here is an example configuration of the exporter: ```yaml --- -exporters: - elasticsearch: - # Elasticsearch Exporter ---------- - # An example configuration for the elasticsearch exporter: - # - # These setting can also be overridden using the environment variables "ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_..." - # - - className: io.camunda.zeebe.exporter.ElasticsearchExporter - - args: - # A comma separated list of URLs pointing to the Elasticsearch instances you wish to export to. - # For example, if you want to connect to multiple nodes for redundancy: - # url: http://localhost:9200,http://localhost:9201 - url: http://localhost:9200 - - bulk: - delay: 5 - size: 1000 - memoryLimit: 10485760 - - retention: - enabled: true - minimumAge: 30d - policyName: zeebe-records-retention-policy - - authentication: - username: elastic - password: changeme - - index: - prefix: zeebe-record - createTemplate: true - - indexSuffixDatePattern: "yyyy-MM-dd" - - command: false - event: true - rejection: false - - commandDistribution: true - decisionRequirements: true - decision: true - decisionEvaluation: true - deployment: true - deploymentDistribution: true - error: true - escalation: true - form: true - incident: true - job: true - jobBatch: false - message: true - messageStartSubscription: true - messageSubscription: true - process: true - processEvent: false - processInstance: true - processInstanceCreation: true - processInstanceMigration: true - processInstanceModification: true - processMessageSubscription: true - resourceDeletion: true - signal: true - signalSubscription: true - timer: true - userTask: true - variable: true - variableDocument: true +zeebe: + broker: + ... + exporters: + elasticsearch: + # Elasticsearch Exporter ---------- + # An example configuration for the elasticsearch exporter: + # + # These setting can also be overridden using the environment variables "ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_..." + # + + className: io.camunda.zeebe.exporter.ElasticsearchExporter + + args: + # A comma separated list of URLs pointing to the Elasticsearch instances you wish to export to. + # For example, if you want to connect to multiple nodes for redundancy: + # url: http://localhost:9200,http://localhost:9201 + url: http://localhost:9200 + + bulk: + delay: 5 + size: 1000 + memoryLimit: 10485760 + + retention: + enabled: true + minimumAge: 30d + policyName: zeebe-records-retention-policy + + authentication: + username: elastic + password: changeme + + index: + prefix: zeebe-record + createTemplate: true + + indexSuffixDatePattern: "yyyy-MM-dd" + + command: false + event: true + rejection: false + + commandDistribution: true + decisionRequirements: true + decision: true + decisionEvaluation: true + deployment: true + deploymentDistribution: true + error: true + escalation: true + form: true + incident: true + job: true + jobBatch: false + message: true + messageStartSubscription: true + messageSubscription: true + process: true + processEvent: false + processInstance: true + processInstanceCreation: true + processInstanceMigration: true + processInstanceModification: true + processMessageSubscription: true + resourceDeletion: true + signal: true + signalSubscription: true + timer: true + userTask: true + variable: true + variableDocument: true ``` ## Self-signed certificates @@ -253,7 +259,6 @@ signed using trusted root certificate authorities. 1. First, create a new custom trust store which contains the same data as the default one, using PKCS12 format. To do so, find the location of the default `cacerts` trust store: - - On Linux systems, find it at `$JAVA_HOME/lib/security/cacerts`. - For macOS, find it under `$(/usr/libexec/java_home)/jre/lib/security/cacerts`. @@ -285,7 +290,6 @@ signed using trusted root certificate authorities. ``` Then, specify the following properties when running the application: - - `javax.net.ssl.trustStore`: must be set to the path of your custom trust store. - `javax.net.ssl.trustStorePassword`: set to your trust store password. diff --git a/versioned_docs/version-8.6/self-managed/zeebe-deployment/exporters/opensearch-exporter.md b/versioned_docs/version-8.6/self-managed/zeebe-deployment/exporters/opensearch-exporter.md index c5eb09a561e..cd558798893 100644 --- a/versioned_docs/version-8.6/self-managed/zeebe-deployment/exporters/opensearch-exporter.md +++ b/versioned_docs/version-8.6/self-managed/zeebe-deployment/exporters/opensearch-exporter.md @@ -43,11 +43,14 @@ The exporter can be enabled by configuring it with the classpath in the broker s For example: ```yaml -exporters: - opensearch: - className: io.camunda.zeebe.exporter.opensearch.OpensearchExporter - args: - # Refer to the table below for the available args options +zeebe: + broker: + ... + exporters: + opensearch: + className: io.camunda.zeebe.exporter.opensearch.OpensearchExporter + args: + # Refer to the table below for the available args options ``` The exporter can be configured by providing `args`. The table below explains all the different @@ -192,78 +195,81 @@ Here is an example configuration of the exporter: ```yaml --- -exporters: - opensearch: - # Opensearch Exporter ---------- - # An example configuration for the opensearch exporter: - # - # These setting can also be overridden using the environment variables "ZEEBE_BROKER_EXPORTERS_OPENSEARCH_..." - - className: io.camunda.zeebe.exporter.opensearch.OpensearchExporter - - args: - # A comma separated list of URLs pointing to the Opensearch instances you wish to export to. - # For example, if you want to connect to multiple nodes for redundancy: - # url: http://localhost:9200,http://localhost:9201 - url: http://localhost:9200 - - bulk: - delay: 5 - size: 1000 - memoryLimit: 10485760 - - retention: - enabled: true - minimumAge: 30d - policyName: zeebe-records-retention-policy - policyDescription: Zeebe records retention policy - - authentication: - username: opensearch - password: changeme - - aws: - enabled: true - serviceName: es - region: eu-west-1 - - index: - prefix: zeebe-record - createTemplate: true - - command: false - event: true - rejection: false - - commandDistribution: true - decisionRequirements: true - decision: true - decisionEvaluation: true - deployment: true - deploymentDistribution: true - error: true - escalation: true - form: true - incident: true - job: true - jobBatch: false - message: true - messageStartSubscription: true - messageSubscription: true - process: true - processEvent: false - processInstance: true - processInstanceCreation: true - processInstanceMigration: true - processInstanceModification: true - processMessageSubscription: true - resourceDeletion: true - signal: true - signalSubscription: true - timer: true - userTask: true - variable: true - variableDocument: true +zeebe: + broker: + ... + exporters: + opensearch: + # Opensearch Exporter ---------- + # An example configuration for the opensearch exporter: + # + # These setting can also be overridden using the environment variables "ZEEBE_BROKER_EXPORTERS_OPENSEARCH_..." + + className: io.camunda.zeebe.exporter.opensearch.OpensearchExporter + + args: + # A comma separated list of URLs pointing to the Opensearch instances you wish to export to. + # For example, if you want to connect to multiple nodes for redundancy: + # url: http://localhost:9200,http://localhost:9201 + url: http://localhost:9200 + + bulk: + delay: 5 + size: 1000 + memoryLimit: 10485760 + + retention: + enabled: true + minimumAge: 30d + policyName: zeebe-records-retention-policy + policyDescription: Zeebe records retention policy + + authentication: + username: opensearch + password: changeme + + aws: + enabled: true + serviceName: es + region: eu-west-1 + + index: + prefix: zeebe-record + createTemplate: true + + command: false + event: true + rejection: false + + commandDistribution: true + decisionRequirements: true + decision: true + decisionEvaluation: true + deployment: true + deploymentDistribution: true + error: true + escalation: true + form: true + incident: true + job: true + jobBatch: false + message: true + messageStartSubscription: true + messageSubscription: true + process: true + processEvent: false + processInstance: true + processInstanceCreation: true + processInstanceMigration: true + processInstanceModification: true + processMessageSubscription: true + resourceDeletion: true + signal: true + signalSubscription: true + timer: true + userTask: true + variable: true + variableDocument: true ``` ## Self-signed certificates @@ -276,7 +282,6 @@ signed using trusted root certificate authorities. 1. First, create a new custom trust store which contains the same data as the default one, using PKCS12 format. To do so, find the location of the default `cacerts` trust store: - - On Linux systems, find it at `$JAVA_HOME/lib/security/cacerts`. - For macOS, find it under `$(/usr/libexec/java_home)/jre/lib/security/cacerts`. @@ -308,7 +313,6 @@ signed using trusted root certificate authorities. ``` Then, specify the following properties when running the application: - - `javax.net.ssl.trustStore`: must be set to the path of your custom trust store. - `javax.net.ssl.trustStorePassword`: set to your trust store password. diff --git a/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/broker.md b/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/broker.md index 85ea2e085d3..4cd6b73b8cb 100644 --- a/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/broker.md +++ b/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/broker.md @@ -912,9 +912,12 @@ Each exporter should be configured following this template: #### YAML snippet ```yaml -exporters: - jarPath: - className: +zeebe: + broker: + ... + exporters: + jarPath: + className: ``` ### zeebe.broker.exporters.elasticsearch diff --git a/versioned_docs/version-8.7/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md b/versioned_docs/version-8.7/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md index 04295f7dbd6..dd6f59208cc 100644 --- a/versioned_docs/version-8.7/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md +++ b/versioned_docs/version-8.7/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md @@ -43,11 +43,14 @@ The exporter can be enabled by configuring it with the `classpath` in the broker For example: ```yaml -exporters: - elasticsearch: - className: io.camunda.zeebe.exporter.ElasticsearchExporter - args: - # Refer to the table below for the available args options +zeebe: + broker: + ... + exporters: + elasticsearch: + className: io.camunda.zeebe.exporter.ElasticsearchExporter + args: + # Refer to the table below for the available args options ``` The exporter can be configured by providing `args`. The table below explains all the different @@ -173,75 +176,78 @@ Here is an example configuration of the exporter: ```yaml --- -exporters: - elasticsearch: - # Elasticsearch Exporter ---------- - # An example configuration for the elasticsearch exporter: - # - # These setting can also be overridden using the environment variables "ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_..." - # - - className: io.camunda.zeebe.exporter.ElasticsearchExporter - - args: - # A comma separated list of URLs pointing to the Elasticsearch instances you wish to export to. - # For example, if you want to connect to multiple nodes for redundancy: - # url: http://localhost:9200,http://localhost:9201 - url: http://localhost:9200 - - bulk: - delay: 5 - size: 1000 - memoryLimit: 10485760 - - retention: - enabled: true - minimumAge: 30d - policyName: zeebe-records-retention-policy - - authentication: - username: elastic - password: changeme - - index: - prefix: zeebe-record - createTemplate: true - - indexSuffixDatePattern: "yyyy-MM-dd" - - command: false - event: true - rejection: false - - commandDistribution: true - decisionRequirements: true - decision: true - decisionEvaluation: true - deployment: true - deploymentDistribution: true - error: true - escalation: true - form: true - incident: true - job: true - jobBatch: false - message: true - messageStartSubscription: true - messageSubscription: true - process: true - processEvent: false - processInstance: true - processInstanceCreation: true - processInstanceMigration: true - processInstanceModification: true - processMessageSubscription: true - resourceDeletion: true - signal: true - signalSubscription: true - timer: true - userTask: true - variable: true - variableDocument: true +zeebe: + broker: + ... + exporters: + elasticsearch: + # Elasticsearch Exporter ---------- + # An example configuration for the elasticsearch exporter: + # + # These setting can also be overridden using the environment variables "ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_..." + # + + className: io.camunda.zeebe.exporter.ElasticsearchExporter + + args: + # A comma separated list of URLs pointing to the Elasticsearch instances you wish to export to. + # For example, if you want to connect to multiple nodes for redundancy: + # url: http://localhost:9200,http://localhost:9201 + url: http://localhost:9200 + + bulk: + delay: 5 + size: 1000 + memoryLimit: 10485760 + + retention: + enabled: true + minimumAge: 30d + policyName: zeebe-records-retention-policy + + authentication: + username: elastic + password: changeme + + index: + prefix: zeebe-record + createTemplate: true + + indexSuffixDatePattern: "yyyy-MM-dd" + + command: false + event: true + rejection: false + + commandDistribution: true + decisionRequirements: true + decision: true + decisionEvaluation: true + deployment: true + deploymentDistribution: true + error: true + escalation: true + form: true + incident: true + job: true + jobBatch: false + message: true + messageStartSubscription: true + messageSubscription: true + process: true + processEvent: false + processInstance: true + processInstanceCreation: true + processInstanceMigration: true + processInstanceModification: true + processMessageSubscription: true + resourceDeletion: true + signal: true + signalSubscription: true + timer: true + userTask: true + variable: true + variableDocument: true ``` ## Self-signed certificates diff --git a/versioned_docs/version-8.7/self-managed/zeebe-deployment/exporters/opensearch-exporter.md b/versioned_docs/version-8.7/self-managed/zeebe-deployment/exporters/opensearch-exporter.md index 44b4d1d3919..f57eeb8d294 100644 --- a/versioned_docs/version-8.7/self-managed/zeebe-deployment/exporters/opensearch-exporter.md +++ b/versioned_docs/version-8.7/self-managed/zeebe-deployment/exporters/opensearch-exporter.md @@ -43,11 +43,14 @@ The exporter can be enabled by configuring it with the classpath in the broker s For example: ```yaml -exporters: - opensearch: - className: io.camunda.zeebe.exporter.opensearch.OpensearchExporter - args: - # Refer to the table below for the available args options +zeebe: + broker: + ... + exporters: + opensearch: + className: io.camunda.zeebe.exporter.opensearch.OpensearchExporter + args: + # Refer to the table below for the available args options ``` The exporter can be configured by providing `args`. The table below explains all the different @@ -193,78 +196,81 @@ Here is an example configuration of the exporter: ```yaml --- -exporters: - opensearch: - # Opensearch Exporter ---------- - # An example configuration for the opensearch exporter: - # - # These setting can also be overridden using the environment variables "ZEEBE_BROKER_EXPORTERS_OPENSEARCH_..." - - className: io.camunda.zeebe.exporter.opensearch.OpensearchExporter - - args: - # A comma separated list of URLs pointing to the Opensearch instances you wish to export to. - # For example, if you want to connect to multiple nodes for redundancy: - # url: http://localhost:9200,http://localhost:9201 - url: http://localhost:9200 - - bulk: - delay: 5 - size: 1000 - memoryLimit: 10485760 - - retention: - enabled: true - minimumAge: 30d - policyName: zeebe-records-retention-policy - policyDescription: Zeebe records retention policy - - authentication: - username: opensearch - password: changeme - - aws: - enabled: true - serviceName: es - region: eu-west-1 - - index: - prefix: zeebe-record - createTemplate: true - - command: false - event: true - rejection: false - - commandDistribution: true - decisionRequirements: true - decision: true - decisionEvaluation: true - deployment: true - deploymentDistribution: true - error: true - escalation: true - form: true - incident: true - job: true - jobBatch: false - message: true - messageStartSubscription: true - messageSubscription: true - process: true - processEvent: false - processInstance: true - processInstanceCreation: true - processInstanceMigration: true - processInstanceModification: true - processMessageSubscription: true - resourceDeletion: true - signal: true - signalSubscription: true - timer: true - userTask: true - variable: true - variableDocument: true +zeebe: + broker: + ... + exporters: + opensearch: + # Opensearch Exporter ---------- + # An example configuration for the opensearch exporter: + # + # These setting can also be overridden using the environment variables "ZEEBE_BROKER_EXPORTERS_OPENSEARCH_..." + + className: io.camunda.zeebe.exporter.opensearch.OpensearchExporter + + args: + # A comma separated list of URLs pointing to the Opensearch instances you wish to export to. + # For example, if you want to connect to multiple nodes for redundancy: + # url: http://localhost:9200,http://localhost:9201 + url: http://localhost:9200 + + bulk: + delay: 5 + size: 1000 + memoryLimit: 10485760 + + retention: + enabled: true + minimumAge: 30d + policyName: zeebe-records-retention-policy + policyDescription: Zeebe records retention policy + + authentication: + username: opensearch + password: changeme + + aws: + enabled: true + serviceName: es + region: eu-west-1 + + index: + prefix: zeebe-record + createTemplate: true + + command: false + event: true + rejection: false + + commandDistribution: true + decisionRequirements: true + decision: true + decisionEvaluation: true + deployment: true + deploymentDistribution: true + error: true + escalation: true + form: true + incident: true + job: true + jobBatch: false + message: true + messageStartSubscription: true + messageSubscription: true + process: true + processEvent: false + processInstance: true + processInstanceCreation: true + processInstanceMigration: true + processInstanceModification: true + processMessageSubscription: true + resourceDeletion: true + signal: true + signalSubscription: true + timer: true + userTask: true + variable: true + variableDocument: true ``` ## Self-signed certificates