diff --git a/_includes/v2.0/orchestration/start-cluster.md b/_includes/v2.0/orchestration/start-cluster.md index 18504455761..082ff14f97a 100644 --- a/_includes/v2.0/orchestration/start-cluster.md +++ b/_includes/v2.0/orchestration/start-cluster.md @@ -19,6 +19,24 @@ poddisruptionbudget "cockroachdb-budget" created statefulset "cockroachdb" created ~~~ +Alternatively, if you'd rather start with a configuration file that has been customized for performance: + +1. Download our [performance version of `cockroachdb-statefulset-secure.yaml`](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml): + + {% include copy-clipboard.html %} + ~~~ shell + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml + ~~~ + +2. Modify the file wherever there is a `TODO` comment. + +3. Use the file to create the StatefulSet and start the cluster: + + {% include copy-clipboard.html %} + ~~~ shell + $ kubectl create -f cockroachdb-statefulset-secure.yaml + ~~~ + {% else %} 1. From your local workstation, use our [`cockroachdb-statefulset.yaml`](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/cockroachdb-statefulset.yaml) file to create the StatefulSet that automatically creates 3 pods, each with a CockroachDB node running inside it: diff --git a/_includes/v2.1/orchestration/start-cluster.md b/_includes/v2.1/orchestration/start-cluster.md index 18504455761..082ff14f97a 100644 --- a/_includes/v2.1/orchestration/start-cluster.md +++ b/_includes/v2.1/orchestration/start-cluster.md @@ -19,6 +19,24 @@ poddisruptionbudget "cockroachdb-budget" created statefulset "cockroachdb" created ~~~ +Alternatively, if you'd rather start with a configuration file that has been customized for performance: + +1. Download our [performance version of `cockroachdb-statefulset-secure.yaml`](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml): + + {% include copy-clipboard.html %} + ~~~ shell + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml + ~~~ + +2. Modify the file wherever there is a `TODO` comment. + +3. Use the file to create the StatefulSet and start the cluster: + + {% include copy-clipboard.html %} + ~~~ shell + $ kubectl create -f cockroachdb-statefulset-secure.yaml + ~~~ + {% else %} 1. From your local workstation, use our [`cockroachdb-statefulset.yaml`](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/cockroachdb-statefulset.yaml) file to create the StatefulSet that automatically creates 3 pods, each with a CockroachDB node running inside it: diff --git a/v2.0/kubernetes-performance.md b/v2.0/kubernetes-performance.md index e6ee7fce814..9eff10ef974 100644 --- a/v2.0/kubernetes-performance.md +++ b/v2.0/kubernetes-performance.md @@ -21,6 +21,8 @@ There are a number of independent factors that affect the performance you observ In a number of the sections below, we have shown how to modify excerpts from our provided Kubernetes configuration YAML files. You can find the most up-to-date versions of these files on Github, [one for running CockroachDB in secure mode](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/cockroachdb-statefulset-secure.yaml) and one for [running CockroachDB in insecure mode](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/cockroachdb-statefulset.yaml). +You can also use a [configuration file for secure mode that has been customized for performance](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml). Be sure to modify the file wherever there is a `TODO` comment. + ### Version of CockroachDB Because CockroachDB is under very active development, there are typically substantial performance gains in each release. If you aren't running the latest release and aren't getting the performance you desire, you should try the latest and see how much it helps. diff --git a/v2.1/kubernetes-performance.md b/v2.1/kubernetes-performance.md index 1f42754e4d4..bdfb3b59ee7 100644 --- a/v2.1/kubernetes-performance.md +++ b/v2.1/kubernetes-performance.md @@ -21,6 +21,8 @@ There are a number of independent factors that affect the performance you observ In a number of the sections below, we have shown how to modify excerpts from our provided Kubernetes configuration YAML files. You can find the most up-to-date versions of these files on Github, [one for running CockroachDB in secure mode](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/cockroachdb-statefulset-secure.yaml) and one for [running CockroachDB in insecure mode](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/cockroachdb-statefulset.yaml). +You can also use a [configuration file for secure mode that has been customized for performance](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml). Be sure to modify the file wherever there is a `TODO` comment. + ### Version of CockroachDB Because CockroachDB is under very active development, there are typically substantial performance gains in each release. If you aren't running the latest release and aren't getting the performance you desire, you should try the latest and see how much it helps.