Skip to content

Commit c48c5a3

Browse files
committed
Add UI instructions and overview
1 parent a70d3d9 commit c48c5a3

6 files changed

Lines changed: 86 additions & 40 deletions

File tree

src/current/_includes/cockroachcloud/byoc/byoc-common-prerequisites.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
- Review the [shared responsibility model for BYOC]({% link cockroachcloud/byoc-overview.md %}#shared-responsibility-model-for-byoc). Make sure you understand and acknowledge the responsibilities you hold for management of your cloud infrastucture and the necessary permissions you must grant to Cockroach Labs.
2+
13
- [Create a CockroachDB {{ site.data.products.cloud }} organization]({% link cockroachcloud/create-an-account.md %}) if you do not already have one.
24

5+
- (Optional) Create an [API service account]({% link cockroachcloud/managing-access.md %}#create-api-keys) to use the [{{ site.data.products.cloud }} API]({% link cockroachcloud/cloud-api.md %}) with your {{ site.data.products.cloud }} organization.
6+
37
- The BYOC deployment option is not available by default and must be requested. Reach out to your account team to express interest in BYOC.
48

59
- Review the [Plan a CockroachDB {{ site.data.products.advanced }} Cluster]({% link cockroachcloud/plan-your-cluster-advanced.md %}) documentation to plan your cluster sizing and resource allocation.

src/current/_includes/cockroachcloud/byoc/byoc-responsibility-model.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

src/current/cockroachcloud/byoc-aws-deployment.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
---
2-
title: Prepare a CockroachDB Cloud BYOC Deployment in AWS
2+
title: Prepare a CockroachDB Cloud BYOC Deployment in Amazon Web Services
33
summary: Prepare a cloud service account to self-host a CockroachDB Cloud deployment with the BYOC model
44
toc: true
55
keywords: deployment, byoc
66
---
77

8-
CockroachDB {{ site.data.products.cloud }} supports a "bring your own cloud" (BYOC) deployment model, where CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} is hosted in your own account rather than in an account managed by Cockroach Labs. This model allows you to take more control of security and take advantage of existing cloud service credits or discounts.
8+
This page describes how to prepare a cloud service account to host a [BYOC deployment]({% link cockroachcloud/byoc-overview.md %}) of CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} in Amazon Web Services (AWS).
99

1010
{{site.data.alerts.callout_info}}
1111
The BYOC {{ site.data.products.cloud }} deployment option is currently in [Preview]({% link {{ site.current_cloud_version }}/cockroachdb-feature-availability.md %}).
1212
{{site.data.alerts.end}}
1313

14-
This page describes how to prepare a cloud service account to host a BYOC deployment of CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} in Microsoft Azure.
15-
16-
## Shared responsibility model for BYOC
17-
18-
{% include cockroachcloud/byoc/byoc-responsibility-model.md %}
19-
2014
## Prerequisites
2115

2216
{% include cockroachcloud/byoc/byoc-common-prerequisites.md %}
@@ -218,7 +212,22 @@ You may also need to adjust quotas for vCPU and EBS disk storage for the regions
218212

219213
## Step 5. Create the CockroachDB {{ site.data.products.cloud }} cluster
220214

