Azure File CSI Driver
The Azure File CSI driver for IBM Cloud Satellite® implements CSI specification so that container orchestration tools can manage the lifecycle of Azure File volumes.
For an overview of the available features of the Azure File CSI driver, see Features.
The Azure File CSI driver template for Satellite is currently available for cluster versions 4.7 and later.
Before you can deploy storage templates to clusters in your location, make sure you set up Satellite Config by selecting the Enable cluster admin access for Satellite Config option in the console or including the --enable-config-admin
option when you create your cluster.
You cannot customize your storage classes because Satellite Config overwrites your changes.
You cannot scope Satellite storage service to resource groups. However, if you are scoping other resources such as location and cluster to resource groups, you need to add Satellite reader and link administrator role for all resources in the account.
Prerequisites for using Azure File
Set up Azure File storage for Satellite clusters by creating a storage configuration in your location. When you assign a storage configuration to your clusters, the storage drivers of the selected storage provider are installed in your cluster.
To use the Azure File CSI driver storage template, complete the following tasks.
-
Create an Azure location by using the location template or manually adding Azure hosts to Satellite. If you choose to manually assign hosts, you must label your worker nodes before creating your storage configuration.
-
Create a Satellite cluster that runs on compute hosts in Azure. Make sure that you select the Enable cluster admin access for Satellite Config option when you create the cluster. If you don't enable Administrator (admin) access for Satellite Config when creating your cluster, you must re-create your cluster and enable admin access before you can deploy storage.
Optional: Labeling your worker nodes when using Azure File
Complete the following steps to add the required labels to your worker nodes for the Azure File CSI driver template.
If you manually assigned your Azure hosts to your location and did not use an automated deployment such as deploying from the console or a Terraform template, then you must label your worker nodes before creating your storage configuration.
-
List your Azure worker nodes and make a note of the
name
of each node.oc get nodes
-
Get the details of each node and make a note of the
zone
that the node is in. For example:eastus-1
.oc get nodes NODE-NAME -o yaml | grep zone
-
Label your Azure worker nodes with the
zone
value that you retrieved earlier. Replace<node_name>
and<zone>
with the node name and zone of your worker nodes. For example, if you have a worker node in zone:eastus-1
, use the following commands to addeastus-1
as a label to the worker node in theeastus-1
zone.oc label node <node_name> topology.kubernetes.io/zone- oc label node <node_name> topology.kubernetes.io/zone=<zone> --overwrite
-
Repeat the previous steps for each worker node.
-
Sign in to your Azure account and retrieve the required parameters. For more information about the parameters, see the parameter reference.
Creating and assigning a configuration in the console
-
Review the parameter reference.
-
From the Locations console, select the location where you want to create a storage configuration.
-
Select Storage > Create storage configuration
-
Enter a name for your configuration.
-
Select the Storage type.
-
Select the Version and click Next
-
If the Storage type that you selected accepts custom parameters, enter them on the Parameters tab.
-
If the Storage type that you selected requires secrets, enter them on the Secrets tab.
-
On the Storage classes tab, review the storage classes that are deployed by the configuration or create a custom storage class.
-
On the Assign to service tab, select the service that you want to assign your configuration to.
-
Click Complete to assign your storage configuration.
Creating a configuration in the CLI
-
Review the parameter reference for the template version that you want to use.
-
Log in to the IBM Cloud CLI.
ibmcloud login
-
List your Satellite locations and note the
Managed from
column.ibmcloud sat location ls
-
Target the
Managed from
region of your Satellite location. For example, forwdc
targetus-east
. For more information, see Satellite regions.ibmcloud target -r us-east
-
If you use a resource group other than
default
, target it.ibmcloud target -g <resource-group>
-
Copy one of the following example command for the template version that you want to use. For more information about the command, see
ibmcloud sat storage config create
in the command reference.Example command to create a version 1.9.0 configuration.
ibmcloud sat storage config create --location LOCATION --name NAME --template-name azurefile-csi-driver --template-version 1.9.0 --param "tenantId=TENANTID" --param "subscriptionId=SUBSCRIPTIONID" --param "aadClientId=AADCLIENTID" --param "location=LOCATION" --param "aadClientSecret=AADCLIENTSECRET" --param "resourceGroup=RESOURCEGROUP" --param "vmType=VMTYPE" --param "securityGroupName=SECURITYGROUPNAME" --param "vnetName=VNETNAME" --param "subnetName=SUBNETNAME"
Example command to create a version 1.18.0 configuration.
ibmcloud sat storage config create --location LOCATION --name NAME --template-name azurefile-csi-driver --template-version 1.18.0 --param "tenantId=TENANTID" --param "subscriptionId=SUBSCRIPTIONID" --param "aadClientId=AADCLIENTID" --param "location=LOCATION" --param "aadClientSecret=AADCLIENTSECRET" --param "resourceGroup=RESOURCEGROUP" --param "vmType=VMTYPE" --param "securityGroupName=SECURITYGROUPNAME" --param "vnetName=VNETNAME" --param "subnetName=SUBNETNAME"
Example command to create a version 1.22.0 configuration.
ibmcloud sat storage config create --location LOCATION --name NAME --template-name azurefile-csi-driver --template-version 1.22.0 --param "tenantId=TENANTID" --param "subscriptionId=SUBSCRIPTIONID" --param "aadClientId=AADCLIENTID" --param "location=LOCATION" --param "aadClientSecret=AADCLIENTSECRET" --param "resourceGroup=RESOURCEGROUP" --param "vmType=VMTYPE" --param "securityGroupName=SECURITYGROUPNAME" --param "vnetName=VNETNAME" --param "subnetName=SUBNETNAME"
-
Customize the command based on the settings that you want to use.
-
Run the command to create a configuration.
-
Verify your configuration was created.
ibmcloud sat storage config get --config CONFIG
Creating a configuration in the API
-
Generate an API key, then request a refresh token. For more information, see Generating an IBM Cloud IAM token by using an API key.
-
Review the parameter reference for the template version that you want to use.
-
Copy one of the following example requests and replace the variables that you want to use.
Example request to create a version 1.9.0 configuration.
curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createStorageConfigurationByController" -H "accept: application/json" -H "Authorization: TOKEN" -H "Content-Type: application/json" -d "{ \"config-name\": \"string\", \"controller\": \"string\", \"storage-class-parameters\": [ { \"additionalProp1\": \"string\", \"additionalProp2\": \"string\", \"additionalProp3\": \"string\" } ], \"storage-template-name\": \"azurefile-csi-driver\", \"storage-template-version\": \"1.9.0\", \"update-assignments\": true, \"user-config-parameters\": { \"entry.name\": \"LOCATION\", { \"entry.name\": \"RESOURCEGROUP\", { \"entry.name\": \"VMTYPE\", { \"entry.name\": \"SECURITYGROUPNAME\", { \"entry.name\": \"VNETNAME\", { \"entry.name\": \"SUBNETNAME\",\"user-secret-parameters\": { \"entry.name\": \"TENANTID\",{ \"entry.name\": \"SUBSCRIPTIONID\",{ \"entry.name\": \"AADCLIENTID\",{ \"entry.name\": \"AADCLIENTSECRET\",}
Example request to create a version 1.18.0 configuration.
curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createStorageConfigurationByController" -H "accept: application/json" -H "Authorization: TOKEN" -H "Content-Type: application/json" -d "{ \"config-name\": \"string\", \"controller\": \"string\", \"storage-class-parameters\": [ { \"additionalProp1\": \"string\", \"additionalProp2\": \"string\", \"additionalProp3\": \"string\" } ], \"storage-template-name\": \"azurefile-csi-driver\", \"storage-template-version\": \"1.18.0\", \"update-assignments\": true, \"user-config-parameters\": { \"entry.name\": \"LOCATION\", { \"entry.name\": \"RESOURCEGROUP\", { \"entry.name\": \"VMTYPE\", { \"entry.name\": \"SECURITYGROUPNAME\", { \"entry.name\": \"VNETNAME\", { \"entry.name\": \"SUBNETNAME\",\"user-secret-parameters\": { \"entry.name\": \"TENANTID\",{ \"entry.name\": \"SUBSCRIPTIONID\",{ \"entry.name\": \"AADCLIENTID\",{ \"entry.name\": \"AADCLIENTSECRET\",}
Example request to create a version 1.22.0 configuration.
curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createStorageConfigurationByController" -H "accept: application/json" -H "Authorization: TOKEN" -H "Content-Type: application/json" -d "{ \"config-name\": \"string\", \"controller\": \"string\", \"storage-class-parameters\": [ { \"additionalProp1\": \"string\", \"additionalProp2\": \"string\", \"additionalProp3\": \"string\" } ], \"storage-template-name\": \"azurefile-csi-driver\", \"storage-template-version\": \"1.22.0\", \"update-assignments\": true, \"user-config-parameters\": { \"entry.name\": \"LOCATION\", { \"entry.name\": \"RESOURCEGROUP\", { \"entry.name\": \"VMTYPE\", { \"entry.name\": \"SECURITYGROUPNAME\", { \"entry.name\": \"VNETNAME\", { \"entry.name\": \"SUBNETNAME\",\"user-secret-parameters\": { \"entry.name\": \"TENANTID\",{ \"entry.name\": \"SUBSCRIPTIONID\",{ \"entry.name\": \"AADCLIENTID\",{ \"entry.name\": \"AADCLIENTSECRET\",}
Creating an assignment in the CLI
-
List your storage configurations and make a note of the storage configuration that you want to assign to your clusters.
ibmcloud sat storage config ls
-
Get the ID of the cluster, cluster group, or service that you want to assign storage to.
To make sure that your cluster is registered with Satellite Config or to create groups, see Setting up clusters to use with Satellite Config.
Example command to list cluster groups.
ibmcloud sat group ls
Example command to list clusters.
ibmcloud oc cluster ls --provider satellite
Example command to list Satellite services.
ibmcloud sat service ls --location <location>
-
Assign your storage configuration to the cluster, group, or service that you retrieved earlier. For more information, see the
ibmcloud sat storage assignment create
command.Example command to assign a configuration to a cluster group.
ibmcloud sat storage assignment create --group GROUP --config CONFIG --name NAME
Example command to assign a configuration to a cluster.
ibmcloud sat storage assignment create --cluster CLUSTER --config CONFIG --name NAME
Example command to assign a configuration to a service cluster.
ibmcloud sat storage assignment create --service-cluster-id CLUSTER --config CONFIG --name NAME
-
Verify that your assignment is created.
ibmcloud sat storage assignment ls (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)
Creating a storage assignment in the API
-
Copy one of the following example requests.
Example request to assign a configuration to a cluster.
curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createAssignmentByCluster" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d "{ \"channelName\": \"CONFIGURATION-NAME\", \"cluster\": \"CLUSTER-ID\", \"controller\": \"LOCATION-ID\", \"name\": \"ASSIGNMENT-NAME\"}"
Example request to assign configuration to a cluster group.
curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createAssignment" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d "{ \"channelName\": \"CONFIGURATION-NAME\", \"cluster\": \"string\", \"groups\": [ \"CLUSTER-GROUP\" ], \"name\": \"ASSIGNMENT-NAME\"}"
-
Replace the variables with your details and run the request.
-
Verify the assignment was created by listing your assignments.
curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignments" -H "accept: application/json" -H "Authorization: Bearer TOKEN"
Updating storage assignments in the console
You can use the Satellite console to apply the latest patch updates to your assignments.
-
From the Locations page in the Satellite console, select your location.
-
Click the Storage tab to view your configurations.
-
Click the configuration you want to update.
-
Click information Information (i) icon to apply the latest revision or patch.
-
Optional: Enable automatic patch updates for your storage assignment. Enabling automatic patch updates ensures that your assignment always has the latest security fixes.
If you enable automatic patch updates, you must still apply major updates manually.
Manually upgrading assignments in the CLI
Upgrade an assignment to use the latest storage template revision.
-
List your Satellite storage assignments, make a note of the Satellite assignment you want to upgrade.
ibmcloud sat storage assignment ls
-
List the Satellite storage templates to see the latest available versions.
ibmcloud sat storage template ls
-
Upgrade the Satellite assignment.
Example command to upgrade an assignment.
ibmcloud sat storage assignment upgrade --assignment ASSIGNMENT
Enabling automatic patch updates for configurations and assignments in the CLI
You can use the sat storage assignment autopatch enable
CLI to enable automatic patch updates for your assignments. Enabling automatic patch updates applies the latest storage template revisions (patches) automatically. You must
still apply major updates manually.
-
List your Satellite storage configurations. Make a note of the configuration ID.
ibmcloud sat storage assignment ls
-
Run one of the following example commands to enable automatic patch updates for your configuration and its associated assignments. Enter the configuration ID that you retrieved in the previous step.
Example command to enable automatic patch updates for an assignment.
ibmcloud sat storage assignment autopatch enable --config CONFIG (--all | --assignment ASSIGNMENT-ID [--assignment ASSIGNMENT-ID])
Example command to enable automatic patch updates for all storage assignments under a given configuration.
ibmcloud sat storage assignment autopatch enable --config CONFIG --all
Example command to disable automatic patch updates for all assignments under a specific configuration.
ibmcloud sat storage assignment autopatch disable --config CONFIG --all
Example command to disable automatic patch updates for an single assignment and a specific configuration.
ibmcloud sat storage assignment autopatch disable --config CONFIG --assignment ASSIGNMENT-ID
Example command to disable automatic patch updates for an multiple assignment and a specific configuration.
ibmcloud sat storage assignment autopatch disable --config CONFIG --assignment ASSIGNMENT-ID --assignment ASSIGNMENT-ID
Upgrading a configuration and assignments in the API
You can use the /v2/storage/satellite/updateAssignment
API to update your assignments with new clusters
or cluster groups. Set updateConfigVersion
to true
to apply the revision update.
-
Copy the following example request and replace the variables for the cluster groups and assignments that you want to update.
curl -X PATCH "https://containers.cloud.ibm.com/global/v2/storage/satellite/updateAssignment" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d "{ \"groups\": [ \"CLUSTER-GROUPS\" ], \"name\": \"ASSIGNMENT-NAME\", \"updateConfigVersion\": true, \"uuid\": \"ASSIGNMENT-ID\"}"
-
Run the request.
-
Get the details of you assignment to verify the update.
curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignment?uuid=ASSIGNMENT-ID" -H "accept: application/json" -H "Authorization: Bearer TOKEN"
Enabling automatic patch updates for assignments in the API
You can use the /v2/storage/satellite/setAssignmentAutoupgrade
API to enable automatic patch updates for your assignments. Enabling automatic patch updates applies the latest storage template revisions (patches) automatically. You
must still apply major updates manually.
-
Copy the following example request and replace the variables for the cluster groups and assignments that you want to update.
curl -X PATCH "https://containers.cloud.ibm.com/global/v2/storage/satellite/setAssignmentAutoupgrade" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d { "config": "string", "controller": "string", "autopatch": boolean,"assignment" : { "all": boolean, "uuid": ["string", "string", ...], } }
-
Run the request.
-
Get the details of you assignment to verify the upgrade.
curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignment?uuid=ASSIGNMENT-ID" -H "accept: application/json" -H "Authorization: Bearer TOKEN"
Deploying an app that uses your Azure File storage
You can use the Azure File driver to create PVCs that you can use in your cluster workloads.
-
Create a PVC that references an Azure File storage class that you created earlier.
kind: PersistentVolumeClaim apiVersion: v1 metadata: name: pvc-azurefile4 spec: accessModes: - ReadWriteMany resources: requests: storage: 100Gi storageClassName: sat-azure-file-bronze
-
Create the PVC in your cluster.
oc apply -f pvc-azurefile.yml
-
Verify that the PVC is created and the status is
Bound
.oc get pvc
-
Create a YAML configuration file for a stateful set that mounts the PVC that you created. This example deployment creates one app pod that writes the date.
apiVersion: apps/v1 kind: Deployment metadata: labels: app: nginx name: DEPLOYMENT-NAME spec: replicas: 1 selector: matchLabels: app: nginx strategy: type: RollingUpdate rollingUpdate: maxSurge: 0 maxUnavailable: 1 template: metadata: labels: app: nginx spec: nodeSelector: kubernetes.io/os: linux containers: - name: deployment-azurefile image: nginx command: - /bin/bash - -c - set -euo pipefail; while true; do echo $(date) >> /mnt/azurefile/outfile; sleep 1; done volumeMounts: - name: azurefile mountPath: /mnt/azurefile readOnly: false volumes: - name: azurefile persistentVolumeClaim: claimName: PVC-NAME
-
Create the pod in your cluster.
oc apply -f statefulset-azurefile.yml
-
Verify that the pod is deployed. Note that it might take a few minutes for your app to get into a
Running
state.oc get pods
NAME READY STATUS RESTARTS AGE statefulset-azurefile 1/1 Running 0 2m58s
-
Verify that the app can write to your Azure Disk by logging in to your pod.
oc exec statefulset-azurefile -it bash
-
View the contents of the
outfile
file to confirm that your app can write data to your persistent storage.cat /mnt/azurefile/outfile
Example output
Fri Jul 16 07:49:39 EDT 2021 Fri Jul 16 07:49:39 EDT 2021 Fri Jul 16 07:49:39 EDT 2021
-
Exit the pod.
exit
Removing Azure file storage from your apps
If you no longer need your Azure File configuration, you can remove your apps, PVCs, PVs, and assignment from your clusters.
-
List your PVCs and note the name of the PVC that you want to remove.
oc get pvc
-
Remove any pods that mount the PVC.
-
List all the pods that currently mount the PVC that you want to delete. If no pods are returned, you do not have any pods that currently use your PVC.
oc get pods --all-namespaces -o=jsonpath='{range .items[*]}{"\n"}{.metadata.name}{":\t"}{range .spec.volumes[*]}{.persistentVolumeClaim.claimName}{" "}{end}{end}' | grep "<pvc_name>"
Example output
app sat-azure-file-platinum
-
Remove the pod that uses the PVC. If the pod is part of a deployment or statefulset, remove the deployment or statefulset.
oc delete pod <pod_name>
oc delete deployment <deployment_name>
oc delete statefulset <statefulset_name>
-
Verify that the pod, deployment, or statefulset is removed.
oc get pods
oc get deployments
oc get statefulset
-
-
Delete the PVC. Because the Azure File storage classes have a
Delete
reclaim policy, the PV and the disks in your Azure account are automatically deleted when you delete the PVC.oc delete pvc <pvc_name>
-
Verify that your PV is automatically removed.
oc get pv
Removing the Azure File storage configuration from your cluster
If you no longer plan on using Azure File storage in your cluster, you can use the CLI unassign your cluster from the storage configuration.
Note that if you remove the storage configuration, the driver is then uninstalled from all assigned clusters. Your PVCs, PVs, and data are not removed. However, you might not be able to access your data until you re-install the driver in your cluster again.
Removing the Azure File storage configuration from the console
- From the Satellite storage dashboard, select the storage configuration you want to delete.
- Select Actions > Delete
- Enter the name of your storage configuration.
- Select Delete.
Removing the Azure File storage configuration from the CLI
-
List your storage assignments and find the one that you used for your cluster.
ibmcloud sat storage assignment ls (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)
-
Remove the assignment. After the assignment is removed, the driver pods and storage classes are removed from all clusters that were part of the storage assignment.
ibmcloud sat storage assignment rm --assignment <assignment_ID>
-
Verify that the driver is removed from your cluster.
-
List of the storage classes in your cluster and verify that the storage classes are removed.
oc get sc
-
List the pods in the
kube-system
namespace and verify that the storage driver pods are removed.oc get pods -n kube-system | grep azure
-
-
Optional: Remove the storage configuration.
-
List the storage configurations.
ibmcloud sat storage config ls
-
Remove the storage configuration.
ibmcloud sat storage config rm --config <config_name>
-
Parameter reference
1.9.0 parameter reference
Display name | CLI option | Type | Description | Required? | Default value |
---|---|---|---|---|---|
Tenant ID | tenantId |
Secret | Tenant ID : The Azure tenant ID that you want to use for your configuration. You can find your tenant ID in the Azure portal or by running the az account tenant list command. |
true | N/A |
Subscription ID | subscriptionId |
Secret | Your Azure subscription ID. From the Azure portal, search for Subscription to find a list of your subscriptions. You can also find your subscription ID by running the az account subscription list command. |
true | N/A |
Azure Active Directory Client ID | aadClientId |
Secret | Your Azure Active Directory Client ID. You can find your Client ID in the Azure portal or by running the az ad sp list --display-name appDisplayName command. |
true | N/A |
Location | location |
Config | The location of your Azure hosts. You can find the location of your virtual machines in the Azure portal or by running the az vm list command. Example location: useast . |
true | N/A |
Azure Active Directory Client Secret | aadClientSecret |
Secret | Your Azure Active Directory Client Secret. You can find your client secret in the Azure portal under the App registrations menu. |
true | N/A |
Resource Group | resourceGroup |
Config | The name of your Azure resource group. You can find your resource group detail in the Azure portal or by running the az group list command. |
true | N/A |
Virtual Machine Type | vmType |
Config | You can find your virtual machine type in the Azure portal or by running the az vm list command. Example types: standard or VMSS . |
true | N/A |
Network Security Group Name | securityGroupName |
Config | The name of your security group. You can find your security group details in the Azure portal or by running the az network nsg list command. |
true | N/A |
Virtual Network Name | vnetName |
Config | The name of the virtual network. You can find the name of your virtual network in the Azure portal or by running the az network vnet list command. |
true | N/A |
Subnet Name | subnetName |
Config | Name of one the of the subnets under the provided VNet | true | N/A |
1.18.0 parameter reference
Display name | CLI option | Type | Description | Required? | Default value |
---|---|---|---|---|---|
Tenant ID | tenantId |
Secret | Tenant ID : The Azure tenant ID that you want to use for your configuration. You can find your tenant ID in the Azure portal or by running the az account tenant list command. |
true | N/A |
Subscription ID | subscriptionId |
Secret | Your Azure subscription ID. From the Azure portal, search for Subscription to find a list of your subscriptions. You can also find your subscription ID by running the az account subscription list command. |
true | N/A |
Azure Active Directory Client ID | aadClientId |
Secret | Your Azure Active Directory Client ID. You can find your Client ID in the Azure portal or by running the az ad sp list --display-name appDisplayName command. |
true | N/A |
Location | location |
Config | The location of your Azure hosts. You can find the location of your virtual machines in the Azure portal or by running the az vm list command. Example location: useast . |
true | N/A |
Azure Active Directory Client Secret | aadClientSecret |
Secret | Your Azure Active Directory Client Secret. You can find your client secret in the Azure portal under the App registrations menu. |
true | N/A |
Resource Group | resourceGroup |
Config | The name of your Azure resource group. You can find your resource group detail in the Azure portal or by running the az group list command. |
true | N/A |
Virtual Machine Type | vmType |
Config | You can find your virtual machine type in the Azure portal or by running the az vm list command. Example types: standard or VMSS . |
true | N/A |
Network Security Group Name | securityGroupName |
Config | The name of your security group. You can find your security group details in the Azure portal or by running the az network nsg list command. |
true | N/A |
Virtual Network Name | vnetName |
Config | The name of the virtual network. You can find the name of your virtual network in the Azure portal or by running the az network vnet list command. |
true | N/A |
Subnet Name | subnetName |
Config | Name of one the of the subnets under the provided VNet | true | N/A |
1.22.0 parameter reference
Display name | CLI option | Type | Description | Required? | Default value |
---|---|---|---|---|---|
Tenant ID | tenantId |
Secret | Tenant ID : The Azure tenant ID that you want to use for your configuration. You can find your tenant ID in the Azure portal or by running the az account tenant list command. |
true | N/A |
Subscription ID | subscriptionId |
Secret | Your Azure subscription ID. From the Azure portal, search for Subscription to find a list of your subscriptions. You can also find your subscription ID by running the az account subscription list command. |
true | N/A |
Azure Active Directory Client ID | aadClientId |
Secret | Your Azure Active Directory Client ID. You can find your Client ID in the Azure portal or by running the az ad sp list --display-name appDisplayName command. |
true | N/A |
Location | location |
Config | The location of your Azure hosts. You can find the location of your virtual machines in the Azure portal or by running the az vm list command. Example location: useast . |
true | N/A |
Azure Active Directory Client Secret | aadClientSecret |
Secret | Your Azure Active Directory Client Secret. You can find your client secret in the Azure portal under the App registrations menu. |
true | N/A |
Resource Group | resourceGroup |
Config | The name of your Azure resource group. You can find your resource group detail in the Azure portal or by running the az group list command. |
true | N/A |
Virtual Machine Type | vmType |
Config | You can find your virtual machine type in the Azure portal or by running the az vm list command. Example types: standard or VMSS . |
true | N/A |
Network Security Group Name | securityGroupName |
Config | The name of your security group. You can find your security group details in the Azure portal or by running the az network nsg list command. |
true | N/A |
Virtual Network Name | vnetName |
Config | The name of the virtual network. You can find the name of your virtual network in the Azure portal or by running the az network vnet list command. |
true | N/A |
Subnet Name | subnetName |
Config | Name of one the of the subnets under the provided VNet | true | N/A |
Storage class reference for Azure File
Storage class name | Reclaim policy | Volume Binding Mode |
---|---|---|
sat-azure-file-platinum |
Delete | Immediate |
sat-azure-file-platinum-metro |
Delete | WaitForFirstConsumer |
sat-azure-file-gold |
Delete | Immediate |
sat-azure-file-gold-metro Default |
Delete | WaitForFirstConsumer |
sat-azure-file-silver |
Delete | Immediate |
sat-azure-file-silver-metro |
Delete | WaitForFirstConsumer |
sat-azure-file-bronze |
Delete | Immediate |
sat-azure-file-bronze-metro |
Delete | WaitForFirstConsumer |
Getting help and support for Azure File storage
When you use Azure File, try the following resources before you open a support case.
- Review the FAQs in the Azure Knowledge Center.
- Review the troubleshooting documentation to troubleshoot and resolve common issues.
- Check the status of the IBM Cloud platform and resources by going to the Status page.
- Review Stack Overflow to see whether other users experienced the same problem. Tag any questions with
ibm-cloud
andAzure-Disk
. - Open an issue in the Azure Service Portal.