[DOC-75] Document guidance for hybrid and multi-cloud #19123
Conversation
Files changed:
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Small typo on the following line. **In a multi-region deployment, we recommend that you use manifests. Refer to Deploy CockroachDB on GKE for details. |
In case you are referring to the unbalanced bold, that's fixed. I also adjusted the link title to hopefully be more accurate. |
| @@ -33,6 +33,12 @@ | |||
| "/${VERSION}/start-a-local-cluster-in-docker-windows.html" | |||
| ] | |||
| }, | |||
| { | |||
| "title": "Hybrid and multi-cloud deployments", | |||
There was a problem hiding this comment.
Why is this under "deploy locally" vs "deploy manually"?
There was a problem hiding this comment.
OR even under Multi-Region perhaps?
There was a problem hiding this comment.
Done, after the clouds and before Kubernetes.
| This page provides information about hybrid and multi-cloud self-hosted deployments of CockroachDB. Each of these types of deployments can help an organization to meet its service-level and disaster recovery objectives. | ||
|
|
||
| - In a _hybrid deployment_, a cluster's nodes are deployed in a combination of infrastructure you manage, private cloud provider infrastructure, and public cloud provider infrastructure. | ||
| - In a _multi-cloud deployment_, a cluster's nodes are deployed in multiple cloud providers' infrastructure public or private infrastructure. |
There was a problem hiding this comment.
Extra "infrastructure" here
| CockroachDB could route SQL client requests to any cluster node, regardless of where the client connection originates. | ||
| - **There must be no overlapping IP address ranges** across the cluster. It is an error for multiple nodes to have the same IP address or to resolve to the same hostname. | ||
|
|
||
| DNS name resolution is particularly complex in a Kubernetes deployment. We recommend that you replace `kube-dns` with Core DNS. Refer to [Deploy CockroachDB on GKE](https://github.com/mbookham7/crdb-multi-cloud-k8s/blob/master/markdown/5-deploy-cockroach.md) for details. |
There was a problem hiding this comment.
Can you state "In a k8s deployment, we recommend that you replace ..."
I think we want to make this doc generic (aka not kube specific)
There was a problem hiding this comment.
I do say "in a Kubernetes deployment" just before the "We" so I don't think this change would add much. WDYT?
| - **There must be no overlapping IP address ranges** across the cluster. It is an error for multiple nodes to have the same IP address or to resolve to the same hostname. | ||
|
|
||
| DNS name resolution is particularly complex in a Kubernetes deployment. We recommend that you replace `kube-dns` with Core DNS. Refer to [Deploy CockroachDB on GKE](https://github.com/mbookham7/crdb-multi-cloud-k8s/blob/master/markdown/5-deploy-cockroach.md) for details. | ||
| - **In a multi-region deployment, we recommend that you use manifests**. Refer to [Deploy multi-cloud CockroachDB on GKE](https://github.com/mbookham7/crdb-multi-cloud-k8s/blob/master/markdown/5-deploy-cockroach.md) for details. |
There was a problem hiding this comment.
Ditto re: qualifying that if you're doing MR Kube
|
|
||
| DNS name resolution is particularly complex in a Kubernetes deployment. We recommend that you replace `kube-dns` with Core DNS. Refer to [Deploy CockroachDB on GKE](https://github.com/mbookham7/crdb-multi-cloud-k8s/blob/master/markdown/5-deploy-cockroach.md) for details. | ||
| - **In a multi-region deployment, we recommend that you use manifests**. Refer to [Deploy multi-cloud CockroachDB on GKE](https://github.com/mbookham7/crdb-multi-cloud-k8s/blob/master/markdown/5-deploy-cockroach.md) for details. | ||
| - **Each node deployed in the same environment must share locality** to ensure that the cluster's replicas are spread across deployment environments and to prevent single points of failure or hot spots. To specify a node's locality, pass the `--locality` flag when [starting a node]({% link {{ page.version.version }}/cockroach-start.md %}). This flag accepts an arbitrary set of key-value pairs that describe the location of the node. For example, if nodes are deployed in both Azure and Digital Ocean, you could set each node's locality to either `--locality data-center=azure` or `--locality data-center=digital-ocean`. |
There was a problem hiding this comment.
nit: They should share one level of tag, but if e.g. within each environment there are different AZs, then they would have the same "data-center" tag but different 'az' tag. You specify that in the next para but saying they "must share locality" makes it seem like they have to be exactly the same.
Also, is there a good page to link to re: locality hierarchy?
There was a problem hiding this comment.
There isn't a good reference page for that. There are several open issues about locality, which someone else will need to take on.
Addressed the other feedback by a bit of reworking of this section.
|
|
||
| ## Simulate an outage | ||
|
|
||
| This section shows some ways to simulate an outage and validate disaster recovery procedures in a hybrid or multi-cloud deployment. |
There was a problem hiding this comment.
Can we add a sentence along the lines of "you should run this testing to ensure you've correctly set up the locality flags"?
[DOC-75] Document guidance for hybrid and multi-cloud
Preview
src/current/v23.2/hybrid-and-multi-cloud.md
src/current/v24.1/hybrid-and-multi-cloud.md
src/current/v24.2/hybrid-and-multi-cloud.md
src/current/v24.3/hybrid-and-multi-cloud.md
Tests