221-
In BYOC deployments, CockroachDB clusters are deployed with the {{ site.data.products.cloud }} API and must use the {{ site.data.products.advanced }} plan. Follow the API documentation to [create a CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} cluster]({% link cockroachcloud/cloud-api.md %}#create-an-advanced-cluster).
215+
In BYOC deployments, CockroachDB clusters can be deployed in the {{ site.data.products.cloud }} Console or with the [{{ site.data.products.cloud }} API]({% link cockroachcloud/cloud-api.md %}).
216+
217+
### Create a cluster with the {{ site.data.products.cloud }} Console
218+
219+
Follow these steps to create a CockroachDB cluster in the {{ site.data.products.cloud }} console:
220+
221+
1. Open the {{ site.data.products.cloud }} and select the organization that has been enabled for BYOC.
222+
1. Click **Create cluster**
223+
1. Under **Select a plan**, click **{{ site.data.products.advanced }}.
224+
1. Under **Cloud & Regions**, click **Bring Your Own Cloud** and select AWS.
225+
1. Under **Cloud account**, click **Select your cloud account > Add new cloud account**. Enter the ARN associated with your intermediate IAM role.
226+
1. Follow the rest of the **Create Cluster** steps to configure your cluster's regions, capacity, and features as desired. Read the [Plan a CockroachDB {{ site.data.products.advanced}} Cluster]({% link cockroachcloud/plan-your-cluster-advanced.md %}) documentation for more details.
227+
228+
### Create a cluster with the {{ site.data.products.cloud }} API
229+
230+
Send a `POST` request to the the `/v1/clusters` endpoint to [create a CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} cluster]({% link cockroachcloud/cloud-api.md %}#create-an-advanced-cluster).
222231

223232
The following example request creates a 3-node {{ site.data.products.advanced }} cluster in the `us-east-2` region, specifying the ARN associated with your intermediate IAM role:
224233

src/current/cockroachcloud/byoc-azure-deployment.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,12 @@ toc: true
55
keywords: deployment, byoc
66
---
77

8-
CockroachDB {{ site.data.products.cloud }} supports a "bring your own cloud" (BYOC) deployment model, where CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} is hosted in your own account rather than in an account managed by Cockroach Labs. This model allows you to take more control of security and take advantage of existing cloud service credits or discounts.
8+
This page describes how to prepare a cloud service account to host a [BYOC deployment]({% link cockroachcloud/byoc-overview.md %}) of CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} in Microsoft Azure.
99

1010
{{site.data.alerts.callout_info}}
1111
The BYOC {{ site.data.products.cloud }} deployment option is currently in [Preview]({% link {{ site.current_cloud_version }}/cockroachdb-feature-availability.md %}).
1212
{{site.data.alerts.end}}
1313

14-
This page describes how to prepare a cloud service account to host a BYOC deployment of CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} in Microsoft Azure.
15-
16-
## Shared responsibility model for BYOC
17-
18-
{% include cockroachcloud/byoc/byoc-responsibility-model.md %}
19-
2014
## Prerequisites
2115

2216
{% include cockroachcloud/byoc/byoc-common-prerequisites.md %}
@@ -230,7 +224,22 @@ Register the following [resource providers](https://learn.microsoft.com/azure/az
230224
231225
## Step 6. Create the CockroachDB {{ site.data.products.cloud }} cluster
232226
233-
In BYOC deployments, CockroachDB clusters are deployed with the {{ site.data.products.cloud }} API and must use the {{ site.data.products.advanced }} plan. Follow the API documentation to [create a CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} cluster]({% link cockroachcloud/cloud-api.md %}#create-an-advanced-cluster).
227+
In BYOC deployments, CockroachDB clusters can be deployed in the {{ site.data.products.cloud }} Console or with the [{{ site.data.products.cloud }} API]({% link cockroachcloud/cloud-api.md %}).
228+
229+
### Create a cluster with the {{ site.data.products.cloud }} Console
230+
231+
Follow these steps to create a CockroachDB cluster in the {{ site.data.products.cloud }} console:
232+
233+
1. Open the {{ site.data.products.cloud }} and select the organization that has been enabled for BYOC.
234+
1. Click **Create cluster**
235+
1. Under **Select a plan**, click **{{ site.data.products.advanced }}.
236+
1. Under **Cloud & Regions**, click **Bring Your Own Cloud** and select Azure.
237+
1. Under **Cloud account**, click **Select your cloud account > Add new cloud account**. Enter the tenant ID and subscription ID associated with your Azure subscription.
238+
1. Follow the rest of the **Create Cluster** steps to configure your cluster's regions, capacity, and features as desired. Read the [Plan a CockroachDB {{ site.data.products.advanced}} Cluster]({% link cockroachcloud/plan-your-cluster-advanced.md %}) documentation for more details.
239+
240+
### Create a cluster with the {{ site.data.products.cloud }} API
241+
242+
Send a `POST` request to the the `/v1/clusters` endpoint to [create a CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} cluster]({% link cockroachcloud/cloud-api.md %}#create-an-advanced-cluster).
234243
235244
The following example request creates a 3-node {{ site.data.products.advanced }} cluster in the `centralus` region, specifying the `subscription-id` and `customer-tenant-id` associated with your Azure subscription:
236245

src/current/cockroachcloud/byoc-gcp-deployment.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
---
2-
title: Prepare a CockroachDB Cloud BYOC Deployment in GCP
2+
title: Prepare a CockroachDB Cloud BYOC Deployment in Google Cloud Platform
33
summary: Prepare a cloud service account to self-host a CockroachDB Cloud deployment with the BYOC model
44
toc: true
55
keywords: deployment, byoc
66
---
77

8-
CockroachDB {{ site.data.products.cloud }} supports a "bring your own cloud" (BYOC) deployment model, where CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} is hosted in your own account rather than in an account managed by Cockroach Labs. This model allows you to take more control of security and take advantage of existing cloud service credits or discounts.
8+
This page describes how to prepare a cloud service account to host a [BYOC deployment]({% link cockroachcloud/byoc-overview.md %}) of CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} in Google Cloud Platform (GCP).
99

