Skip to content

Commit a477bd5

Browse files
authored
Merge pull request #178 from davidz627/feature/testreadme
Add testgrid status to README.md
2 parents 4a67cdf + d4d7605 commit a477bd5

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,18 @@ lifecycle of Google Compute Engine Persistent Disks.
1313
Status: Beta
1414
Latest stable image: `gcr.io/gke-release/gcp-compute-persistent-disk-csi-driver:v0.3.0-gke.0`
1515

16+
### Test Status
17+
18+
#### Kubernetes Integration
19+
20+
[<img alt="Test Status" src="https://testgrid.k8s.io/q/summary/sig-gcp-compute-persistent-disk-csi-driver/Kubernetes%20Master%20Driver%20Stable/tests_status" />](https://testgrid.k8s.io/sig-gcp-compute-persistent-disk-csi-driver#Kubernetes%20Master%20Driver%20Stable)
21+
1622
### CSI Compatibility
23+
1724
This plugin is compatible with CSI versions [v1.0.0](https://github.com/container-storage-interface/spec/blob/v1.0.0/spec.md)
1825

1926
### Kubernetes Compatibility
27+
2028
| GCE PD CSI Driver\Kubernetes Version | 1.10.5 - 1.11 | 1.12 | 1.13+ |
2129
|--------------------------------------|---------------|------|-------|
2230
| v0.1.0.alpha | yes | no | no |
@@ -25,25 +33,32 @@ This plugin is compatible with CSI versions [v1.0.0](https://github.com/containe
2533
| dev | no | no | yes |
2634

2735
### Known Issues
36+
2837
See Github [Issues](https://github.com/kubernetes-sigs/gcp-compute-persistent-disk-csi-driver/issues)
2938

3039
## Plugin Features
40+
3141
### CreateVolume Parameters
42+
3243
| Parameter | Values | Default | Description |
3344
|--------------------|----------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------|
3445
| "type" | pd-ssd OR pd-standard | pd-standard | Type allows you to choose between standard Persistent Disks or Solid State Drive Persistent Disks |
3546
| "replication-type" | none OR regional-pd | none | Replication type allows you to choose between standard zonal Persistent Disks or highly available Regional Persistent Disks |
3647

3748
### Future Features
49+
3850
See Github [Issues](https://github.com/kubernetes-sigs/gcp-compute-persistent-disk-csi-driver/issues)
3951

4052
### Topology
53+
4154
This driver supports only one topology key:
4255
`topology.gke.io/zone`
4356
that represents availability by zone.
4457

4558
## Kubernetes User Guide
59+
4660
### Install Driver
61+
4762
1. [One-time per project] Create GCP service account for the CSI driver and set required roles
4863
```
4964
$ PROJECT=your-project-here # GCP project
@@ -60,6 +75,7 @@ $ ./deploy/kubernetes/deploy-driver.sh
6075
```
6176

6277
### Zonal Example
78+
6379
1. Create example Zonal Storage Class
6480
```
6581
$ kubectl apply -f ./examples/kubernetes/demo-zonal-sc.yaml
@@ -85,6 +101,7 @@ web-server 1/1 Running 0 1m
85101
```
86102

87103
### Snapshot Example
104+
88105
1. Create example Default Snapshot Class
89106
```
90107
$ kubectl create -f ./examples/kubernetes/demo-defaultsnapshotclass.yaml
@@ -120,6 +137,7 @@ $ kubectl create -f ./examples/kubernetes/demo-restore-snapshot.yaml
120137
## Kubernetes Development
121138

122139
### Manual
140+
123141
To build and install a development version of the driver:
124142
```
125143
$ GCE_PD_CSI_STAGING_IMAGE=gcr.io/path/to/driver/image:dev # Location to push dev image to
@@ -136,6 +154,7 @@ $ ./deploy/kubernetes/delete-driver.sh
136154
```
137155

138156
## Testing
157+
139158
Running E2E Tests:
140159
```
141160
$ PROJECT=my-project # GCP Project to run tests in
@@ -154,6 +173,7 @@ $ ./test/run-unit.sh
154173
```
155174

156175
## Dependency Management
176+
157177
Use [dep](https://github.com/golang/dep)
158178
```
159179
$ dep ensure

0 commit comments

Comments
 (0)