-
Notifications
You must be signed in to change notification settings - Fork 4
DOC-1350 Document feature Serverless on GCP #432
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.
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe PR restructures Serverless documentation: converts narrative steps into modular sections with explicit prerequisites, get-started flow, and interaction guidance. Adds a formal NOTE block for availability by cloud (AWS/GCP) and introduces a tabular Serverless usage limits section. Expands connection instructions for UI, rpk, Kafka API, and Redpanda Connect, including ACLs/security references and bootstrap server guidance. Updates What’s New with GCP Serverless (beta) and a Connect quick start. Adds GCP to Serverless supported regions (us-central1). Updates onboarding partial to include a welcome cluster, hello-world topic, and concrete CLI/UI steps. Sequence Diagram(s)sequenceDiagram
autonumber
actor User
participant CloudUI as Redpanda Cloud UI
participant Cluster as Serverless Cluster
participant KafkaAPI as Kafka API
participant rpk as rpk CLI
Note over CloudUI,Cluster: New structure: prerequisites, usage limits (table), availability note per cloud
User->>CloudUI: Sign in and open Welcome cluster
CloudUI-->>User: Show bootstrap server URL and security settings
User->>rpk: rpk cloud login / configure
rpk->>KafkaAPI: Authenticate using provided credentials
rpk->>KafkaAPI: Produce/consume on hello-world topic
KafkaAPI-->>rpk: ACKs/messages
rpk-->>User: Output records and status
sequenceDiagram
autonumber
actor User
participant CloudUI as Redpanda Cloud UI
participant Connect as Redpanda Connect
participant Source as Data Source
participant Topic as Redpanda Topic
Note over CloudUI,Connect: New quick start with Redpanda Connect in Serverless docs
User->>CloudUI: Open Connect quick start
CloudUI->>Connect: Create pipeline (source -> topic)
Connect->>Source: Pull data (configured credentials)
Connect->>Topic: Publish records
Topic-->>User: Data visible via rpk/UI
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
modules/get-started/pages/cluster-types/serverless.adoc(3 hunks)modules/get-started/pages/whats-new-cloud.adoc(1 hunks)modules/get-started/partials/get-started-serverless.adoc(1 hunks)modules/reference/pages/tiers/serverless-regions.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
nicolaferraro
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. My only comment is about the pre-existing AWS LA description, that does not describe reality. Maybe @towfiqa can chime in
| NOTE: Serverless is currently in a limited availability (LA) release with xref:get-started:cluster-types/serverless.adoc#serverless-usage-limits[usage limits]. | ||
| [NOTE] | ||
| ==== | ||
| * Serverless on AWS is currently in a glossterm:LA[,limited availability (LA)] release. During LA, existing clusters can scale to the usage limits, but new clusters may need to wait for availability. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what we mean here by "may need to wait for availability". I think we can remove
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks, I've removed that sentence
towfiqa
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Except for that one sentence where I commented the rest looks great.
…ut new clusters may need to wait for availability.
Removed the prereq for rpk, since rpk is not a prereq to getting started with Serverless. Instead, that info is in a note where we talk about using rpk
This reverts commit c7bc055.
Description
This pull request updates documentation to reflect the introduction of Redpanda Serverless clusters on Google Cloud Platform (GCP) as a beta release.
serverless.adocto clarify that Serverless on AWS is in limited availability (LA), while Serverless on GCP is in beta.us-central1) alongside AWS regions.Resolves https://redpandadata.atlassian.net/browse/DOC-1350
Review deadline:
Page previews
What's New
Create a Serverless Cluster
Serverless Regions
Cloud Overview
Checks