1010
{{site.data.alerts.callout_info}}
1111
The BYOC {{ site.data.products.cloud }} deployment option is currently in [Preview]({% link {{ site.current_cloud_version }}/cockroachdb-feature-availability.md %}).
1212
{{site.data.alerts.end}}
1313

14-
This page describes how to prepare a cloud service account to host a BYOC deployment of CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} in GCP.
15-
16-
## Shared responsibility model for BYOC
17-
18-
{% include cockroachcloud/byoc/byoc-responsibility-model.md %}
19-
2014
## Prerequisites
2115

2216
{% include cockroachcloud/byoc/byoc-common-prerequisites.md %}
@@ -56,7 +50,22 @@ Follow these steps to create the intermediate service account:
5650

5751
## Step 3. Create the CockroachDB {{ site.data.products.cloud }} cluster
5852

59-
In BYOC deployments, CockroachDB clusters are deployed with the {{ site.data.products.cloud }} API and must use the {{ site.data.products.advanced }} plan. Follow the API documentation to [create a CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} cluster]({% link cockroachcloud/cloud-api.md %}#create-an-advanced-cluster).
53+
In BYOC deployments, CockroachDB clusters can be deployed in the {{ site.data.products.cloud }} Console or with the [{{ site.data.products.cloud }} API]({% link cockroachcloud/cloud-api.md %}).
54+
55+
### Create a cluster with the {{ site.data.products.cloud }} Console
56+
57+
Follow these steps to create a CockroachDB cluster in the {{ site.data.products.cloud }} console:
58+
59+
1. Open the {{ site.data.products.cloud }} and select the organization that has been enabled for BYOC.
60+
1. Click **Create cluster**
61+
1. Under **Select a plan**, click **{{ site.data.products.advanced }}.
62+
1. Under **Cloud & Regions**, click **Bring Your Own Cloud** and select Google Cloud.
63+
1. Under **Cloud account**, click **Select your cloud account > Add new cloud account**. Enter the service account email associated with your intermediate service account.
64+
1. Follow the rest of the **Create Cluster** steps to configure your cluster's regions, capacity, and features as desired. Read the [Plan a CockroachDB {{ site.data.products.advanced}} Cluster]({% link cockroachcloud/plan-your-cluster-advanced.md %}) documentation for more details.
65+
66+
### Create a cluster with the {{ site.data.products.cloud }} API
67+
68+
Send a `POST` request to the the `/v1/clusters` endpoint to [create a CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} cluster]({% link cockroachcloud/cloud-api.md %}#create-an-advanced-cluster).
6069

6170
The following example request creates a 3-node {{ site.data.products.advanced }} cluster in the `us-east1` region, specifying the `service_account_email` associated with the intermediate service account you created:
6271

src/current/cockroachcloud/byoc-overview.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,32 @@ toc: true
55
keywords: deployment, byoc
66
---
77

8-
TODO
8+
CockroachDB {{ site.data.products.cloud }} supports a ["bring your own cloud" (BYOC) deployment model](https://www.cockroachlabs.com/product/cloud/bring-your-own-cloud/), where CockroachDB {{ site.data.products.cloud }} {{ site.data.products.advanced }} is hosted in your own account rather than in an account managed by Cockroach Labs. This model allows you to take more control of security and take advantage of existing cloud service credits or discounts.
9+
10+
{{site.data.alerts.callout_info}}
11+
The BYOC {{ site.data.products.cloud }} deployment option is currently in [Preview]({% link {{ site.current_cloud_version }}/cockroachdb-feature-availability.md %}).
12+
{{site.data.alerts.end}}
13+
14+
## Shared responsibility model for BYOC
15+
16+
In any CockroachDB {{ site.data.products.cloud }} deployment, responsibility for a successful and healthy deployment is [split between you and Cockroach Labs]({% link cockroachcloud/production-checklist.md %}). In a BYOC deployment, all of the [CockroachDB {{ site.data.products.cloud }} infrastructure]({% link cockroachcloud/plan-your-cluster-advanced.md %}#advanced-cluster-architecture) except the control plane lives in an account under your control, which means that you incur additional responsibilities under the shared model.
17+
18+
The following table describes the split of responsibilities between you and Cockroach Labs in the shared responsibility model for BYOC:
19+
20+
Area | Cockroach Labs responsibility | Customer responsibility
21+
:----------:|:-----------------------------:|:----------------------:
22+
Uptime | Ensure 99.999% cluster uptime | Ensure that clusters remain accessible
23+
Deployments | Automate cluster provisioning and scaling, provide hardware best practices | Provision new cloud service accounts and grant IAM permissions for Cockroach Labs to create and manage clusters
24+
Upgrades | Provide automatic minor/patch upgrades and major upgrade automation via Terraform, APIs, or the {{ site.data.products.cloud }} Console | Initiate [major version upgrades]({% link cockroachcloud/upgrade-cockroach-version.md %}), [set maintenance windows]({% link cockroachcloud/advanced-cluster-management.md %}#set-a-maintenance-window) if applicable
25+
Workload | Troubleshoot problems as they pertain to cluster availability | [Size clusters]({% link cockroachcloud/advanced-cluster-management.md %}#scale-your-cluster) to manage workload requirements, [tune performance]({% link {{ site.versions["stable"] }}/performance-recipes.md %}), and adjust schema designs with support from Cockroach Labs
26+
Backups | Initialize a default backup schedule and write to customer-owned Cloud storage, ensure backup jobs run successfully | Configure a backup schedule as needed to meet RPO/RTO requirements
27+
Support | Reactively and proactively identify and resolve availability-impacting incidents | Ensure sufficient hardware is made available and appropriate IAM permissions are maintained at all times
28+
Billing | Meter vCPUs consumed, [charge for vCPU consumption]({% link cockroachcloud/costs.md %}) at the per-minute level | Negotiate with cloud service provider, manage infrastructure spend and discounts
29+
30+
## Next steps
31+
32+
CockroachDB supports BYOC deployments in Amazon Web Services, Microsoft Azure, and Google Cloud Platform. Read the corresponding deployment guides:
33+
34+
- [Prepare a CockroachDB Cloud BYOC Deployment in Amazon Web Services]({% link cockroachcloud/byoc-aws-deployment.md %}).
35+
- [Prepare a CockroachDB Cloud BYOC Deployment in Azure]({% link cockroachcloud/byoc-azure-deployment.md %}).
36+
- [Prepare a CockroachDB Cloud BYOC Deployment in Google Cloud Platform]({% link cockroachcloud/byoc-gcp-deployment.md %}).

0 commit comments

Comments
 (0)