Skip to content

Commit ac52f17

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #715 from saikat-royc/overlays
Update README for overlays
2 parents 4a5a0d3 + cbd6104 commit ac52f17

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

‎README.md

+28-17
Original file line numberDiff line numberDiff line change
@@ -21,28 +21,39 @@ Latest stable image: `gcr.io/gke-release/gcp-compute-persistent-disk-csi-driver:
2121
| Driver Version | Kubernetes Version | Test Status |
2222
|----------------|--------------------|-------------|
2323
| HEAD Latest | HEAD | [<img alt="Test Status" src="https://testgrid.k8s.io/q/summary/provider-gcp-compute-persistent-disk-csi-driver/Kubernetes%20Master%20Driver%20Latest/tests_status" />](https://testgrid.k8s.io/provider-gcp-compute-persistent-disk-csi-driver#Kubernetes%20Master%20Driver%20Latest) |
24-
| 0.5.x Stable | HEAD | [<img alt="Test Status" src="https://testgrid.k8s.io/q/summary/provider-gcp-compute-persistent-disk-csi-driver/Kubernetes%20Master%20Driver%20Release%200.5/tests_status" />](https://testgrid.k8s.io/provider-gcp-compute-persistent-disk-csi-driver#Kubernetes%20Master%20Driver%20Release%200.5) |
25-
| 0.4.x Stable | 1.13.5 | [<img alt="Test Status" src="https://testgrid.k8s.io/q/summary/provider-gcp-compute-persistent-disk-csi-driver/Kubernetes%20v1.13.5%20Driver%20Release%200.4/tests_status" />](https://testgrid.k8s.io/provider-gcp-compute-persistent-disk-csi-driver#Kubernetes%20v1.13.5%20Driver%20Release%200.4) |
24+
| 0.7.x stable | HEAD | [<img alt="Test Status" src="https://testgrid.k8s.io/q/summary/provider-gcp-compute-persistent-disk-csi-driver/Kubernetes%20Master%20Driver%20Release%200.7/tests_status" />](https://https://testgrid.k8s.io/provider-gcp-compute-persistent-disk-csi-driver#Kubernetes%20Master%20Driver%20Release%200.7) |
2625
| HEAD Latest | HEAD (Migration ON) | [<img alt="Test Status" src="https://testgrid.k8s.io/q/summary/provider-gcp-compute-persistent-disk-csi-driver/Migration%20Kubernetes%20Master%20Driver%20Latest/tests_status" />](https://testgrid.k8s.io/provider-gcp-compute-persistent-disk-csi-driver#Migration%20Kubernetes%20Master%20Driver%20Latest) |
27-
| HEAD Stable | HEAD (Migration ON) | [<img alt="Test Status" src="https://testgrid.k8s.io/q/summary/provider-gcp-compute-persistent-disk-csi-driver/Migration%20Kubernetes%20Master%20Driver%20Stable/tests_status" />](https://testgrid.k8s.io/provider-gcp-compute-persistent-disk-csi-driver#Migration%20Kubernetes%20Master%20Driver%20Stable) |
26+
| HEAD stable-master | HEAD (Migration ON) | [<img alt="Test Status" src="https://testgrid.k8s.io/q/summary/provider-gcp-compute-persistent-disk-csi-driver/Migration%20Kubernetes%20Master%20Driver%20Stable/tests_status" />](https://testgrid.k8s.io/provider-gcp-compute-persistent-disk-csi-driver#Migration%20Kubernetes%20Master%20Driver%20Stable) |
2827

2928
### CSI Compatibility
3029

3130
This plugin is compatible with CSI versions [v1.2.0](https://github.com/container-storage-interface/spec/blob/v1.2.0/spec.md), [v1.1.0](https://github.com/container-storage-interface/spec/blob/v1.1.0/spec.md), and [v1.0.0](https://github.com/container-storage-interface/spec/blob/v1.0.0/spec.md)
3231

3332
### Kubernetes Compatibility
33+
The following table captures the compatibility matrix of the core persistent disk driver binary
34+
`gke.gcr.io/gcp-compute-persistent-disk-csi-driver`
3435

35-
| GCE PD CSI Driver\Kubernetes Version | 1.10.5 - 1.11 | 1.12 | 1.13 | 1.14 | 1.15 | 1.16+ | 1.17+ |
36-
|--------------------------------------|---------------|------|------|------|------|-------|-------|
37-
| v0.1.x.alpha | yes | no | no | no | no | no | no |
38-
| v0.2.x (alpha) | no | yes | no | no | no | no | no |
39-
| v0.3.x (beta) | no | no | yes | yes | yes | yes | yes |
40-
| v0.4.x (beta) | no | no | yes | yes | yes | yes | yes |
41-
| v0.5.x (beta) | no | no | no | yes | yes | yes | yes |
42-
| v0.6.x (beta) | no | no | no | yes | yes | yes | yes |
43-
| v0.7.x (beta) | no | no | no | no | no | yes | yes |
44-
| v1.0.x (ga) | no | no | no | no | no | no | yes |
45-
| dev | no | no | no | no | no | no | yes |
36+
| GCE PD CSI Driver\Kubernetes Version | 1.15 | 1.16 | 1.17+ |
37+
|--------------------------------------|------|-------|-------|
38+
| v0.2.x (alpha) | no | no | no |
39+
| v0.3.x (beta) | yes | yes | yes |
40+
| v0.4.x (beta) | yes | yes | yes |
41+
| v0.5.x (beta) | yes | yes | yes |
42+
| v0.6.x (beta) | yes | yes | yes |
43+
| v0.7.x (beta) | yes | yes | yes |
44+
| v1.0.x (ga) | yes | yes | yes |
45+
| dev | yes | yes | yes |
46+
47+
The manifest bundle which captures all the driver components (driver pod which includes the containers csi-provisioner, csi-resizer, csi-snapshotter, gce-pd-driver, csi-driver-registrar;
48+
csi driver object, rbacs, pod security policies etc) can be picked up from the master branch [overlays](deploy/kubernetes/overlays) directory. We structure the overlays directory, per minor version of kubernetes because not all driver components can be used with all kubernetes versions. For example volume snapshots are supported 1.17+ kubernetes versions thus [stable-1-16](deploy/kubernetes/overlays/stable-1-16) driver manifests does not contain the snapshotter sidecar.
49+
50+
Example:
51+
52+
`stable-1-19` overlays bundle can be used to deploy all the components of the driver on kubernetes 1.19.
53+
54+
`stable-master` overlays bundle can be used to deploy all the components of the driver on kubernetes master.
55+
56+
For more details about per k8s minor version overlays, please check this [doc](docs/release/overlays.md)
4657

4758
### Known Issues
4859

@@ -73,10 +84,10 @@ GCE PD driver starts to support CSI Windows with [CSI Proxy] (https://github.com
7384
| Feature | Stage | Min Kubernetes Master Version | Min Kubernetes Nodes Version | Min Driver Version | Deployment Overlay |
7485
|-----------------|-------|-------------------------------|------------------------------|--------------------|--------------------|
7586
| Snapshots | Alpha | 1.13 | Any | v0.3.0 | Alpha |
76-
| Snapshots | Beta | 1.17 | Any | v1.0.0 | Stable |
87+
| Snapshots | Beta | 1.17 | Any | v1.0.0 | stable-1-17, stable-1-18, stable-1-19, stable-master |
7788
| Resize (Expand) | Alpha | 1.14 | 1.14 | v0.6.0 | Alpha |
78-
| Resize (Expand) | Beta | 1.16 | 1.16 | v0.7.0 | Stable |
79-
| Windows* | Beta | 1.18 | 1.18 | v1.1.0 | Alpha |
89+
| Resize (Expand) | Beta | 1.16 | 1.16 | v0.7.0 | stable-1-16, stable-1-17, stable-1-18, stable-1-19, stable-master |
90+
| Windows* | Beta | 1.18 | 1.18 | v1.1.0 | stable-1-18, stable-1-19, stable-master |
8091

8192
\* For Windows, it is recommended to use this driver with CSI proxy v0.2.2+. The master version of driver requires disk v1beta2 group, which is only available in CSI proxy v0.2.2+
8293

0 commit comments

Comments
 (0)