doc: promote NFS feature to beta

kubernetes-sigs · Jan 2, 2021 · 88297af · 88297af
1 parent 82cb2d4
commit 88297af
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 28 deletions.
diff --git a/deploy/example/daemonset.yaml b/deploy/example/daemonset.yaml
@@ -28,11 +28,11 @@ spec:
         kubernetes.io/os: linux
       containers:
         - name: nginx
-          image: mcr.microsoft.com/oss/nginx/nginx:1.17.3-alpine
+          image: mcr.microsoft.com/oss/nginx/nginx:1.19.5
           command:
-            - "/bin/sh"
+            - "/bin/bash"
             - "-c"
-            - while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done
+            - set -euo pipefail; while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done
           volumeMounts:
             - name: azurefile
               mountPath: "/mnt/azurefile"

diff --git a/deploy/example/deployment.yaml b/deploy/example/deployment.yaml
@@ -32,11 +32,11 @@ spec:
         "kubernetes.io/os": linux
       containers:
         - name: deployment-azurefile
-          image: mcr.microsoft.com/oss/nginx/nginx:1.17.3-alpine
+          image: mcr.microsoft.com/oss/nginx/nginx:1.19.5
           command:
-            - "/bin/sh"
+            - "/bin/bash"
             - "-c"
-            - while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done
+            - set -euo pipefail; while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done
           volumeMounts:
             - name: azurefile
               mountPath: "/mnt/azurefile"

diff --git a/deploy/example/nfs/README.md b/deploy/example/nfs/README.md
@@ -1,10 +1,11 @@
 ## NFS support
 [NFS 4.1 support for Azure Files](https://azure.microsoft.com/en-us/blog/nfs-41-support-for-azure-files-is-now-in-preview/preview/) is now in Public Preview. This service is optimized for random access workloads with in-place data updates and provides full POSIX file system support. This page shows how to use NFS feature by Azure File CSI driver on Azure Kubernetes cluster.
 
-#### Feature Status: Alpha
+#### Feature Status: Beta
 > supported OS: Linux
 
-#### Supported CSI driver version: `v0.8.0`
+#### Supported CSI driver version: `v0.9.0`
+> storage account dynamic provisioning is supported from `v0.10.0`.
 
 #### [Available regions](https://aka.ms/azurefiles/nfs/preview/regions)
 We are continually adding more regions. Latest region list is available on [Azure NFS documentation](https://aka.ms/azurefiles/nfs/preview/regions)
@@ -17,14 +18,15 @@ az feature register --name AllowNfsFileShares --namespace Microsoft.Storage
 az feature list -o table --query "[?contains(name, 'Microsoft.Storage/AllowNfsFileShares')].{Name:name,State:properties.state}"
 az provider register --namespace Microsoft.Storage
 ```
- - Create a `Premium_LRS` Azure storage account with following configurations to support NFS share
+ - [Optional] Create a `Premium_LRS` Azure storage account with following configurations to support NFS share
    - account kind: `FileStorage`
    - secure transfer required(enable HTTPS traffic only): `false`
    - select virtual network of agent nodes in `Firewalls and virtual networks`
+   - specify `storageAccount` in below storage class `parameters`
 
 #### How to use NFS feature
  - Create an Azure File storage class
-> specify `storageAccount` and `protocol: nfs` in storage class `parameters`
+> specify `protocol: nfs` in storage class `parameters`
 > </br>for more details, refer to [driver parameters](../../../docs/driver-parameters.md)
 ```yaml
 apiVersion: storage.k8s.io/v1
@@ -33,9 +35,7 @@ metadata:
   name: azurefile-csi-nfs
 provisioner: file.csi.azure.com
 parameters:
-  resourceGroup: EXISTING_RESOURCE_GROUP_NAME  # optional, only set this when storage account is not in the same resource group as agent node
-  storageAccount: EXISTING_STORAGE_ACCOUNT_NAME
-  protocol: nfs  # use "fsType: nfs" in v0.8.0
+  protocol: nfs
 ```
 
 run following commands to create a storage class:

diff --git a/deploy/example/nfs/statefulset.yaml b/deploy/example/nfs/statefulset.yaml
@@ -17,11 +17,11 @@ spec:
         "kubernetes.io/os": linux
       containers:
         - name: statefulset-azurefile
-          image: mcr.microsoft.com/oss/nginx/nginx:1.17.3-alpine
+          image: mcr.microsoft.com/oss/nginx/nginx:1.19.5
           command:
-            - "/bin/sh"
+            - "/bin/bash"
             - "-c"
-            - while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done
+            - set -euo pipefail; while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done
           volumeMounts:
             - name: persistent-storage
               mountPath: /mnt/azurefile

diff --git a/deploy/example/nginx-pod-azurefile.yaml b/deploy/example/nginx-pod-azurefile.yaml
@@ -7,16 +7,16 @@ spec:
   nodeSelector:
     "kubernetes.io/os": linux
   containers:
-    - image: mcr.microsoft.com/oss/nginx/nginx:1.17.3-alpine
+    - image: mcr.microsoft.com/oss/nginx/nginx:1.19.5
       name: nginx-azurefile
       command:
-        - "/bin/sh"
+        - "/bin/bash"
         - "-c"
-        - while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done
+        - set -euo pipefail; while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done
       volumeMounts:
-        - name: azurefile01
+        - name: persistent-storage
           mountPath: "/mnt/azurefile"
   volumes:
-    - name: azurefile01
+    - name: persistent-storage
       persistentVolumeClaim:
         claimName: pvc-azurefile
diff --git a/deploy/example/statefulset.yaml b/deploy/example/statefulset.yaml
@@ -17,11 +17,11 @@ spec:
         "kubernetes.io/os": linux
       containers:
         - name: statefulset-azurefile
-          image: mcr.microsoft.com/oss/nginx/nginx:1.17.3-alpine
+          image: mcr.microsoft.com/oss/nginx/nginx:1.19.5
           command:
-            - "/bin/sh"
+            - "/bin/bash"
             - "-c"
-            - while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done
+            - set -euo pipefail; while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done
           volumeMounts:
             - name: persistent-storage
               mountPath: /mnt/azurefile

diff --git a/deploy/example/storageclass-azurefile-nfs.yaml b/deploy/example/storageclass-azurefile-nfs.yaml
@@ -5,8 +5,7 @@ metadata:
   name: azurefile-csi-nfs
 provisioner: file.csi.azure.com
 parameters:
-  storageAccount: EXISTING_STORAGE_ACCOUNT_NAME
-  protocol: nfs  # use "fsType: nfs" in v0.8.0
+  protocol: nfs
 reclaimPolicy: Delete
 volumeBindingMode: Immediate
 allowVolumeExpansion: true
diff --git a/deploy/example/windows/README.md b/deploy/example/windows/README.md
@@ -1,7 +1,7 @@
 # CSI Driver on Windows
 
-## Feature Status: Alpha
-CSI on Windows support is an alpha feature since Kubernetes v1.18, refer to [Windows-CSI-Support](https://github.com/kubernetes/enhancements/blob/master/keps/sig-windows/20190714-windows-csi-support.md) for more details.
+## Feature Status: Beta
+Refer to [Windows-CSI-Support](https://github.com/kubernetes/enhancements/blob/master/keps/sig-windows/20190714-windows-csi-support.md) for more details.
 
 ## Prerequisite
 - Install CSI-Proxy on Windows Node