Merge pull request kubernetes-sigs#495 from ialidzhikov/doc/snapshot-example

Update snapshot guide

Author: k8s-ci-robot

Makefile

@@ -41,15 +41,15 @@ endif
 
 build-and-push-windows-container-ltsc2019:
 ifndef GCE_PD_CSI_STAGING_IMAGE
-	$(error "Must set enviroment variable GCE_PD_CSI_STAGING_IMAGE to staging image repository")
+	$(error "Must set environment variable GCE_PD_CSI_STAGING_IMAGE to staging image repository")
 endif
 	@sh init-buildx.sh; \
 	DOCKER_CLI_EXPERIMENTAL=enabled docker buildx build --file=Dockerfile.Windows --platform=windows \
 	-t $(STAGINGIMAGE):$(STAGINGVERSION) --build-arg BASE_IMAGE=servercore --build-arg BASE_IMAGE_TAG=ltsc2019 --push .
 
 build-and-push-windows-container-1909:
 ifndef GCE_PD_CSI_STAGING_IMAGE
-	$(error "Must set enviroment variable GCE_PD_CSI_STAGING_IMAGE to staging image repository")
+	$(error "Must set environment variable GCE_PD_CSI_STAGING_IMAGE to staging image repository")
 endif
 	@sh init-buildx.sh; \
 	DOCKER_CLI_EXPERIMENTAL=enabled docker buildx build --file=Dockerfile.Windows --platform=windows \

deploy/kubernetes/overlays/alpha/rbac_add_snapshotter.yaml

@@ -16,7 +16,7 @@ rules:
   - apiGroups: [""]
     resources: ["events"]
     verbs: ["list", "watch", "create", "update", "patch"]
-  # Secrets resource ommitted since GCE PD snapshots does not require them
+  # Secrets resource omitted since GCE PD snapshots does not require them
   - apiGroups: ["snapshot.storage.k8s.io"]
     resources: ["volumesnapshotclasses"]
     verbs: ["get", "list", "watch"]

docs/kubernetes/user-guides/snapshots.md

@@ -6,106 +6,121 @@
 
 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
-```
+    ```
+    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
+    ```
 
-2. Deploy driver to Kubernetes Cluster
+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=alpha                     # Driver version to deploy
-$ ./deploy/kubernetes/deploy-driver.sh
-```
+    ```
+    GCE_PD_SA_DIR=/my/safe/credentials/directory    # Directory to get the service account key
+    GCE_PD_DRIVER_VERSION=alpha                     # Driver version to deploy
+    ./deploy/kubernetes/deploy-driver.sh
+    ```
 
 ### Snapshot Example
 
-**Create Storage Class:**
+1. Create `StorageClass`
 
-If you haven't created a `StorageClass` yet, create one first:
+    If you haven't created a `StorageClass` yet, create one first:
 
-```console
-kubectl apply -f ./examples/kubernetes/demo-zonal-sc.yaml
-```
+    ```console
+    kubectl apply -f ./examples/kubernetes/demo-zonal-sc.yaml
+    ```
 
-**Create  Default VolumeSnapshotClass:**
+1. Create default `VolumeSnapshotClass`
 
-```console
-kubectl create -f ./examples/kubernetes/snapshot/default_volumesnapshotclass.yaml
-```
+    ```console
+    kubectl create -f ./examples/kubernetes/snapshot/default-volumesnapshotclass.yaml
+    ```
 
-**Create source PVC:**
+1. Create source PVC
 
-```console
-kubectl create -f ./examples/kubernetes/snapshot/source_pvc.yaml
-```
+    ```console
+    kubectl create -f ./examples/kubernetes/snapshot/source-pvc.yaml
+    ```
 
-**Generate sample data:**
+1. Generate sample data
 
-Create a sample pod with the source PVC. The source PVC is mounted into `/demo/data` directory of this pod. This pod will create a file `sample-file.txt` in `/demo/data` directory.
+    Create a sample pod with the source PVC. The source PVC is mounted into `/demo/data` directory of this pod. This pod will create a file `sample-file.txt` in `/demo/data` directory.
 
-```console
-kubectl create -f ./examples/kubernetes/snapshot/source_pod.yaml
-```
+    ```console
+    kubectl create -f ./examples/kubernetes/snapshot/source-pod.yaml
+    ```
 
-Check if the file has been created successfully:
+    Check if the file has been created successfully:
 
-```console
-$ kubectl exec source-pod -- ls /demo/data/
-lost+found
-sample-file.txt
-```
+    ```console
+    kubectl exec source-pod -- ls /demo/data/
+    ```
 
-**Create a snapshot of the source PVC:**
+    The output should be:
 
-```console
-kubectl create -f ./examples/kubernetes/snapshot/snapshot.yaml
-```
+    ```
+    lost+found
+    sample-file.txt
+    ```
 
