DOC-241 doc all possible cluster states #323

micheleRP · 2025-06-10T21:58:57Z

Description

This pull request introduces a new section to the documentation about cluster states, providing descriptions of various states for different cluster types (Serverless, BYOC, and Dedicated).

Documentation updates:

Added a new "Cluster State" page: This page explains the various states a cluster can be in, categorized by cluster types (Serverless, BYOC, Dedicated). It includes detailed descriptions of each state, such as "Creating," "Ready," "Suspended," and more.
Updated navigation to include the "Cluster State" page: Added a new entry under the "Cluster Maintenance" section in the navigation (modules/ROOT/nav.adoc).

Resolves https://redpandadata.atlassian.net/browse/DOC-241
Review deadline:

Page previews

Cluster State

Checks

New feature
Content gap
Support Follow-up
Small fix (typos, links, copyedits, etc)

netlify · 2025-06-10T21:59:02Z

✅ Deploy Preview for rp-cloud ready!

Name	Link
🔨 Latest commit	`9f8b9d6`
🔍 Latest deploy log	https://app.netlify.com/projects/rp-cloud/deploys/687fff4567601300080e016c
😎 Deploy Preview	https://deploy-preview-323--rp-cloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2025-06-10T21:59:04Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

A new documentation page, "Cluster State," has been added under the "Cluster Maintenance" section in the navigation structure. This page details the various possible states of a cluster managed by Redpanda Cloud, categorizing them by deployment type: Serverless, BYOC (Bring Your Own Cloud), and Dedicated. Each deployment type has a tabbed table listing all possible states and their descriptions. No changes were made to code, APIs, or existing documentation outside of these additions.

Sequence Diagram(s)

Assessment against linked issues

Objective	Addressed	Explanation
Document all possible cluster states for BYOC/Dedicated and Serverless, including definitions and descriptions (DOC-241)	✅
Add a new documentation page before "Monitor Redpanda Cloud" for cluster states (DOC-241)	✅
Include state names such as Unknown, Creating, Creating agent, Upgrading, Deleting, Deleted, Failed, Resizing, Unspecified, Placing, Ready, Unrecognized, Suspended, etc. (DOC-241)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 3

🧹 Nitpick comments (1)

modules/manage/pages/cluster-maintenance/cluster-state.adoc (1)

21-21: Inconsistent state naming across tables
Serverless uses Unrecognized and Unspecified, while BYOC and Dedicated use Unknown. Consider unifying state terms or explaining why different terminology is used.

Also applies to: 41-41, 60-60

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4059278 and 8218a69.

📒 Files selected for processing (2)

