Skip to content

doc: refine doc #816

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
Jan 18, 2023
Merged

doc: refine doc #816

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
10 changes: 6 additions & 4 deletions deploy/example/e2e_usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,19 +82,21 @@ kubectl create secret generic azure-secret --from-literal azurestorageaccountnam
apiVersion: v1
kind: PersistentVolume
metadata:
annotations:
pv.kubernetes.io/provisioned-by: blob.csi.azure.com
name: pv-blob
spec:
capacity:
storage: 10Gi
accessModes:
- ReadWriteMany
persistentVolumeReclaimPolicy: Retain # "Delete" is not supported in static provisioning
persistentVolumeReclaimPolicy: Retain
csi:
driver: blob.csi.azure.com
readOnly: false
# make sure volumeid is unique for every identical storage blob container in the cluster
# character `#` is reserved for internal use and cannot be used in volumehandle
volumeHandle: unique-volumeid
# make sure volumeid is unique for every storage blob container in the cluster
# the # character is reserved for internal use
volumeHandle: account-name_container-name
volumeAttributes:
containerName: EXISTING_CONTAINER_NAME
nodeStageSecretRef:
Expand Down
10 changes: 6 additions & 4 deletions deploy/example/pv-blobfuse-auth.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,25 @@
apiVersion: v1
kind: PersistentVolume
metadata:
annotations:
pv.kubernetes.io/provisioned-by: blob.csi.azure.com
name: pv-blob
spec:
capacity:
storage: 10Gi
accessModes:
- ReadWriteMany
persistentVolumeReclaimPolicy: Retain # "Delete" is not supported in static provisioning
persistentVolumeReclaimPolicy: Retain
storageClassName: blob-fuse
mountOptions:
- -o allow_other
- --file-cache-timeout-in-seconds=120
csi:
driver: blob.csi.azure.com
readOnly: false
# make sure volumeid is unique for every identical storage blob container in the cluster
# character `#` is reserved for internal use and cannot be used in volumehandle
volumeHandle: unique-volumeid
# make sure volumeid is unique for every storage blob container in the cluster
# the # character is reserved for internal use
volumeHandle: account-name_container-name
volumeAttributes:
resourceGroup: EXISTING_RESOURCE_GROUP_NAME
storageAccount: EXISTING_STORAGE_ACCOUNT_NAME
Expand Down
10 changes: 6 additions & 4 deletions deploy/example/pv-blobfuse-csi-keyvault.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,22 @@
apiVersion: v1
kind: PersistentVolume
metadata:
annotations:
pv.kubernetes.io/provisioned-by: blob.csi.azure.com
name: pv-blob-keyvault
spec:
capacity:
storage: 10Gi
accessModes:
- ReadWriteMany
persistentVolumeReclaimPolicy: Retain # If set as "Delete" container would be removed after pvc deletion
persistentVolumeReclaimPolicy: Retain
storageClassName: blob-fuse
csi:
driver: blob.csi.azure.com
readOnly: false
# make sure volumeid is unique for every identical storage blob container in the cluster
# character `#` is reserved for internal use and cannot be used in volumehandle
volumeHandle: unique-volumeid
# make sure volumeid is unique for every storage blob container in the cluster
# the # character is reserved for internal use
volumeHandle: account-name_container-name
volumeAttributes:
containerName: EXISTING_CONTAINER_NAME
storageAccountName: EXISTING_STORAGE_ACCOUNT_NAME
Expand Down
10 changes: 6 additions & 4 deletions deploy/example/pv-blobfuse-csi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,25 @@
apiVersion: v1
kind: PersistentVolume
metadata:
annotations:
pv.kubernetes.io/provisioned-by: blob.csi.azure.com
name: pv-blob
spec:
capacity:
storage: 10Gi
accessModes:
- ReadWriteMany
persistentVolumeReclaimPolicy: Retain # If set as "Delete" container would be removed after pvc deletion
persistentVolumeReclaimPolicy: Retain
storageClassName: blob-fuse
mountOptions:
- -o allow_other
- --file-cache-timeout-in-seconds=120
csi:
driver: blob.csi.azure.com
readOnly: false
# make sure volumeid is unique for every identical storage blob container in the cluster
# character `#` is reserved for internal use and cannot be used in volumehandle
volumeHandle: unique-volumeid
# make sure volumeid is unique for every storage blob container in the cluster
# the # character is reserved for internal use
volumeHandle: account-name_container-name
volumeAttributes:
resourceGroup: EXISTING_RESOURCE_GROUP_NAME
storageAccount: EXISTING_STORAGE_ACCOUNT_NAME
Expand Down
10 changes: 6 additions & 4 deletions deploy/example/pv-blobfuse-nfs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,22 @@
apiVersion: v1
kind: PersistentVolume
metadata:
annotations:
pv.kubernetes.io/provisioned-by: blob.csi.azure.com
name: pv-blob
spec:
capacity:
storage: 10Gi
accessModes:
- ReadWriteMany
persistentVolumeReclaimPolicy: Retain # If set as "Delete" container would be removed after pvc deletion
persistentVolumeReclaimPolicy: Retain
storageClassName: blob-nfs
csi:
driver: blob.csi.azure.com
readOnly: false
# make sure volumeid is unique for every identical storage blob container in the cluster
# character `#` is reserved for internal use and cannot be used in volumehandle
volumeHandle: unique-volumeid
# make sure volumeid is unique for every storage blob container in the cluster
# the # character is reserved for internal use
volumeHandle: account-name_container-name
volumeAttributes:
resourceGroup: EXISTING_RESOURCE_GROUP_NAME
storageAccount: EXISTING_STORAGE_ACCOUNT_NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/driver-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ pvc-92a4d7f2-f23b-4904-bad4-2cbfcff6e388
Name | Meaning | Available Value | Mandatory | Default value
--- | --- | --- | --- | ---
volumeHandle | Specify a value the driver can use to uniquely identify the storage blob container in the cluster. | A recommended way to produce a unique value is to combine the globally unique storage account name and container name: {account-name}_{container-name}. Note: The # character is reserved for internal use and can't be used in a volume handle. | Yes |
volumeHandle | Specify a value the driver can use to uniquely identify the storage blob container in the cluster. | A recommended way to produce a unique value is to combine the globally unique storage account name and container name: {account-name}_{container-name}. Note: the # character is reserved for internal use. | Yes |
volumeAttributes.resourceGroup | Azure resource group name | existing resource group name | No | if empty, driver will use the same resource group name as current k8s cluster
volumeAttributes.storageAccount | existing storage account name | existing storage account name | Yes |
volumeAttributes.containerName | existing container name | existing container name | Yes |
Expand Down