Skip to content

Commit 988868e

Browse files
micheleRPsago2k8paulohtb6
authored
DOC-241 doc all possible cluster states (#323)
* DOC-241 doc all possible cluster states * incorporate review feedback * edits * typo * combine BYOC/Dedicated tab * remove the Unspecified state * reorder rows * Update modules/manage/pages/cluster-maintenance/cluster-state.adoc Co-authored-by: Santiago Jimenez Giraldo <[email protected]> * incorporate Santi's feedback * minor edit, putting suspended last * Add cc to turn Suspended back to Ready state * Santi's feedback for failed state * Update modules/manage/pages/cluster-maintenance/cluster-state.adoc Co-authored-by: Paulo Borges <[email protected]> * Update modules/manage/pages/cluster-maintenance/cluster-state.adoc Co-authored-by: Paulo Borges <[email protected]> * put all cluster states in bold font * minor edits --------- Co-authored-by: Santiago Jimenez Giraldo <[email protected]> Co-authored-by: Paulo Borges <[email protected]>
1 parent 5dad926 commit 988868e

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,7 @@
399399
400400
* xref:manage:index.adoc[Manage]
401401
** xref:manage:cluster-maintenance/index.adoc[Cluster Maintenance]
402+
*** xref:manage:cluster-maintenance/cluster-state.adoc[]
402403
*** xref:manage:maintenance.adoc[]
403404
*** xref:manage:cluster-maintenance/config-cluster.adoc[]
404405
*** xref:manage:audit-logging.adoc[]
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
= Cluster State
2+
:description: Learn about the current status of a cluster.
3+
4+
The cluster state shows the current status of a cluster. Redpanda Cloud updates the state automatically, allowing you to monitor a cluster's health and availability.
5+
6+
[tabs]
7+
=====
8+
Serverless::
9+
+
10+
--
11+
[cols="1,4",options="header"]
12+
|===
13+
|State |Description
14+
|*Creating* |Cluster is in the process of having its control plane state created.
15+
|*Placing* |Cluster is in the process of being placed on a cell with sufficient resources in the data plane.
16+
|*Ready* |Cluster is running and accepting external requests.
17+
|*Deleting* |Cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane are released.
18+
|*Failed* |Cluster is unable to enter the *Ready* state from either the *Creating* or *Placing* states. +
19+
Try re-creating the cluster.
20+
|*Suspended* |Cluster is running but blocks all external requests. +
21+
This can happen when credits run out. Enter a credit card to return to the *Ready* state.
22+
|===
23+
--
24+
BYOC/Dedicated::
25+
+
26+
--
27+
[cols="1,4",options="header"]
28+
|===
29+
|State |Description
30+
|*Creating agent* |Cluster is in the process of having its control plane state created, and the Redpanda Cloud agent is being deployed.
31+
|*Creating* |Cluster is in the process of having its control plane state created.
32+
|*Ready* |Cluster is running and accepting external requests.
33+
|*Deleting* |Cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane are released.
34+
|*Deleting agent* |Cluster is in the process of having its control plane state and Redpanda Cloud agent removed.
35+
|*Upgrading* |Cluster is undergoing a rolling upgrade or a scaling operation.
36+
|*Failed* |Cluster is unable to enter the *Ready* state from either the *Creating* or the *Creating agent* states. +
37+
Try re-creating the cluster.
38+
|*Suspended* |Cluster is running but blocks all external requests. +
39+
This can happen when credits run out. Enter a credit card to return to the *Ready* state.
40+
--
41+
=====

0 commit comments

Comments
 (0)