diff --git a/docs/guides/update-guide/connectors/010-to-020.md b/docs/components/connectors/custom-built-connectors/update-guide/010-to-020.md similarity index 100% rename from docs/guides/update-guide/connectors/010-to-020.md rename to docs/components/connectors/custom-built-connectors/update-guide/010-to-020.md diff --git a/docs/guides/update-guide/connectors/0100-to-0110.md b/docs/components/connectors/custom-built-connectors/update-guide/0100-to-0110.md similarity index 100% rename from docs/guides/update-guide/connectors/0100-to-0110.md rename to docs/components/connectors/custom-built-connectors/update-guide/0100-to-0110.md diff --git a/docs/guides/update-guide/connectors/020-to-030.md b/docs/components/connectors/custom-built-connectors/update-guide/020-to-030.md similarity index 100% rename from docs/guides/update-guide/connectors/020-to-030.md rename to docs/components/connectors/custom-built-connectors/update-guide/020-to-030.md diff --git a/docs/guides/update-guide/connectors/030-to-040.md b/docs/components/connectors/custom-built-connectors/update-guide/030-to-040.md similarity index 82% rename from docs/guides/update-guide/connectors/030-to-040.md rename to docs/components/connectors/custom-built-connectors/update-guide/030-to-040.md index 5d79ef5f3f8..8eaec7c1a8b 100644 --- a/docs/guides/update-guide/connectors/030-to-040.md +++ b/docs/components/connectors/custom-built-connectors/update-guide/030-to-040.md @@ -27,9 +27,9 @@ With SDK version 0.4.0, we introduce many basic structural changes: ### Inbound webhook Spring Zeebe runtime with version `0.4.0` SDK introduces support of inbound webhook capabilities. -See the [list of available inbound Connectors](../../../components/connectors/out-of-the-box-connectors/available-connectors-overview.md). +See the [list of available inbound Connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md). -To function properly, Spring Zeebe runtime requires connection to [Operate API](../../../apis-tools/operate-api/overview.md). Read more on [how to connect to Operate or disable it completely](../../../self-managed/connectors-deployment/connectors-configuration.md#local-installation). +To function properly, Spring Zeebe runtime requires connection to [Operate API](/apis-tools/operate-api/overview.md). Read more on [how to connect to Operate or disable it completely](/self-managed/connectors-deployment/connectors-configuration.md#local-installation). ### What happens if I don't properly configure connection to Operate API? diff --git a/docs/guides/update-guide/connectors/040-to-050.md b/docs/components/connectors/custom-built-connectors/update-guide/040-to-050.md similarity index 100% rename from docs/guides/update-guide/connectors/040-to-050.md rename to docs/components/connectors/custom-built-connectors/update-guide/040-to-050.md diff --git a/docs/guides/update-guide/connectors/050-to-060.md b/docs/components/connectors/custom-built-connectors/update-guide/050-to-060.md similarity index 100% rename from docs/guides/update-guide/connectors/050-to-060.md rename to docs/components/connectors/custom-built-connectors/update-guide/050-to-060.md diff --git a/docs/guides/update-guide/connectors/060-to-070.md b/docs/components/connectors/custom-built-connectors/update-guide/060-to-070.md similarity index 100% rename from docs/guides/update-guide/connectors/060-to-070.md rename to docs/components/connectors/custom-built-connectors/update-guide/060-to-070.md diff --git a/docs/guides/update-guide/connectors/070-to-080.md b/docs/components/connectors/custom-built-connectors/update-guide/070-to-080.md similarity index 100% rename from docs/guides/update-guide/connectors/070-to-080.md rename to docs/components/connectors/custom-built-connectors/update-guide/070-to-080.md diff --git a/docs/guides/update-guide/connectors/080-to-090.md b/docs/components/connectors/custom-built-connectors/update-guide/080-to-090.md similarity index 100% rename from docs/guides/update-guide/connectors/080-to-090.md rename to docs/components/connectors/custom-built-connectors/update-guide/080-to-090.md diff --git a/docs/guides/update-guide/connectors/090-to-0100.md b/docs/components/connectors/custom-built-connectors/update-guide/090-to-0100.md similarity index 100% rename from docs/guides/update-guide/connectors/090-to-0100.md rename to docs/components/connectors/custom-built-connectors/update-guide/090-to-0100.md diff --git a/docs/guides/update-guide/connectors/introduction.md b/docs/components/connectors/custom-built-connectors/update-guide/introduction.md similarity index 100% rename from docs/guides/update-guide/connectors/introduction.md rename to docs/components/connectors/custom-built-connectors/update-guide/introduction.md diff --git a/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md b/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md index 9b61a0f3cd5..dc0c3fb5f0f 100644 --- a/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md +++ b/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md @@ -8,7 +8,7 @@ Out-of-the-box (OOTB) Connectors accelerate solution implementation by providing Each Connector has a dedicated page with relevant configuration. -All Connectors are available for Camunda 8 SaaS and [Self-Managed](../../../self-managed/connectors-deployment/install-and-start.md). +All Connectors are available for Camunda 8 SaaS and [Self-Managed](/self-managed/connectors-deployment/install-and-start.md). Beginners to Connectors may want to get familiar with Connectors using a [guide](/guides/configuring-out-of-the-box-connector.md). diff --git a/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge-webhook.md b/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge-webhook.md index 335b102abb3..efd6b3f987a 100644 --- a/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge-webhook.md +++ b/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge-webhook.md @@ -8,7 +8,7 @@ description: Learn how the AWS EventBridge Connector allows you to start a BPMN The **AWS EventBridge Webhook Connector** is an inbound Connector enabling you to start a BPMN process instance triggered by an event from [AWS EventBridge](https://aws.amazon.com/eventbridge/). :::note -If you have used the **AWS EventBridge Webhook Connector** with a Self-Managed Camunda 8 configuration before the Connector SDK [0.7.0 release](https://github.com/camunda/connector-sdk/releases/tag/0.7.0), you might need to manually replace the element template. Refer to the [update guide](/guides/update-guide/connectors/060-to-070.md) for more details. +If you have used the **AWS EventBridge Webhook Connector** with a Self-Managed Camunda 8 configuration before the Connector SDK [0.7.0 release](https://github.com/camunda/connector-sdk/releases/tag/0.7.0), you might need to manually replace the element template. Refer to the [update guide](/components/connectors/custom-built-connectors/update-guide/060-to-070.md) for more details. ::: ## Create an AWS EventBridge Webhook Connector task diff --git a/docs/components/connectors/out-of-the-box-connectors/github-webhook.md b/docs/components/connectors/out-of-the-box-connectors/github-webhook.md index d4c08e4f660..7cf8891e233 100644 --- a/docs/components/connectors/out-of-the-box-connectors/github-webhook.md +++ b/docs/components/connectors/out-of-the-box-connectors/github-webhook.md @@ -10,7 +10,7 @@ The **GitHub Webhook Connector** is an inbound Connector that allows you to star :::note If you have used the GitHub Webhook Connector with a self-managed Camunda 8 configuration before the Connector SDK [0.7.0 release](https://github.com/camunda/connector-sdk/releases/tag/0.7.0), you might need to manually replace the element template. -Please refer to the [update guide](/guides/update-guide/connectors/060-to-070.md) for more details. +Please refer to the [update guide](/components/connectors/custom-built-connectors/update-guide/060-to-070.md) for more details. ::: ## Create a GitHub Webhook Connector task diff --git a/docs/components/connectors/out-of-the-box-connectors/twilio-webhook.md b/docs/components/connectors/out-of-the-box-connectors/twilio-webhook.md index cf3236f9617..8fafbc26fdd 100644 --- a/docs/components/connectors/out-of-the-box-connectors/twilio-webhook.md +++ b/docs/components/connectors/out-of-the-box-connectors/twilio-webhook.md @@ -8,7 +8,7 @@ description: Learn how the Twilio Webhook Connector allows you to start a BPMN p The **Twilio Webhook Connector** is an inbound Connector that enables you to start a BPMN process instance triggered by a [Twilio event](https://www.twilio.com/docs/usage/webhooks). :::note -If you have used the **Twilio Webhook Connector** with a Self-Managed Camunda 8 configuration before the Connector SDK [0.7.0 release](https://github.com/camunda/connector-sdk/releases/tag/0.7.0), you might need to manually replace the element template. Refer to the [update guide](/guides/update-guide/connectors/060-to-070.md) for more details. +If you have used the **Twilio Webhook Connector** with a Self-Managed Camunda 8 configuration before the Connector SDK [0.7.0 release](https://github.com/camunda/connector-sdk/releases/tag/0.7.0), you might need to manually replace the element template. Refer to the [update guide](/components/connectors/custom-built-connectors/update-guide/060-to-070.md) for more details. ::: ## Create a Twilio Webhook Connector task diff --git a/docs/components/connectors/protocol/http-webhook.md b/docs/components/connectors/protocol/http-webhook.md index 663d90bca51..9d095630d7f 100644 --- a/docs/components/connectors/protocol/http-webhook.md +++ b/docs/components/connectors/protocol/http-webhook.md @@ -10,7 +10,7 @@ The **HTTP Webhook Connector** is an inbound Connector that allows you to start :::note If you have used the HTTP Webhook Connector with a self-managed Camunda 8 configuration before the Connector SDK [0.7.0 release](https://github.com/camunda/connector-sdk/releases/tag/0.7.0), you might need to manually replace the element template. -Please refer to the [update guide](/guides/update-guide/connectors/060-to-070.md) for more details. +Please refer to the [update guide](/components/connectors/custom-built-connectors/update-guide/060-to-070.md) for more details. ::: ## Create an HTTP Webhook Connector event diff --git a/docs/guides/update-guide/026-to-100.md b/docs/guides/update-guide/026-to-100.md deleted file mode 100644 index e57d0903f2c..00000000000 --- a/docs/guides/update-guide/026-to-100.md +++ /dev/null @@ -1,341 +0,0 @@ ---- -id: 026-to-100 -title: Update 0.26 to 1.0 -description: "Review which adjustments must be made to migrate from Camunda Cloud 0.26.x to 1.0.0." ---- - -Intermediate - -The following sections explain which adjustments must be made to migrate from Camunda Cloud 0.26.x to 1.0.0 for each component of the system. - -:::caution - -Be aware that the major version update from 0.26 to 1.0 is not backwards -compatible. Therefore, data cannot be migrated from 0.26 to 1.0 and client -applications must be adjusted to the new API versions. - -::: - -## Server - -### Zeebe - -#### Distribution - -With Zeebe 1.0.0, the Java package names were adjusted. They changed from -`io.zeebe` to `io.camunda.zeebe`. Therefore, any logging configurations and -similar, which are based on the package names, must be adjusted. - -Additionally, the group id of the Java artifacts were migrated from `io.zeebe` -to `io.camunda`. This requires all dependencies to the artifacts to be updated -to use the new group id. - -The downloadable artifact of the Zeebe distribution was renamed from: - -- `zeebe-distribution-${VERSION}.tar.gz` to `camunda-cloud-zeebe-${VERSION}.tar.gz`, -- `zeebe-distribution-${VERSION}.zip` to `camunda-cloud-zeebe-${VERSION}.zip` - -#### Workflow Engine - -The support for YAML workflows was removed from the workflow engine, after the -deprecation with 0.26. This means only [BPMN -processes](/components/modeler/bpmn/bpmn-primer.md) are supported from now on. - -#### Elasticsearch Exporter - -The supported Elasticsearch version of the Elasticsearch Exporter was increased -from `6.8` to `7.10`, read more about this in the -[Elasticsearch](#elasticsearch) section. - -The index templates of the Elasticsearch Exporter were migrated to use -[composable index templates](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html). - -#### Protocol - -The Java protocol received the following adjustments: - -- Enum `IncidentIntent` - - - remove `CREATE` - - change short value of `CREATED` to `0` - - change short value of `RESOLVE` to `1` - - change short value of `RESOLVED` to `2` - -- Enum `WorkflowInstanceIntent` renamed to `ProcessInstanceIntent` - -- Enum `WorkflowInstanceSubscriptionIntent` renamed to `ProcessMessageSubscriptionIntent` - -- Enum `WorkflowInstanceCreationIntent` renamed to `ProcessInstanceCreationIntent` - -- Enum `JobIntent` - - - remove `CREATE` and `ACTIVATED` - - change short value of `CREATED` to `0` - - change short value of `COMPLETE` to `1` - - change short value of `COMPLETED` to `2` - - change short value of `TIME_OUT` to `3` - - change short value of `TIMED_OUT` to `4` - - change short value of `FAIL` to `5` - - change short value of `FAILED` to `6` - - change short value of `UPDATE_RETRIES` to `7` - - change short value of `RETRIES_UPDATED` to `8` - - change short value of `CANCEL` to `9` - - change short value of `CANCELED` to `10` - - change short value of `THROW_ERROR` to `11` - - change short value of `ERROR_THROWN` to `12` - -- Enum `MessageIntent` - - - rename `DELETE` to `EXPIRE` - - rename `DELETED` to `EXPIRED` - -- Enum `MessageStartEventSubscriptionIntent` - - - remove `OPEN`, `OPENED`, `CLOSE` and `CLOSED` - - add `CREATED`, `CORRELATED` and `DELETED` - -- Enum `MessageSubscriptionIntent` - - - rename `OPEN` to `CREATE` - - rename `OPENED` to `CREATED` - - rename `CLOSE` to `DELETE` - - rename `CLOSED` to `DELETED` - - add `CORRELATING - -- Enum `TimerIntent` - - - remove `CREATE` - - change short value of `CREATED` to `0` - - change short value of `TRIGGER` to `1` - - change short value of `TRIGGERED` to `2` - - change short value of `CANCEL` to `3` - - change short value of `CANCELED` to `4` - -- Interface `DeploymentRecordValue` - - - rename method `getDeployedWorkflows` to `getProcessMetadata` and change type from `List` to `List` - -- Interface `IncidentRecordValue` - - - rename method `getWorkflowKey` to `getProcessDefinitionKey` - - rename method `getWorkflowInstanceKey` to `getProcessInstanceKey` - -- Interface `JobRecordValue` - - - rename method `getWorkflowDefinitionVersion` to `getProcessDefinitionVersion` - - rename method `getWorkflowKey` to `getProcessDefinitionKey` - -- Interface `MessageStartEventSubscriptionRecordValue` - - - rename method `getWorkflowKey` to `getProcessDefinitionKey` - - rename method `getWorkflowInstanceKey` to `getProcessInstanceKey` - -- Interface `MessageSubscriptionRecordValue` - - - rename method `getWorkflowInstanceKey` to `getProcessInstanceKey` - -- Interface `TimerRecordValue` - - - rename method `getWorkflowKey` to `getProcessDefinitionKey` - - rename method `getWorkflowInstanceKey` to `getProcessInstanceKey` - -- Interface `VariableRecordValue` - - rename method `getWorkflowInstanceKey` to `getProcessInstanceKey` - - rename method `getWorkflowKey` to `getProcessDefinitionKey` - -#### gRPC - -The following changes were made to the gRPC protocol definition: - -- `ActivatedJob` message - - - rename field `workflowInstanceKey` to `processInstanceKey` - - rename field `workflowDefinitionVersion` to `processDefinitionVersion` - - rename field `workflowKey` to `processDefinitionKey` - -- `CancelWorkflowInstanceRequest` message renamed to - `CancelProcessInstanceRequest` - - - rename field `workflowInstanceKey` to `processInstanceKey` - -- `CancelWorkflowInstanceResponse` message renamed to - `CancelProcessInstanceResponse` - -- `CreateWorkflowInstanceRequest` message renamed to - `CreateProcessInstanceRequest` - - - rename field `workflowKey` to `processDefinitionKey` - -- `CreateWorkflowInstanceResponse` message renamed to - `CreateProcessInstanceResponse` - - - rename field `workflowKey` to `processDefinitionKey` - - rename field `workflowInstanceKey` to `processInstanceKey` - -- `CreateWorkflowInstanceWithResultRequest` message renamed to - `CreateProcessInstanceWithResultRequest` - - - change type of field `request` from `CreateWorkflowInstanceRequest` to `CreateProcessInstanceRequest` - -- `CreateWorkflowInstanceWithResultResponse` message renamed to - `CreateProcessInstanceWithResultResponse` - - - rename field `workflowKey` to `processDefinitionKey` - - rename field `workflowInstanceKey` to `processInstanceKey` - -- `DeployWorkflowRequest` message renamed to `DeployProcessRequest` - - - rename field `workflows` to `processes` and change type from `WorkflowRequestObject` to `ProcessRequestObject` - -- `WorkflowRequestObject` message renamed to `ProcessRequestObject` - - - remove enum `ResourcetType` - - remove field type - - change field id of `definition` field to 2 - -- `DeployWorkflowResponse` message renamed to `DeployProcessResponse` - - - rename field `wokrflows` to `processes` and change type from `WorkflowMetadata` to `ProcessMetadata` - -- `WorkflowMetadata` message renamed to `ProcessMetadata` - - - rename field `workflowKey` to `processDefinitionKey` - -- `Partition` message - - - enum `PartitionBrokerRole` added `INACTIVE` state - -- `Gateway` service - - - rename rpc `CancelWorkflowInstance` to `CancelProcessInstance` and change input type from `CancelWorkflowInstanceRequest` to `CancelProcessInstanceRequest` and output type from `CancelWorkflowInstanceResponse` to `CancelProcessInstanceResponse` - - - rename rpc `CreateWorkflowInstance` to `CreateProcessInstance` and change input type from `CreateWorkflowInstanceRequest` to `CreateProcessInstanceRequest` and output type from `CreateWorkflowInstanceResponse` to `CreateProcessInstanceResponse` - - - rename rpc `CreateWorkflowInstanceWithResult` to `CreateProcessInstance` and change input type from `CreateWorkflowInstanceWithResultRequest` to `CreateProcessInstanceWithResultRequest` and output type from `CreateWorkflowInstanceWithResultResponse` to `CreateProcessInstanceResponse` - - - rename rpc `DeployWorkflow` to `DeployProcess` and change input type from `DeployWorkflowRequest` to `DeployProcessRequest` and output type from `DeployWorkflowResponse` to `DeployProcessResponse` - -#### Exporter API - -In the Java Exporter API, the depracted method `Controller#scheduleTask` was removed. - -### Operate - -With Operate 1.0.0, the Java package names were adjusted. They changed from -`org.camunda.operate` to `io.camunda.operate`. Therefore, any logging -configurations and similar, which are based on the package names, must be -adjusted. - -The downloadable artifact of the Operate distribution was renamed from: - -- `camunda-operate-${VERSION}.tar.gz` to `camunda-cloud-operate-${VERSION}.tar.gz`, -- `camunda-operate-${VERSION}.zip` to `camunda-cloud-operate-${VERSION}.zip` - -The supported Elasticsearch version was increased from `6.8` to `7.10`. Read -more about this in the [Elasticsearch](#elasticsearch) section. - -### Tasklist - -With Tasklist 1.0.0, the Java package names were adjusted. They changed from -`io.zeebe.tasklist` to `io.camunda.tasklist`. Therefore, any logging -configurations and similar, which are based on the package names, must be -adjusted. - -Additionally, the configuration prefix was migrated from `zeebe.tasklist` to -`camunda.tasklist`, which requires all configurations to be adjusted to the new -prefix. - -The downloadable artifact of the Tasklist distribution was renamed from: - -- `zeebe-tasklist-${VERSION}.tar.gz` to `camunda-cloud-tasklist-${VERSION}.tar.gz`, -- `zeebe-tasklist-${VERSION}.zip` to `camunda-cloud-tasklist-${VERSION}.zip` - -The supported Elasticsearch version was increased from `6.8` to `7.10`. Read -more about this in the [Elasticsearch](#elasticsearch) section. - -### Elasticsearch - -Zeebe, Operate, and Tasklist use Elasticsearch as Datastore to exchange the event -stream from Zeebe's exporter, and store their own data model representation. - -Camunda Cloud 1.0 requires an update from Elasticsearch 6.8 to 7.10. - -Follow the [update guide from -Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html), -to migrate existing data. - -:::note -Zeebe, Operate, and Tasklist data inside Elasticsearch cannot be migrated, it can only be preserved for -histroy or audit purpose, but cannot be loaded by Camunda Cloud 1.0. -::: - -If you want to keep the existing data in Elasticsearch, ensure you set a -new index prefix for all systems. See the configuration documentation for -[Zeebe](self-managed/zeebe-deployment/zeebe-installation.md), -[Operate](self-managed/operate-deployment/operate-configuration.md), and [Tasklist](self-managed/tasklist-deployment/tasklist-configuration.md). - -## Client - -### Zeebe Java Client - -With Zeebe 1.0.0, the Java package names were adjusted. They changed from -`io.zeebe` to `io.camunda.zeebe`. Therefore, any imports and logging -configurations and similar, which are based on the package names, must be -adjusted. - -Additionally, the group id of the Java artifacts were migrated from `io.zeebe` -to `io.camunda`. This requires all dependencies to the artifacts to be updated -to use the new group id. - -The public API of the Java client changed as follows: - -- Interface `ActivatedJob` - - - rename method `getWorkflowInstanceKey` to `getProcessInstanceKey` - - rename method `getWorkflowDefinitionVersion` to `getProcessDefinitionVersion` - - rename method `getWorkflowKey` to `getProcessDefinitionKey` - -- Class `ClientProperties` - - - remove deprecated field `BROKER_CONTACTPOINT` - -- Interface `ZeebeClientBuilder` - - - remove deprecated method `brokerContactPoint` - -- Interface `ZeebeClientConfiguration` - - - remove deprecated method `getBrokerContactPoint` - -- Interface `ZeebeClient` - - change return type of `newDeployCommand` from `DeployWorkflowCommandStep1` to `DeployProcessCommandStep1` - - change return type of `newCreateInstanceCommand` from `CreateWorkflowInstanceCommandStep1` to `CreateProcessInstanceCommandStep1` - - change return type of `newCancelInstanceCommand` from `CancelWorkflowInstanceCommandStep1` to `CancelProcessInstanceCommandStep1` - -### Zeebe Go Client - -The repository of Zeebe was moved from `github.com/zeebe-io/zeebe` to -`github.com/camunda-cloud/zeebe`. Therefore, all go dependencies and imports must be adjusted to the new GitHub URL. - -The public API of the Go client was changed as follows: - -- Interface `CancelInstanceStep1` - - - rename method `WorkflowInstanceKey` to `ProcessInstanceKey` and change return type from `DispatchCancelWorkflowInstanceCommand` to `DispatchCancelProcessInstanceCommand` - -- Interface `DispatchCancelWorkflowInstanceCommand` renamed to `DispatchCancelProcessInstanceCommand` - -- Interface `CancelWorkflowInstanceCommand` renamed to `CancelProcessInstanceCommand` - - - rename method `WorkflowInstanceKey` to `ProcessInstanceKey` - -- Interface `CreateInstanceCommandStep1` - - - rename method `WorkflowKey` to `ProcessDefinitionKey` and change `DispatchCancelProcessInstanceCommand` - -- Struct `DeployCommand` - - - method `AddResource(definition, name, resourceType)` remove `resourceType` from parameter list - -- Interface `Client` - - rename method `NewDeployWorkflowCommand` to `NewDeployProcessCommand` diff --git a/docs/guides/update-guide/100-to-110.md b/docs/guides/update-guide/100-to-110.md deleted file mode 100644 index 59b7971d94b..00000000000 --- a/docs/guides/update-guide/100-to-110.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -id: 100-to-110 -title: Update 1.0 to 1.1 -description: "Review which adjustments must be made to migrate from Camunda Cloud 1.0.x to 1.1.0." ---- - -Intermediate - -The following sections explain which adjustments must be made to migrate from Camunda Cloud 1.0.x to 1.1.0 for each component of the system. - -:::caution - -We identified an issue in our recent release of Operate 1.1.0 (part of Camunda -Cloud 1.1.0). This issue only applies if you are updating from a previous -version of Operate 1.0.x to Operate 1.1. - -We recommend to immediately update to 1.1.1 by skipping the 1.1.0 release. - -::: - -## Server - -### Operate - -With Operate 1.1, a new feature was introduced to navigate between call activity -hierarchies. This feature is only available for instances started after the -version 1.1 update. Older instances will not expose this information to the user. - -## Client - -### Zeebe Java Client - -To prepare to support multiple regions in Camunda Cloud SaaS, we adopted the -Zeebe URLs used to connect to your cluster to contain a region sub-domain, i.e -`${CLUSTE_ID}.zeebe.camunda.io` is now `${CLUSTER_ID}.bru-2.zeebe.camunda.io`. - -We are confident that we rolled out this change transparently and as backwards -compatible as possible. Still, there exists scenarios which this might impact -you on your update path. For existing clusters, the old URLs will still be -functional. We recommend you update the configuration of your clients to -the new URL format. - -To support this feature, we expose a new configuration method -[`withRegion`]() -in the Camunda Cloud builder of the Java Client to set the region. - -By default, the builder will assume the `bru-2` region, which is the region of -any clusters created after Camunda Cloud GA in May 2021. - -If you are using the Java Client Camunda Cloud builder with a pre GA -cluster, you must set the region to the specific value of your cluster. - -To copy the region of your cluster, visit the clusters details page in -Camunda Cloud Console, and select the copy button next to the region. - -![](../img/update-guide-100-to-110-copy-region.png) diff --git a/docs/guides/update-guide/110-to-120.md b/docs/guides/update-guide/110-to-120.md deleted file mode 100644 index dc9b7dbc15e..00000000000 --- a/docs/guides/update-guide/110-to-120.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: 110-to-120 -title: Update 1.1 to 1.2 -description: "Review which adjustments must be made to migrate from Camunda Cloud 1.1.x to 1.2.0." ---- - -Intermediate - -The following sections explain which adjustments must be made to migrate from Camunda Cloud 1.1.x to 1.2.0 for each component of the system. - -:::caution - -We identified an issue in our recent release of Zeebe 1.2 related to our -concept of processing on followers. Version 1.2.0 and 1.2.1 are affected by a -bug, resulting in an inconsistent state -([#8044](https://github.com/camunda-cloud/zeebe/issues/8044)). - -Therefore we recommend updating to 1.2.4 directly. - -::: - -## Server - -### Operate - -With Operate 1.2, a new feature was introduced to quickly navigate a call -activity hierarchy. This feature is only available for instances started after -the version 1.2 update. Older instances will not expose this information to the -user. diff --git a/docs/guides/update-guide/120-to-130.md b/docs/guides/update-guide/120-to-130.md deleted file mode 100644 index fecae209e45..00000000000 --- a/docs/guides/update-guide/120-to-130.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: 120-to-130 -title: Update 1.2 to 1.3 -description: "Review which adjustments must be made to migrate from Camunda Cloud 1.2.x to 1.3.2." ---- - -Intermediate - -The following sections explain which adjustments must be made to migrate from Camunda Cloud 1.2.x to 1.3.2 for each component of the system. - -## Server - -### Zeebe - -:::caution -A critical [issue](https://github.com/camunda-cloud/zeebe/issues/8611) which may lead to data loss was identified in 1.3.0 and 1.3.1. This issue is related to the new assignee and candidate group feature introduced in 1.3.0, and only affects users which make use of it. However, when updating, it's still recommended that you skip versions 1.3.0 and 1.3.1 and update directly from 1.2.9 to 1.3.2. - -Please refer to the [release notes](https://github.com/camunda-cloud/zeebe/releases/tag/1.3.2) for more. -::: - -With Zeebe 1.3.0, we removed the monitoring specific configuration from the broker and the gateway. Instead, the monitoring configuration is now completely handled via the Spring Boot management server. Read [this Spring Boot documentation](https://docs.spring.io/spring-boot/docs/2.6.x/reference/htmlsingle/#actuator) for more information on how to configure the server. - -For the broker, this replaces the following configuration settings: - -```yaml -zeebe: - broker: - network: - monitoringApi: - host: 0.0.0.0 - port: 9600 -``` - -For the gateway, the following was removed: - -```yaml -zeebe: - gateway: - monitoring: - enabled: true - host: 0.0.0.0 - port: 9600 -``` - -To configure the monitoring URL for the broker and gateway, you can instead use the `server.port` and `server.address` properties. Given how Spring loads its configuration, it's not possible to configure this directly in the YAML configuration. However, you can use environment variables - respectively `SERVER_PORT` and `SERVER_ADDRESS` - or system properties - respectively `-Dserver.port=` or `-Dserver.address=` - to configure them. - -To disable monitoring the monitoring server, configure the broker or gateway with the following: - -```yaml -spring: - main: - web-application-type: none -``` - -### Operate - -:::caution -A critical issue was found on Operate data importer which may lead to incidents not being imported to Operate. This issue is affecting versions `1.3.0`, `1.3.1`, `1.3.2` and `1.3.3`. -We strongly recommend to skip affected versions and make sure you are running version `1.3.4` if updating from `1.2.x`. - -Please refer to the [release notes](https://github.com/camunda-cloud/zeebe/releases/tag/1.3.4) for more. -::: - -With Operate 1.3, a new feature was introduced to propagate incidents from called instances to calling instances. -This feature is only available for instances started after the version 1.3 update. Older instances will still be shown as active -even though incidents in called instances may exist. - -### Tasklist - -Because of internal changes in user data processing update to Tasklist 1.3 will erase all information about task assignments. -End users would need to claim their tasks again. diff --git a/docs/reference/announcements.md b/docs/reference/announcements.md index e0abad03e7f..608d00fc23d 100644 --- a/docs/reference/announcements.md +++ b/docs/reference/announcements.md @@ -16,7 +16,7 @@ End of maintenance: 9th of April 2025 The default user in the Zeebe Docker image changed from root to an unprivileged user with the UID 1000. This was done to provide stronger compliance with the [OWASP recommendations on Docker Security](https://cheatsheetseries.owasp.org/cheatsheets/Docker_Security_Cheat_Sheet.html#rule-2-set-a-user). -Please refer to the [Update 8.2 to 8.3](../guides/update-guide/820-to-830.md) guide. +Please refer to the [Update 8.2 to 8.3](/self-managed/operational-guides/update-guide/820-to-830.md) guide. ::: ## Versioning changes in Helm chart diff --git a/docs/reference/release-notes.md b/docs/reference/release-notes.md index eb38ae7d6ce..f7d7fa1abac 100644 --- a/docs/reference/release-notes.md +++ b/docs/reference/release-notes.md @@ -8,7 +8,7 @@ Release notes for Camunda Platform 8, including alphas, are available on [GitHub The current release notes can be found [here](https://github.com/camunda/camunda-platform/releases/latest). -[Update guides](/guides/update-guide/introduction.md) include links to both release notes and release blogs. +[Update guides](/self-managed/operational-guides/update-guide/introduction.md) include links to both release notes and release blogs. Most releases and release notes are available through the [Camunda Platform repo](https://github.com/camunda/camunda-platform), however, the following component release notes are available as linked below: diff --git a/docs/reference/release-policy.md b/docs/reference/release-policy.md index fee7e8e88c7..88a48032701 100644 --- a/docs/reference/release-policy.md +++ b/docs/reference/release-policy.md @@ -55,4 +55,4 @@ If you are not an enterprise customer, you can stay up to date via [release blog ### New versions -If you are running Camunda Platform 8 Self-Managed, follow our [update guide](/guides/update-guide/introduction.md). +If you are running Camunda Platform 8 Self-Managed, follow our [update guide](/self-managed/operational-guides/update-guide/introduction.md). diff --git a/docs/self-managed/backup-restore/backup-and-restore.md b/docs/self-managed/operational-guides/backup-restore/backup-and-restore.md similarity index 72% rename from docs/self-managed/backup-restore/backup-and-restore.md rename to docs/self-managed/operational-guides/backup-restore/backup-and-restore.md index 7d183b0190d..f0558cf79ad 100644 --- a/docs/self-managed/backup-restore/backup-and-restore.md +++ b/docs/self-managed/operational-guides/backup-restore/backup-and-restore.md @@ -19,7 +19,7 @@ To take backups, you must first configure backup storage. Operate, Tasklist, and Optimize use Elasticsearch as backend storage and use the snapshot feature of Elasticsearch for backing up their state. Therefore, you must configure a [snapshot repository](https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html) in Elasticsearch. -Zeebe stores its backup to an external storage and must be configured before the cluster is started. Refer to [Zeebe backup configuration](/self-managed/backup-restore/zeebe-backup-and-restore.md/#configuration) for additional information. +Zeebe stores its backup to an external storage and must be configured before the cluster is started. Refer to [Zeebe backup configuration](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md/#configuration) for additional information. ### Backup process @@ -31,12 +31,12 @@ We recommend using the timestamp as the backup id. To back up a Camunda Platform 8 cluster, execute the following sequential steps: -1. Trigger a backup `x` of Optimize. See [how to take an Optimize backup](/self-managed/backup-restore/optimize-backup.md). -2. Trigger a backup `x` of Operate. See [how to take an Operate backup](/self-managed/backup-restore/operate-tasklist-backup.md). -3. Trigger a backup `x` of Tasklist. See [how to take a Tasklist backup](/self-managed/backup-restore/operate-tasklist-backup.md). -4. Wait until the backup `x` of Optimize is complete. See [how to monitor an Optimize backup](/self-managed/backup-restore/optimize-backup.md). -5. Wait until the backup `x` of Operate is complete. See [how to monitor an Operate backup](/self-managed/backup-restore/operate-tasklist-backup.md). -6. Wait until the backup `x` of Tasklist is complete. See [how to monitor a Tasklist backup](/self-managed/backup-restore/operate-tasklist-backup.md). +1. Trigger a backup `x` of Optimize. See [how to take an Optimize backup](/self-managed/operational-guides/backup-restore/optimize-backup.md). +2. Trigger a backup `x` of Operate. See [how to take an Operate backup](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md). +3. Trigger a backup `x` of Tasklist. See [how to take a Tasklist backup](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md). +4. Wait until the backup `x` of Optimize is complete. See [how to monitor an Optimize backup](/self-managed/operational-guides/backup-restore/optimize-backup.md). +5. Wait until the backup `x` of Operate is complete. See [how to monitor an Operate backup](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md). +6. Wait until the backup `x` of Tasklist is complete. See [how to monitor a Tasklist backup](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md). 7. Pause exporting in Zeebe. See [Zeebe management API](/self-managed/zeebe-deployment/operations/management-api.md). 8. Take a backup `x` of the exported Zeebe records in Elasticsearch using the Elasticsearch Snapshots API. @@ -52,7 +52,7 @@ PUT /_snapshot/my_repository/camunda_zeebe_records_backup_x By default, the indices are prefixed with `zeebe-record`. If you have configured a different prefix when configuring Elasticsearch exporter in Zeebe, use this instead. -9. Take a backup `x` of Zeebe. See [how to take a Zeebe backup](self-managed/backup-restore/zeebe-backup-and-restore.md). Wait until the backup `x` of the exported Zeebe records is complete and wait until the backup `x` of Zeebe is completed before proceeding. See [how to monitor a Zeebe backup](self-managed/backup-restore/zeebe-backup-and-restore.md). +9. Take a backup `x` of Zeebe. See [how to take a Zeebe backup](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md). Wait until the backup `x` of the exported Zeebe records is complete and wait until the backup `x` of Zeebe is completed before proceeding. See [how to monitor a Zeebe backup](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md). 10. Resume exporting in Zeebe. See [Zeebe management API](/self-managed/zeebe-deployment/operations/management-api.md). :::note @@ -63,7 +63,7 @@ If any of the steps above fail, you may have to restart with a new backup id. En To restore a Camunda Platform 8 cluster from a backup, all components must be restored from their backup corresponding to the same backup id: -1. Restore the state of [Operate](/self-managed/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/backup-restore/optimize-backup.md). +1. Restore the state of [Operate](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), [Tasklist](/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md), and [Optimize](/self-managed/operational-guides/backup-restore/optimize-backup.md). 2. Restore `zeebe-records*` indices from Elasticsearch snapshot. -3. Restore [Zeebe](self-managed/backup-restore/zeebe-backup-and-restore.md). +3. Restore [Zeebe](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md). 4. Start Zeebe, Operate, Tasklist, and Optimize. diff --git a/docs/self-managed/backup-restore/operate-tasklist-backup.md b/docs/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md similarity index 100% rename from docs/self-managed/backup-restore/operate-tasklist-backup.md rename to docs/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md diff --git a/docs/self-managed/backup-restore/optimize-backup.md b/docs/self-managed/operational-guides/backup-restore/optimize-backup.md similarity index 100% rename from docs/self-managed/backup-restore/optimize-backup.md rename to docs/self-managed/operational-guides/backup-restore/optimize-backup.md diff --git a/docs/self-managed/backup-restore/zeebe-backup-and-restore.md b/docs/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md similarity index 100% rename from docs/self-managed/backup-restore/zeebe-backup-and-restore.md rename to docs/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md diff --git a/docs/self-managed/troubleshooting/log-levels.md b/docs/self-managed/operational-guides/troubleshooting/log-levels.md similarity index 81% rename from docs/self-managed/troubleshooting/log-levels.md rename to docs/self-managed/operational-guides/troubleshooting/log-levels.md index 937ebf9ead5..d73f0121779 100644 --- a/docs/self-managed/troubleshooting/log-levels.md +++ b/docs/self-managed/operational-guides/troubleshooting/log-levels.md @@ -20,7 +20,7 @@ Camunda Platform 8 uses the following log levels: Enable logging for each component of Camunda Platform 8 using the following instructions: -- [Zeebe](../zeebe-deployment/configuration/logging.md) -- [Operate](../operate-deployment/operate-configuration.md/#logging) -- [Tasklist](../tasklist-deployment/tasklist-configuration.md/#logging) -- [Web Modeler](../modeler/web-modeler/configuration/logging.md) +- [Zeebe](/self-managed/zeebe-deployment/configuration/logging.md) +- [Operate](/self-managed/operate-deployment/operate-configuration.md/#logging) +- [Tasklist](/self-managed/tasklist-deployment/tasklist-configuration.md/#logging) +- [Web Modeler](/self-managed/modeler/web-modeler/configuration/logging.md) diff --git a/docs/guides/update-guide/130-to-800.md b/docs/self-managed/operational-guides/update-guide/130-to-800.md similarity index 100% rename from docs/guides/update-guide/130-to-800.md rename to docs/self-managed/operational-guides/update-guide/130-to-800.md diff --git a/docs/guides/update-guide/800-to-810.md b/docs/self-managed/operational-guides/update-guide/800-to-810.md similarity index 94% rename from docs/guides/update-guide/800-to-810.md rename to docs/self-managed/operational-guides/update-guide/800-to-810.md index 2100e3ab6fa..bc1ea25c05f 100644 --- a/docs/guides/update-guide/800-to-810.md +++ b/docs/self-managed/operational-guides/update-guide/800-to-810.md @@ -32,7 +32,7 @@ Deprecated properties: - Use the `zeebe.gateway.cluster.initialContactPoints` property or the `ZEEBE_GATEWAY_CLUSTER_INITIALCONTACTPOINTS` environment variable. :::note -You can set the list of broker addresses here to make the start process of the Zeebe gateway more resilient. Refer to [the Zeebe gateway's configuration guide](../../self-managed/zeebe-deployment/configuration/gateway.md) for more details. +You can set the list of broker addresses here to make the start process of the Zeebe gateway more resilient. Refer to [the Zeebe gateway's configuration guide](/self-managed/zeebe-deployment/configuration/gateway.md) for more details. ::: ### Operate diff --git a/docs/guides/update-guide/810-to-820.md b/docs/self-managed/operational-guides/update-guide/810-to-820.md similarity index 87% rename from docs/guides/update-guide/810-to-820.md rename to docs/self-managed/operational-guides/update-guide/810-to-820.md index 1ebe8b02b2e..65c70cf8d1c 100644 --- a/docs/guides/update-guide/810-to-820.md +++ b/docs/self-managed/operational-guides/update-guide/810-to-820.md @@ -26,9 +26,9 @@ This may change the performance characteristics. If you have tuned your system f ### Spring Boot 3.0 - URL Matching Changes Zeebe now uses Spring Boot 3.0, which comes with a breaking change regarding [trailing slash URL matching](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.0-Migration-Guide#spring-mvc-and-webflux-url-matching-changes). -This only applies to the Actuator endpoints such as the [Management API](../../self-managed/zeebe-deployment/operations/management-api.md) and the [Backup API](../../self-managed/backup-restore/zeebe-backup-and-restore.md), as well as to the [health status endpoints](../../self-managed/zeebe-deployment/operations/health.md). Ensure you remove any trailing slashes when you access these endpoints, otherwise you will encounter a `404 - Not Found` error. +This only applies to the Actuator endpoints such as the [Management API](/self-managed/zeebe-deployment/operations/management-api.md) and the [Backup API](/self-managed/operational-guides/backup-restore/zeebe-backup-and-restore.md), as well as to the [health status endpoints](/self-managed/zeebe-deployment/operations/health.md). Ensure you remove any trailing slashes when you access these endpoints, otherwise you will encounter a `404 - Not Found` error. -The [GRPC API](../../apis-tools/grpc.md) is not affected by this change. +The [gRPC API](/apis-tools/grpc.md) is not affected by this change. ## Operate diff --git a/docs/guides/update-guide/820-to-830.md b/docs/self-managed/operational-guides/update-guide/820-to-830.md similarity index 96% rename from docs/guides/update-guide/820-to-830.md rename to docs/self-managed/operational-guides/update-guide/820-to-830.md index 90bbf51f3d6..9fa9b603bbd 100644 --- a/docs/guides/update-guide/820-to-830.md +++ b/docs/self-managed/operational-guides/update-guide/820-to-830.md @@ -19,7 +19,7 @@ If you experience permission errors on data or log volumes access when updating In a [kubernetes setup this can be done by setting the fsGroup](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#configure-volume-permission-and-ownership-change-policy-for-pods) to 1000. Newer versions of the Camunda Helm chart have this is set by default -For more details and alternatives please refer to the [Camunda Helm Update instructions](../../self-managed/platform-deployment/helm-kubernetes/upgrade.md/#v83). +For more details and alternatives please refer to the [Camunda Helm Update instructions](/self-managed/platform-deployment/helm-kubernetes/upgrade.md/#v83). ::: :::caution diff --git a/docs/guides/update-guide/elasticsearch/7-to-8.md b/docs/self-managed/operational-guides/update-guide/elasticsearch/7-to-8.md similarity index 78% rename from docs/guides/update-guide/elasticsearch/7-to-8.md rename to docs/self-managed/operational-guides/update-guide/elasticsearch/7-to-8.md index 3b4e8109fb4..659f6e57f9e 100644 --- a/docs/guides/update-guide/elasticsearch/7-to-8.md +++ b/docs/self-managed/operational-guides/update-guide/elasticsearch/7-to-8.md @@ -5,14 +5,14 @@ description: "Review which adjustments must be made to migrate from Elasticsearc --- Camunda is not compatible with the Elasticsearch 8 Curator. This Curator is used to manage -[data retention](../../../components/concepts/data-retention.md) within Elasticsearch. To update to Elasticsearch 8, +[data retention](/components/concepts/data-retention.md) within Elasticsearch. To update to Elasticsearch 8, the Curator must be replaced with [Index Lifecycle Management](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html) (ILM). Once the update to Elasticsearch 8 is complete, the Curator can be disabled. Disabling the Curator before could result in indexes without a configured ILM policy. These will not get deleted automatically. Details on how to configure ILM for Zeebe can be found on the -[Elasticsearch exporter](../../../../self-managed/zeebe-deployment/exporters/elasticsearch-exporter#retention) page. +[Elasticsearch exporter](/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md#retention) page. :::tip The Elasticsearch Curator can be replaced with ILM when using Elasticsearch 7 as well. This is useful when incrementally diff --git a/docs/guides/update-guide/introduction.md b/docs/self-managed/operational-guides/update-guide/introduction.md similarity index 56% rename from docs/guides/update-guide/introduction.md rename to docs/self-managed/operational-guides/update-guide/introduction.md index 60c03f2f839..7b3608a9bcb 100644 --- a/docs/guides/update-guide/introduction.md +++ b/docs/self-managed/operational-guides/update-guide/introduction.md @@ -10,10 +10,6 @@ application or server installation from one Camunda 8 version to the other. When updating from one minor version to the next, you do not need to update to each **patch** version along the way. However, do not skip **minor** versions when updating. ::: -You can find guides on how to update your Connector runtimes to a newer version of the -[Connector SDK](/components/connectors/custom-built-connectors/connector-sdk.md) -in the **Connectors** section. - :::note Versions prior to Camunda 8 are listed below and identified as Camunda Cloud versions. ::: @@ -49,31 +45,3 @@ Update from 1.3.x to 8.0.0 [Release notes](https://github.com/camunda/camunda-platform/releases/tag/8.0.0) [Release blog](https://camunda.com/blog/2022/04/camunda-platform-8-0-released-whats-new/) - -### [Camunda Cloud 1.2 to 1.3](../120-to-130) - -Update from 1.2.x to 1.3.0 - -[Release notes](https://github.com/camunda-cloud/zeebe/releases/tag/1.3.0) -[Release blog](https://camunda.com/blog/2022/01/camunda-cloud-1-3-0-released/) - -### [Camunda Cloud 1.1 to 1.2](../110-to-120) - -Update from 1.1.x to 1.2.0 - -[Release notes](https://github.com/camunda-cloud/zeebe/releases/tag/1.2.0) -[Release blog](https://camunda.com/blog/2021/10/camunda-cloud-1-2-0-released/) - -### [Camunda Cloud 1.0 to 1.1](../100-to-110) - -Update from 1.0.x to 1.1.0 - -[Release notes](https://github.com/camunda-cloud/zeebe/releases/tag/1.1.0) -[Release blog](https://camunda.com/blog/2021/07/camunda-cloud-110-released/) - -### [Camunda Cloud 0.26 to 1.0](../026-to-100) - -Update from 0.26.x to 1.0.0 - -[Release notes](https://github.com/camunda-cloud/zeebe/releases/tag/1.0.0) -[Release blog](https://camunda.com/blog/2021/05/camunda-cloud-10-released/) diff --git a/docs/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md b/docs/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md index 1364ae8e0f3..f05a30655f1 100644 --- a/docs/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md +++ b/docs/self-managed/zeebe-deployment/exporters/elasticsearch-exporter.md @@ -6,7 +6,7 @@ description: "The Zeebe Elasticsearch exporter acts as a bridge between Zeebe an --- :::note -Please refer to [Supported Environments](../../../reference/supported-environments.md#camunda-platform-8-self-managed) to find out which versions of Elasticsearch are supported in a Camunda Platform 8 Self-Managed setup. +Please refer to [Supported Environments](/reference/supported-environments.md#camunda-platform-8-self-managed) to find out which versions of Elasticsearch are supported in a Camunda Platform 8 Self-Managed setup. ::: The Zeebe Elasticsearch exporter acts as a bridge between diff --git a/docs/self-managed/zeebe-deployment/operations/backups.md b/docs/self-managed/zeebe-deployment/operations/backups.md index b5f00e20a72..1375a84028f 100644 --- a/docs/self-managed/zeebe-deployment/operations/backups.md +++ b/docs/self-managed/zeebe-deployment/operations/backups.md @@ -6,7 +6,7 @@ keywords: ["backup", "backups"] --- :::note -Refer to our documentation on [backup and restore](/self-managed/backup-restore/backup-and-restore.md) to learn how to take backups without downtime. +Refer to our documentation on [backup and restore](/self-managed/operational-guides/backup-restore/backup-and-restore.md) to learn how to take backups without downtime. ::: As Zeebe fully manages the state of your process instances, consider taking backups of Zeebe data; this is crucial to prevent data loss, roll back application-level errors, and more. @@ -75,7 +75,7 @@ After taking the backup, brokers can be started again and will automatically res :::note Caution Always use the same or the next minor version of Zeebe that you were using when taking the backup. Using a different version may result in data corruption or data loss. -See the [update guide](/guides/update-guide/introduction.md) for more details. +See the [update guide](/self-managed/operational-guides/update-guide/introduction.md) for more details. ::: Ensure your replacement cluster has the same number of brokers as the old cluster and uses the [same node IDs](setting-up-a-cluster.md#configuration). diff --git a/docs/self-managed/zeebe-deployment/operations/management-api.md b/docs/self-managed/zeebe-deployment/operations/management-api.md index 91ac93093ac..6323597130f 100644 --- a/docs/self-managed/zeebe-deployment/operations/management-api.md +++ b/docs/self-managed/zeebe-deployment/operations/management-api.md @@ -18,7 +18,7 @@ The following operations are currently available: Exporting API is used: - As a debugging tool. -- When taking a backup of Camunda Platform 8 (see [backup and restore](/self-managed/backup-restore/backup-and-restore.md)). +- When taking a backup of Camunda Platform 8 (see [backup and restore](/self-managed/operational-guides/backup-restore/backup-and-restore.md)). ### Pause exporting diff --git a/docs/self-managed/zeebe-deployment/operations/update-zeebe.md b/docs/self-managed/zeebe-deployment/operations/update-zeebe.md index 7e26a237e9c..8578450c903 100644 --- a/docs/self-managed/zeebe-deployment/operations/update-zeebe.md +++ b/docs/self-managed/zeebe-deployment/operations/update-zeebe.md @@ -6,7 +6,7 @@ description: "This section describes how to update Zeebe to a new version." ## Update -See the [update guide](/guides/update-guide/introduction.md) for specific instructions per Zeebe version. +See the [update guide](/self-managed/operational-guides/update-guide/introduction.md) for specific instructions per Zeebe version. To update a Zeebe cluster, take the following steps: diff --git a/optimize_sidebars.js b/optimize_sidebars.js index 92831c01b59..917dbada161 100644 --- a/optimize_sidebars.js +++ b/optimize_sidebars.js @@ -2064,25 +2064,28 @@ module.exports = { "Backup and restore": [ docsLink( "Backup and restore", - "self-managed/backup-restore/backup-and-restore/" + "self-managed/operational-guides/backup-restore/backup-and-restore/" ), docsLink( "Backup and restore Optimize data", - "self-managed/backup-restore/optimize-backup/" + "self-managed/operational-guides/backup-restore/optimize-backup/" ), docsLink( "Backup and restore Operate and Tasklist data", - "self-managed/backup-restore/operate-tasklist-backup/" + "self-managed/operational-guides/backup-restore/operate-tasklist-backup/" ), docsLink( "Backup and restore Zeebe data", - "self-managed/backup-restore/zeebe-backup-and-restore/" + "self-managed/operational-guides/backup-restore/zeebe-backup-and-restore/" ), ], }, { Troubleshooting: [ - docsLink("Log levels", "self-managed/troubleshooting/log-levels/"), + docsLink( + "Log levels", + "self-managed/operational-guides/troubleshooting/log-levels/" + ), ], }, ], diff --git a/sidebars.js b/sidebars.js index 310617bd54f..da86dd66b85 100644 --- a/sidebars.js +++ b/sidebars.js @@ -38,37 +38,6 @@ module.exports = { "guides/host-custom-connectors", ], }, - { - "Update guide": [ - "guides/update-guide/introduction", - "guides/update-guide/820-to-830", - "guides/update-guide/810-to-820", - "guides/update-guide/800-to-810", - "guides/update-guide/130-to-800", - "guides/update-guide/120-to-130", - "guides/update-guide/110-to-120", - "guides/update-guide/100-to-110", - "guides/update-guide/026-to-100", - { - Connectors: [ - "guides/update-guide/connectors/introduction", - "guides/update-guide/connectors/0100-to-0110", - "guides/update-guide/connectors/090-to-0100", - "guides/update-guide/connectors/080-to-090", - "guides/update-guide/connectors/070-to-080", - "guides/update-guide/connectors/060-to-070", - "guides/update-guide/connectors/050-to-060", - "guides/update-guide/connectors/040-to-050", - "guides/update-guide/connectors/030-to-040", - "guides/update-guide/connectors/020-to-030", - "guides/update-guide/connectors/010-to-020", - ], - }, - { - Elasticsearch: ["guides/update-guide/elasticsearch/7-to-8"], - }, - ], - }, "guides/migrating-from-cawemo", { "Migrating From Camunda 7": [ @@ -377,6 +346,21 @@ module.exports = { "Building custom Connectors": [ "components/connectors/custom-built-connectors/connector-sdk", "components/connectors/custom-built-connectors/connector-templates", + { + "Update guide": [ + "components/connectors/custom-built-connectors/update-guide/introduction", + "components/connectors/custom-built-connectors/update-guide/0100-to-0110", + "components/connectors/custom-built-connectors/update-guide/090-to-0100", + "components/connectors/custom-built-connectors/update-guide/080-to-090", + "components/connectors/custom-built-connectors/update-guide/070-to-080", + "components/connectors/custom-built-connectors/update-guide/060-to-070", + "components/connectors/custom-built-connectors/update-guide/050-to-060", + "components/connectors/custom-built-connectors/update-guide/040-to-050", + "components/connectors/custom-built-connectors/update-guide/030-to-040", + "components/connectors/custom-built-connectors/update-guide/020-to-030", + "components/connectors/custom-built-connectors/update-guide/010-to-020", + ], + }, ], }, ], @@ -866,6 +850,45 @@ module.exports = { "self-managed/platform-deployment/docker", "self-managed/platform-deployment/manual", ], + "Operational guides": [ + { + type: "category", + label: "Update guide", + link: { + type: "doc", + id: "self-managed/operational-guides/update-guide/introduction", + }, + items: [ + "self-managed/operational-guides/update-guide/820-to-830", + "self-managed/operational-guides/update-guide/810-to-820", + "self-managed/operational-guides/update-guide/800-to-810", + "self-managed/operational-guides/update-guide/130-to-800", + { + Elasticsearch: [ + "self-managed/operational-guides/update-guide/elasticsearch/7-to-8", + ], + }, + ], + }, + { + type: "category", + label: "Backup and restore", + link: { + type: "doc", + id: "self-managed/operational-guides/backup-restore/backup-and-restore", + }, + items: [ + "self-managed/operational-guides/backup-restore/optimize-backup", + "self-managed/operational-guides/backup-restore/operate-tasklist-backup", + "self-managed/operational-guides/backup-restore/zeebe-backup-and-restore", + ], + }, + { + Troubleshooting: [ + "self-managed/operational-guides/troubleshooting/log-levels", + ], + }, + ], }, { Concepts: [ @@ -1270,16 +1293,5 @@ module.exports = { }, ], }, - { - "Backup and restore": [ - "self-managed/backup-restore/backup-and-restore", - "self-managed/backup-restore/optimize-backup", - "self-managed/backup-restore/operate-tasklist-backup", - "self-managed/backup-restore/zeebe-backup-and-restore", - ], - }, - { - Troubleshooting: ["self-managed/troubleshooting/log-levels"], - }, ], };