Skip to content

Commit

Permalink
consolidate manage cluster section (#4202)
Browse files Browse the repository at this point in the history
* consolidate manage cluster section

* add little intro sentence

* clean up wording of limited functionality

* minor tweaks

* backport to 8.5

* fix broken link

* whoops

* fix redirects
  • Loading branch information
christinaausley committed Sep 20, 2024
1 parent 471ded4 commit 72881cf
Show file tree
Hide file tree
Showing 26 changed files with 192 additions and 205 deletions.
6 changes: 5 additions & 1 deletion docs/components/concepts/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ When your Free Trial plan expires, you are automatically transferred to the Free

Free Trial `dev` (or untagged) clusters are automatically paused eight hours after a cluster is created or resumed from a paused state. Auto-pause occurs regardless of cluster usage.

You can resume a paused cluster at any time, which typically takes five to ten minutes to complete. See [resume your cluster](/components/console/manage-clusters/resume-cluster.md/).
You can resume a paused cluster at any time, which typically takes five to ten minutes to complete. See [resume your cluster](/components/console/manage-clusters/manage-cluster.md#resume-a-cluster).

- Clusters tagged as `test`, `stage`, or `prod` do not auto-pause.
- Paused clusters are automatically deleted after 30 consecutive paused days. You can change the tag to avoid cluster deletion.
Expand Down Expand Up @@ -71,3 +71,7 @@ Additionally in the Starter Plan, the following applies to **development cluster

- **Cluster is not highly available & includes less hardware**: Reduced hardware resources and availability compared to production cluster (for example, one Zeebe node only).
- **Shorter history of processes and decisions**: Data retention in Operate, Optimize, and Tasklist is reduced to one day. For example, pending or historical process instances are deleted after one day as per the [fair usage limits of the Starter plan](https://camunda.com/legal/fair-usage-limits-for-starter-plan/).

:::caution
**Cluster auto-pause** is not yet available and only applies to non-Enterprise clusters. Development clusters will be paused if they go unused for two hours. When a cluster is paused, not all functionality is limited. For example, you may still execute BPMN timers and BPMN message catch events. To resume your cluster, review [how to resume a cluster](/components/console/manage-clusters/manage-cluster.md#resume-a-cluster).
:::
2 changes: 1 addition & 1 deletion docs/components/console/introduction-to-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Camunda Console is the management application for the included products, such as

Using Camunda Console, you can:

- [Create](./manage-clusters/create-cluster.md) and [delete](./manage-clusters/delete-cluster.md) clusters.
- [Create](./manage-clusters/create-cluster.md) and [delete](./manage-clusters/manage-cluster.md#delete-a-cluster) clusters.
- [Manage API clients](./manage-clusters/manage-api-clients.md) to interact with [Zeebe](/components/zeebe/zeebe-overview.md) and [Tasklist](/components/tasklist/introduction-to-tasklist.md).
- [Manage alerts](./manage-clusters/manage-alerts.md) to get notified when workflow errors occur.
- [Manage IP allowlists](./manage-clusters/manage-ip-allowlists.md) to restrict access to clusters.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,7 @@ Users without **Admin** roles can deploy only on `dev`, `test`, or `stage` clust
![cluster-healthy](./img/cluster-overview-new-cluster-healthy.png)

3. After the cluster is created, click on the cluster name to visit the cluster detail page.

:::note
**Cluster auto-pause** is not yet available and only applies to non-Enterprise clusters. Development clusters will be paused if they go unused for two hours. When a cluster is paused, not all functionality is limited. For example, you may still execute BPMN timers and BPMN message catch events. To resume your cluster, review [how to resume a cluster](/components/console/manage-clusters/manage-cluster.md#resume-a-cluster).
:::
11 changes: 0 additions & 11 deletions docs/components/console/manage-clusters/delete-cluster.md

This file was deleted.

72 changes: 72 additions & 0 deletions docs/components/console/manage-clusters/manage-cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
id: manage-cluster
title: Manage your cluster
description: "Follow these steps to rename, resume, update, or delete your cluster."
---

Read through the following sections to rename, resume, update, or delete your cluster.

## Rename a cluster

A cluster can be renamed at any time. To rename your cluster, follow the steps below:

1. Open the cluster details by clicking on the cluster name.
2. Select the three vertical dots next to the cluster name near the top of the page to open the cluster's menu.
3. Click **Rename**.

![cluster-rename](./img/cluster-rename.png)

## Resume a cluster

:::note
**Cluster auto-pause** is not yet available and only applies to non-Enterprise clusters. Development clusters will be paused if they go unused for two hours. When a cluster is paused, not all functionality is limited. For example, you may still execute BPMN timers and BPMN message catch events. To learn more about automatic cluster pausing on Free Trial plan clusters, see [auto-pause](/components/concepts/clusters.md#auto-pause).
:::

You can resume your paused cluster during deployment, or from the **Console** at any time.

### Resume during deployment

During deployment, you can resume the selected cluster if it is paused.

![Resume a paused cluster during deployment](./img/cluster-resume-deploy.png)

1. Select your paused cluster during deployment.
1. Select **Resume** in the paused cluster notification.

### Resume from Console

You can resume your paused cluster from the **Console** at any time.

![Resume a paused cluster from the Console](./img/cluster-resume-console.png)

1. Navigate to **Console**, and select the **Clusters** tab.
1. The cluster **Status** shows “Paused” if a cluster is paused. Select the cluster that you want to resume.
1. On the cluster **Overview** tab, select **Resume cluster** in the **Status** row of the **Cluster Details**.

## Update a cluster

:::note
This action cannot be undone. Updated clusters cannot be reverted to the previous version.
:::

Clusters can be updated to new versions of Camunda 8 manually or automatically.

Clusters eligible for updates will show a button on the UI.

At this time, updates do not trigger backups, however, manual backups can be initiated through the Console Backups tab.

### Update a cluster manually

When an update is available, an **Update** button will appear. This button is not available for clusters enrolled in [automatic updates](/reference/auto-updates.md).

### Automated cluster updates

You can decide if you want to have [automated updates](/reference/auto-updates.md) to new versions of Camunda 8 activated. You can also toggle this feature anytime later in the **Settings** tab of your cluster.

## Delete a cluster

:::note
This action cannot be undone.
:::

A cluster can be deleted at any time. To delete your cluster, navigate to the **Clusters** tab in the top navigation and click **Delete** to the far right of the cluster name.
13 changes: 0 additions & 13 deletions docs/components/console/manage-clusters/rename-cluster.md

This file was deleted.

29 changes: 0 additions & 29 deletions docs/components/console/manage-clusters/resume-cluster.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/components/console/manage-clusters/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You can set the cluster to automatically update to newer versions of Camunda 8 w
- Disable this setting if you do not want the cluster to automatically update. You must manually update the cluster.

:::tip
For more information on updating clusters, see [update your cluster](/components/console/manage-clusters/update-cluster.md).
For more information on updating clusters, see [update your cluster](/components/console/manage-clusters/manage-cluster.md#update-a-cluster).
:::

## Enforce user task restrictions
Expand All @@ -51,7 +51,7 @@ For more information on user task access restrictions, see [user task access res

## Delete this cluster

You can _permanently_ delete the selected cluster. See [delete your cluster](/components/console/manage-clusters/delete-cluster.md).
You can _permanently_ delete the selected cluster. See [delete your cluster](/components/console/manage-clusters/manage-cluster.md#delete-a-cluster).

:::caution
Deleting a cluster is permanent. You cannot reuse a cluster after it has been deleted.
Expand Down
23 changes: 0 additions & 23 deletions docs/components/console/manage-clusters/update-cluster.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To deploy your process application:
<p><img src={DeployImg} alt="Deploy a process application" /></p>
1. Turn on the toggle for the cluster stage you want to deploy to.
1. Perform any other actions as required, such as:
- Unpausing the chosen cluster if it has been auto-paused. Select **Resume**.
- Unpausing the chosen cluster if it has been auto-paused. Select **Resume cluster** within the **Cluster Details**.
- Managing the cluster. Select **Manage**.
- [Defining the stages](process-application-pipeline.md#deployment-pipeline-stages) of your deployment pipeline. Select **Define stages**.
1. Select **Deploy** to deploy the process application to the selected cluster.
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/announcements.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The Zeebe Go Client and zbctl will be officially deprecated with the 8.6 release
### Camunda 8 SaaS - Required cluster update

:::caution
By **August 30th, 2024** all automation clusters in Camunda 8 SaaS must be [updated](/components/console/manage-clusters/update-cluster.md) to the following versions at a **minimum**:
By **August 30th, 2024** all automation clusters in Camunda 8 SaaS must be [updated](/components/console/manage-clusters/manage-cluster.md#update-a-cluster) to the following versions at a **minimum**:

- **8.2+gen27**
- **8.3+gen11**
Expand All @@ -68,7 +68,7 @@ By **August 30th, 2024** all automation clusters in Camunda 8 SaaS must be [upda

auth0 announced an End-Of-Life for one of the functionalities that is being utilized by previous automation clusters. The new versions are not using this functionality anymore. This update ensures your cluster will work seamlessly after auth0 deactivates the feature in production.

You minimally need to take the following [update](/components/console/manage-clusters/update-cluster.md) path:
You minimally need to take the following [update](/components/console/manage-clusters/manage-cluster.md#update-a-cluster) path:

- 8.0.x -> 8.2+gen27
- 8.1.x -> 8.2+gen27
Expand Down
16 changes: 2 additions & 14 deletions optimize_sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -123,20 +123,8 @@ module.exports = {
"components/console/manage-clusters/create-cluster/"
),
docsLink(
"Rename your cluster",
"components/console/manage-clusters/rename-cluster/"
),
docsLink(
"Resume your cluster",
"components/console/manage-clusters/resume-cluster/"
),
docsLink(
"Update your cluster",
"components/console/manage-clusters/update-cluster/"
),
docsLink(
"Delete your cluster",
"components/console/manage-clusters/delete-cluster/"
"Manage your cluster",
"components/console/manage-clusters/manage-cluster/"
),
docsLink(
"Manage API clients",
Expand Down
19 changes: 2 additions & 17 deletions optimize_versioned_sidebars/version-3.13.0-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -188,23 +188,8 @@
},
{
"type": "link",
"label": "Rename your cluster",
"href": "/docs/components/console/manage-clusters/rename-cluster/"
},
{
"type": "link",
"label": "Resume your cluster",
"href": "/docs/components/console/manage-clusters/resume-cluster/"
},
{
"type": "link",
"label": "Update your cluster",
"href": "/docs/components/console/manage-clusters/update-cluster/"
},
{
"type": "link",
"label": "Delete your cluster",
"href": "/docs/components/console/manage-clusters/delete-cluster/"
"label": "Manage your cluster",
"href": "/docs/components/console/manage-clusters/manage-cluster/"
},
{
"type": "link",
Expand Down
5 changes: 1 addition & 4 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,7 @@ module.exports = {
{
"Manage clusters": [
"components/console/manage-clusters/create-cluster",
"components/console/manage-clusters/rename-cluster",
"components/console/manage-clusters/resume-cluster",
"components/console/manage-clusters/update-cluster",
"components/console/manage-clusters/delete-cluster",
"components/console/manage-clusters/manage-cluster",
"components/console/manage-clusters/manage-api-clients",
"components/console/manage-clusters/manage-alerts",
"components/console/manage-clusters/manage-ip-allowlists",
Expand Down
16 changes: 16 additions & 0 deletions static/.htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@ RewriteRule (.*) https://%{SERVER_NAME}/$1 [R=301,L]
# Disable directory listing and multi views
Options -Indexes -MultiViews

# Remove rename, resume, update, and delete a cluster
RewriteRule ^docs/next/components/console/manage-clusters/rename-cluster/?$ /docs/next/components/console/manage-clusters/manage-cluster/$1 [R=301,L]
RewriteRule ^docs/next/components/console/manage-clusters/resume-cluster/?$ /docs/next/components/console/manage-clusters/manage-cluster/$1 [R=301,L]
RewriteRule ^docs/next/components/console/manage-clusters/update-cluster/?$ /docs/next/components/console/manage-clusters/manage-cluster/$1 [R=301,L]
RewriteRule ^docs/next/components/console/manage-clusters/delete-cluster/?$ /docs/next/components/console/manage-clusters/manage-cluster/$1 [R=301,L]

RewriteRule ^docs/components/console/manage-clusters/rename-cluster/?$ /docs/components/console/manage-clusters/manage-cluster/$1 [R=301,L]
RewriteRule ^docs/components/console/manage-clusters/resume-cluster/?$ /docs/components/console/manage-clusters/manage-cluster/$1 [R=301,L]
RewriteRule ^docs/components/console/manage-clusters/update-cluster/?$ /docs/components/console/manage-clusters/manage-cluster/$1 [R=301,L]
RewriteRule ^docs/components/console/manage-clusters/delete-cluster/?$ /docs/components/console/manage-clusters/manage-cluster/$1 [R=301,L]

RewriteRule ^docs/8.5/components/console/manage-clusters/rename-cluster/?$ /docs/8.5/components/console/manage-clusters/manage-cluster/$1 [R=301,L]
RewriteRule ^docs/8.5/components/console/manage-clusters/resume-cluster/?$ /docs/8.5/components/console/manage-clusters/manage-cluster/$1 [R=301,L]
RewriteRule ^docs/8.5/components/console/manage-clusters/update-cluster/?$ /docs/8.5/components/console/manage-clusters/manage-cluster/$1 [R=301,L]
RewriteRule ^docs/8.5/components/console/manage-clusters/delete-cluster/?$ /docs/8.5/components/console/manage-clusters/manage-cluster/$1 [R=301,L]

# Remove community-supported Spring Zeebe SDK
RewriteRule ^docs/apis-tools/community-clients/spring/?$ /docs/apis-tools/spring-zeebe-sdk/getting-started/$1 [R=301,L]
# Rename Console SM to Administration API (Self-Managed)
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-8.5/components/concepts/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ When your Free Trial plan expires, you are automatically transferred to the Free

Free Trial `dev` (or untagged) clusters are automatically paused eight hours after a cluster is created or resumed from a paused state. Auto-pause occurs regardless of cluster usage.

You can resume a paused cluster at any time, which typically takes five to ten minutes to complete. See [resume your cluster](/components/console/manage-clusters/resume-cluster.md/).
You can resume a paused cluster at any time, which typically takes five to ten minutes to complete. See [resume your cluster](/components/console/manage-clusters/manage-cluster.md#resume-a-cluster).

- Clusters tagged as `test`, `stage`, or `prod` do not auto-pause.
- Paused clusters are automatically deleted after 30 consecutive paused days. You can change the tag to avoid cluster deletion.
Expand Down Expand Up @@ -73,5 +73,5 @@ Additionally in the Starter Plan, the following applies to **development cluster
- **Shorter history of processes and decisions**: Data retention in Operate, Optimize, and Tasklist is reduced to one day. For example, pending or historical process instances are deleted after one day as per the [fair usage limits of the Starter plan](https://camunda.com/legal/fair-usage-limits-for-starter-plan/).

:::caution
**Cluster auto-pause** is not yet available and only applies to non-Enterprise clusters. Development clusters will be paused if they go unused for two hours. When a cluster is paused, not all functionality will be limited, including the execution of BPMN timers and BPMN message catch events.
**Cluster auto-pause** is not yet available and only applies to non-Enterprise clusters. Development clusters will be paused if they go unused for two hours. When a cluster is paused, not all functionality is limited. For example, you may still execute BPMN timers and BPMN message catch events. To resume your cluster, review [how to resume a cluster](/components/console/manage-clusters/manage-cluster.md#resume-a-cluster).
:::
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Camunda Console is the management application for the included products, such as

Using Camunda Console, you can:

- [Create](./manage-clusters/create-cluster.md) and [delete](./manage-clusters/delete-cluster.md) clusters.
- [Create](./manage-clusters/create-cluster.md) and [delete](./manage-clusters/manage-cluster.md#delete-a-cluster) clusters.
- [Manage API clients](./manage-clusters/manage-api-clients.md) to interact with [Zeebe](/components/zeebe/zeebe-overview.md) and [Tasklist](/components/tasklist/introduction-to-tasklist.md).
- [Manage alerts](./manage-clusters/manage-alerts.md) to get notified when workflow errors occur.
- [Manage IP allowlists](./manage-clusters/manage-ip-allowlists.md) to restrict access to clusters.
Expand Down
Loading

0 comments on commit 72881cf

Please sign in to comment.