Skip to content

Commit e108a4b

Browse files
Merge pull request #312890 from eh8/main
Fix default ACStor NVMe storage class name
2 parents 70cb7e0 + dbc5ec0 commit e108a4b

2 files changed

Lines changed: 28 additions & 18 deletions

File tree

articles/storage/container-storage/install-container-storage-aks.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Run the following command to create a new AKS cluster and install Azure Containe
106106
az aks create -n <cluster-name> -g <resource-group> --node-vm-size Standard_L8s_v3 --enable-azure-container-storage ephemeralDisk --generate-ssh-keys
107107
```
108108

109-
This command installs the installer, deploys the `ephemeralDisk` driver, and creates a default storage class. You can install and use both local NVMe and Elastic SAN by providing comma-separated values such as `ephemeralDisk,elasticSan`.
109+
This command installs the installer, deploys the local NVMe CSI driver, and creates a default storage class called `local-csi`. You can install and use both local NVMe and Elastic SAN by providing comma-separated values such as `ephemeralDisk,elasticSan`.
110110

111111
## Install Azure Container Storage on an existing AKS cluster
112112

@@ -128,7 +128,7 @@ Run the following command to enable Azure Container Storage on an existing AKS c
128128
az aks update -n <cluster-name> -g <resource-group> --enable-azure-container-storage elasticSan
129129
```
130130

131-
This command installs the installer, deploys the Elastic SAN CSI driver, and creates a default storage class. You can install and use both local NVMe and Elastic SAN by providing comma-separated values such as `ephemeralDisk,elasticSan`.
131+
This command installs the installer, deploys the Elastic SAN CSI driver, and creates a default storage class called `azuresan`. You can install and use both local NVMe and Elastic SAN by providing comma-separated values such as `ephemeralDisk,elasticSan`.
132132

133133
::: zone-end
134134

@@ -286,6 +286,16 @@ When it completes, the cluster has the Azure Container Storage installer compone
286286

287287
## Verify installation
288288

289+
### Connect to the AKS cluster
290+
291+
Before running the verification commands, make sure your local kubeconfig is set to the target cluster:
292+
293+
```azurecli
294+
az aks get-credentials --resource-group <resource-group-name> --name <cluster-name>
295+
```
296+
297+
If you manage multiple clusters, add `--overwrite-existing` to replace an existing context or use `--context` to set a unique context name.
298+
289299
### Verify installer (installer-only mode)
290300

291301
After an installer-only enable, verify that the installer is present:
@@ -314,7 +324,7 @@ Example output:
314324
```output
315325
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
316326
azuresan san.csi.azure.com Delete Immediate false 4d7h
317-
local localdisk.csi.acstor.io Delete WaitForFirstConsumer true 4d5h
327+
local-csi localdisk.csi.acstor.io Delete WaitForFirstConsumer true 4d5h
318328
```
319329

320330
### Verify driver installation