modules/ROOT/nav.adoc (1 hunks)
modules/manage/pages/cluster-maintenance/cluster-state.adoc (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Redirect rules - rp-cloud
GitHub Check: Header rules - rp-cloud
GitHub Check: Pages changed - rp-cloud

🔇 Additional comments (1)

modules/ROOT/nav.adoc (1)

385-385: Navigation entry added under Cluster Maintenance looks correct
The new cluster-state.adoc link follows the existing pattern and indentation.

modules/manage/pages/cluster-maintenance/cluster-state.adoc

micheleRP · 2025-06-12T19:25:17Z

@birdayz Would you please review and confirm that we should document these cluster states? Do users need to know how transitions between cluster states happen?

sago2k8 · 2025-06-30T22:35:46Z

modules/manage/pages/cluster-maintenance/cluster-state.adoc

+|Failed |Cluster was unable to enter the ready state from either the creating or placing states.
+|Placing |Cluster is in the process of being placed on a cell with sufficient resources in the data plane.
+|Ready |Cluster is running and accepting external requests.
+|Suspended |Cluster is running but blocks all external requests.


Should we mention suspension is mostly related to being out of credits keep me true on the suspension reason @nicolaferraro.

True, automated suspension (close to 100% of the cases) is related to credit exhaustion for trial accounts. Adding a credit card unlocks clusters that transition to the Ready state again.

sago2k8 · 2025-06-30T22:37:49Z

modules/manage/pages/cluster-maintenance/cluster-state.adoc

+[cols="1,4",options="header"]
+|===
+|State |Description
+|Creating |Cluster is in the process of having its control plane state created.


I am not a native speaker but this reads a little off imo, could we simply say The Redpanda cluster has started the creation process

modules/manage/pages/cluster-maintenance/cluster-state.adoc

Co-authored-by: Santiago Jimenez Giraldo <santiago@redpanda.com>

sago2k8 · 2025-07-16T09:49:39Z

Is Node operation in progress state internal only? Does it equal Upgrading?

Correct it is Upgrading, the public states are:

    STATE_CREATING_AGENT = 1;
    STATE_CREATING = 2;
    STATE_READY = 3;
    STATE_DELETING = 4;
    STATE_DELETING_AGENT = 5;
    STATE_UPGRADING = 6;
    STATE_FAILED = 7;
    STATE_SUSPENDED = 8;

sago2k8

Some comments on the states, sorry for taking long to review.

modules/manage/pages/cluster-maintenance/cluster-state.adoc

c4milo · 2025-07-17T17:55:33Z

modules/manage/pages/cluster-maintenance/cluster-state.adoc

+|Deleting agent |Cluster is in the process of having its control plane state removed, and the Redpanda Cloud agent is being removed. 
+|Upgrading |Cluster is undergoing a rolling upgrade or a scale-up/scale-down operation.
+|Failed |Cluster was unable to enter the Ready state from either the Creating or the Creating agent states.
+|Suspended |Cluster is running but blocks all external requests. +


I'm not aware of this state in BYOC and Dedicated. @alenkacz, @birdayz, do you know?

Yes it's possible to be in suspended state.

c4milo

This looks good to me as initial documentation about cluster states but I'm honestly not super happy of how we designed this state machine, and customers will also notice.

micheleRP · 2025-07-17T18:07:38Z

@sago2k8, or any reviewer: What action can a user take to get out of a failed state?

sago2k8 · 2025-07-21T17:09:29Z

@sago2k8, or any reviewer: What action can a user take to get out of a failed state?

Today, re-creating the cluster, there will be some details about what went wrong.

paulohtb6 · 2025-07-21T20:58:32Z

modules/manage/pages/cluster-maintenance/cluster-state.adoc

+|Placing |Cluster is in the process of being placed on a cell with sufficient resources in the data plane.
+|Ready |Cluster is running and accepting external requests.
+|Deleting |Cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released.
+|Failed |Cluster was unable to enter the ready state from either the Creating or Placing states. +


where can I check what went wrong? If we know, we could provide this info here

paulohtb6 · 2025-07-21T20:59:08Z

modules/manage/pages/cluster-maintenance/cluster-state.adoc

+|State |Description
+|Creating |Cluster is in the process of having its control plane state created.
+|Placing |Cluster is in the process of being placed on a cell with sufficient resources in the data plane.
+|Ready |Cluster is running and accepting external requests.


What do we mean exactly by external requests? Requests outside of the network?

Maybe a better question is, what is an internal request?

modules/manage/pages/cluster-maintenance/cluster-state.adoc

paulohtb6 · 2025-07-21T21:03:58Z

modules/manage/pages/cluster-maintenance/cluster-state.adoc

+|Deleting |Cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane are released.
+|Deleting agent |Cluster is in the process of having its control plane state removed, and the Redpanda Cloud agent is being removed. 
+|Upgrading |Cluster is undergoing a rolling upgrade or a scale-up/scale-down operation.
+|Failed |Cluster was unable to enter the Ready state from either the Creating or the Creating agent states. +


Suggested change

|Failed |Cluster was unable to enter the Ready state from either the Creating or the Creating agent states. +

|Failed |Cluster was unable to enter the *Ready* state from either the *Creating* or the *Creating agent states*. +

and again, if we know where the user can look, we should provide directions

modules/manage/pages/cluster-maintenance/cluster-state.adoc

Co-authored-by: Paulo Borges <paulohtb6@gmail.com>

DOC-241 doc all possible cluster states

8218a69

micheleRP requested a review from a team as a code owner June 10, 2025 21:58

coderabbitai bot reviewed Jun 10, 2025

View reviewed changes

modules/manage/pages/cluster-maintenance/cluster-state.adoc Outdated Show resolved Hide resolved

modules/manage/pages/cluster-maintenance/cluster-state.adoc Outdated Show resolved Hide resolved

modules/manage/pages/cluster-maintenance/cluster-state.adoc Outdated Show resolved Hide resolved

micheleRP requested review from c4milo and malinskibeniamin June 10, 2025 22:03

micheleRP added 3 commits June 10, 2025 17:53

incorporate review feedback

138c949

edits

b173990

typo

ef35dac

micheleRP requested a review from birdayz June 12, 2025 19:23

combine BYOC/Dedicated tab

87c83f7

micheleRP requested a review from deniscoady June 18, 2025 18:43

remove the Unspecified state

fb7ac4f

sago2k8 reviewed Jun 30, 2025

View reviewed changes

reorder rows

e24d6bd

This comment was marked as resolved.

Sign in to view

sago2k8 reviewed Jul 15, 2025

View reviewed changes

modules/manage/pages/cluster-maintenance/cluster-state.adoc Outdated Show resolved Hide resolved

Update modules/manage/pages/cluster-maintenance/cluster-state.adoc

1241803

Co-authored-by: Santiago Jimenez Giraldo <santiago@redpanda.com>

sago2k8 reviewed Jul 16, 2025

View reviewed changes

modules/manage/pages/cluster-maintenance/cluster-state.adoc Outdated Show resolved Hide resolved

modules/manage/pages/cluster-maintenance/cluster-state.adoc Outdated Show resolved Hide resolved

modules/manage/pages/cluster-maintenance/cluster-state.adoc Outdated Show resolved Hide resolved

micheleRP added 3 commits July 16, 2025 12:37

incorporate Santi's feedback

0c8dfd9

minor edit, putting suspended last

5914abc

Add cc to turn Suspended back to Ready state

13ef492

c4milo reviewed Jul 17, 2025

View reviewed changes

c4milo approved these changes Jul 17, 2025

View reviewed changes

sago2k8 approved these changes Jul 21, 2025

View reviewed changes

Santi's feedback for failed state

efff51b

paulohtb6 reviewed Jul 21, 2025

View reviewed changes

modules/manage/pages/cluster-maintenance/cluster-state.adoc Outdated Show resolved Hide resolved

paulohtb6 reviewed Jul 21, 2025

View reviewed changes

modules/manage/pages/cluster-maintenance/cluster-state.adoc Outdated Show resolved Hide resolved

paulohtb6 reviewed Jul 21, 2025

View reviewed changes

modules/manage/pages/cluster-maintenance/cluster-state.adoc Outdated Show resolved Hide resolved

Update modules/manage/pages/cluster-maintenance/cluster-state.adoc

7cd1d63

Co-authored-by: Paulo Borges <paulohtb6@gmail.com>

paulohtb6 approved these changes Jul 21, 2025

View reviewed changes

micheleRP and others added 3 commits July 21, 2025 16:51

Update modules/manage/pages/cluster-maintenance/cluster-state.adoc

bf83224

Co-authored-by: Paulo Borges <paulohtb6@gmail.com>

put all cluster states in bold font

5806667

minor edits

9f8b9d6

micheleRP merged commit 988868e into main Jul 23, 2025
5 checks passed

micheleRP deleted the DOC-241-doc-all-possible-cluster-states branch July 23, 2025 02:11

coderabbitai bot mentioned this pull request Jul 24, 2025

fix table #367

Merged

4 tasks

	\|Failed \|Cluster was unable to enter the Ready state from either the Creating or the Creating agent states. +
	\|Failed \|Cluster was unable to enter the Ready state from either the Creating or the Creating agent states. +

DOC-241 doc all possible cluster states #323

DOC-241 doc all possible cluster states #323

Uh oh!

Conversation

micheleRP commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Documentation updates:

Page previews

Checks

Uh oh!

netlify bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for rp-cloud ready!

Uh oh!

coderabbitai bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Sequence Diagram(s)

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

micheleRP commented Jun 12, 2025

Uh oh!

sago2k8 Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

nicolaferraro Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sago2k8 Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

sago2k8 commented Jul 16, 2025

Uh oh!

sago2k8 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

c4milo Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

sago2k8 Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

c4milo left a comment

Choose a reason for hiding this comment

Uh oh!

micheleRP commented Jul 17, 2025

Uh oh!

sago2k8 commented Jul 21, 2025

Uh oh!

paulohtb6 Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

paulohtb6 Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

micheleRP commented Jun 10, 2025 •

edited

Loading

netlify bot commented Jun 10, 2025 •

edited

Loading

coderabbitai bot commented Jun 10, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

nicolaferraro Jul 17, 2025 •

edited

Loading

paulohtb6 Jul 21, 2025 •

edited

Loading

paulohtb6 Jul 21, 2025 •

edited

Loading