Skip to content

Commit 24399a8

Browse files
committed
Add CSI Windows Suppoort Doc
add doc for csi windows support
1 parent 2a53287 commit 24399a8

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@ This driver supports only one topology key:
6464
`topology.gke.io/zone`
6565
that represents availability by zone (e.g. `us-central1-c`, etc.).
6666

67+
### CSI Windows Support
68+
69+
GCE PD driver starts to support CSI Windows (alpha) with version v1.0.*. It requires to install [CSI Proxy] (https://github.com/kubernetes-csi/csi-proxy) binary on each Windows node. The latest version of CSI Proxy is Beta. GCE PD driver start to support Beta CSI Proxy starting from v1.1.0. Starting Kubernetes 1.19, CSI Proxy binary is automatically installed during node start up. In Kubernetes 1.20, CSI Proxy will be running a windows service to improve its stablibity.
70+
6771
### Features in Development
6872

6973
| Feature | Stage | Min Kubernetes Master Version | Min Kubernetes Nodes Version | Min Driver Version | Deployment Overlay |
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Kubernetes CSI Windowos User Guide
2+
3+
>**Attention:** CSI Windows Beta is only available in the driver version v1.1.0+
4+
>**Attention:** CSI Windows Alpha is only available in the driver version v1.0.0-v1.0.*
5+
6+
### Install CSI Proxy binary
7+
CSI proxy can be installed as binary or run as a Windows service on each Windows node. Starting Kubernetes 1.19, [CSI Proxy Alpha](https://github.com/kubernetes-csi/csi-proxy/releases/tag/v0.1.0) binary is automatically installed during node start up. In Kubernetes 1.20, [CSI Proxy Beta.1 v0.2.1](https://github.com/kubernetes-csi/csi-proxy/releases/tag/v0.2.1) is installed and running as a windows service to improve its stablibity.
8+
9+
10+
### Install Driver with CSI Windows support
11+
12+
1. [One-time per project] Create GCP service account for the CSI driver and set required roles
13+
14+
```
15+
$ PROJECT=your-project-here # GCP project
16+
$ GCE_PD_SA_NAME=my-gce-pd-csi-sa # Name of the service account to create
17+
$ GCE_PD_SA_DIR=/my/safe/credentials/directory # Directory to save the service account key
18+
$ ./deploy/setup-project.sh
19+
```
20+
21+
2. Deploy driver to Kubernetes Cluster
22+
23+
```
24+
$ GCE_PD_SA_DIR=/my/safe/credentials/directory # Directory to get the service account key
25+
$ GCE_PD_DRIVER_VERSION=alpha # Currently alpha deploy Driver version with Windows Alpha support. Will add beta supporot to beta GCE_PD_DRIVER_VERSION deployment script.
26+
$ ./deploy/kubernetes/deploy-driver.sh
27+
```

0 commit comments

Comments
 (0)