IBM Cloud Docs
Managing software instances

Managing software instances

After you install an Operator from the IBM Cloud® catalog, you can view details about it from your software instance details page. You can also take common actions such as renaming, deleting, and viewing the logs for the instance.

Viewing details about your software instance in the console

The details page for your software instance includes information about the installed version, deployment target, pricing plan, and so on. To view details about your software instance, complete the following steps:

  1. Go to the Navigation Menu icon Navigation Menu icon > Resource list.
  2. Expand Services and software.
  3. Click the name of your software instance.

Viewing logs for your software instance in the console

To view changes to your software instance, click Actions > View logs.

Renaming your software instance in the console

To rename your software instance, click Actions > Rename instance.

Deleting your software instance in the console

Deleting a software instance removes the software from the cluster to which it is deployed. To delete your software instance, click Actions > Delete instance.

Before you begin

Before you can rename your software instance by using Terraform, make sure that you have completed the following:

  • Install the Terraform CLI and configure the IBM Cloud Provider plug-in for Terraform. For more information, see the tutorial for Getting started with Terraform on IBM Cloud®. The plug-in abstracts the IBM Cloud APIs that are used to complete this task.
  • Create a Terraform configuration file that is named main.tf. In this file, you define resources by using HashiCorp Configuration Language. For more information, see the Terraform documentation.

Viewing details about your software instance by using Terraform

You can't view details about your software instance by using Terraform. To view your software instance details, switch to the UI steps.

Viewing logs for your software instance by using Terraform

You can't view logs for your software instance by using Terraform. To view the logs, switch to the UI steps.

Renaming your software instance by using Terraform

You can rename your software instance by using Terraform.

  1. Create an argument in your main.tf file. The following example shows the software instance details by using the ibm_cm_offering_instance resource, where label is a display name to identify the instance. To rename your software instance, update label.

    resource "ibm_cm_offering_instance" "cm_offering_instance" {
    catalog_id = "catalog_id"
    label = "label"
    kind_format = "operator"
    version = "version"
    cluster_id = "cluster_id"
    cluster_region = "cluster_region"
    cluster_namespaces = [ "cluster_namespaces", "cluster_namespaces" ]
    cluster_all_namespaces = false
    }
    

    You can specify an update timeout for the ibm_cm_offering_instance resource. For more information, see the timeout reference details on the Terraform Catalog Management page.

  2. After you finish building your configuration file, initialize the Terraform CLI. For more information, see Initializing Working Directories.

    terraform init
    
  3. Provision the resources from the main.tf file. For more information, see Provisioning Infrastructure with Terraform.

    1. Run terraform plan to generate a Terraform execution plan to preview the proposed actions.

      terraform plan
      
    2. Run terraform apply to create the resources that are defined in the plan.

      terraform apply
      

Deleting your software instance by using Terraform

You can delete your software instance by using Terraform.

  1. You can delete the software instance by removing the following code block from your Terraform file. You must have created the cm_offering_instance using the Terraform file.

    resource "ibm_cm_offering_instance" "cm_offering_instance" {
    catalog_id = "catalog_id"
    label = "label"
    kind_format = "operator"
    version = "version"
    cluster_id = "cluster_id"
    cluster_region = "cluster_region"
    cluster_namespaces = [ "cluster_namespaces", "cluster_namespaces"]
    cluster_all_namespaces = false
    }
    

    You can specify a delete timeout for the ibm_cm_offering_instance resource. For more information, see the timeout reference details on the Terraform Catalog Management page.

  2. Initialize the Terraform CLI.

    terraform init
    
  3. Run terraform plan to generate a Terraform execution plan to preview the proposed actions. The Terraform execution plan summarizes all the actions that need to be run to delete the software instance.

    terraform plan
    
  4. Delete the software instance.

    terraform apply