#2413 consolidate tier info for APIs #475
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
modules/deploy/pages/deployment-option/cloud/create-byoc-cluster-aws.adoc
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,11 @@ | |||
| = Throughput Tiers | |||
There was a problem hiding this comment.
No explanation is given about what a Throughput Tier is. We should link to some sort of definition. Customers should understand WHY they need a tier.
There was a problem hiding this comment.
tiers are more than just throughput. I'd almost drop the the word from the framing and describe that Tiers are shaped according to workload characteristics, including throughput requirements, partition sizing, etc.
There was a problem hiding this comment.
Changed to: "When you create a BYOC cluster, you select your usage tier. Each tier provides tested and guaranteed workload configurations for throughput, logical partitions, and connections. The following table lists the supported tiers for BYOC clusters." (similar to Dedicated)
| @@ -30,8 +30,7 @@ NOTE: Serverless is currently in a limited availability (LA) release with xref:d | |||
| === Dedicated Cloud | |||
|
|
|||
| With Dedicated clusters, you host your data in Redpanda's VPC, and Redpanda handles provisioning, operations, and maintenance. Dedicated clusters are single-tenant deployments that support private networking (that is, VPC peering to talk over private IPs) for better data isolation. | |||
There was a problem hiding this comment.
The statement "host your data in Redpanda's VPC" is misleading. Re-word.
There was a problem hiding this comment.
Changed to "...you host your data on Redpanda cloud resources (AWS or GCP)..."
| @@ -30,8 +30,7 @@ NOTE: Serverless is currently in a limited availability (LA) release with xref:d | |||
| === Dedicated Cloud | |||
|
|
|||
| With Dedicated clusters, you host your data in Redpanda's VPC, and Redpanda handles provisioning, operations, and maintenance. Dedicated clusters are single-tenant deployments that support private networking (that is, VPC peering to talk over private IPs) for better data isolation. | |||
|
|
|||
| Available on AWS or GCP. | |||
| When you create a Dedicated cluster, you select a xref:deploy:deployment-option/cloud/dedicated/dedicated-tiers.adoc[throughput tier and region] on either AWS or GCP. | |||
There was a problem hiding this comment.
Why do I need to select a throughput tier. This should be covered somewhere and linked in this paragraph.
| @@ -40,10 +39,7 @@ To start using Dedicated, contact https://redpanda.com/try-redpanda?section=ente | |||
| === Bring Your Own Cloud (BYOC) | |||
|
|
|||
| With BYOC clusters, you deploy Redpanda in your own VPC, so all data is | |||
There was a problem hiding this comment.
This is only for BYO VPC. Re-word for standard BYOC.
There was a problem hiding this comment.
reworded: "With BYOC clusters, you deploy Redpanda in your own cloud (AWS or GCP),..."
modules/deploy/pages/deployment-option/cloud/create-byoc-cluster-gcp.adoc
Outdated
Show resolved
Hide resolved
modules/deploy/pages/deployment-option/cloud/create-dedicated-cloud-cluster-aws.adoc
Outdated
Show resolved
Hide resolved
modules/deploy/pages/deployment-option/cloud/dedicated/dedicated-tiers.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
This page is called "Throughput Tiers". No explanation is given for what a throughput tier. But the first thing on the page tells us Serverless has no tiers. Then we jump immediately into Tier limits. And to finish things off we tell them Legacy tiers have different limits and they should contact Support.
This page needs to be re-worked entirely.
First start by removing that note about Serverless Clusters. Having this be the first thing on the page is very confusing. And also we repeat it later on the page. Which is also confusing because the page is for BYOC. Why are we talking about Serverless?
Then start with what a throughput tier is and why a customer cares about this. This is THE most important decision a customer will make when creating a cluster. They should understand why and what that entails. Then talk about the characteristics of those tiers. I know we internally call these "limits" but for customers we should find better terminology. Limits has a negative connotation and implies something we enforce, which we do not. I will defer to @bpraseed on what that terminology should be or if we should continue using limits.
We should then remove the reference to legacy tiers at the top of the page. Customers don't have an easy way to know if they have legacy or new tiers. We can put this as a "Note" at the bottom of the page or remove the reference entirely. Having this at the top of the page feels alarming to me.
Then for the supported regions, is there a reason we are specifying "tier-1-aws-v2-arm"? If this is intended for the API folks, this should be in the API reference. Not here. The tiers should appear closer to what customers see in the UI today. Can we make this table a drop down type of information? The long scrolling page is not easy to use. And add AWS and GCP as a select. I missed the "tabs" the first time I tried this.
There was a problem hiding this comment.
@towfiqa and @bpraseed: I've removed the zone/machine type details from the main docs. After the API docs are published, we can add links to them here. I'm not sure what else to say about our tiers. Can you please review this and share any guidance about how they should decide which tier to pick, or what happens if they want/need to switch tiers?
There was a problem hiding this comment.
noting here as well: don't call these throughput tiers because that causes confusion with customers who we have to size up along a different workload dimension. Maybe call it "Workload Tiers" or something like that.
| and isolation. Redpanda handles provisioning, operations, and maintenance. See <<BYOC architecture>>. | ||
|
|
||
| Available on AWS or GCP. | ||
| contained in your own environment. This provides an additional layer of security and isolation. When you create a BYOC cluster, you select a xref:deploy:deployment-option/cloud/byoc-tiers.adoc[throughput tier and region] on either AWS or GCP. Redpanda handles provisioning, operations, and maintenance. See also: <<BYOC architecture>>. | ||
|
|
||
| ==== Sign up for BYOC |
There was a problem hiding this comment.
Is this info needed for an overview page? It seems a little crammed in there.
There was a problem hiding this comment.
We need a comparison somewhere between the three different cloud managed deployment models.
I think it's reasonable here.
|
Let's drop the zones from the region table as its a function of availability by the cloud provider. |
# Conflicts: # modules/deploy/pages/deployment-option/cloud/cloud-overview.adoc # modules/deploy/pages/deployment-option/cloud/create-byoc-cluster-aws.adoc # modules/deploy/pages/deployment-option/cloud/create-byoc-cluster-gcp.adoc # modules/deploy/pages/deployment-option/cloud/create-dedicated-cloud-cluster-aws.adoc
|
Merging so link is available in API docs. For any additional updates, we'll open a new PR. |
Co-authored-by: JakeSCahill <jake@redpanda.com>
fixes https://github.com/redpanda-data/documentation-private/issues/2413
Review deadline: Thursday, May 16
Right now, we have Redpanda Cloud supported tiers and regions in separate places in the doc. This PR consolidates the tiers and regions and it separates out the content for BYOC and Dedicated for better readability.
In the UI, you only see the options available based on the provider, tier, and region you select. But API users need to input their selection, so the API docs list additional details like zones/machine types. After the Cloud API reference doc is published, we'll link to that for API users.
It also simplifies the Cloud side-nav:
preview: