Skip to content

Update overlay documentation #932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 17, 2022
Merged

Update overlay documentation #932

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOGs

- [CHANGELOG v1.3.0](./CHANGELOG-1.4.md)
- [CHANGELOG v1.3.0](./CHANGELOG-1.3.md)
- [CHANGELOG v1.2.0](./CHANGELOG-1.2.md)
- [CHANGELOG v1.1.0](./CHANGELOG-1.1.md)
- [CHANGELOG v1.0.0](./CHANGELOG-1.0.md)
- [CHANGELOG v0.7.0](./CHANGELOG-0.7.md)
- [CHANGELOG v0.6.0](./CHANGELOG-0.6.md)
2 changes: 1 addition & 1 deletion Dockerfile.debug
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ COPY --from=mad-hack /lib/udev/scsi_id /lib/udev_containerized/scsi_id

# PDCSI driver isn't copied to / because of delve not being able to correlate
# the binary and the source code, instead just run the binary where it was
# compiled, the overlay noauth-dev calls this binary
# compiled, the overlay noauth-debug calls this binary
ENTRYPOINT ["/go/src/sigs.k8s.io/gcp-compute-persistent-disk-csi-driver/bin/gce-pd-csi-driver"]
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ The following table captures the compatibility matrix of the core persistent dis
| dev | yes |

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;
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, v1 CSIDriver resources are supported in 1.18+ only, so [stable-1-17](deploy/kubernetes/overlays/stable-1-17) driver manifests use the v1beta1 version.
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.

Example:

`stable-1-19` overlays bundle can be used to deploy all the components of the driver on kubernetes 1.19.
`stable-1-21` overlays bundle can be used to deploy all the components of the driver on kubernetes 1.21.

`stable-master` overlays bundle can be used to deploy all the components of the driver on kubernetes master.

Expand Down Expand Up @@ -79,9 +79,10 @@ GCE PD driver starts to support CSI Windows with [CSI Proxy] (https://github.com

| Feature | Stage | Min Kubernetes Master Version | Min Kubernetes Nodes Version | Min Driver Version | Deployment Overlay |
|-----------------|-------|-------------------------------|------------------------------|--------------------|--------------------|
| Snapshots | Beta | 1.17 | Any | v1.0.0 | stable-1-17, stable-1-18, stable-1-19, stable-master |
| Resize (Expand) | Beta | 1.16 | 1.16 | v0.7.0 | stable-1-17, stable-1-18, stable-1-19, stable-master |
| Windows* | Beta | 1.18 | 1.18 | v1.1.0 | stable-1-18, stable-1-19, stable-master |
| Snapshots | GA | 1.17 | Any | v1.0.0 | stable-1-21, stable-1-22, stable-1-23, stable-master |
| Clones | GA | 1.18 | Any | v1.4.0 | stable-1-21, stable-1-22, stable-1-23, stable-master |
| Resize (Expand) | Beta | 1.16 | 1.16 | v0.7.0 | stable-1-21, stable-1-22, stable-1-23, stable-master |
| Windows* | GA | 1.19 | 1.19 | v1.1.0 | stable-1-21, stable-1-22, stable-1-23, stable-master |

\* 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+

Expand Down
32 changes: 15 additions & 17 deletions deploy/kubernetes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,22 @@
The current structure for kustomization is as follows. Note that Windows support is currently an alpha feature.

* `base`: It contains the setup that is common to different driver versions.
* `controller_setup`: Includes cluster setup and controller yaml files.
* `node_setup`:
* Linux: Includes node yaml file and related setting that is only applicable for Linux.
* Windows: Includes node yaml file and related setting that is only applicable for Windows.
* `images`: It has a list of images for different versions.
* `stable-master`: Image list of a stable driver for latest k8s master.
* `alpha`: Image list containing features in development, in addition to images in `stable-master`. It also includes Windows images.
* `prow-gke-release-xxx`: Image list used for Prow tests.
* `overlays`: It has the k8s minor version-specific driver manifest bundle.
* `controller`: Includes cluster setup and controller yaml files.
* `node_linux`: Includes node yaml file and related setting that is only applicable for Linux.
* `node_windows`: Includes node yaml file and related setting that is only applicable for Windows.
* `images`: Contains driver and sidecar image versions for the various [overlays](deploy/kubernetes/overlays/).
* `stable-master`: Image versions for the stable-master overlay.
* `stable-{k8s-minor}`: Image versions for the stable-{k8s-minor} overlays.
* `prow-stable-sidecar-rc-master`: Image versions for the prow-stable-sidecar-rc-master overlay.
* `prow-canary-sidecar`: Image versions for the prow-canary-sidecar overlay.
* `overlays`: Contains various k8s resources driver manifest bundles used to deploy all the components of the driver.
* `stable-master`: Contains deployment specs of a stable driver for k8s master.
* `stable-{k8s-minor}`: Contains deployment specs of a stable driver for given k8s minor version release.
* `alpha`: Contains deployment specs for features in development. Both Linux and Windows are supported.
* `dev`: Based on alpha, and also contains the developer's specs for use in driver development.
* `noauth-debug`: Based on alpha, used for debugging purposes only, see docs/kubernetes/development.md.
* `prow-gke-release-staging-rc-master`: Used for prow tests. Contains deployment specs of a driver for latest k8s master.
* `prow-gke-release-staging-rc-{k8s-minor}`: Used for prow tests. Contains deployment specs of a driver for given k8s minor version release.
* `prow-gke-release-staging-rc-head`: Used for prow tests. Contains deployment specs of a driver with latest sidecar images, for latest k8s master.
* `stable`, `prow-gke-release-staging-rc`: Soon to be removed!
* `stable-{k8s-minor}`: Contains deployment specs of a stable driver for given k8s minor version release.
* `dev`: Based on stable-master, and also contains the developer's specs for use in driver development.
* `noauth` Based on stable-master, patches the [base controller configuration](deploy/kubernetes/base/controller.yaml) to remove any dependencies on service account keys.
* `noauth-debug`: Based on stable-master, used for debugging purposes only, see docs/kubernetes/development.md.
* `prow-stable-sidecar-rc-master`: Used for prow tests on OSS testgrid to test the latest sidecars. Contains deployment specs of a driver with k8s master branch, driver latest release candidate, and stable sidecars.
* `prow-canary-sidecar`: Used for prow tests on OSS testgrid to test release candidates when a new release is being cut. Contains deployment specs of a driver with k8s master branch, Kubernetes driver latest build, and canary sidecars.

## NVME support
udev folder under deploy/kubernetes contains google_nvme_id script required for NVME support. Source is downloaded from [GoogleCloudPlatform/guest-configs](https://github.com/GoogleCloudPlatform/guest-configs). README file in the folder contains the downloaded version.
Expand Down
Loading