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.

Sign up for GitHub

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

Jump to bottom

Advanced SaaS Offering with increased uptime #4361

Merged
merged 11 commits into from
Oct 4, 2024
Merged

Advanced SaaS Offering with increased uptime #4361

Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
47ebe15
Initial draft of Clusters page
mesellings Sep 27, 2024
0da832e
Fix typo
mesellings Sep 27, 2024
e4ad2cb
Add hardware sizing table
mesellings Sep 30, 2024
50adac0
Review edits
mesellings Oct 1, 2024
1ea51dc
Cluster sizes table
mesellings Oct 2, 2024
64c190f
TW edits
mesellings Oct 2, 2024
2a31ddb
TW and feedback edits
mesellings Oct 3, 2024
8cf09e3
Merge branch 'main' into mes-2377-advanced-SaaS-clusters
mesellings Oct 3, 2024
6a19532
Add 4x size and incorporate feedback
mesellings Oct 4, 2024
e21c142
Merge branch 'main' into mes-2377-advanced-SaaS-clusters
mesellings Oct 4, 2024
5090efd
Fix table Disk size
mesellings Oct 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
96 changes: 56 additions & 40 deletions docs/components/concepts/clusters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,72 +6,88 @@ description: "Learn more about the clusters available in your Camunda 8 plan."

A [cluster](../../guides/create-cluster.md) is a provided group of production-ready nodes that run Camunda 8.

