Skip to content

Commit 9ef849e

Browse files
authored
DOC-1158 move Dedicated quickstart to partials (#246)
* DOC-1158 move Dedicated quickstart to partials * move streaming from quickstart into create page * deprioritize Dedicated in shared responsibility * deprioritize Dedicated in overview table * prioritize BYOC on home page * remove index page, add redirect * add redirect
1 parent 7c85cd8 commit 9ef849e

File tree

8 files changed

+223
-119
lines changed

8 files changed

+223
-119
lines changed

antora.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ asciidoc:
3737
description: 'Clusters hosted in Redpanda Cloud. This is the fastest and easiest way to start data streaming.'
3838
url: 'get-started:cluster-types/serverless.adoc'
3939
link-text: 'Get started'
40-
- title: 'Dedicated'
41-
description: 'Clusters hosted in Redpanda Cloud. This provides more control over your deployment.'
42-
url: 'get-started:cluster-types/dedicated/quick-start-cloud.adoc'
43-
link-text: 'Get started'
4440
- title: 'BYOC'
45-
description: 'Clusters hosted in your private cloud. This provides more control over your deployment and full data sovereignty.'
41+
description: 'Clusters hosted in your private cloud. This provides full data sovereignty and the most control over your deployment.'
4642
url: 'get-started:cluster-types/byoc/index.adoc'
4743
link-text: 'Get started'
44+
- title: 'Dedicated'
45+
description: 'Clusters hosted in Redpanda Cloud. This provides data sovereignty and single-tenant control over your deployment.'
46+
url: 'get-started:cluster-types/dedicated/quick-start-cloud.adoc'
47+
link-text: 'Get started'
4848
page-home-secondary-row-title: Popular topics
4949
page-home-secondary-row:
5050
- title: "What's new"

modules/ROOT/nav.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@
1818
**** xref:get-started:cluster-types/byoc/gcp/create-byoc-cluster-gcp.adoc[]
1919
**** xref:get-started:cluster-types/byoc/gcp/vpc-byo-gcp.adoc[]
2020
*** xref:get-started:cluster-types/byoc/remote-read-replicas.adoc[]
21-
** xref:get-started:cluster-types/dedicated/index.adoc[Dedicated]
22-
*** xref:get-started:cluster-types/dedicated/quick-start-cloud.adoc[Dedicated Cluster Quickstart]
23-
*** xref:get-started:cluster-types/dedicated/create-dedicated-cloud-cluster.adoc[]
21+
** xref:get-started:cluster-types/create-dedicated-cloud-cluster.adoc[]
2422
** xref:get-started:create-topic.adoc[Create a Topic]
2523
** xref:get-started:config-topics.adoc[Manage Topics]
2624

modules/get-started/pages/cloud-overview.adoc

Lines changed: 67 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
= Redpanda Cloud Overview
2-
:description: Learn about Redpanda Serverless, Dedicated, and Bring Your Own Cloud (BYOC) clusters.
3-
:description: Learn about Redpanda Serverless, Dedicated, and Bring Your Own Cloud (BYOC) clusters.
2+
:description: Learn about Redpanda Serverless, Bring Your Own Cloud (BYOC), and Dedicated clusters.
43
:tag-pipeline-service: api:ROOT:cloud-dataplane-api.adoc#tag--Redpanda-Connect-Pipeline
54
:page-aliases: cloud:dedicated-byoc.adoc, deploy:deployment-option/cloud/dedicated-byoc.adoc, deploy:deployment-option/cloud/cloud-overview.adoc
65

@@ -12,25 +11,24 @@ TIP: For more detailed information about the Redpanda platform, see xref:get-sta
1211
== Redpanda Cloud cluster types
1312

1413
Redpanda offers four types of fully-managed cloud clusters. All products have access to unlimited storage and 280+ data connectors with xref:develop:connect/about.adoc[Redpanda Connect].
15-
1614
|===
17-
| <<Serverless>> | <<Dedicated Cloud>> | <<Bring Your Own Cloud (BYOC)>>
18-
19-
| For starter projects and applications with low or variable traffic. | For production clusters requiring expert cloud hosting, higher throughput, and extra isolation. | For production clusters requiring data sovereignty, the highest throughput, and added security.
20-
| Multi-tenant on AWS | Single-tenant on AWS, Azure, or GCP | In your cloud on AWS, Azure, or GCP
21-
| 100 MB/s max write throughput | 400 MB/s max write throughput | 2 GB/s max write throughput
22-
| 300 MB/s max read throughput | 800 MB/s max read throughput | 4 GB/s max read throughput
23-
| 5000 partitions | 22,800 partitions | 112,500 partitions
24-
| 99.9% SLA | 99.99% SLA | 99.99% SLA
15+
| <<Serverless>> | <<Bring Your Own Cloud (BYOC)>> | <<Dedicated>>
16+
17+
| For starter projects and applications with low or variable traffic. | For production clusters requiring data sovereignty, the highest throughput, and added security. | For production clusters requiring expert cloud hosting, higher throughput, and extra isolation.
18+
| Multi-tenant in Redpanda Cloud on AWS | In your cloud on AWS, Azure, or GCP | Single-tenant in Redpanda Cloud on AWS, Azure, or GCP
19+
| 100 MB/s max write throughput | 2 GB/s max write throughput | 400 MB/s max write throughput
20+
| 300 MB/s max read throughput | 4 GB/s max read throughput | 800 MB/s max read throughput
21+
| 5000 partitions | 112,500 partitions | 22,800 partitions
22+
| 99.9% SLA | 99.99% SLA | 99.99% SLA
2523
| Public networking | Public or private networking | Public or private networking
26-
| SSO (GitHub, Google), Kafka ACLs | SSO (GitHub, Google, OIDC), RBAC, audit logs | SSO (GitHub, Google, OIDC), RBAC, audit logs
27-
| Enterprise support with annual contracts| Enterprise support | Enterprise support
24+
| SSO (GitHub, Google), Kafka ACLs | SSO (GitHub, Google, OIDC), RBAC, audit logs | SSO (GitHub, Google, OIDC), RBAC, audit logs
25+
| Enterprise support with annual contracts | Enterprise support | Enterprise support
2826
|===
2927

3028
[NOTE]
3129
====
3230
33-
* The partition limit is the number of logical partitions before replication occurs. Redpanda Cloud uses a replication factor of 3.
31+
* The partition limit is the number of logical partitions before replication occurs. Redpanda Cloud uses a replication factor of three.
3432
* Enterprise support is staffed by streaming experts around the clock Monday through Friday, plus immediate escalation for production outages 24/7.
3533
====
3634

@@ -44,9 +42,22 @@ NOTE: Serverless is currently in a limited availability (LA) release with xref:g
4442

4543
include::get-started:partial$get-started-serverless.adoc[]
4644

47-
=== Dedicated Cloud
45+
=== Bring Your Own Cloud (BYOC)
46+
47+
With BYOC clusters, you deploy Redpanda in your own cloud (AWS, Azure, or GCP), and all data is
48+
contained in your own environment. This provides an additional layer of security and isolation. (See <<BYOC architecture>>.) When you create a BYOC cluster, you select the supported xref:reference:tiers/byoc-tiers.adoc[tier] that meets your compute and storage needs. Redpanda handles provisioning, operations, and maintenance.
49+
50+
NOTE: With standard BYOC clusters, Redpanda manages security policies and resources for your VPC or VNet, including subnetworks, IAM roles, and storage buckets/accounts. A Bring Your Own Virtual Private Cloud (BYOVPC) cluster allows you to deploy the Redpanda glossterm:data plane[] into your existing VPC/VNet and take full control of managing the networking lifecycle. Compared to standard BYOC, BYOVPC provides more security, but the configuration is more complex. See <<Shared responsibility model>>.
51+
52+
The BYOC infrastructure that Redpanda manages should not be used to deploy any other workloads.
53+
54+
==== Sign up for BYOC
55+
56+
To start using BYOC, contact https://redpanda.com/try-redpanda?section=enterprise-trial[Redpanda sales^] to request a private offer with possible discounts. You are billed directly or through Google Cloud Marketplace or AWS Marketplace.
57+
58+
=== Dedicated
4859

49-
With Dedicated clusters, you host your data on Redpanda cloud resources (AWS, GCP, or Azure), and Redpanda handles provisioning, operations, and maintenance. Dedicated clusters are single-tenant deployments that support private networking (for example, VPC peering to talk over private IPs) for better data isolation.
60+
With Dedicated clusters, you host your data on Redpanda Cloud resources (AWS, GCP, or Azure), and Redpanda handles provisioning, operations, and maintenance. Dedicated clusters are single-tenant deployments that support private networking (for example, VPC peering to talk over private IPs) for better data isolation.
5061
When you create a Dedicated cluster, you select the supported xref:reference:tiers/dedicated-tiers.adoc[tier] that meets your compute and storage needs.
5162

5263
==== Sign up for Dedicated
@@ -69,76 +80,30 @@ Redpanda creates a cloud organization for you and sends you a welcome email.
6980
--
7081
=====
7182

72-
=== Bring Your Own Cloud (BYOC)
73-
74-
With BYOC clusters, you deploy Redpanda in your own cloud (AWS, Azure, or GCP), and all data is
75-
contained in your own environment. This provides an additional layer of security and isolation. (See <<BYOC architecture>>.) When you create a BYOC cluster, you select the supported xref:reference:tiers/byoc-tiers.adoc[tier] that meets your compute and storage needs. Redpanda handles provisioning, operations, and maintenance.
76-
77-
NOTE: With standard BYOC clusters, Redpanda manages security policies and resources for your VPC or VNet, including subnetworks, IAM roles, and storage buckets/accounts. A Bring Your Own Virtual Private Cloud (BYOVPC) cluster allows you to deploy the Redpanda glossterm:data plane[] into your existing VPC/VNet and take full control of managing the networking lifecycle. Compared to standard BYOC, BYOVPC provides more security, but the configuration is more complex. See <<Shared responsibility model>>.
78-
79-
The BYOC infrastructure that Redpanda manages should not be used to deploy any other workloads.
80-
81-
==== Sign up for BYOC
82-
83-
To start using BYOC, contact https://redpanda.com/try-redpanda?section=enterprise-trial[Redpanda sales^] to request a private offer with possible discounts. You are billed directly or through Google Cloud Marketplace or AWS Marketplace.
84-
85-
== Serverless vs Dedicated/BYOC
83+
== Serverless vs BYOC/Dedicated
8684

8785
Serverless clusters are a good fit for the following use cases:
8886

8987
* Starter and growing workloads
9088
* Spiky workloads (that is, development environments, systems that only occasionally get busy, or workloads that come and go)
9189
* Fast and dynamic cluster creation: you can use a Serverless cluster as an isolated container for topics
9290

93-
With Serverless (and for Dedicated when procured through the AWS Marketplace), you only pay for what you consume, without any commitment. A cluster is created instantly, so you can surface it in your applications (for example, for tenant isolation). If your workload increases, you can migrate it to a Dedicated or BYOC cluster.
91+
With Serverless (and for Dedicated when procured through the AWS Marketplace), you only pay for what you consume, without any commitment. A cluster is created instantly, so you can surface it in your applications (for example, for tenant isolation). If your workload increases, you can migrate it to a BYOC or Dedicated cluster.
9492

95-
Consider Dedicated or BYOC if you need more control over the deployment or if you have workloads with consistently-high throughput. Dedicated and BYOC clusters offer the following features:
93+
Consider BYOC or Dedicated if you need more control over the deployment or if you have workloads with consistently-high throughput. BYOC and Dedicated clusters offer the following features:
9694

9795
* Private networking
9896
* Single-zone or multi-zone availability. A multi-zone cluster provides higher resiliency in the event of a failure in one of the zones.
9997
* Ability to export metrics to a 3rd-party monitoring system
10098
* Kafka Connect
101-
* Higher limits and quotas. See xref:reference:tiers/dedicated-tiers.adoc[Dedicated usage tiers] and xref:reference:tiers/byoc-tiers.adoc[BYOC usage tiers] compared to xref:get-started:cluster-types/serverless.adoc#serverless-usage-limits[Serverless limits].
99+
* Higher limits and quotas. See xref:reference:tiers/byoc-tiers.adoc[BYOC usage tiers] and xref:reference:tiers/dedicated-tiers.adoc[Dedicated usage tiers] compared to xref:get-started:cluster-types/serverless.adoc#serverless-usage-limits[Serverless limits].
102100

103101
== Shared responsibility model
104102

105103
The Redpanda Cloud shared responsibility model lists the security ownership areas for Redpanda and customers. Responsibilities depend on the type of deployment.
106104

107105
[tabs]
108106
=====
109-
Dedicated::
110-
+
111-
--
112-
|===
113-
| Resource | Redpanda responsibility | Customer responsibility
114-
115-
| Redpanda upgrades and hotfixes | &#10003; |
116-
| Cost management and attribution | &#10003; |
117-
| Software vulnerability remediation | &#10003; |
118-
| Infrastructure vulnerability remediation | &#10003; |
119-
| IAM (roles, service accounts, access segmentation) | &#10003; |
120-
| Compute | &#10003; |
121-
| Redpanda agent VM maintenance | &#10003; |
122-
| VPC (subnets, routing, firewall) | &#10003; |
123-
| VPC peering | &#10003; |
124-
| VPC private links (service endpoint) | &#10003; |
125-
| VPC private links (consumer endpoint) | | &#10003;
126-
| Local storage | &#10003; |
127-
| Tiered Storage | &#10003; |
128-
| Control plane | &#10003; |
129-
| Access controls and audit | &#10003; |
130-
| Managed disaster recovery | | &#10003;
131-
| Observability and monitoring (SLOs, SLIs, tracing, alerting, runbooks) | &#10003; |
132-
| Availability SLA | &#10003; |
133-
| Proactive threat detection | &#10003; |
134-
| Static secret rotation | &#10003; |
135-
| Incident response | &#10003; |
136-
| Resilience verification | &#10003; |
137-
| Kafka Connect infrastructure | &#10003; |
138-
| Kafka Connect tasks state | | &#10003;
139-
|===
140-
141-
--
142107
BYOC::
143108
+
144109
--
@@ -204,6 +169,39 @@ BYOVPC::
204169
| Kafka Connect tasks state | | &#10003;
205170
|===
206171
172+
--
173+
Dedicated::
174+
+
175+
--
176+
|===
177+
| Resource | Redpanda responsibility | Customer responsibility
178+
179+
| Redpanda upgrades and hotfixes | &#10003; |
180+
| Cost management and attribution | &#10003; |
181+
| Software vulnerability remediation | &#10003; |
182+
| Infrastructure vulnerability remediation | &#10003; |
183+
| IAM (roles, service accounts, access segmentation) | &#10003; |
184+
| Compute | &#10003; |
185+
| Redpanda agent VM maintenance | &#10003; |
186+
| VPC (subnets, routing, firewall) | &#10003; |
187+
| VPC peering | &#10003; |
188+
| VPC private links (service endpoint) | &#10003; |
189+
| VPC private links (consumer endpoint) | | &#10003;
190+
| Local storage | &#10003; |
191+
| Tiered Storage | &#10003; |
192+
| Control plane | &#10003; |
193+
| Access controls and audit | &#10003; |
194+
| Managed disaster recovery | | &#10003;
195+
| Observability and monitoring (SLOs, SLIs, tracing, alerting, runbooks) | &#10003; |
196+
| Availability SLA | &#10003; |
197+
| Proactive threat detection | &#10003; |
198+
| Static secret rotation | &#10003; |
199+
| Incident response | &#10003; |
200+
| Resilience verification | &#10003; |
201+
| Kafka Connect infrastructure | &#10003; |
202+
| Kafka Connect tasks state | | &#10003;
203+
|===
204+
207205
--
208206
=====
209207

@@ -317,9 +315,9 @@ The following features are currently in beta in Redpanda Cloud:
317315

318316
== Next steps
319317
* xref:manage:maintenance.adoc[Learn about upgrades and maintenance]
320-
* xref:get-started:cluster-types/serverless.adoc[Create a Serverless Cluster]
321-
* xref:get-started:cluster-types/dedicated/create-dedicated-cloud-cluster-aws.adoc[Create a Dedicated Cloud Cluster]
322-
* xref:get-started:cluster-types/byoc/index.adoc[Create a BYOC Cluster]
318+
* xref:get-started:cluster-types/serverless.adoc[Create a Serverless cluster]
319+
* xref:get-started:cluster-types/byoc/index.adoc[Create a BYOC cluster]
320+
* xref:get-started:cluster-types/dedicated/create-dedicated-cloud-cluster-aws.adoc[Create a Dedicated cluster]
323321

324322
include::shared:partial$suggested-reading.adoc[]
325323

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
= Dedicated
2+
:description: Learn how to create a Dedicated cluster and start streaming.
3+
:page-aliases: cloud:create-dedicated-cloud-cluster-aws.adoc, deploy:deployment-option/cloud/provision-a-dedicated-cluster/index.adoc, deploy:deployment-option/cloud/create-dedicated-cloud-cluster-aws.adoc, get-started:cluster-types/dedicated/create-dedicated-cloud-cluster-aws.adoc, get-started:cluster-types/dedicated/quick-start-cloud.adoc, get-started:cluster-types/dedicated/index.adoc, get-started:cluster-types/dedicated/create-dedicated-cloud-cluster.adoc
4+
5+
After you log in to https://cloud.redpanda.com[Redpanda Cloud^], you land on the *Clusters* page. This page lists all the clusters in your organization.
6+
7+
== Create a Dedicated cluster
8+
9+
. On the Clusters page, click *Create cluster*, then click *Create Dedicated cluster*.
10+
+
11+
Enter a cluster name, then select the resource group, cloud provider (AWS, GCP, or Azure), xref:reference:tiers/dedicated-tiers.adoc[region, tier], availability, and Redpanda version.
12+
13+
+
14+
[NOTE]
15+
====
16+
* If you plan to create a private network in your own VPC, select the region where your VPC is located.
17+
* Three availability zones provide two backups in case one availability zone goes down.
18+
====
19+
+
20+
[IMPORTANT]
21+
====
22+
To unlock this feature for Azure, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda support^].
23+
====
24+
25+
. Click *Next*.
26+
. On the Network page, enter the connection type: *Public* or *Private*. For private networks:
27+
** Your network name is used to identify this network.
28+
** For a xref:networking:cidr-ranges.adoc[CIDR range], choose one that does not overlap with your existing VPCs or your Redpanda network.
29+
+
30+
Private networks require either a VPC peering connection or a private connectivity service, such as xref:networking:configure-privatelink-in-cloud-ui.adoc[AWS PrivateLink], xref:networking:configure-private-service-connect-in-cloud-ui.adoc[GCP Private Service Connect], or xref:networking:azure-private-link.adoc[Azure Private Link].
31+
32+
. Click *Create*.
33+
34+
After the cluster is created, you can select the cluster on the *Clusters* page to see the overview for it.
35+
36+
include::shared:partial$kafka-connect.adoc[]
37+
38+
== Start streaming: example
39+
40+
Use `rpk`, Redpanda's CLI, to build a basic streaming application that creates a topic, produces messages to it, and consumes messages from it. To learn about `rpk`, see the xref:manage:rpk/intro-to-rpk.adoc[].
41+
42+
. Login to Redpanda Cloud, and select your resource group using the interactive prompt.
43+
+
44+
```bash
45+
rpk cloud login
46+
```
47+
48+
. On the **Overview** page, copy your bootstrap server address and set it as an environment variable on your local machine:
49+
+
50+
```bash
51+
export REDPANDA_BROKERS="<bootstrap-server-address>"
52+
```
53+
54+
. Go to the **Security** page, and create a user called **redpanda-chat-account** that uses the SCRAM-SHA-256 mechanism.
55+
56+
. Copy the password, and set the following environment variables on your local machine:
57+
+
58+
```bash
59+
export REDPANDA_SASL_USERNAME="redpanda-chat-account"
60+
export REDPANDA_SASL_PASSWORD="<password>"
61+
export REDPANDA_SASL_MECHANISM="SCRAM-SHA-256"
62+
```
63+
64+
. Click the name of your user, and add the following permissions to the ACL (access control list):
65+
+
66+
- **Host**: *
67+
- **Topic name**: `chat-room`
68+
- **Operations**: All
69+
+
70+
. Click **Create**.
71+
72+
. Use `rpk` on your local machine to authenticate to Redpanda as the **redpanda-chat-account** user and get information about the cluster:
73+
+
74+
```bash
75+
rpk cluster info -X tls.enabled=true
76+
```
77+
78+
. Create a topic called `chat-room`.
79+
+
80+
You granted permissions to the **redpanda-chat-account** user to access only this topic.
81+
+
82+
```bash
83+
rpk topic create chat-room -X tls.enabled=true
84+
```
85+
+
86+
Output:
87+
+
88+
[.no-copy]
89+
----
90+
TOPIC STATUS
91+
chat-room OK
92+
----
93+
94+
. Produce a message to the topic:
95+
+
96+
```bash
97+
rpk topic produce chat-room -X tls.enabled=true
98+
```
99+
100+
. Enter a message, then press kbd:[Enter]:
101+
+
102+
```text
103+
Pandas are fabulous!
104+
```
105+
+
106+
Example output:
107+
+
108+
[.no-copy]
109+
----
110+
Produced to partition 0 at offset 0 with timestamp 1663282629789.
111+
----
112+
113+
. Press kbd:[Ctrl + C] to finish producing messages to the topic.
114+
115+
. Consume one message from the topic:
116+
+
117+
```bash
118+
rpk topic consume chat-room --num 1 -X tls.enabled=true
119+
```
120+
+
121+
Your message is displayed along with its metadata:
122+
+
123+
```json
124+
{
125+
"topic": "chat-room",
126+
"value": "Pandas are fabulous!",
127+
"timestamp": 1663282629789,
128+
"partition": 0,
129+
"offset": 0
130+
}
131+
```
132+
133+
=== Explore your topic
134+
135+
In Redpanda Cloud, go to **Topics** > **chat-room**.
136+
137+
The message that you produced to the topic is displayed along with some other details about the topic.
138+
139+
=== Clean up
140+
141+
If you don't want to continue experimenting with your cluster, you can delete it.
142+
143+
Go to **Cluster settings** and click **Delete cluster**.
144+
145+
== Next steps
146+
147+
- xref:get-started:cloud-overview.adoc[Learn more about Redpanda Cloud]
148+
- xref:networking:dedicated/index.adoc[Learn about private networking]
149+

0 commit comments

Comments
 (0)