diff --git a/docs/components/console/manage-clusters/manage-api-clients.md b/docs/components/console/manage-clusters/manage-api-clients.md index 1aedf801c1..daea6fd920 100644 --- a/docs/components/console/manage-clusters/manage-api-clients.md +++ b/docs/components/console/manage-clusters/manage-api-clients.md @@ -40,6 +40,14 @@ When the rate limit is triggered, the client will receive an HTTP 429 response. ## Create a client +Currently, Camunda 8 SaaS supports the following scopes: + +- Zeebe - Access to the [Zeebe gRPC](/apis-tools/zeebe-api/grpc.md) and [REST](/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md) APIs. +- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API. +- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md). +- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/overview). +- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md). + To create a client, take the following steps: 1. Navigate into the **API** tab. diff --git a/docs/guides/setup-client-connection-credentials.md b/docs/guides/setup-client-connection-credentials.md index 67bf51523d..73662335c6 100644 --- a/docs/guides/setup-client-connection-credentials.md +++ b/docs/guides/setup-client-connection-credentials.md @@ -9,6 +9,16 @@ description: "Set up client connection credentials to create, name, and connect Here, we'll set up client connection credentials to create, name, and connect your client. +## Create a client + +Currently, Camunda 8 SaaS supports the following scopes: + +- Zeebe - Access to the [Zeebe gRPC](/apis-tools/zeebe-api/grpc.md) and [REST](/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md) APIs. +- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API. +- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md). +- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/overview). +- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md). + To create a new client, take the following steps: 1. Navigate to the API tab [in Camunda Console](https://console.cloud.camunda.io/) by clicking **Clusters > Cluster name > API**. diff --git a/docs/reference/release-notes/860.md b/docs/reference/release-notes/860.md index b8fbab87dc..223221f93c 100644 --- a/docs/reference/release-notes/860.md +++ b/docs/reference/release-notes/860.md @@ -2,12 +2,26 @@ id: 860 title: "8.6 Release notes" description: "Release notes for 8.6, including alphas" +keywords: + ["product development lifecycle", "software development lifecycle", "CI/CD"] --- ## Enhancements ## 8.6.0-alpha1 +### Process development lifecycle (PDLC) blueprint + + + +Developing and releasing Camunda processes in compliance with your organization's policies often creates a long-running, sometimes complex process across many endpoints - a great use case for an orchestrator like Camunda. Camunda is taking the first steps to orchestrate the development lifecycle using its own engine, relevant Connectors, and a [customizable blueprint](https://marketplace.camunda.com/en-US/apps/439170/cicd-pipeline) that you can modify to fit your needs. + +### Process application MVP (SaaS only) + + + +The [process application](/components/modeler/web-modeler/process-applications.md) is a special type of folder in Web Modeler that enables bulk actions like deploying all assets together. This reduces the risk of having a broken deployment at runtime and makes it more convenient to deploy related files. + ### Instance modification as batch diff --git a/docs/self-managed/tasklist-deployment/data-retention.md b/docs/self-managed/tasklist-deployment/data-retention.md index bb5b6fc547..ce9da9ca7c 100644 --- a/docs/self-managed/tasklist-deployment/data-retention.md +++ b/docs/self-managed/tasklist-deployment/data-retention.md @@ -54,6 +54,8 @@ Only indices containing dates in their suffix may be deleted. ### OpenSearch -OpenSearch does not support the Index Lifecycle Management (ILM) Policy, and instead uses Index State Management. Refer to the [AWS documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ism.html) for configuration guidance. +OpenSearch does not support the Index Lifecycle Management (ILM) Policy, and instead uses Index State Management (ISM). The same environment variables that are used to activate ILM on Elasticsearch can be used to activate ISM on OpenSearch. +```yaml As of the 8.4 release, Tasklist is now compatible with [Amazon OpenSearch](https://aws.amazon.com/de/opensearch-service/) 2.5.x. Note that using Amazon OpenSearch requires [setting up a new Camunda installation](/self-managed/setup/overview.md). A migration from previous versions or Elasticsearch environments is currently not supported. +``` diff --git a/docusaurus.config.js b/docusaurus.config.js index 72e0deff4e..d5ebc29266 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -139,6 +139,7 @@ module.exports = { "data-modal-disclaimer": "Welcome to Camunda 8 Smart docs, powered by AI. Accessing developer docs, forum posts and product blogs from the last year, responses are generated by combining various sources to formulate the best possible answer. If you have feedback please give a thumbs up or down as we continue to improve the AI.", "data-modal-example-questions": `What's new in Camunda ${latestVersion}?,What's Camunda SaaS vs Self-Managed?`, + "data-search-mode-enabled": "true", async: true, }, ], diff --git a/optimize/self-managed/optimize-deployment/configuration/service-config.yaml b/optimize/self-managed/optimize-deployment/configuration/service-config.yaml index f650474ba8..23b92e2a00 100644 --- a/optimize/self-managed/optimize-deployment/configuration/service-config.yaml +++ b/optimize/self-managed/optimize-deployment/configuration/service-config.yaml @@ -597,8 +597,3 @@ externalVariable: scheduleIntervalInMinutes: 10 # A rollover is triggered when the size of the current external variable index matches or exceeds the maxIndexSizeGB threshold. maxIndexSizeGB: 50 - -telemetry: - # Sets the initial property value of telemetry configuration once when it has never been enabled/disabled before. - # Telemetry can later be enabled/disabled in the UI by superusers - initializeTelemetry: false diff --git a/optimize/self-managed/optimize-deployment/configuration/system-configuration.md b/optimize/self-managed/optimize-deployment/configuration/system-configuration.md index 25af920729..5bb021e10c 100644 --- a/optimize/self-managed/optimize-deployment/configuration/system-configuration.md +++ b/optimize/self-managed/optimize-deployment/configuration/system-configuration.md @@ -336,16 +336,6 @@ Customize the Optimize UI e.g. by adjusting the logo, head background color etc. | externalVariable.variableIngestion.maxBatchRequestBytes | 10485760 | Content length limit for a variable ingestion REST API bulk request in bytes. Requests will be rejected when exceeding that limit. Defaults to 10MB. In case this limit is raised you should carefully tune the heap memory accordingly, see Adjust Optimize heap size on how to do that. | | externalVariable.variableIngestion.maxRequests | 5 | The maximum number of variable ingestion requests that can be serviced at any given time. | -### Telemetry configuration - -Camunda 7 only - -Configuration of initial telemetry settings. - -| YAML path | Default value | Description | -| ----------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| telemetry.initializeTelemetry | false | Decides whether telemetry is initially enabled or disabled when Optimize starts. Thereafter, telemetry can be turned on and off in the UI by superusers. If enabled, information about the setup and usage of the Optimize is sent to remote Camunda servers for the sake of analytical evaluation. When enabled, the following information is sent every 24 hours: Optimize version, License Key, Optimize installation ID, Database version.

Legal note: Before you install Camunda Optimize version >= 3.2.0 or activate the telemetric functionality, please make sure that you are authorized to take this step, and that the installation or activation of the telemetric functionality is not in conflict with any internal company policies, compliance guidelines, any contractual or other provisions or obligations of your company. Camunda cannot be held responsible in the event of unauthorized installation or activation of this function. | - ### Other Settings of plugin subsystem serialization format, variable import, Camunda endpoint. diff --git a/optimize/self-managed/optimize-deployment/configuration/telemetry.md b/optimize/self-managed/optimize-deployment/configuration/telemetry.md deleted file mode 100644 index f9691209c3..0000000000 --- a/optimize/self-managed/optimize-deployment/configuration/telemetry.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -id: telemetry -title: "Telemetry" -description: "Learn about Optimize telemetry, what data is collected and why." ---- - -Camunda 7 only - -At Camunda, we strive to offer excellent user experience at a high and stable level. On a strict opt-in basis, we are looking to collect environment and usage data to further improve the user experience for you. These insights help us to understand typical environment setups and product usage patterns and will be used to inform product improvement decisions to your benefit. - -The telemetry reporting is disabled by default and only collects and sends data after you explicitly enable the telemetry configuration flag. The configuration can be changed by `superusers` at any time during runtime via a configuration menu option in the UI. - -The collected data will be sent once every 24 hours via HTTPS, and it is ensured that the performance of Optimize will not be negatively affected by the reporting, even if the telemetry reporter faces unexpected errors. Furthermore, no data will be collected and sent when you stop Optimize. - -## Collected data - -Below you find the full list of data we want to collect, followed by a real-world example. On a conceptual level, they can be categorized into general data and meta/environment data. - -### General data - -The general data category contains information about your Optimize installation: - -| Item | Explanation | -| --------------- | -------------------------------------------------------------------- | -| Installation | A unique installation ID stored in Optimize's Elasticsearch database | -| Product name | The name of the product (i.e. `Camunda Optimize`) | -| Product version | The version of Optimize you are running | -| Product edition | The edition of the product (i.e. "enterprise") | - -### Meta/environment data - -The meta/environment data category contains information about the environmental setup: - -| Item | Explanation | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Database vendor | The database vendor (i.e. `Elasticsearch`) | -| Database version | The version of Elasticsearch Optimize is using | -| License Key: Customer name | The customer name that appears in the license key you are using with this Optimize installation | -| License Key: Type | The type of license key used with this Optimize installation | -| License Key: Valid Until | The expiry date of the license key used with this Optimize installation | -| License Key: Unlimited | A flag that indicates whether this license key is unlimited | -| License Key: Features | A map which includes information on which products can be used with this license key | -| License Key: Raw | The raw license key string without signature. We add this just in case some properties are listed in the raw license key that have not yet been mapped to other fields (eg. the features map). | -| Engine Installation IDs | A list containing the ID of each engine connected to this Optimize installation | - -### Example - -Below is an example payload including all telemetry data currently sent by Optimize. - -``` -{ - "installation": "7b86edba-fcb7-11ea-adc1-0242ac120002", - "product": { - "name": "Camunda Optimize", - "version": "3.2.0", - "edition": "enterprise", - "internals": { - "database": { - "vendor": "elasticsearch", - "version": "7.0.0" - }, - "license-key": { - "customer": "a customer name", - "type": "UNIFIED", - "valid-until": "2025-01-01", - "unlimited": "false", - "features": { - "camundaBPM": "false", - "optimize": "true", - "cawemo": "false" - }, - "raw": - "customer = a customer name; expiryDate = 2025-01-01; optimize: true;" - }, - "engine-installation-ids": - [ "8343cc7a-8ad1-42d4-97d2-43452c0bdfa3", - "22607b92-fcb8-11ea-adc1-0242ac120002" ] - } - } -} -``` - -## How to enable telemetry - -### Optimize configuration - -You can enable telemetry before starting Optimize by setting the `initializeTelemetry` flag in your configuration file to `true`. Refer to the [configuration section](./system-configuration.md#telemetry-configuration) for more details. - -### UI - -Once Optimize is running, telemetry can be enabled (or disabled) via a modal accessible from the user menu. Only superusers are authorized to access this menu and alter the telemetry configuration. - -## Legal note - -Before you install Camunda Optimize version >= 3.2.0 or activate the telemetric functionality, please make sure that you are authorized to take this step, and that the installation or activation of the telemetric functionality is not in conflict with any internal company policies, compliance guidelines, any contractual or other provisions or obligations of your company. - -Camunda cannot be held responsible in the event of unauthorized installation or activation of this function. diff --git a/optimize/self-managed/optimize-deployment/migration-update/3.13_8.5-to-3.14_8.6.md b/optimize/self-managed/optimize-deployment/migration-update/3.13_8.5-to-3.14_8.6.md index 30a195d842..06345baffc 100644 --- a/optimize/self-managed/optimize-deployment/migration-update/3.13_8.5-to-3.14_8.6.md +++ b/optimize/self-managed/optimize-deployment/migration-update/3.13_8.5-to-3.14_8.6.md @@ -19,6 +19,10 @@ Here you will find information about: ## Changes in supported environments +### Telemetry + +Optimize no longer gathers telemetry data. This change includes removing it from UI and ElasticSearch. The associated key in configuration file (`telemetry.telemetryEndpoint`) was removed. + ### Camunda 7 In Optimize, the minimum supported version of `Java` is 21. diff --git a/optimize_sidebars.js b/optimize_sidebars.js index c1702e8565..5630ff6d32 100644 --- a/optimize_sidebars.js +++ b/optimize_sidebars.js @@ -2687,7 +2687,6 @@ module.exports = { "self-managed/optimize-deployment/configuration/multi-tenancy", "self-managed/optimize-deployment/configuration/multiple-engines", "self-managed/optimize-deployment/configuration/setup-event-based-processes", - "self-managed/optimize-deployment/configuration/telemetry", "self-managed/optimize-deployment/configuration/common-problems", ], }, diff --git a/sidebars.js b/sidebars.js index 506a697602..1c62c7e13f 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1181,10 +1181,6 @@ module.exports = { "Event-based processes", "self-managed/optimize-deployment/configuration/setup-event-based-processes/" ), - optimizeLink( - "Telemetry", - "self-managed/optimize-deployment/configuration/telemetry/" - ), optimizeLink( "Common problems", "self-managed/optimize-deployment/configuration/common-problems/" diff --git a/static/.htaccess b/static/.htaccess index 96b484fecd..9cadd3289e 100644 --- a/static/.htaccess +++ b/static/.htaccess @@ -6,6 +6,9 @@ RewriteRule (.*) https://%{SERVER_NAME}/$1 [R=301,L] # Disable directory listing and multi views Options -Indexes -MultiViews +# Removing telemetry page +RewriteRule ^optimize/self-managed/optimize-deployment/configuration/telemetry/(.*)$ /optimize/self-managed/optimize-deployment/configuration/getting-started/$1 [R=301,L] + # Remove updating-tasklist pages RewriteRule ^docs/components/tasklist/userguide/updating-tasklist-cloud/?$ /docs/self-managed/operational-guides/update-guide/introduction/$1 [R=301,L] RewriteRule ^docs/8.5/components/tasklist/userguide/updating-tasklist-cloud/?$ /docs/8.5/self-managed/operational-guides/update-guide/introduction/$1 [R=301,L] @@ -19,7 +22,6 @@ RewriteRule ^docs/8.4/self-managed/tasklist-deployment/updating-tasklist/?$ /doc RewriteRule ^docs/8.3/self-managed/tasklist-deployment/updating-tasklist/?$ /docs/8.3/self-managed/operational-guides/update-guide/introduction/$1 [R=301,L] RewriteRule ^docs/8.2/self-managed/tasklist-deployment/updating-tasklist/?$ /docs/8.2/guides/update-guide/introduction/$1 [R=301,L] - # Remove community Node Zeebe page RewriteRule ^docs/apis-tools/community-clients/javascript/?$ /docs/apis-tools/node-js-sdk/$1 [R=301,L] RewriteRule ^docs/8.5/apis-tools/community-clients/javascript/?$ /docs/8.5/apis-tools/node-js-sdk/$1 [R=301,L] diff --git a/versioned_docs/version-8.2/components/console/manage-clusters/manage-api-clients.md b/versioned_docs/version-8.2/components/console/manage-clusters/manage-api-clients.md index be04325646..033bc50035 100644 --- a/versioned_docs/version-8.2/components/console/manage-clusters/manage-api-clients.md +++ b/versioned_docs/version-8.2/components/console/manage-clusters/manage-api-clients.md @@ -24,6 +24,14 @@ The officially offered client libraries (as well as the Node.js client) have alr ### Create a client +Currently, Camunda 8 SaaS supports the following scopes: + +- Zeebe - Access to the [Zeebe gRPC](/apis-tools/grpc.md) API. +- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API. +- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md). +- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/optimize-api-authorization). +- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md). + To create a client, take the following steps: 1. Navigate into the **API** tab. diff --git a/versioned_docs/version-8.2/guides/setup-client-connection-credentials.md b/versioned_docs/version-8.2/guides/setup-client-connection-credentials.md index 61447e8cab..661604332c 100644 --- a/versioned_docs/version-8.2/guides/setup-client-connection-credentials.md +++ b/versioned_docs/version-8.2/guides/setup-client-connection-credentials.md @@ -9,6 +9,16 @@ description: "Set up client connection credentials to create, name, and connect Here, we'll set up client connection credentials to create, name, and connect your client. +## Create a client + +Currently, Camunda 8 SaaS supports the following scopes: + +- Zeebe - Access to the [Zeebe gRPC](/apis-tools/grpc.md) API. +- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API. +- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md). +- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/optimize-api-authorization). +- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md). + To create a new client, take the following steps: 1. Navigate to the API tab [in Camunda Console](https://console.cloud.camunda.io/) by clicking **Organization > Cluster name > API**. diff --git a/versioned_docs/version-8.3/components/console/manage-clusters/manage-api-clients.md b/versioned_docs/version-8.3/components/console/manage-clusters/manage-api-clients.md index d49f79b0e1..e0f50f7cce 100644 --- a/versioned_docs/version-8.3/components/console/manage-clusters/manage-api-clients.md +++ b/versioned_docs/version-8.3/components/console/manage-clusters/manage-api-clients.md @@ -26,6 +26,14 @@ The officially offered [client libraries](../../../apis-tools/working-with-apis- ## Create a client +Currently, Camunda 8 SaaS supports the following scopes: + +- Zeebe - Access to the [Zeebe gRPC](/apis-tools/grpc.md) API. +- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API. +- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md). +- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/optimize-api-authorization). +- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md). + To create a client, take the following steps: 1. Navigate into the **API** tab. diff --git a/versioned_docs/version-8.3/guides/setup-client-connection-credentials.md b/versioned_docs/version-8.3/guides/setup-client-connection-credentials.md index 67bf51523d..6de800eded 100644 --- a/versioned_docs/version-8.3/guides/setup-client-connection-credentials.md +++ b/versioned_docs/version-8.3/guides/setup-client-connection-credentials.md @@ -9,6 +9,16 @@ description: "Set up client connection credentials to create, name, and connect Here, we'll set up client connection credentials to create, name, and connect your client. +## Create a client + +Currently, Camunda 8 SaaS supports the following scopes: + +- Zeebe - Access to the [Zeebe gRPC](/apis-tools/grpc.md) API. +- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API. +- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md). +- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/optimize-api-authorization). +- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md). + To create a new client, take the following steps: 1. Navigate to the API tab [in Camunda Console](https://console.cloud.camunda.io/) by clicking **Clusters > Cluster name > API**. diff --git a/versioned_docs/version-8.4/components/console/manage-clusters/manage-api-clients.md b/versioned_docs/version-8.4/components/console/manage-clusters/manage-api-clients.md index 1aedf801c1..8b576fa5ce 100644 --- a/versioned_docs/version-8.4/components/console/manage-clusters/manage-api-clients.md +++ b/versioned_docs/version-8.4/components/console/manage-clusters/manage-api-clients.md @@ -40,6 +40,14 @@ When the rate limit is triggered, the client will receive an HTTP 429 response. ## Create a client +Currently, Camunda 8 SaaS supports the following scopes: + +- Zeebe - Access to the [Zeebe gRPC](/apis-tools/zeebe-api/grpc.md) API. +- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API. +- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md). +- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/overview). +- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md). + To create a client, take the following steps: 1. Navigate into the **API** tab. diff --git a/versioned_docs/version-8.4/guides/setup-client-connection-credentials.md b/versioned_docs/version-8.4/guides/setup-client-connection-credentials.md index 8ccbd335be..d40e88b833 100644 --- a/versioned_docs/version-8.4/guides/setup-client-connection-credentials.md +++ b/versioned_docs/version-8.4/guides/setup-client-connection-credentials.md @@ -10,6 +10,16 @@ description: "Set up client connection credentials to create, name, and connect Here, we'll set up client connection credentials to create, name, and connect your client. +## Create a client + +Currently, Camunda 8 SaaS supports the following scopes: + +- Zeebe - Access to the [Zeebe gRPC](/apis-tools/zeebe-api/grpc.md) API. +- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API. +- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md). +- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/overview). +- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md). + To create a new client, take the following steps: 1. Navigate to the API tab [in Camunda Console](https://console.cloud.camunda.io/) by clicking **Clusters > Cluster name > API**. diff --git a/versioned_docs/version-8.4/self-managed/tasklist-deployment/data-retention.md b/versioned_docs/version-8.4/self-managed/tasklist-deployment/data-retention.md index 1c9ebfadb0..eb1b7e0f4b 100644 --- a/versioned_docs/version-8.4/self-managed/tasklist-deployment/data-retention.md +++ b/versioned_docs/version-8.4/self-managed/tasklist-deployment/data-retention.md @@ -54,6 +54,6 @@ Only indices containing dates in their suffix may be deleted. ### OpenSearch -OpenSearch does not support the Index Lifecycle Management (ILM) Policy, and instead uses Index State Management. Refer to the [AWS documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ism.html) for configuration guidance. +OpenSearch does not support the Index Lifecycle Management (ILM) Policy, and instead uses Index State Management (ISM). The same environment variables that are used to activate ILM on Elasticsearch can be used to activate ISM on OpenSearch. As of the 8.4 release, Tasklist is now compatible with [Amazon OpenSearch](https://aws.amazon.com/de/opensearch-service/) 2.5.x. Note that using Amazon OpenSearch requires [setting up a new Camunda installation](/self-managed/platform-deployment/overview.md). A migration from previous versions or Elasticsearch environments is currently not supported. diff --git a/versioned_docs/version-8.5/components/console/manage-clusters/manage-api-clients.md b/versioned_docs/version-8.5/components/console/manage-clusters/manage-api-clients.md index 1aedf801c1..daea6fd920 100644 --- a/versioned_docs/version-8.5/components/console/manage-clusters/manage-api-clients.md +++ b/versioned_docs/version-8.5/components/console/manage-clusters/manage-api-clients.md @@ -40,6 +40,14 @@ When the rate limit is triggered, the client will receive an HTTP 429 response. ## Create a client +Currently, Camunda 8 SaaS supports the following scopes: + +- Zeebe - Access to the [Zeebe gRPC](/apis-tools/zeebe-api/grpc.md) and [REST](/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md) APIs. +- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API. +- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md). +- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/overview). +- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md). + To create a client, take the following steps: 1. Navigate into the **API** tab. diff --git a/versioned_docs/version-8.5/guides/setup-client-connection-credentials.md b/versioned_docs/version-8.5/guides/setup-client-connection-credentials.md index 67bf51523d..73662335c6 100644 --- a/versioned_docs/version-8.5/guides/setup-client-connection-credentials.md +++ b/versioned_docs/version-8.5/guides/setup-client-connection-credentials.md @@ -9,6 +9,16 @@ description: "Set up client connection credentials to create, name, and connect Here, we'll set up client connection credentials to create, name, and connect your client. +## Create a client + +Currently, Camunda 8 SaaS supports the following scopes: + +- Zeebe - Access to the [Zeebe gRPC](/apis-tools/zeebe-api/grpc.md) and [REST](/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md) APIs. +- Tasklist - Access to the [Tasklist GraphQL](/apis-tools/tasklist-api/tasklist-api-overview.md) API. +- Operate - Access to the [Operate REST API](/apis-tools/operate-api/overview.md). +- Optimize - Access to the [Optimize REST API]($optimize$/apis-tools/optimize-api/overview). +- Secrets - Access cluster secrets in a [hybrid setup](/guides/use-connectors-in-hybrid-mode.md). + To create a new client, take the following steps: 1. Navigate to the API tab [in Camunda Console](https://console.cloud.camunda.io/) by clicking **Clusters > Cluster name > API**. diff --git a/versioned_docs/version-8.5/self-managed/tasklist-deployment/data-retention.md b/versioned_docs/version-8.5/self-managed/tasklist-deployment/data-retention.md index bb5b6fc547..0af2677c40 100644 --- a/versioned_docs/version-8.5/self-managed/tasklist-deployment/data-retention.md +++ b/versioned_docs/version-8.5/self-managed/tasklist-deployment/data-retention.md @@ -54,6 +54,6 @@ Only indices containing dates in their suffix may be deleted. ### OpenSearch -OpenSearch does not support the Index Lifecycle Management (ILM) Policy, and instead uses Index State Management. Refer to the [AWS documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ism.html) for configuration guidance. +OpenSearch does not support the Index Lifecycle Management (ILM) Policy, and instead uses Index State Management (ISM). The same environment variables that are used to activate ILM on Elasticsearch can be used to activate ISM on OpenSearch. As of the 8.4 release, Tasklist is now compatible with [Amazon OpenSearch](https://aws.amazon.com/de/opensearch-service/) 2.5.x. Note that using Amazon OpenSearch requires [setting up a new Camunda installation](/self-managed/setup/overview.md). A migration from previous versions or Elasticsearch environments is currently not supported.