-**Verify Snapshot has been created and it is ready to use:**
+1. Create a `VolumeSnapshot` of the source PVC
 
-```console
-$ kubectl get volumesnapshot snapshot-source-pvc -o yaml
-apiVersion: snapshot.storage.k8s.io/v1alpha1
-kind: VolumeSnapshot
-metadata:
-  ...
-  name: snapshot-source-pvc
-  namespace: default
-  ...
-spec:
-  snapshotClassName: default-snapshot-class
-  snapshotContentName: snapcontent-b408076b-720b-11e9-b9e3-42010a800014
-  ...
-status:
-  creationTime: "2019-05-09T03:37:01Z"
-  readyToUse: true
-  restoreSize: 6Gi
-```
+    ```console
+    kubectl create -f ./examples/kubernetes/snapshot/snapshot.yaml
+    ```
 
-**Restore the Snapshot into a new PVC:**
+1. Verify that `VolumeSnapshot` has been created and it is ready to use:
 
-Create a new PVC. Specify `spec.dataSource` section to restore from VolumeSnapshot `snapshot-source-pvc`.
+    ```console
+    kubectl get volumesnapshot snapshot-source-pvc -o yaml
+    ```
 
-```console
- kubectl create -f ./examples/kubernetes/snapshot/restored_pvc.yaml
-```
+    The output is similar to this:
 
-**Verify sample data has been restored:**
+    ```yaml
+    apiVersion: snapshot.storage.k8s.io/v1alpha1
+    kind: VolumeSnapshot
+    metadata:
+      ...
+      name: snapshot-source-pvc
+      namespace: default
+      ...
+    spec:
+      snapshotClassName: default-snapshot-class
+      snapshotContentName: snapcontent-b408076b-720b-11e9-b9e3-42010a800014
+      ...
+    status:
+      creationTime: "2019-05-09T03:37:01Z"
+      readyToUse: true
+      restoreSize: 6Gi
+    ```
 
-Create a sample pod with the restored PVC:
+1. Restore the `VolumeSnapshot` into a new PVC:
 
-```console
-kubectl create -f ./examples/kubernetes/snapshot/restored_pod.yaml
-```
+    Create a new PVC. Specify `spec.dataSource` section to restore from VolumeSnapshot `snapshot-source-pvc`.
 
-Check data has been restored in `/demo/data` directory:
+    ```console
+    kubectl create -f ./examples/kubernetes/snapshot/restored-pvc.yaml
+    ```
 
-```console
-$ kubectl exec restored-pod -- ls /demo/data/
-lost+found
-sample-file.txt
-```
+1. Verify sample data has been restored:
+
+    Create a sample pod with the restored PVC:
+
+    ```console
+    kubectl create -f ./examples/kubernetes/snapshot/restored-pod.yaml
+    ```
+
+    Check data has been restored in `/demo/data` directory:
+
+    ```console
+    kubectl exec restored-pod -- ls /demo/data/
+    ```
+
+    Verify that the output is:
+
+    ```
+    lost+found
+    sample-file.txt
+    ```

examples/kubernetes/snapshot/default-volumesnapshotclass.yaml

@@ -5,4 +5,3 @@ metadata:
     snapshot.storage.kubernetes.io/is-default-class: "true"
   name: default-snapshot-class
 snapshotter: pd.csi.storage.gke.io
-

pkg/gce-cloud-provider/compute/gce-compute.go

@@ -310,7 +310,7 @@ func (cloud *CloudProvider) insertRegionalDisk(ctx context.Context, volKey *meta
 			klog.Warningf("GCE PD %s already exists, reusing", volKey.Name)
 			return nil
 		}
-		return status.Error(codes.Internal, fmt.Sprintf("unkown Insert disk error: %v", err))
+		return status.Error(codes.Internal, fmt.Sprintf("unknown Insert disk error: %v", err))
 	}
 
 	err = cloud.waitForRegionalOp(ctx, insertOp, volKey.Region)
@@ -329,7 +329,7 @@ func (cloud *CloudProvider) insertRegionalDisk(ctx context.Context, volKey *meta
 			klog.Warningf("GCE PD %s already exists after wait, reusing", volKey.Name)
 			return nil
 		}
-		return fmt.Errorf("unkown Insert disk operation error: %v", err)
+		return fmt.Errorf("unknown Insert disk operation error: %v", err)
 	}
 	return nil
 }
@@ -369,7 +369,7 @@ func (cloud *CloudProvider) insertZonalDisk(ctx context.Context, volKey *meta.Ke
 			klog.Warningf("GCE PD %s already exists, reusing", volKey.Name)
 			return nil
 		}