- **Enterprise** plan customers can create as many production or development clusters as they want based on their Enterprise agreement.
- **Starter** plan customers are limited based on the [fair usage limits of the plan](https://camunda.com/legal/fair-usage-limits-for-starter-plan/).
When [creating a cluster](/components/console/manage-clusters/create-cluster.md), you can customize the cluster **type** and **size** to meet your organization's availability and scalability needs, and to provide control over cluster performance, uptime, and disaster recovery guarantees.

Production clusters come in three sizes: small (S), medium (M), and large (L). To learn more about the size of cluster best suited for your use case, refer to our [Best Practices](/components/best-practices/best-practices-overview.md) for more information on [sizing your runtime environment](/components/best-practices/architecture/sizing-your-environment.md#sizing-your-runtime-environment).
:::note

The following table shows each plan and available type or size of cluster:
Prior to 8.6, clusters were configured by hardware size (S, M, L).

| | Development | Production - S | Production - M | Production - L |
| ---------- | ----------- | -------------- | -------------- | -------------- |
| Free Trial | \- | X | \- | \- |
| Free | \- | \- | \- | \- |
| Starter | X | X | \- | \- |
| Enterprise | X | X | X | X |
- To learn more about clusters prior to 8.6, see previous documentation versions.
- To learn more about migrating your existing clusters to the newer model, contact your Customer Success Manager.

When you deploy and execute your [BPMN](/components/modeler/bpmn/bpmn.md) or [DMN](/components/modeler/dmn/dmn.md) models on a production cluster, this might impact your monthly (Starter) or annual (Enterprise) total fee, meaning the more you execute your models, the higher your total fee may be.
:::

## Free Trial cluster
## Cluster type

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.
The cluster type defines the level of availability and uptime for the cluster.

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

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.
- Use a **Basic** cluster for experimentation, early development, and basic use cases not requiring a guaranteed high uptime.
- Use an **Advanced** cluster for production, with minimal disruption and high uptime.

### Auto-pause
You can choose from three different cluster types:

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.
| Type | Basic | Standard | Advanced |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------- | :---------------------------- | :-------------------------------------------------- |
| Usage | Experimentation, early development, basic use cases. | Production-ready use cases. | Production with minimal disruption and high uptime. |
| Uptime Percentage<br/> (Core Automation Cluster<strong>\*</strong>) | 99% | 99.5% | 99.9 |
mesellings marked this conversation as resolved.
Show resolved Hide resolved
| Uptime Percentage<br/>(Management Components<strong>\*\*</strong>) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | 99% | 99% | 99% |
mesellings marked this conversation as resolved.
Show resolved Hide resolved
| RTO/RPO<strong>\*\*\*</strong><br/>(Core Automation Cluster<strong>\*</strong>) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | RTO: 8 hours<br/>RPO: 24 hours | RTO: 2 hours<br/>RPO: 4 hours | RTO: < 1 hour<br/>RPO: < 1 hour |

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).
<p><strong>* Core Automation Cluster</strong> means the components critical for automating processes and decisions, such as Zeebe, Operate, Tasklist, Optimize and Connectors.</p>
<p><strong>** Management Components</strong> means the components responsible for designing and making processes and decisions executable, such as Web Modeler and Console.</p>
mesellings marked this conversation as resolved.
Show resolved Hide resolved
<p><strong>*** RTO (Recovery Time Objective)</strong> means the maximum allowable time that a system or application can be down after a failure or disaster before it must be restored. It defines the target time to get the system back up and running. <strong>RPO (Recovery Point Objective)</strong> means the maximum acceptable amount of data loss measured in time. It indicates the point in time to which data must be restored to resume normal operations after a failure. It defines how much data you can afford to lose. The RTO/RPO figures shown in the table are provided on a best-effort basis and are not guaranteed.</p>

- 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.
:::info
See [Camunda Enterprise General Terms](https://legal.camunda.com/licensing-and-other-legal-terms#camunda-enterprise-general-terms) for term definitions for **Monthly Uptime Percentage** and **Downtime**.
:::

:::tip
## Cluster size

To prevent auto-pause, you can:
The cluster size defines the cluster performance and capacity.

- 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.
- You can choose from three sizes of cluster (1x, 2x, 3x).
mesellings marked this conversation as resolved.
Show resolved Hide resolved
- Each increase in size boosts cluster performance and adds capacity. Larger cluster sizes allow you to serve more workload.
- Increased usage such as higher throughput or longer data retention requires a larger cluster size. See [sizing your environment](/components/best-practices/architecture/sizing-your-environment.md).
- Each size increase uses one of your available cluster reservations.
mesellings marked this conversation as resolved.
Show resolved Hide resolved

:::
### Cluster size hardware packages

## Development clusters
Cluster sizes determine the hosting hardware package used for the cluster, as follows:

Development clusters, available in the Starter and Enterprise plans, are recommended for development, testing, proof of concepts, and demos.
| Size | 1x | 2x | 3x |
| :---- | :-- | :-- | :-- |
| Spec? | | | |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think here we should then add the input from @rodrigo-lourenco-lopes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@felix-mueller @rodrigo-lourenco-lopes I've added the table into the sizing your runtime page along with the starred explanations - just need the final figures 👍


The way this type of cluster works varies depending on if you are using it in the Starter or the Enterprise plan.
### Limitations

### Development clusters in the Enterprise Plan
- Currently, there are limits on the number of packages you can select.
mesellings marked this conversation as resolved.
Show resolved Hide resolved
- Cluster sizes can only be increased for an existing cluster by contacting your Customer Success Manager.

Enterprise Plan users can purchase development clusters as part of their Enterprise subscription agreement. Deployment and execution of models (process instances, decision instances, and task users) are included at no extra cost for this type of cluster. Additionally, this type of cluster in the Enterprise plan follows the [standard data retention policy](/components/concepts/data-retention.md) and does not auto-pause when not in use.
## Free Trial clusters
mesellings marked this conversation as resolved.
Show resolved Hide resolved

Please [contact us](https://camunda.com/contact/) if you are an existing customer and would like to purchase a development cluster.
Free Trial clusters have the same functionality as a production cluster, but are of a Basic type and 1x size, and only available during your trial period. You cannot convert a Free Trial cluster to a different kind of cluster.

### Development clusters in the Starter Plan
Once you sign up for a Free Trial, you are able to create one production cluster for the duration of your trial.

Starter Plan users have one **development cluster** with free execution for development included in their plan. Deployment and execution of models (process instances, decision instances, and task users) are provided at no cost.
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

Additional clusters can be purchased through your [billing reservations](/components/console/manage-plan/update-billing-reservations.md).
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.

Additionally in the Starter Plan, the following applies to **development clusters**:
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).

- **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/).
- 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.
mesellings marked this conversation as resolved.
Show resolved Hide resolved

:::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).
:::
Loading