--- name: satellite-storage-ibm-object-storage-plugin title: Configuring IBM Cloud Object Storage driver for Satellite clusters description: Learn how to deploy the IBM Cloud Object Storage driver to your Satellite clusters to create and access data across multiple S3-compatible cloud storage providers including IBM, AWS, Wasabi, and Azure. last-updated: 2026-08-19 --- > ## Documentation Index > The table of contents for this documentation set is at https://cloud.ibm.com/docs/satellite?format=markdown > The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt > Use these files to discover more information as needed. # Configuring IBM Cloud Object Storage driver for Satellite clusters {: #storage-ibm-object-storage-plugin} Learn how to deploy the IBM Cloud Object Storage driver to your Satellite clusters to create and access data across multiple S3-compatible cloud storage providers including IBM, AWS, Wasabi, and Azure. {: shortdesc} 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. {: important} 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. {: note} ## Prerequisites {: #storage-ibm-object-storage-plugin-prereqs} 1. [Create a Satellite location](https://cloud.ibm.com/docs/satellite?topic=satellite-locations&format=markdown). 1. Create a set of service credentials in your object storage provider. * [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-service-credentials&format=markdown). * [AWS service credential](https://docs.aws.amazon.com/cli/latest/reference/iam/create-service-specific-credential.html){: external}. * [Wasabi access key](https://docs.wasabi.com/v1/docs/creating-a-user-account-and-access-key#assigning-an-access-key){: external}. 1. [Create a secret that contains your s3 credentials](#config-storage-cos-secret). ## Creating a secret in your cluster that contains your object storage credentials {: #config-storage-cos-secret} Create the Kubernetes secret in your cluster that contains your service credentials. 1. Follow the steps based on your object storage provider to create a secret in your cluster. When you create your secret, all values are automatically encoded to base64. In the following example, the secret name is `cos-write-access`. - IBM Cloud Object Storage 1. Find your service instance ID. ```sh ibmcloud resource service-instance | grep GUID ``` {: pre} 1. Create the secret in your cluster. ```sh oc create secret generic cos-write-access --type=ibm/ibmc-s3fs --from-literal=api-key=API-KEY --from-literal=service-instance-id=SERVICE-INSTANCE-ID ``` {: pre} - AWS or Wasabi ```sh oc create secret generic cos-write-access --type=ibm/ibmc-s3fs --from-literal=access-key=ACCESS-KEY-ID --from-literal=secret-key=SECRET-ACCESS-KEY ``` {: pre} ## Creating and assigning a configuration in the console {: #ibm-object-storage-plugin-config-create-console} {: ui} 1. Review the [parameter reference](#ibm-object-storage-plugin-parameter-reference). 1. [From the Locations console](https://cloud.ibm.com/satellite/locations){: external}, select the location where you want to create a storage configuration. 1. Select **Storage** > **Create storage configuration** 1. Enter a name for your configuration. 1. Select the **Storage type**. 1. Select the **Version** and click **Next** 1. If the **Storage type** that you selected accepts custom parameters, enter them on the **Parameters** tab. 1. If the **Storage type** that you selected requires secrets, enter them on the **Secrets** tab. 1. On the **Storage classes** tab, review the storage classes that are deployed by the configuration or create a custom storage class. 1. On the **Assign to service** tab, select the service that you want to assign your configuration to. 1. Click **Complete** to assign your storage configuration. ## Creating a configuration in the CLI {: #ibm-object-storage-plugin-config-create-cli} {: cli} 1. Review the [parameter reference](#ibm-object-storage-plugin-parameter-reference) for the template version that you want to use. 1. Log in to the IBM Cloud CLI. ```sh ibmcloud login ``` {: pre} 1. List your Satellite locations and note the `Managed from` column. ```sh ibmcloud sat location ls ``` {: pre} 1. Target the `Managed from` region of your Satellite location. For example, for `wdc` target `us-east`. For more information, see [Satellite regions](https://cloud.ibm.com/docs/satellite?topic=satellite-sat-regions&format=markdown). ```sh ibmcloud target -r us-east ``` {: pre} 1. If you use a resource group other than `default`, target it. ```sh ibmcloud target -g RESOURCE_GROUP ``` {: pre} 1. 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](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-reference&format=markdown#storage-config-create-cli). Example command to create a version 2.2 configuration. ```sh ibmcloud sat storage config create --location LOCATION --name NAME --template-name ibm-object-storage-plugin --template-version 2.2 --param "helm-release-name=HELM-RELEASE-NAME" --param "parameters=PARAMETERS" --param "license=LICENSE" --param "s3provider=S3PROVIDER" --param "cos-storageclass=COS-STORAGECLASS" --param "cos-endpoint=COS-ENDPOINT" ``` {: pre} 1. Customize the command based on the settings that you want to use. 1. Run the command to create a configuration. 1. Verify your configuration was created. ```sh ibmcloud sat storage config get --config CONFIG ``` {: pre} ## Creating a configuration in the API {: #ibm-object-storage-plugin-config-create-api} {: api} 1. Generate an API key, then request a refresh token. For more information, see [Generating an IBM Cloud IAM token by using an API key](https://cloud.ibm.com/docs/iam?topic=iam-iamtoken_from_apikey&format=markdown). 1. Review the [parameter reference](#ibm-object-storage-plugin-parameter-reference) for the template version that you want to use. 1. Copy one of the following example requests and replace the variables that you want to use. Example request to create a version 2.2 configuration. ```sh 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\": \"ibm-object-storage-plugin\", \"storage-template-version\": \"2.2\", \"update-assignments\": true, \"user-config-parameters\": { \"entry.name\": \"HELM-RELEASE-NAME\", { \"entry.name\": \"PARAMETERS\", { \"entry.name\": \"LICENSE\", { \"entry.name\": \"S3PROVIDER\", { \"entry.name\": \"COS-STORAGECLASS\", { \"entry.name\": \"COS-ENDPOINT\",\"user-secret-parameters\": } ``` {: pre} {: cli} 1. List your storage configurations and make a note of the storage configuration that you want to assign to your clusters. ```sh ibmcloud sat storage config ls ``` {: pre} 1. 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](https://cloud.ibm.com/docs/satellite?topic=satellite-setup-clusters-satconfig&format=markdown). {: tip} Example command to list cluster groups. ```sh ibmcloud sat group ls ``` {: pre} Example command to list clusters. ```sh ibmcloud oc cluster ls --provider satellite ``` {: pre} Example command to list Satellite services. ```sh ibmcloud sat service ls --location LOCATION ``` {: pre} 1. 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](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-reference&format=markdown#storage-assignment-create-cli). Example command to assign a configuration to a cluster group. ```sh ibmcloud sat storage assignment create --group GROUP --config CONFIG --name NAME ``` {: pre} Example command to assign a configuration to a cluster. ```sh ibmcloud sat storage assignment create --cluster CLUSTER --config CONFIG --name NAME ``` {: pre} Example command to assign a configuration to a service cluster. ```sh ibmcloud sat storage assignment create --service-cluster-id CLUSTER --config CONFIG --name NAME ``` {: pre} 1. Verify that your assignment is created. ```sh ibmcloud sat storage assignment ls (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER) ``` {: pre} {: api} 1. Copy one of the following example requests. Example request to assign a [configuration to a cluster](https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2){: external}. ```sh 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\"}" ``` {: pre} Example request to [assign configuration to a cluster group](https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2){: external}. ```sh 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\"}" ``` {: pre} 1. Replace the variables with your details and run the request. 1. Verify the assignment was created by listing your assignments. ```sh curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignments" -H "accept: application/json" -H "Authorization: Bearer TOKEN" ``` {: pre} {: ui} You can use the [Satellite console](https://cloud.ibm.com/satellite/locations){: external} to apply the latest patch updates to your assignments. 1. From the **Locations** page in the [Satellite console](https://cloud.ibm.com/satellite/locations){: external}, select your location. 1. Click the **Storage** tab to view your configurations. 1. Click the configuration you want to update. 1. Click information **Information** (i) icon to apply the latest revision or patch. 1. **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. {: note} {: cli} Upgrade an assignment to use the latest storage template revision. 1. List your Satellite storage assignments, make a note of the Satellite assignment you want to upgrade. ```sh ibmcloud sat storage assignment ls ``` {: pre} 1. List the Satellite storage templates to see the latest available versions. ```sh ibmcloud sat storage template ls ``` {: pre} 1. Upgrade the Satellite assignment. Example command to upgrade an assignment. ```sh ibmcloud sat storage assignment upgrade --assignment ASSIGNMENT ``` {: pre} {: 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. 1. List your Satellite storage configurations. Make a note of the configuration ID. ```sh ibmcloud sat storage assignment ls ``` {: pre} 1. 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. ```sh ibmcloud sat storage assignment autopatch enable --config CONFIG (--all | --assignment ASSIGNMENT-ID [--assignment ASSIGNMENT-ID]) ``` {: pre} Example command to enable automatic patch updates for all storage assignments under a given configuration. ```sh ibmcloud sat storage assignment autopatch enable --config CONFIG --all ``` {: pre} Example command to disable automatic patch updates for all assignments under a specific configuration. ```sh ibmcloud sat storage assignment autopatch disable --config CONFIG --all ``` {: pre} Example command to disable automatic patch updates for an single assignment and a specific configuration. ```sh ibmcloud sat storage assignment autopatch disable --config CONFIG --assignment ASSIGNMENT-ID ``` {: pre} Example command to disable automatic patch updates for an multiple assignment and a specific configuration. ```sh ibmcloud sat storage assignment autopatch disable --config CONFIG --assignment ASSIGNMENT-ID --assignment ASSIGNMENT-ID ``` {: pre} {: api} You can use the [`/v2/storage/satellite/updateAssignment`](https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2){: external} API to update your assignments with new clusters or cluster groups. Set `updateConfigVersion` to `true` to apply the revision update. 1. Copy the following example request and replace the variables for the cluster groups and assignments that you want to update. ```sh 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\"}" ``` {: pre} 1. Run the request. 1. Get the details of you assignment to verify the update. ```txt curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignment?uuid=ASSIGNMENT-ID" -H "accept: application/json" -H "Authorization: Bearer TOKEN" ``` {: pre} {: 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. 1. Copy the following example request and replace the variables for the cluster groups and assignments that you want to update. ```txt 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", ...], } } ``` {: pre} 1. Run the request. 1. Get the details of you assignment to verify the upgrade. ```sh curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignment?uuid=ASSIGNMENT-ID" -H "accept: application/json" -H "Authorization: Bearer TOKEN" ``` {: pre} ## Deploying an app that uses IBM Cloud Object Storage {: #config-storage-cos-app} You can use the `ibm-object-s3fs` driver to create PVCs that you can use in your cluster workloads. {: shortdesc} 1. Create a PVC that references your object storage configuration. ```yaml kind: PersistentVolumeClaim apiVersion: v1 metadata: name: demo #Enter a name for your PVC. namespace: default annotations: ibm.io/auto-create-bucket: "false" ibm.io/auto-delete-bucket: "false" ibm.io/bucket: BUCKET-NAME #Enter the name of your object storage bucket. ibm.io/secret-name: SECRET-NAME #Enter the name of the secret you created earlier. ibm.io/secret-namespace: NAMESPACE #Enter the namespace where you want to create the PVC. spec: accessModes: - ReadWriteOnce resources: requests: storage: 10Gi storageClassName: ibmc-s3fs-cos #The storage class that you want to use. ``` {: codeblock} 1. Create the PVC in your cluster. ```sh oc apply -f pvc-cos.yaml ``` {: pre} 1. Create a YAML configuration file for a pod that mounts the PVC that you create. ```yaml apiVersion: v1 kind: Pod metadata: name: demo-pod namespace: default spec: securityContext: runAsUser: 2000 fsGroup: 2000 volumes: - name: demo-vol persistentVolumeClaim: claimName: demo containers: - name: test image: nginxinc/nginx-unprivileged imagePullPolicy: Always volumeMounts: - name: demo-vol mountPath: /mnt/cosvol ``` {: codeblock} 1. Create the pod in your cluster. ```sh oc apply -f demo-pod.yaml ``` {: pre} 1. Verify that the pod is deployed. Note that it can take a few minutes for your app to get into a `Running` state. ```sh oc get pods ``` {: pre} ```sh NAME READY STATUS RESTARTS AGE demo-pod 1/1 Running 0 2m58s ``` {: screen} 1. Verify that the app can write to your block storage volume by logging in to your pod. ```sh oc exec demo-pod -- bash -c "touch /mnt/cosvol/test.txt && ls /mnt/cosvol" test.txt ``` {: pre} ## Removing the IBM Cloud Object Storage storage configuration using the console {: #config-storage-cos-rm-ui} {: ui} 1. From the Satellite storage dashboard, select the storage configuration you want to delete. 1. Select **Actions** > **Delete** 1. Enter the name of your storage configuration. 1. Select **Delete**. ## Removing the IBM Cloud Object Storage storage configuration using the command line {: #config-storage-cos-rm-cli} {: cli} If you no longer need your IBM Cloud Object Storage configuration, you can remove your apps, PVCs, PVs, and assignment from your clusters. {: shortdesc} 1. List your storage assignments and find the one that you used for your cluster. ```sh ibmcloud sat storage assignment ls (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER) ``` {: pre} 1. 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. ```sh ibmcloud sat storage assignment rm --assignment ``` {: pre} 1. Verify that the driver is removed from your cluster. 1. List of the storage classes in your cluster and verify that the storage classes are removed. ```sh oc get sc ``` {: pre} 1. List the pods in the `kube-system` namespace and verify that the storage driver pods are removed. ```sh oc get pods -n kube-system | grep cos ``` {: pre} 1. Optional: Remove the storage configuration. 1. List the storage configurations. ```sh ibmcloud sat storage config ls ``` {: pre} 1. Remove the storage configuration. ```sh ibmcloud sat storage config rm --config ``` {: pre} ## Parameter reference {: #ibm-object-storage-plugin-parameter-reference} ### 2.2 parameter reference {: #ibm-object-storage-plugin-2.2-parameters} | Display name | CLI option | Type | Description | Default value | | --- | --- | --- | --- | --- | | Release name | `helm-release-name`| Config | Helm chart release name. |`ibm-object-storage-plugin` | | Helm Chart additional parameters | `parameters` | Config | Helm Chart additional parameters. | N/A | | Object Storage plug-in license | `license` | Config | Object storage plug-in license: Apache license Version 2.0. Set to 'true' to accept the license and install the plug-in. | N/A | | Object Storage provider | `s3provider` | Config | Available providers are 'IBM', 'AWS' and 'Wasabi'. For providers other than these, you must provide the 'Object Storage service endpoint' parameter. | N/A | | Object Storage region | `cos-storageclass` | Config | Enter the region where your object storage is located. For IBM COS regions, see https://ibm.biz/cos-endpoints-list. For Wasabi, see https://ibm.biz/wasabi-endpoints. For AWS, see https://ibm.biz/aws-endpoints. | N/A | | Object Storage service endpoint | `cos-endpoint` | Config | Object Storage service endpoint. Required when using Object Storage providers other than IBM, AWS or Wasabi. Preference is given to 'Object Storage provider' when both are set. | N/A | {: caption="Table 1. 2.2 parameter reference" caption-side="bottom"} ## Storage class reference for IBM Cloud Object Storage {: #config-storage-cos-sc-ref} | Storage class name | Volume binding mode | Retain | | --- | --- | --- | | `ibm-s3fs-cos` | Immediate | False | | `ibm-s3fs-cos-perf` | Immediate | False | {: caption="Cloud Object storage class reference" caption-side="bottom"} ## Getting help and support for IBM Cloud Object Storage {: #sat-storage-cos-support} When you use IBM Cloud Object Storage, try the following resources before you open a support case. {: shortdesc} 1. Review the FAQs in the [Block Storage for VPC docs](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-faq&format=markdown). 1. Review the [troubleshooting documentation](https://cloud.ibm.com/docs/satellite?topic=satellite-storage-must-gather&format=markdown) to troubleshoot and resolve common issues. 1. Check the status of the IBM Cloud platform and resources by going to the [Status page](https://cloud.ibm.com/status){: external}. 1. Review [Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-cloud){: external} to see whether other users experienced the same problem. Tag any questions with `ibm-cloud` and `COS`. 1. If you run into an issue with Block Storage for VPC, submit a support request with [IBM Cloud® Support](https://www.ibm.com/products/cloud/support){: external}.