Enabling the IBM Cloud File Storage for VPC cluster add-on

Virtual Private Cloud

IBM Cloud File Storage for VPC is persistent, fast, and flexible network-attached, NFS-based File Storage for VPC that you can add to your apps by using Kubernetes persistent volumes claims (PVCs). You can choose between predefined storage classes that meet the GB sizes and IOPS that meet the requirements of your workloads. To find out if File Storage for VPC is the correct storage option for you, see Choosing a storage solution. For pricing information, see Pricing.

The File Storage for VPC cluster add-on is available in Beta.

The following limitations apply to the add-on beta.

• It is recommended that your cluster and VPC are part of same resource group. If your cluster and VPC are in separate resource groups, then before you can provision file shares, you must create your own storage class and provide your VPC resource group ID. For more information, see Creating your own storage class.
• New security group rules were introduced in cluster versions 1.25 and later. These rule changes mean that you must sync your security groups before you can use File Storage for VPC. For more information, see Adding File Storage for VPC to apps.
• New storage classes were added with version 2.0 of the add-on. You can no longer provision new file shares that use the older storage classes. Existing volumes that use the older storage classes continue to function, however you cannot expand the volumes that were created using the older classes. For more information, see the Migrating to a new storage class.

Need to update the add-on to a newer version? See Updating the File Storage for VPC add-on

1. Update the container-service CLI plug-in.

   ibmcloud update && ibmcloud plugin update container-service
   

2. Get a list of the add-on versions and decide which version to install for your cluster version.

   ibmcloud ks cluster addon versions --addon vpc-file-csi-driver
   

   Example output

   Name                  Version         Supported Kubernetes Range   Supported OpenShift Range   Kubernetes Default   OpenShift Default
   vpc-file-csi-driver   2.0 (default)   >=1.30.0                     >=4.15.0                    -                    -
   

3. Enable the add-on and follow the prompts to install any dependencies. Version 2.0 is recommended.

   ibmcloud ks cluster addon enable vpc-file-csi-driver --version 2.0 --cluster CLUSTER
   

   Example output

   Enabling add-on vpc-file-csi-driver(2.0) for cluster devcluster2...
   The add-on might take several minutes to deploy and become ready for use.
   The ibm-storage-operator add-on version 1.0 is required to enable the vpc-file-csi-driver add-on. Enable ibm-storage-operator? [y/N]> y
   

   Example prompt to install dependencies.

   The ibm-storage-operator add-on version 1.0 is required to enable the vpc-file-csi-driver add-on. Enable ibm-storage-operator? [y/N]> y
   

4. Verify that the add-on is enabled.

   ibmcloud ks cluster addon ls --cluster <cluster_name_or_ID>
   

   Example output

   Name                   Version   Health State   Health Status
   ibm-storage-operator   1.0       normal         Addon Ready. For more info: http://ibm.biz/addon-state (H1500)
   vpc-file-csi-driver    2.0       normal         Addon Ready. For more info: http://ibm.biz/addon-state (H1500)