Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(console): Add cluster autopause #4085

Merged
merged 25 commits into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
79a4da7
Draft Autopause feature
mesellings Jul 30, 2024
3215719
Remove old pause message
mesellings Jul 30, 2024
b6498d1
Minor edits
mesellings Jul 31, 2024
0be2ed6
Merge branch 'main' into mes-2419-cluster-autopause
mesellings Jul 31, 2024
607afdd
Minor edit
mesellings Jul 31, 2024
5752ed8
Minor edits
mesellings Jul 31, 2024
22fd015
Fix admonition closing tag
mesellings Jul 31, 2024
ed38630
Edit from review
mesellings Jul 31, 2024
56c83b7
Structure edits following review
mesellings Aug 1, 2024
2504a05
Merge branch 'main' into mes-2419-cluster-autopause
mesellings Aug 1, 2024
7e45184
Edits following Slack review
mesellings Aug 1, 2024
e3d5d09
Merge branch 'mes-2419-cluster-autopause' of https://github.com/camun…
mesellings Aug 1, 2024
851271f
Edit to remove Production cluster bullet reference
mesellings Aug 1, 2024
6c6ca42
Edits to match the UI text
mesellings Aug 1, 2024
902ba25
Add link to explain small sizing
mesellings Aug 1, 2024
65f2deb
Minor grammatical edits
mesellings Aug 1, 2024
a7309e2
Add resume cluster duration
mesellings Aug 1, 2024
326ca3e
Edit 8 to eight for style consistency
mesellings Aug 2, 2024
ebd3c80
Minor edit for conciseness
mesellings Aug 7, 2024
ac68cc5
Backport auto-pause work to 8.2,8.3,8.4,8.5
mesellings Aug 7, 2024
07954d4
Edits to resume cluster following review
mesellings Aug 8, 2024
09c1a7a
Merge branch 'main' into mes-2419-cluster-autopause
mesellings Aug 8, 2024
31a79c8
Backport of resume cluster changes to 8.5, 8.4
mesellings Aug 8, 2024
ecca232
Merge branch 'mes-2419-cluster-autopause' of https://github.com/camun…
mesellings Aug 8, 2024
0e3301e
Merge branch 'main' into mes-2419-cluster-autopause
mesellings Sep 4, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions docs/components/concepts/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,36 @@ 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.
## Autopause

Free and Free Trial plan `dev` (or untagged) clusters are automatically paused 8 hours after the creation of the cluster or since you last resumed it from a paused state.
mesellings marked this conversation as resolved.
Show resolved Hide resolved

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.

- Production clusters and clusters tagged as `test`, `stage`, or `prod` are exempt and do not autopause.
- Starter, Professional, and Enterprise customer clusters are exempt and do not autopause.
- Paused clusters are automatically deleted after 30 consecutive days in a paused state. You can change the tag to avoid cluster deletion.
- Autopause occurs regardless of cluster usage.
- You can resume a paused cluster at any time. See [Resume your cluster](/components/console/manage-clusters/resume-cluster.md/).
mesellings marked this conversation as resolved.
Show resolved Hide resolved

The following table shows the cluster autopause schedule for each plan and tag.

| | Untagged or `dev`\* | `test` | `stage` | `prod` |
| ------------ | ------------------- | -------- | -------- | -------- |
| Free Trial | 8 hours | _exempt_ | _exempt_ | _exempt_ |
| Free | 8 hours | _exempt_ | _exempt_ | _exempt_ |
| Starter | _exempt_ | _exempt_ | _exempt_ | _exempt_ |
| Professional | _exempt_ | _exempt_ | _exempt_ | _exempt_ |
| Enterprise | _exempt_ | _exempt_ | _exempt_ | _exempt_ |

\* Untagged clusters are treated as `dev` tagged clusters.

:::tip

To avoid having to keep resuming your cluster(s) after an autopause, you can:
mesellings marked this conversation as resolved.
Show resolved Hide resolved

- Tag the cluster as `test`, `stage`, or `prod`.
- Use the Camunda 8 Production environment.
- [Upgrade your free Camunda 8 plan](https://camunda.com/pricing/) to a Starter, Professional, or Enterprise plan.

:::
12 changes: 10 additions & 2 deletions docs/components/console/manage-clusters/resume-cluster.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
---
id: resume-cluster
title: Resume your cluster
description: "Follow these instructions to resume your cluster"
description: "You can resume your paused cluster 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**.
If your cluster has been automatically paused, you can resume your cluster at any time.

mesellings marked this conversation as resolved.
Show resolved Hide resolved
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 in the **Cluster Details**.

:::info
To learn more about automatic cluster pausing on Free and Free Trial plan clusters, see [Autopause](/components/concepts/clusters.md#autopause).
:::
Loading