articles/storage/container-storage/use-container-storage-with-local-disk.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,15 @@ For more information, refer to [Best practices for ephemeral NVMe data disks in
6969

7070
If you don't already have Azure Container Storage installed, [install it](install-container-storage-aks.md).
7171

72-
Azure Container Storage (version 2.x.x) presents local NVMe as a standard Kubernetes storage class. Create the `local` storage class once per cluster and reuse it for both generic ephemeral volumes and persistent volume claims.
72+
Azure Container Storage (version 2.x.x) presents local NVMe as a standard Kubernetes storage class. Create the `local-csi` storage class once per cluster and reuse it for both generic ephemeral volumes and persistent volume claims.
7373

7474
1. Use your favorite text editor to create a YAML manifest file such as `storageclass.yaml`, then paste in the following specification.
7575

7676
```yaml
7777
apiVersion: storage.k8s.io/v1
7878
kind: StorageClass
7979
metadata:
80-
name: local
80+
name: local-csi
8181
provisioner: localdisk.csi.acstor.io
8282
reclaimPolicy: Delete
8383
volumeBindingMode: WaitForFirstConsumer
@@ -109,9 +109,9 @@ Alternatively, you can create the storage class using Terraform.
109109
config_path = "~/.kube/config"
110110
}
111111
112-
resource "kubernetes_storage_class_v1" "local" {
112+
resource "kubernetes_storage_class_v1" "local_csi" {
113113
metadata {
114-
name = "local"
114+
name = "local-csi"
115115
}
116116
117117
storage_provisioner = "localdisk.csi.acstor.io"
@@ -134,19 +134,19 @@ Alternatively, you can create the storage class using Terraform.
134134
Run the following command to verify that the storage class is created:
135135

136136
```azurecli
137-
kubectl get storageclass local
137+
kubectl get storageclass local-csi
138138
```
139139

140140
You should see output similar to:
141141

142142
```output
143-
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
144-
local localdisk.csi.acstor.io Delete WaitForFirstConsumer true 10s
143+
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
144+
local-csi localdisk.csi.acstor.io Delete WaitForFirstConsumer true 10s
145145
```
146146

147147
## Create and attach generic ephemeral volumes
148148

149-
Follow these steps to create and attach a generic ephemeral volume using Azure Container Storage. Make sure Azure Container Storage is [installed](install-container-storage-aks.md) and the `local` storage class exists before you continue.
149+
Follow these steps to create and attach a generic ephemeral volume using Azure Container Storage. Make sure Azure Container Storage is [installed](install-container-storage-aks.md) and the `local-csi` storage class exists before you continue.
150150

151151
### Deploy a pod with generic ephemeral volume
152152

@@ -178,7 +178,7 @@ Create a pod using [Fio](https://github.com/axboe/fio) (Flexible I/O Tester) for
178178
spec:
179179
volumeMode: Filesystem
180180
accessModes: ["ReadWriteOnce"]
181-
storageClassName: local
181+
storageClassName: local-csi
182182
resources:
183183
requests:
184184
storage: 10Gi
@@ -211,7 +211,7 @@ While generic ephemeral volumes are recommended for ephemeral storage, Azure Con
211211
> [!NOTE]
212212
> Azure Container Storage (version 2.x.x) uses the new annotation `localdisk.csi.acstor.io/accept-ephemeral-storage: "true"` instead of the previous `acstor.azure.com/accept-ephemeral-storage: "true"`.
213213

214-
Make sure Azure Container Storage is [installed](install-container-storage-aks.md) and the `local` storage class you created earlier is available before deploying workloads that use it.
214+
Make sure Azure Container Storage is [installed](install-container-storage-aks.md) and the `local-csi` storage class you created earlier is available before deploying workloads that use it.
215215

216216
### Deploy a stateful set with persistent volumes
217217

@@ -259,7 +259,7 @@ spec:
259259
localdisk.csi.acstor.io/accept-ephemeral-storage: "true"
260260
spec:
261261
accessModes: ["ReadWriteOnce"]
262-
storageClassName: local
262+
storageClassName: local-csi
263263
resources:
264264
requests:
265265
storage: 10Gi
@@ -289,8 +289,8 @@ You should see output similar to this example:
289289

290290
```output
291291
NAME STORAGE_CLASS CAPACITY NODE
292-
csisc-2pkx4 local 1373172Mi aks-storagepool-31410930-vmss000001
293-
csisc-gnmm9 local 1373172Mi aks-storagepool-31410930-vmss000000
292+
csisc-2pkx4 local-csi 1373172Mi aks-storagepool-31410930-vmss000001
293+
csisc-gnmm9 local-csi 1373172Mi aks-storagepool-31410930-vmss000000
294294
```
295295

296296
If you encounter empty capacity output, confirm that a StorageClass for `localdisk.csi.acstor.io` exists. The `csistoragecapacities.storage.k8s.io` resource is only generated after a StorageClass for `localdisk.csi.acstor.io` exists.
@@ -309,10 +309,10 @@ az aks nodepool scale --cluster-name <cluster-name> --name <nodepool-name> --res
309309

310310
To clean up storage resources, you must first delete all PersistentVolumeClaims and/or PersistentVolumes. Deleting the Azure Container Storage StorageClass doesn't automatically remove your existing PersistentVolumes/PersistentVolumeClaims.
311311

312-
To delete a storage class named `local`, run the following command:
312+
To delete a storage class named `local-csi`, run the following command:
313313

314314
```azurecli
315-
kubectl delete storageclass local
315+
kubectl delete storageclass local-csi
316316
```
317317

318318
## See also

0 commit comments

Comments
 (0)