Skip to content

Commit 6a7e49c

Browse files
authored
Merge pull request #99 from davidz627/fix/docsAgain
Minor Docs Fixes
2 parents 432526c + d18b51d commit 6a7e49c

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

Diff for: README.md

+19-18
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Status: Alpha
2020
Latest image: `gcr.io/google-containers/volume-csi/gcp-compute-persistent-disk-csi-driver:v0.1.0.alpha`
2121

2222
### CSI Compatibility
23-
This plugin is compatible with CSI versions v0.2.0 and v0.3.0
23+
This plugin is compatible with CSI versions [v0.2.0](https://github.com/container-storage-interface/spec/blob/v0.2.0/spec.md) and [v0.3.0](https://github.com/container-storage-interface/spec/blob/v0.3.0/spec.md)
2424

2525
### Kubernetes Compatibility
2626
This plugin can be used as-is beginning with Kubernetes v1.10.5
@@ -32,8 +32,8 @@ See Github [Issues](https://github.com/kubernetes-sigs/gcp-compute-persistent-di
3232
### CreateVolume Parameters
3333
| Parameter | Values | Default | Description |
3434
|--------------------|----------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------|
35-
| "type" | pd-ssd | pd-standard | pd-standard | Type allows you to choose between standard Persistent Disks or Solid State Drive Persistent Disks |
36-
| "replication-type" | none | regional-pd | none | Replication type allows you to choose between standard zonal Persistent Disks or highly available Regional Persistent Disks |
35+
| "type" | pd-ssd OR pd-standard | pd-standard | Type allows you to choose between standard Persistent Disks or Solid State Drive Persistent Disks |
36+
| "replication-type" | none OR regional-pd | none | Replication type allows you to choose between standard zonal Persistent Disks or highly available Regional Persistent Disks |
3737

3838
### Future Features
3939
See Github [Issues](https://github.com/kubernetes-sigs/gcp-compute-persistent-disk-csi-driver/issues)
@@ -47,28 +47,28 @@ that represents availability by zone.
4747
### Install Driver
4848
1. [One-time per project] Create GCP service account for the CSI driver and set required roles
4949
```
50-
PROJECT=your-project-here # GCP project
51-
GCE_PD_SA_NAME=my-gce-pd-csi-sa # Name of the service account to create
52-
GCE_PD_SA_DIR=/my/safe/credentials/directory # Directory to save the service account key
53-
./deploy/setup-project.sh
50+
$ PROJECT=your-project-here # GCP project
51+
$ GCE_PD_SA_NAME=my-gce-pd-csi-sa # Name of the service account to create
52+
$ GCE_PD_SA_DIR=/my/safe/credentials/directory # Directory to save the service account key
53+
$ ./deploy/setup-project.sh
5454
```
5555

5656
2. Deploy driver to Kubernetes Cluster
5757
```
58-
GCE_PD_SA_DIR=/my/safe/credentials/directory # Directory to get the service account key
59-
GCE_PD_DRIVER_VERSION=stable # Driver version to deploy
60-
./deploy/kubernetes/deploy-driver.sh
58+
$ GCE_PD_SA_DIR=/my/safe/credentials/directory # Directory to get the service account key
59+
$ GCE_PD_DRIVER_VERSION=stable # Driver version to deploy
60+
$ ./deploy/kubernetes/deploy-driver.sh
6161
```
6262

6363
### Zonal Example
6464
1. Create example Zonal Storage Class
6565
```
66-
kubectl apply -f ./examples/kubernetes/demo-zonal-sc.yaml
66+
$ kubectl apply -f ./examples/kubernetes/demo-zonal-sc.yaml
6767
```
6868

6969
2. Create example PVC and Pod
7070
```
71-
kubectl apply -f ./examples/kubernetes/demo-pod.yaml
71+
$ kubectl apply -f ./examples/kubernetes/demo-pod.yaml
7272
```
7373

7474
3. Verify PV is created and bound to PVC
@@ -80,6 +80,7 @@ podpvc Bound pvc-e36abf50-84f3-11e8-8538-42010a800002 10Gi RWO
8080

8181
4. Verify pod is created and in `RUNNING` state (it may take a few minutes to get to running state)
8282
```
83+
$ kubectl get pods
8384
NAME READY STATUS RESTARTS AGE
8485
web-server 1/1 Running 0 1m
8586
```
@@ -93,7 +94,7 @@ $ GCE_PD_CSI_STAGING_IMAGE=gcr.io/path/to/driver/image:dev # Location to push
9394
$ make push-container
9495
9596
# Modify controller.yaml and node.yaml in ./deploy/kubernetes/dev to use dev image
96-
GCE_PD_DRIVER_VERSION=dev
97+
$ GCE_PD_DRIVER_VERSION=dev
9798
$ ./deploy/kubernetes/deploy-driver.sh
9899
```
99100

@@ -105,19 +106,19 @@ $ ./deploy/kubernetes/delete-driver.sh
105106
## Testing
106107
Running E2E Tests:
107108
```
108-
PROJECT=my-project # GCP Project to run tests in
109-
[email protected] # Existing IAM Account with GCE PD CSI Driver Permissions
110-
./test/run-e2e-local.sh
109+
$ PROJECT=my-project # GCP Project to run tests in
110+
$ [email protected] # Existing IAM Account with GCE PD CSI Driver Permissions
111+
$ ./test/run-e2e-local.sh
111112
```
112113

113114
Running Sanity Tests:
114115
```
115-
./test/run-sanity.sh
116+
$ ./test/run-sanity.sh
116117
```
117118

118119
Running Unit Tests:
119120
```
120-
./test/run-unit.sh
121+
$ ./test/run-unit.sh
121122
```
122123

123124
## Dependency Management

0 commit comments

Comments
 (0)