Skip to content

Add usage of regiona PD in zonal clusters to user guide #689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 17, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions docs/kubernetes/user-guides/basic.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Kubernetes Basic User Guide
This guide gives a simple example on how to provision zonal and regional PDs in single-zone and regional clusters.

**Note:** Regional cluster support only available in beta starting with
Kubernetes 1.14.
**Note:** Regional PD [support](https://kubernetes-csi.github.io/docs/topology.html) is available in beta starting with
Kubernetes 1.14 and GA starting with 1.17.

## Install Driver

Expand Down Expand Up @@ -43,21 +43,20 @@ web-server 1/1 Running 0 1m

## Regional PD example

**Note:** Regional cluster support only available in beta starting with
Kubernetes 1.14.
This example provisions a regional PD in either zonal or regional clusters.

This example provisions a regional PD in regional clusters.
1. Create example Regional Storage Class. For zonal clusters, `allowedTopologies` must be specified with two zones where one of the zones must be the cluster's zone. For regional clusters this configuration can also be used to make sure that regional PD is provisioned in those two zones.

1. Create example Regional Storage Class. Choose between:

* Unrestricted zones
* Restricted zones
```
$ kubectl apply -f ./examples/kubernetes/demo-regional-sc.yaml
$ kubectl apply -f ./examples/kubernetes/demo-regional-restricted-sc.yaml
```

* Restricted zones
For regional clusters it is also possible to not specify `allowedTopologies`, in which case two zones will be picked from the available zones in the cluster's region.

* Unrestricted zones
```
$ kubectl apply -f ./examples/kubernetes/demo-regional-restricted-sc.yaml
$ kubectl apply -f ./examples/kubernetes/demo-regional-sc.yaml
```

2. Create example PVC and Pod
Expand Down