Skip to content

Commit 64966a3

Browse files
committed
doc: add msi auth doc
1 parent 338f9e8 commit 64966a3

File tree

4 files changed

+34
-25
lines changed

4 files changed

+34
-25
lines changed

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
apiVersion: storage.k8s.io/v1
3+
kind: StorageClass
4+
metadata:
5+
name: blob
6+
provisioner: blob.csi.azure.com
7+
parameters:
8+
resourceGroup: EXISTING_RESOURCE_GROUP
9+
storageAccount: EXISTING_STORAGE_ACCOUNT
10+
containerName: EXISTING_CONTAINER_NAME
11+
# refer to https://github.com/Azure/azure-storage-fuse#environment-variables
12+
AzureStorageIdentityClientID:
13+
AzureStorageIdentityObjectID:
14+
AzureStorageIdentityResourceID:
15+
MSIEndpoint:
16+
AzureStorageSPNClientID:
17+
AzureStorageSPNTenantID:
18+
AzureStorageAADEndpoint:
19+
volumeBindingMode: Immediate
20+
mountOptions:
21+
- -o allow_other
22+
- --file-cache-timeout-in-seconds=120

docs/csi-dev.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,10 @@ helm repo index charts --url=https://raw.githubusercontent.com/kubernetes-sigs/b
116116
```
117117
FROM us.gcr.io/k8s-artifacts-prod/build-image/debian-base-amd64:v2.1.0
118118
RUN apt-get update && clean-install ca-certificates pkg-config libfuse-dev cmake libcurl4-gnutls-dev libgnutls28-dev uuid-dev libgcrypt20-dev wget
119-
# this is a workaround to install nfs-common and don't quit with error
120-
RUN apt update && apt install udev util-linux mount nfs-common -y || true
119+
RUN wget -O /tmp/packages-microsoft-prod.deb https://packages.microsoft.com/config/ubuntu/16.04/packages-microsoft-prod.deb && dpkg -i /tmp/packages-microsoft-prod.deb && apt-get update && apt install blobfuse fuse -y && rm -f /tmp/packages-microsoft-prod.deb
120+
RUN apt remove wget -y
121+
# this is a workaround to install nfs-common & nfs-kernel-server and don't quit with error
122+
RUN apt update && apt install nfs-common nfs-kernel-server -y || true
121123
LABEL maintainers="andyzhangx"
122124
LABEL description="Azure Blob Storage CSI driver"
123125
```

docs/driver-parameters.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
> parameter names are case-insensitive
33
44
### Dynamic Provisioning
5-
> get a [blobfuse example](../deploy/example/storageclass-blobfuse.yaml)
5+
> [blobfuse example](../deploy/example/storageclass-blobfuse.yaml)
66
7-
> get a `mountOptions` [example](../deploy/example/storageclass-blobfuse-mountoptions.yaml)
7+
> [blobfuse mountOptions example](../deploy/example/storageclass-blobfuse-mountoptions.yaml)
88
9-
> get a [nfs example](../deploy/example/storageclass-blob-nfs.yaml)
9+
> [blobfuse Managed Identity and Service Principal Name auth example](../deploy/example/storageclass-blobfuse-msi.yaml)
10+
11+
> [nfs example](../deploy/example/storageclass-blob-nfs.yaml)
1012
1113
Name | Meaning | Example | Mandatory | Default value
1214
--- | --- | --- | --- | ---
@@ -24,9 +26,9 @@ tags | [tags](https://docs.microsoft.com/en-us/azure/azure-resource-manager/mana
2426
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.
2527

2628
### Static Provisioning(bring your own storage container)
27-
> get an [example](../deploy/example/pv-blobfuse-csi.yaml)
28-
>
29-
> get a key vault [example](../deploy/example/keyvault/pv-blobfuse-csi-keyvault.yaml)
29+
> [blobfuse example](../deploy/example/pv-blobfuse-csi.yaml)
30+
31+
> [blobfuse key vault example](../deploy/example/keyvault/pv-blobfuse-csi-keyvault.yaml)
3032
3133
Name | Meaning | Available Value | Mandatory | Default value
3234
--- | --- | --- | --- | ---

0 commit comments

Comments
 (0)