Skip to content

Commit caec089

Browse files
authored
doc: add nfs support parameters
1 parent 9e2cd38 commit caec089

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

docs/driver-parameters.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,25 @@
22
> parameter names are case-insensitive
33
44
### Dynamic Provisioning
5-
> get a [example](../deploy/example/storageclass-blobfuse-csi.yaml)
6-
5+
> get a [blobfuse example](../deploy/example/storageclass-blobfuse-csi.yaml)
6+
77
> get a `mountOptions` [example](../deploy/example/storageclass-blobfuse-csi-mountoptions.yaml)
8+
9+
> get a [nfs example](../deploy/example/storageclass-blob-nfs.yaml)
810
911
Name | Meaning | Example | Mandatory | Default value
1012
--- | --- | --- | --- | ---
11-
skuName | blobfuse storage account type (alias: `storageAccountType`) | `Standard_LRS`, `Premium_LRS`, `Standard_GRS`, `Standard_RAGRS` | No | `Standard_LRS`
12-
location | specify the location in which blobfuse share will be created | `eastus`, `westus`, etc. | No | if empty, driver will use the same location name as current k8s cluster
13-
resourceGroup | specify the existing resource group name where the container is | existing resource group name | No | if empty, driver will use the same resource group name as current k8s cluster
14-
storageAccount | specify the storage account name in which blobfuse share will be created | STORAGE_ACCOUNT_NAME | No | if empty, driver will find a suitable storage account that matches `skuName` in the same resource group; if a storage account name is provided, it means that storage account must exist otherwise there would be error
13+
skuName | Azure storage account type (alias: `storageAccountType`) | `Standard_LRS`, `Premium_LRS`, `Standard_GRS`, `Standard_RAGRS` | No | `Standard_LRS`
14+
location | Azure location | `eastus`, `westus`, etc. | No | if empty, driver will use the same location name as current k8s cluster
15+
resourceGroup | Azure resource group name | existing resource group name | No | if empty, driver will use the same resource group name as current k8s cluster
16+
storageAccount | specify the Azure storage account name which has the blob container | STORAGE_ACCOUNT_NAME | No | if empty, driver will find a suitable storage account that matches `skuName` in the same resource group; if a storage account name is provided, storage account must exist
17+
protocol | specify blobfuse mount or NFSv3 mount | `fuse`, `nfs` | No | `fuse`
1518
containerName | specify the existing container name where blob storage will be created | existing container name | No | if empty, driver will create a new container name, starting with `pvc-fuse`
16-
server | specify azure storage account server address | existing server address, e.g. `accountname.privatelink.blob.core.windows.net` | No | if empty, driver will use default `accountname.blob.core.windows.net` or other sovereign cloud account address
19+
server | specify Azure storage account server address | existing server address, e.g. `accountname.privatelink.blob.core.windows.net` | No | if empty, driver will use default `accountname.blob.core.windows.net` or other sovereign cloud account address
1720

1821
- `fsGroup` securityContext setting
1922

20-
Blobfuse driver does not honor `fsGroup` securityContext setting, instead user could use `-o gid=1000` in `mountoptions` to set ownership, check [here](https://github.com/Azure/azure-storage-fuse#mount-options) for more mountoptions.
23+
Blobfuse driver does not honor `fsGroup` securityContext setting, instead user could use `-o gid=1000` in `mountoptions` to set ownership, check [here](https://github.com/Azure/Azure-storage-fuse#mount-options) for more mountoptions.
2124

2225
### Static Provisioning(bring your own storage container)
2326
> get an [example](../deploy/example/pv-blobfuse-csi.yaml)
@@ -28,8 +31,9 @@ Name | Meaning | Available Value | Mandatory | Default value
2831
--- | --- | --- | --- | ---
2932
volumeAttributes.containerName | existing container name | existing container name | Yes |
3033
volumeAttributes.storageAccountName | existing storage account name | existing storage account name | Yes |
34+
volumeAttributes.protocol | specify blobfuse mount or NFSv3 mount | `fuse`, `nfs` | No | `fuse`
3135
volumeAttributes.keyVaultURL | Azure Key Vault DNS name | existing Azure Key Vault DNS name | No |
3236
volumeAttributes.keyVaultSecretName | Azure Key Vault secret name | existing Azure Key Vault secret name | No |
3337
volumeAttributes.keyVaultSecretVersion | Azure Key Vault secret version | existing version | No |if empty, driver will use "current version"
34-
nodeStageSecretRef.name | secret name that stores storage account name and key(or sastoken) | existing kubernetes secret name | No |
38+
nodeStageSecretRef.name | secret name that stores storage account name and key(or sastoken) | existing Kubernetes secret name | No |
3539
nodeStageSecretRef.namespace | namespace where the secret is | k8s namespace | Yes |

0 commit comments

Comments
 (0)