Skip to content

Adding Kustomize structure in deployment README #562

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.

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
Aug 17, 2020
Merged
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions deploy/kubernetes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# PD CSI Driver Deployment in Kubernetes

## Kustomize Structure

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`: image list of a stable driver release. Currently only has image list for Linux stable version.
* `alpha`: image list containing features in development, in addition to images in stable. It also includes Windows images.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe mention the reason windows images are only included here because the support for windows is still alpha?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a line up top

* `dev`: based on alpha, and also contains the developer's image for use in driver development.
* `prow-gke-release-xxx`: image list used for Prow tests. Currently only Linux is supported.
* `overlays`: it has the version-specific setup. Each overlay corresponds to image lists with the matching name.
* `stable`: contains deployment specs of a stable driver release. Currently only Linux is supported.
* `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.
* `prow-gke-release-xxx`: based on stable, and contains specs for Prow tests. Currently only Linux is supported.