Skip to content

conref.md

Latest commit

 

History

History
369 lines (251 loc) · 14.6 KB

conref.md

File metadata and controls

369 lines (251 loc) · 14.6 KB
Raw
copyright
years
2020, 2026
lastupdated 2026-09-03
keywords satellite, hybrid, multicloud
subcollection satellite
content-type conref

Content references for Satellite

{: #conref-satellite}

Review content references for {{site.data.keyword.satelliteshort}}, including reusable snippets for storage templates and shared content. {: shortdesc}

Understanding which OpenShift Data Foundation (ODF) storage template to use

{: #compare-odf}

You have two options when deploying OpenShift Data Foundation to your {{site.data.keyword.satelliteshort}} clusters, which are the odf-local and odf-remote storage templates.

  • odf-local: Choose this template when you have local storage available to your worker nodes. If your storage volumes are visible when running lsblk, you can use these disks when deploying ODF if they are raw and unformatted.
  • odf-remote: Choose this template if you have a Container Storage Interface (CSI) driver installed in your cluster. For example, the azuredisk-csi-driver driver. You can use the CSI driver to dynamically provision storage volumes when deploying ODF.

Can I estimate my costs?

{: #cost-estimate} {: faq}

When you create a resource such as a location or cluster, you can review a cost estimate in the Summary pane of the console. For other types of estimates, see Estimating your costs.

Keep in mind that some charges are not reflected in the estimate, such as the costs for your underlying infrastructure.

Can I view and control my current usage?

{: #usage} {: faq}

See View your usage and Set spending notifications for general {{site.data.keyword.cloud_notm}} account guidance.

Creating an assignment in the command-line interface (CLI)

{: #assignment-create-cli} {: cli}

  1. 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

    {: pre}

  2. 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 {{site.data.keyword.satelliteshort}} Config or to create groups, see Setting up clusters to use with {{site.data.keyword.satelliteshort}} Config. {: tip}

    Example command to list cluster groups.

    ibmcloud sat group ls

    {: pre}

    Example command to list clusters.

    ibmcloud oc cluster ls --provider satellite

    {: pre}

    Example command to list {{site.data.keyword.satelliteshort}} services.

    ibmcloud sat service ls --location LOCATION

    {: pre}

  3. 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

    {: pre}

    Example command to assign a configuration to a cluster.

    ibmcloud sat storage assignment create --cluster CLUSTER --config CONFIG --name NAME

    {: pre}

    Example command to assign a configuration to a service cluster.

    ibmcloud sat storage assignment create --service-cluster-id CLUSTER --config CONFIG --name NAME

    {: pre}

  4. Verify that your assignment is created.

    ibmcloud sat storage assignment ls (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)

    {: pre}

Manually upgrading configurations in the CLI

{: #configuration-upgrade-manual-cli} {: cli}

You can upgrade your {{site.data.keyword.satelliteshort}} storage configurations to get the latest storage template revision within the same major version.

  1. List your {{site.data.keyword.satelliteshort}} storage configurations, make a note of the {{site.data.keyword.satelliteshort}} configuration you want to upgrade.

    ibmcloud sat storage config ls

    {: pre}

  2. Upgrade the {{site.data.keyword.satelliteshort}} configuration. Note, only the configuration is updated. If you want to upgrade the assignments that use this configuration, you can specify the --include-assignments option or you can manually update each assignment using the assignment update command.

    Example command to upgrade a configuration to the latest revision.

    ibmcloud sat storage config upgrade --config CONFIG [--include-assignments]

    {: pre}

    Example command to upgrade a configuration and its associated assignments to the latest revision.

    ibmcloud sat storage config upgrade --config CONFIG --include-assignments

    {: pre}

Manually updating assignments in the CLI

{: #assignment-update-cli} {: cli}

Update an assignment to rename your assignment or assign it to new clusters or cluster groups.

  1. List your assignments, make a note of the {{site.data.keyword.satelliteshort}} assignment you want to update and the clusters or cluster groups included in the assignment.

    ibmcloud sat storage assignment ls

    {: pre}

  2. Update the assignment.

    Example command to update an assignment.

    ibmcloud sat storage assignment update --assignment ASSIGNMENT [--group GROUP ...] [--name NAME]

    {: pre}

    Example command to update assignment name and assign different cluster groups.

    ibmcloud sat storage assignment update --assignment ASSIGNMENT --name new-name --group group-1 --group group-2 --group group-3

    {: pre}

Manually upgrading assignments in the CLI

{: #assignment-upgrade-cli} {: cli}

Upgrade an assignment to use the latest storage template revision.

  1. List your {{site.data.keyword.satelliteshort}} storage assignments, make a note of the {{site.data.keyword.satelliteshort}} assignment you want to upgrade.

    ibmcloud sat storage assignment ls

    {: pre}

  2. List the {{site.data.keyword.satelliteshort}} storage templates to see the latest available versions.

    ibmcloud sat storage template ls

    {: pre}

  3. Upgrade the {{site.data.keyword.satelliteshort}} assignment.

    Example command to upgrade an assignment.

    ibmcloud sat storage assignment upgrade --assignment ASSIGNMENT

    {: pre}

Enabling automatic patch updates for configurations and assignments in the CLI

{: #assignment-autopatch-cli} {: 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 {{site.data.keyword.satelliteshort}} storage configurations. Make a note of the configuration ID.

    ibmcloud sat storage assignment ls

    {: pre}

  2. 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])

    {: pre}

    Example command to enable automatic patch updates for all storage assignments under a given configuration.

    ibmcloud sat storage assignment autopatch enable --config CONFIG --all

    {: pre}

    Example command to disable automatic patch updates for all assignments under a specific configuration.

    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.

    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.

    ibmcloud sat storage assignment autopatch disable --config CONFIG --assignment ASSIGNMENT-ID --assignment ASSIGNMENT-ID

    {: pre}

Updating storage assignments in the console

{: #configuration-upgrade-console} {: ui}

You can use the {{site.data.keyword.satelliteshort}} console{: external} to apply the latest patch updates to your assignments.

  1. From the Locations page in the {{site.data.keyword.satelliteshort}} console{: external}, select your location.

  2. Click the Storage tab to view your configurations.

  3. Click the configuration you want to update.

  4. Click information Information (i) icon to apply the latest revision or patch.

  5. 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}

Creating a storage assignment in the application programming interface (API)

{: #assignment-create-api} {: api}

  1. Copy one of the following example requests.

    Example request to assign a configuration to a cluster{: external}.

    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{: external}.

    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}

  2. Replace the variables with your details and run the request.

  3. 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"

    {: pre}

Updating a storage assignment in the API

{: #assignment-update-api} {: api}

You can use the /v2/storage/satellite/updateAssignment{: external} API to update your assignments with new clusters or cluster groups.

  1. 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\"}"

    {: pre}

  2. Run the request.

  3. 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"

    {: pre}

Upgrading a configuration and assignments in the API

{: #assignment-upgrade-api} {: api}

You can use the /v2/storage/satellite/updateAssignment{: 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.

    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}

  2. Run the request.

  3. 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"

    {: pre}

Enabling automatic patch updates for assignments in the API

{: #assignment-autopatch-api} {: 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.

    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}

  2. Run the request.

  3. 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"

    {: pre}

Removing a storage configuration from the console

{: #configuration-remove-console} {: ui}

  1. From the {{site.data.keyword.satelliteshort}} storage dashboard, select the storage configuration you want to delete.
  2. Select Actions > Delete.
  3. Enter the name of your storage configuration.
  4. Select Delete.