Skip to content

Commit

Permalink
Update Scale cluster page (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
proddata authored Jan 8, 2025
1 parent 52153da commit 77aaf8f
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 27 deletions.
Binary file removed docs/_assets/img/cluster-scale-edit.png
Binary file not shown.
Binary file modified docs/_assets/img/cluster-scale.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/howtos/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ the CrateDB Cloud Console.

Create Organization <create-org>
Add users to organization <add-users>
Reconfigure Cluster <reconfigure-cluster>
Scale Cluster <reconfigure-cluster>
Suspend Cluster <suspend-cluster>
Delete Cluster <delete-cluster>
Restore Backups <restore-backups>
Expand Down Expand Up @@ -60,7 +60,7 @@ Learn how to add users to organizations and manage their privileges.
:margin: 4 4 0 0
:gutter: 1

:::{grid-item-card} {octicon}`tools` Reconfigure Cluster
:::{grid-item-card} {octicon}`tools` Scale Cluster
:link: reconfigure-cluster
:link-type: ref
Learn how to scale your cluster up or down, depending on your needs.
Expand Down
39 changes: 14 additions & 25 deletions docs/howtos/reconfigure-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,31 @@
# Scale cluster

Scaling or reconfiguring your cluster happens on the \"Scale\" tab of
the CrateDB Cloud Console.

The page displays the current configuration of your cluster. You can see
your current plan, the resources of a single node, and the overall
resources of the cluster.
the CrateDB Cloud Console. The page displays the current configuration of your
cluster. You can see your current plan, the resources of a single node, and the
overall resources of the cluster.

![Cloud Console cluster scaling tab](../_assets/img/cluster-scale.png)

You can scale your cluster by clicking the *Edit cluster configuration*
button in the top-right:

![Cloud Console cluster scaling edit](../_assets/img/cluster-scale-edit.png)
You can scale your cluster by selecting a different configuration and
then clicking the **"Scale cluster"** button on the right.

Now you can do three different things:

- Change the plan of your cluster
- Change the compute plan of your cluster
- Increase storage on each node
- Increase/decrease the number of nodes

You can do only one of those operations at a time, i.e., you can\'t
change plans and scale the number of nodes at the same time.

The difference in the price of the cluster can be seen on the bottom
right, when choosing different configurations.

:::{note}
Any promotions or discounts applicable to your cluster will be applied
to your organization as a whole at the end of the billing period. Due to
technical limitations, they may not be directly visible in the cluster
scale pricing shown here, but do not worry! This does not mean that your
promotion or discount is not functioning.
:::
The difference in the price of the cluster can be seen on the right, when
choosing different configurations.

:::{warning}
Storage capacity increases for a given cluster are irreversible. To
reduce cluster storage capacity, reduce the cluster nodes instead (up to
a minimum of 2, although we recommend maintaining a minimum of 3 for
production use).
:::{caution}
Storage capacity increases for a cluster are permanent and cannot be reversed.
To decrease storage capacity, you can either reduce the number of cluster nodes
(minimum of 2 nodes, though we recommend at least 3 for production environments)
or start a new cluster with a smaller storage configuration and restore a backup
to it.
:::

0 comments on commit 77aaf8f

Please sign in to comment.