Skip to content

Commit

Permalink
Use common includes for v24.2 orchestration pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mdlinville committed Sep 27, 2024
1 parent 7232df2 commit 52a695e
Show file tree
Hide file tree
Showing 60 changed files with 775 additions and 783 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{{site.data.alerts.callout_success}}
To deploy a free CockroachDB {{ site.data.products.cloud }} cluster instead of running CockroachDB yourself, see the <a href="{% link cockroachcloud/quickstart.md %}">Quickstart</a>.
To deploy a free CockroachDB Cloud cluster instead of running CockroachDB yourself, see the [Quickstart]({% link cockroachcloud/quickstart.md %}).
{{site.data.alerts.end}}
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,4 @@ The below steps use [`cockroach cert` commands]({% link {{ page.version.version
cockroachdb.client.root Opaque 3 41m
cockroachdb.node Opaque 5 14s
default-token-6qjdb kubernetes.io/service-account-token 3 4m
~~~
~~~
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
You can expand certain [types of persistent volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#types-of-persistent-volumes
) (including GCE Persistent Disk and Amazon Elastic Block Store) by editing their persistent volume claims.
) (including in cloud storage) by editing their persistent volume claims.

{{site.data.alerts.callout_info}}
These steps assume you followed the tutorial [Deploy CockroachDB on Kubernetes](deploy-cockroachdb-with-kubernetes.html?filters=helm).
These steps assume you followed the tutorial [Deploy CockroachDB on Kubernetes]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes.md %}?filters=helm).
{{site.data.alerts.end}}

1. Get the persistent volume claims for the volumes:
Expand Down Expand Up @@ -63,19 +63,19 @@ These steps assume you followed the tutorial [Deploy CockroachDB on Kubernetes](

~~~
persistentvolumeclaim/datadir-my-release-cockroachdb-0 patched
~~~
~~~

1. Check the capacity of the persistent volume claim:

{% include_cached copy-clipboard.html %}
~~~ shell
$ kubectl get pvc datadir-my-release-cockroachdb-0
~~~
~~~

~~~
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
datadir-my-release-cockroachdb-0 Bound pvc-75dadd4c-01a1-11ea-b065-42010a8e00cb 100Gi RWO standard 18m
~~~
~~~

If the PVC capacity has not changed, this may be because `AllowVolumeExpansion` was initially set to `false` or because the [volume has a file system](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#resizing-an-in-use-persistentvolumeclaim) that has to be expanded. You will need to start or restart a pod in order to have it reflect the new capacity.

Expand Down Expand Up @@ -113,6 +113,6 @@ These steps assume you followed the tutorial [Deploy CockroachDB on Kubernetes](
~~~
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
datadir-my-release-cockroachdb-0 Bound pvc-75dadd4c-01a1-11ea-b065-42010a8e00cb 200Gi RWO standard 20m
~~~
~~~
1. The CockroachDB cluster needs to be expanded one node at a time. Repeat steps 3 - 6 to increase the capacities of the remaining volumes by the same amount.
1. The CockroachDB cluster needs to be expanded one node at a time. Repeat steps 3 - 6 to increase the capacities of the remaining volumes by the same amount.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ You can expand certain [types of persistent volumes](https://kubernetes.io/docs/
) (including GCE Persistent Disk and Amazon Elastic Block Store) by editing their persistent volume claims.

{{site.data.alerts.callout_info}}
These steps assume you followed the tutorial [Deploy CockroachDB on Kubernetes](deploy-cockroachdb-with-kubernetes.html?filters=manual).
These steps assume you followed the tutorial [Deploy CockroachDB on Kubernetes]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes.md %}?filters=manual).
{{site.data.alerts.end}}

1. Get the persistent volume claims for the volumes:
Expand Down Expand Up @@ -70,7 +70,7 @@ These steps assume you followed the tutorial [Deploy CockroachDB on Kubernetes](
{% include_cached copy-clipboard.html %}
~~~ shell
$ kubectl get pvc datadir-cockroachdb-0
~~~
~~~

~~~
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
Expand Down Expand Up @@ -115,4 +115,4 @@ These steps assume you followed the tutorial [Deploy CockroachDB on Kubernetes](
datadir-cockroachdb-0 Bound pvc-75dadd4c-01a1-11ea-b065-42010a8e00cb 200Gi RWO standard 20m
~~~
1. The CockroachDB cluster needs to be expanded one node at a time. Repeat steps 3 - 6 to increase the capacities of the remaining volumes by the same amount.
1. The CockroachDB cluster needs to be expanded one node at a time. Repeat steps 3 - 6 to increase the capacities of the remaining volumes by the same amount.
30 changes: 30 additions & 0 deletions src/current/_includes/common/orchestration/kubernetes-stop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
To delete the Kubernetes cluster:

- Hosted GKE:

{% include_cached copy-clipboard.html %}
~~~ shell
$ gcloud container clusters delete cockroachdb --region {region-name}
~~~
- Hosted EKS:

{% include_cached copy-clipboard.html %}
~~~ shell
$ eksctl delete cluster --name cockroachdb
~~~
- Manual GCE:

{% include_cached copy-clipboard.html %}
~~~ shell
$ cluster/kube-down.sh
~~~
- Manual AWS:

{% include_cached copy-clipboard.html %}
~~~ shell
$ cluster/kube-down.sh
~~~

{{site.data.alerts.callout_danger}}
If you stop Kubernetes without first deleting the persistent volumes, they will still exist in your cloud project.
{{site.data.alerts.end}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Feature | Description
--------|------------
[node](https://kubernetes.io/docs/concepts/architecture/nodes/) | A physical or virtual machine. In this tutorial, you'll create GCE or AWS instances and join them as worker nodes into a single Kubernetes cluster from your local workstation.
[pod](http://kubernetes.io/docs/user-guide/pods/) | A pod is a group of one or more Docker containers. In this tutorial, each pod will run on a separate Kubernetes node and include one Docker container running a single CockroachDB node. You'll start with 3 pods and grow to 4.
[StatefulSet](http://kubernetes.io/docs/concepts/abstractions/controllers/statefulsets/) | A StatefulSet is a group of pods treated as stateful units, where each pod has distinguishable network identity and always binds back to the same persistent storage on restart. StatefulSets are considered stable as of Kubernetes version 1.9 after reaching beta in version 1.5.
[persistent volumes](http://kubernetes.io/docs/user-guide/persistent-volumes/) | A persistent volume is a piece of networked storage (Persistent Disk on GCE, Elastic Block Store on AWS) mounted into a pod. The lifetime of a persistent volume is decoupled from the lifetime of the pod that's using it, ensuring that each CockroachDB node binds back to the same storage on restart.<br><br>This tutorial assumes that dynamic volume provisioning is available. When that is not the case, [persistent volume claims](http://kubernetes.io/docs/user-guide/persistent-volumes/#persistentvolumeclaims) need to be created manually.
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Step 1. Start Kubernetes

1. Follow the Kubernetes [documentation](https://kubernetes.io/docs/tasks/tools/install-minikube/) to install the latest release of `minikube`, a tool you can use to run Kubernetes on a workstation. `minikube` includes installing a hypervisor and `kubectl`, the command-line tool used to manage Kubernetes.

1. Start a local Kubernetes cluster:

{% include_cached copy-clipboard.html %}
~~~ shell
$ minikube start
~~~
Loading

0 comments on commit 52a695e

Please sign in to comment.