Skip to content

Commit

Permalink
docs(console): Add cluster autopause (#4085)
Browse files Browse the repository at this point in the history
* Draft Autopause feature

* Remove old pause message

* Minor edits

* Minor edit

* Minor edits

* Fix admonition closing tag

* Edit from review

* Structure edits following review

* Edits following Slack review

* Edit to remove Production cluster bullet reference

* Edits to match the UI text

* Add link to explain small sizing

* Minor grammatical edits

* Add resume cluster duration

* Edit 8 to eight for style consistency

* Minor edit for conciseness

* Backport auto-pause work to 8.2,8.3,8.4,8.5

* Edits to resume cluster following review

* Backport of resume cluster changes to 8.5, 8.4
  • Loading branch information
mesellings authored Sep 5, 2024
1 parent 7e3af7f commit 2c04bc0
Show file tree
Hide file tree
Showing 12 changed files with 165 additions and 18 deletions.
25 changes: 20 additions & 5 deletions docs/components/concepts/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,31 @@ When you deploy and execute your [BPMN](/components/modeler/bpmn/bpmn.md) or [DM

## Free Trial cluster

Free Trial clusters have the same functionality as a production cluster, but are size small and only available during your trial period. You cannot convert a Free Trial cluster to a different kind of cluster.
Free Trial clusters have the same functionality as a production cluster, but are size [small (S)](/components/best-practices/architecture/sizing-your-environment.md#camunda-8-saas) and only available during your trial period. You cannot convert a Free Trial cluster to a different kind of cluster.

Once you sign up for a Free Trial, you are able to create one production cluster for the duration of your trial.

When your Free Trial plan expires, you are automatically transferred to the Free Plan. This plan allows you to model BPMN and DMN collaboratively, but does not support execution of your models. Any cluster created during your trial is deleted, and you cannot create new clusters.

### Auto-pause

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/).

- 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.
- No data is lost while a cluster is paused. All execution and configuration is saved, but cluster components such as Zeebe and Operate are temporarily disabled until you resume the cluster.

:::tip

To prevent auto-pause, you can:

- Tag the cluster as `test`, `stage`, or `prod` instead of `dev`.
- [Upgrade your Free Trial plan](https://camunda.com/pricing/) to a Starter, Professional, or Enterprise plan.

:::

## Development clusters

Development clusters, available in the Starter and Enterprise plans, are recommended for development, testing, proof of concepts, and demos.
Expand All @@ -52,7 +71,3 @@ 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 will be limited, including the execution of BPMN timers and BPMN message catch events.
:::
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 24 additions & 2 deletions docs/components/console/manage-clusters/resume-cluster.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
---
id: resume-cluster
title: Resume your cluster
description: "Follow these instructions to resume your cluster"
description: "You can resume your paused cluster during deployment, or from the Console at any time."
---

A trial cluster can be paused automatically due to inactivity. To resume your cluster, navigate to the **Clusters** tab, click on the cluster name (e.g. Prod Cluster - Project A) from the list and in the cluster details, and click **Resume cluster**.
You can resume your paused cluster during deployment, or from the **Console** at any time.

- Resuming a cluster typically takes five to ten minutes.
- To learn more about automatic cluster pausing on Free Trial plan clusters, see [auto-pause](/components/concepts/clusters.md#auto-pause).

## 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**.
25 changes: 19 additions & 6 deletions versioned_docs/version-8.2/components/concepts/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,25 @@ Once you sign up for a Free Trial, you are able to create one production cluster

When your Free Trial plan expires, you are automatically transferred to the Free Plan. This plan allows you to model BPMN and DMN collaboratively, but does not support execution of your models. Any cluster created during your free trial is deleted, and you cannot create new clusters.

### Auto-pause

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.

- 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.
- No data is lost while a cluster is paused. All execution and configuration is saved, but cluster components such as Zeebe and Operate are temporarily disabled until you resume the cluster.

:::tip

To prevent auto-pause, you can:

- Tag the cluster as `test`, `stage`, or `prod` instead of `dev`.
- [Upgrade your Free Trial plan](https://camunda.com/pricing/) to a Starter, Professional, or Enterprise plan.

:::

## Development clusters

Development clusters are recommended for development, testing, proof of concepts, and demos.
Expand All @@ -39,9 +58,3 @@ Additionally, the following applies to **development clusters**:

- **Cluster is not high-available & 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.

:::caution

**Cluster auto-pause** is not yet available. Development clusters will be paused if they go unused for two hours. When a cluster is paused, not all functionality will work, including BPMN timers and BPMN message catch events.

:::
21 changes: 20 additions & 1 deletion versioned_docs/version-8.3/components/concepts/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,31 @@ When you deploy and execute your [BPMN](/components/modeler/bpmn/bpmn.md) or [DM

## Free Trial cluster

Free Trial clusters have the same functionality as a production cluster, but are size small and only available during your trial period. You cannot convert a Free Trial cluster to a different kind of cluster.
Free Trial clusters have the same functionality as a production cluster, but are size [small (S)](/components/best-practices/architecture/sizing-your-environment.md#camunda-8-saas) and only available during your trial period. You cannot convert a Free Trial cluster to a different kind of cluster.

Once you sign up for a Free Trial, you are able to create one production cluster for the duration of your trial.

When your Free Trial plan expires, you are automatically transferred to the Free Plan. This plan allows you to model BPMN and DMN collaboratively, but does not support execution of your models. Any cluster created during your trial is deleted, and you cannot create new clusters.

### Auto-pause

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.

- 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.
- No data is lost while a cluster is paused. All execution and configuration is saved, but cluster components such as Zeebe and Operate are temporarily disabled until you resume the cluster.

:::tip

To prevent auto-pause, you can:

- Tag the cluster as `test`, `stage`, or `prod` instead of `dev`.
- [Upgrade your Free Trial plan](https://camunda.com/pricing/) to a Starter, Professional, or Enterprise plan.

:::

## Development clusters

Development clusters are recommended for development, testing, proof of concepts, and demos.
Expand Down
19 changes: 19 additions & 0 deletions versioned_docs/version-8.4/components/concepts/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,25 @@ Once you sign up for a Free Trial, you are able to create one production cluster

When your Free Trial plan expires, you are automatically transferred to the Free Plan. This plan allows you to model BPMN and DMN collaboratively, but does not support execution of your models. Any cluster created during your trial is deleted, and you cannot create new clusters.

### Auto-pause

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/).

- 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.
- No data is lost while a cluster is paused. All execution and configuration is saved, but cluster components such as Zeebe and Operate are temporarily disabled until you resume the cluster.

:::tip

To prevent auto-pause, you can:

- Tag the cluster as `test`, `stage`, or `prod` instead of `dev`.
- [Upgrade your Free Trial plan](https://camunda.com/pricing/) to a Starter, Professional, or Enterprise plan.

:::

## Development clusters

Development clusters, available in the Starter and Enterprise plans, are recommended for development, testing, proof of concepts, and demos.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,25 @@
---
id: resume-cluster
title: Resume your cluster
description: "Follow these instructions to resume your cluster"
description: "You can resume your paused cluster during deployment, or from the Console at any time."
---

A trial cluster can be paused automatically due to inactivity. To resume your cluster, navigate to the **Clusters** tab, click on the cluster name (e.g. Prod Cluster - Project A) from the list and in the cluster details, and click **Resume cluster**.
You can resume your paused cluster during deployment, or from the **Console** at any time.

- Resuming a cluster typically takes five to ten minutes.
- To learn more about automatic cluster pausing on Free Trial plan clusters, see [auto-pause](/components/concepts/clusters.md#auto-pause).

## Resume during deployment

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

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.

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**.
19 changes: 19 additions & 0 deletions versioned_docs/version-8.5/components/concepts/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,25 @@ Once you sign up for a Free Trial, you are able to create one production cluster

When your Free Trial plan expires, you are automatically transferred to the Free Plan. This plan allows you to model BPMN and DMN collaboratively, but does not support execution of your models. Any cluster created during your trial is deleted, and you cannot create new clusters.

### Auto-pause

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/).

- 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.
- No data is lost while a cluster is paused. All execution and configuration is saved, but cluster components such as Zeebe and Operate are temporarily disabled until you resume the cluster.

:::tip

To prevent auto-pause, you can:

- Tag the cluster as `test`, `stage`, or `prod` instead of `dev`.
- [Upgrade your Free Trial plan](https://camunda.com/pricing/) to a Starter, Professional, or Enterprise plan.

:::

## Development clusters

Development clusters, available in the Starter and Enterprise plans, are recommended for development, testing, proof of concepts, and demos.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
---
id: resume-cluster
title: Resume your cluster
description: "Follow these instructions to resume your cluster"
description: "You can resume your paused cluster during deployment, or from the Console at any time."
---

A trial cluster can be paused automatically due to inactivity. To resume your cluster, navigate to the **Clusters** tab, click on the cluster name (e.g. Prod Cluster - Project A) from the list and in the cluster details, and click **Resume cluster**.
You can resume your paused cluster during deployment, or from the **Console** at any time.

- Resuming a cluster typically takes five to ten minutes.
- To learn more about automatic cluster pausing on Free Trial plan clusters, see [auto-pause](/components/concepts/clusters.md#auto-pause).

## 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**.

0 comments on commit 2c04bc0

Please sign in to comment.