-		return fmt.Errorf("unkown Insert disk error: %v", err)
+		return fmt.Errorf("unknown Insert disk error: %v", err)
 	}
 
 	err = cloud.waitForZonalOp(ctx, op, volKey.Zone)
@@ -389,7 +389,7 @@ func (cloud *CloudProvider) insertZonalDisk(ctx context.Context, volKey *meta.Ke
 			klog.Warningf("GCE PD %s already exists after wait, reusing", volKey.Name)
 			return nil
 		}
-		return fmt.Errorf("unkown Insert disk operation error: %v", err)
+		return fmt.Errorf("unknown Insert disk operation error: %v", err)
 	}
 	return nil
 }

pkg/gce-pd-csi-driver/node.go

@@ -232,7 +232,7 @@ func (ns *GCENodeServer) NodeUnpublishVolume(ctx context.Context, req *csi.NodeU
 	if err := cleanupPublishPath(targetPath, ns.Mounter); err != nil {
 		return nil, status.Error(codes.Internal, fmt.Sprintf("Unmount failed: %v\nUnmounting arguments: %s\n", err, targetPath))
 	}
-	klog.V(4).Infof("NodeUnpublishVolume succeded on %v from %s", volumeID, targetPath)
+	klog.V(4).Infof("NodeUnpublishVolume succeeded on %v from %s", volumeID, targetPath)
 	return &csi.NodeUnpublishVolumeResponse{}, nil
 }
 
@@ -294,7 +294,7 @@ func (ns *GCENodeServer) NodeStageVolume(ctx context.Context, req *csi.NodeStage
 			3) Readonly MUST match
 
 		*/
-		klog.V(4).Infof("NodeStageVolume succeded on %v to %s, mount already exists.", volumeID, stagingTargetPath)
+		klog.V(4).Infof("NodeStageVolume succeeded on %v to %s, mount already exists.", volumeID, stagingTargetPath)
 		return &csi.NodeStageVolumeResponse{}, nil
 
 	}
@@ -315,7 +315,7 @@ func (ns *GCENodeServer) NodeStageVolume(ctx context.Context, req *csi.NodeStage
 		}
 	} else if blk := volumeCapability.GetBlock(); blk != nil {
 		// Noop for Block NodeStageVolume
-		klog.V(4).Infof("NodeStageVolume succeded on %v to %s, capability is block so this is a no-op", volumeID, stagingTargetPath)
+		klog.V(4).Infof("NodeStageVolume succeeded on %v to %s, capability is block so this is a no-op", volumeID, stagingTargetPath)
 		return &csi.NodeStageVolumeResponse{}, nil
 	}
 
@@ -326,7 +326,7 @@ func (ns *GCENodeServer) NodeStageVolume(ctx context.Context, req *csi.NodeStage
 				devicePath, stagingTargetPath, fstype, options, err))
 	}
 
-	klog.V(4).Infof("NodeStageVolume succeded on %v to %s", volumeID, stagingTargetPath)
+	klog.V(4).Infof("NodeStageVolume succeeded on %v to %s", volumeID, stagingTargetPath)
 	return &csi.NodeStageVolumeResponse{}, nil
 }
 
@@ -350,7 +350,7 @@ func (ns *GCENodeServer) NodeUnstageVolume(ctx context.Context, req *csi.NodeUns
 		return nil, status.Error(codes.Internal, fmt.Sprintf("NodeUnstageVolume failed: %v\nUnmounting arguments: %s\n", err, stagingTargetPath))
 	}
 
-	klog.V(4).Infof("NodeUnstageVolume succeded on %v from %s", volumeID, stagingTargetPath)
+	klog.V(4).Infof("NodeUnstageVolume succeeded on %v from %s", volumeID, stagingTargetPath)
 	return &csi.NodeUnstageVolumeResponse{}, nil
 }
 

pkg/mount-manager/device-utils.go

@@ -191,7 +191,7 @@ func (m *deviceUtils) VerifyDevicePath(devicePaths []string, deviceName string)
 				return false, fmt.Errorf("couldn't get SCSI serial number for disk %s: %v", deviceName, innerErr)
 			}
 			// SUCCESS! devicePath points to a /dev/sdx that has a SCSI serial
-			// equivilant to our disk name
+			// equivalent to our disk name
 			if scsiSerial == deviceName {
 				return true, nil
 			}

test/k8s-integration/cluster.go

@@ -271,7 +271,7 @@ func getNormalizedVersion(kubeVersion, gkeVersion string) (string, error) {
 		return "", fmt.Errorf("both kube version (%s) and gke version (%s) specified", kubeVersion, gkeVersion)
 	}
 	if kubeVersion == "" && gkeVersion == "" {
-		return "", errors.New("neither kube verison nor gke verison specified")
+		return "", errors.New("neither kube version nor gke version specified")
 	}
 	var v string
 	if kubeVersion != "" {