Skip to content

Latest commit

 

History

History
87 lines (69 loc) · 2.76 KB

basic.md

File metadata and controls

87 lines (69 loc) · 2.76 KB

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.

Install Driver

  1. [One-time per project] Create GCP service account for the CSI driver and set required roles
$ PROJECT=your-project-here                       # GCP project
$ GCE_PD_SA_NAME=my-gce-pd-csi-sa                 # Name of the service account to create
$ GCE_PD_SA_DIR=/my/safe/credentials/directory    # Directory to save the service account key
$ ./deploy/setup-project.sh
  1. Deploy driver to Kubernetes Cluster
$ GCE_PD_SA_DIR=/my/safe/credentials/directory    # Directory to get the service account key
$ GCE_PD_DRIVER_VERSION=stable                    # Driver version to deploy
$ ./deploy/kubernetes/deploy-driver.sh

Zonal PD example

This example provisions a zonal PD in both single-zone and regional clusters.

  1. Create example Zonal Storage Class
$ kubectl apply -f ./examples/kubernetes/demo-zonal-sc.yaml
  1. Create example PVC and Pod
$ kubectl apply -f ./examples/kubernetes/demo-pod.yaml
  1. Verify PV is created and bound to PVC
$ kubectl get pvc
NAME      STATUS    VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   AGE
podpvc     Bound     pvc-e36abf50-84f3-11e8-8538-42010a800002   10Gi       RWO            csi-gce-pd     9s
  1. Verify pod is created and in RUNNING state (it may take a few minutes to get to running state)
$ kubectl get pods
NAME                      READY     STATUS    RESTARTS   AGE
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 regional clusters.

  1. Create example Regional Storage Class. Choose between:

    • Unrestricted zones

      $ kubectl apply -f ./examples/kubernetes/demo-regional-sc.yaml

    • Restricted zones

      $ kubectl apply -f ./examples/kubernetes/demo-regional-restricted-sc.yaml

  2. Create example PVC and Pod

$ kubectl apply -f ./examples/kubernetes/demo-pod.yaml
  1. Verify PV is created and bound to PVC
$ kubectl get pvc
NAME      STATUS    VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   AGE
podpvc     Bound     pvc-e36abf50-84f3-11e8-8538-42010a800002   10Gi       RWO            csi-gce-pd     9s
  1. Verify pod is created and in RUNNING state (it may take a few minutes to get to running state)
$ kubectl get pods
NAME                      READY     STATUS    RESTARTS   AGE
web-server                1/1       Running   0          1m