Skip to content

Commit a7e7603

Browse files
committed
Scale: Refurbish page layout
1 parent fd48210 commit a7e7603

File tree

5 files changed

+94
-24
lines changed

5 files changed

+94
-24
lines changed

docs/admin/clustering/index.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ adding more nodes. This section of the documentation covers that topic.
1212
.. toctree::
1313
:maxdepth: 1
1414

15-
multi-node-setup
16-
multi-zone-setup
17-
scale/index
18-
scale/kubernetes
19-
logical-replication-setup
15+
Multi-Node Setup <multi-node-setup>
16+
Multi-Zone Setup <multi-zone-setup>
17+
Scale Clusters <scale/index>
18+
Logical Replication <logical-replication-setup>
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
(scale-auto)=
2+
3+
# Autoscale a CrateDB Cloud Cluster
4+
5+
CrateDB’s fully managed solution CrateDB Cloud comes with a REST API,
6+
which enables you to automate a lot of tasks. The tutorial demonstrates
7+
how to use the REST API to scale your CrateDB Cloud Cluster based on a
8+
threshold on the number of shards in a cluster.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
(scale-demand)=
2+
3+
# Scale CrateDB clusters up and down to cope with peaks in demand
4+
5+
This tutorial demonstrates the [shard allocation filtering] functionality,
6+
and how it is applied in a real-world data management scenario, specifically
7+
about tuning your database cluster to cope with high-demand situations.
8+
9+
10+
[shard allocation filtering]: inv:crate-reference#ddl_shard_allocation
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
(scale-expand)=
2+
3+
# How to expand an existing CrateDB cluster
4+

docs/admin/clustering/scale/index.md

Lines changed: 68 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,70 @@ By running your database cluster on multiple nodes, you will gain two benefits.
1212
of replica nodes.
1313

1414

15-
(scaling-expand)=
16-
## Expand Cluster
17-
18-
The article about [how to add new nodes to an existing cluster] walks you
19-
through the process of scaling up your database cluster, and educates you
20-
about the corresponding details to consider.
15+
:::{toctree}
16+
:maxdepth: 1
17+
:hidden:
2118

19+
Expand <expand>
20+
On-Demand <demand>
21+
Autoscale <auto>
22+
On Kubernetes <kubernetes>
23+
:::
2224

23-
(scaling-ondemand)=
24-
## Scale On-Demand
2525

26-
The article about [scaling CrateDB clusters up and down to cope with peaks in
27-
demand] shares knowledge about the [shard allocation filtering] feature of
28-
CrateDB.
26+
## Learn
2927

30-
Along the lines, it demonstrates how this functionality is applied in a real-
31-
world data management scenario, which is about tuning your database cluster to
32-
cope with high-demand situations.
28+
:::::{grid}
3329

34-
Prepare adding extra nodes to the database cluster.
30+
::::{grid-item-card}
31+
:link: scale-expand
32+
:link-type: ref
33+
(scaling-expand)=
34+
:::{rubric} Expand Cluster
35+
:::
36+
Learn how to add new nodes to an existing CrateDB database cluster
37+
running on your premises, in order to expand its capacity using
38+
horizontal scaling.
39+
+++
40+
{hyper-tutorial}`scale-expand`
41+
::::
42+
43+
::::{grid-item-card}
44+
:link: scale-demand
45+
:link-type: ref
46+
(scaling-ondemand)=
47+
:::{rubric} On-Demand Scaling
48+
:::
49+
Learn how to use CrateDB's [shard allocation filtering] feature in
50+
practice, in order to scale CrateDB clusters up and down to cope
51+
with peaks in high-demand situations.
52+
+++
53+
{hyper-tutorial}`scale-demand`
54+
::::
55+
56+
::::{grid-item-card}
57+
:link: scale-auto
58+
:link-type: ref
59+
(scaling-autoscale)=
60+
:::{rubric} Automatic Scaling
61+
:::
62+
Learn how to automatically scale your CrateDB Cloud Cluster based on a
63+
threshold on the number of shards in a cluster, using the
64+
CrateDB Cloud REST API.
65+
+++
66+
{hyper-tutorial}`scale-auto`
67+
::::
68+
:::::
69+
70+
71+
## Synopsis
72+
73+
A rough walkthrough how resource management works in CrateDB, to manage
74+
high-demand / peak situations.
75+
76+
:::{rubric} Provision Resources
77+
:::
78+
Prepare by adding extra nodes to the database cluster.
3579
```sql
3680
/* Apply routing setting to all existing partitions and new partitions. */
3781
ALTER TABLE test SET ("routing.allocation.exclude.storage" = 'temporarynodes');
@@ -40,13 +84,18 @@ ALTER TABLE test SET ("routing.allocation.exclude.storage" = 'temporarynodes');
4084
ALTER TABLE ONLY test RESET ("routing.allocation.exclude.storage");
4185
```
4286

43-
Before the high-demand event, properly configure table routing accordingly.
87+
:::{rubric} Scale Up
88+
:::
89+
Right before the high-demand event, adjust the table routing,
90+
so the cluster will use additional resources.
4491
```sql
4592
ALTER TABLE ONLY test SET ("routing.allocation.total_shards_per_node" = 2);
4693
```
4794

48-
To decommission extra database nodes, we need to move the data collected during
49-
the days of the event.
95+
:::{rubric} Scale Down
96+
:::
97+
To decommission excess database nodes, move the data collected during
98+
the days of the event away.
5099
```sql
51100
-- Move the collected data off the extra nodes.
52101
ALTER TABLE test SET ("routing.allocation.exclude.storage" = 'temporarynodes');
@@ -58,5 +107,5 @@ ALTER CLUSTER DECOMMISSION 'nodename';
58107

59108

60109
[how to add new nodes to an existing cluster]: https://community.cratedb.com/t/how-to-add-new-nodes-to-an-existing-cluster/1546
61-
[scaling CrateDB clusters up and down to cope with peaks in demand]: https://community.cratedb.com/t/scaling-cratedb-clusters-up-and-down-to-cope-with-peaks-in-demand/1314
110+
[how to scale CrateDB clusters up and down to cope with peaks in demand]: https://community.cratedb.com/t/scaling-cratedb-clusters-up-and-down-to-cope-with-peaks-in-demand/1314
62111
[shard allocation filtering]: inv:crate-reference#ddl_shard_allocation

0 commit comments

Comments
 (0)