Managing resources

Creating resources in the console

Use the following steps to create a resource in the console:

1. From your dashboard, click View resources within the Resources summary widget.
2. Click Create resource. From here, you are directed to the catalog. You can search the products or filter based on a specific category, provider, pricing plan, type of compliance, or release type. Examples of resources include apps, service instances, container clusters, storage volumes, virtual servers, and software.

After you create the resource, it is displayed in your list of resources on the Resource list page.

Creating resources by using the CLI

You can create a resource by using the IBM Cloud® Command Line Interface. For detailed information about working with resources, see Working with resources and resource groups.

1. Log in, and select the account.

   ibmcloud login
   

2. Create an organization by running the ibmcloud resource service-instance-create command.

In this command,NAME is the name of the service instance, SERVICE_NAME or SERVICE_ID is the name or ID of the service, SERVICE_PLAN_NAME or SERVICE_PLAN_IDis the name or ID of the service plan, and LOCATIONis the target location or environment to create the service instance.

ibmcloud resource service-instance-create NAME (SERVICE_NAME | SERVICE_ID) SERVICE_PLAN_NAME LOCATION [-d, --deployment DEPLOYMENT_NAME] [-p, --parameters @JSON_FILE | JSON_STRING ] [-g RESOURCE_GROUP] [--service-endpoints SERVICE_ENDPOINTS_TYPE] [--allow-cleanup] [--lock]

To list services, use the ibmcloud catalog service-marketplace command.

For example, the following command creates a service instance that is named my-service-instance, uses service plan test- service-plan of service test-service on location eu-gb:

ibmcloud resource service-instance-create my-service-instance test-service test-service-plan eu-gb

Creating new resource instances by using the API

You can programmatically create a new resource instance by calling the Resource Controller API as shown in the following sample request. For detailed information about the API, see Resource Controller API.

curl -X POST \
  https://resource-controller.cloud.ibm.com/v2/resource_instances \
  -H 'Authorization: Bearer <>' \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "my-instance",
    "target": "bluemix-global",
    "resource_group": "5g9f447903254bb58972a2f3f5a4c711",
    "resource_plan_id": "0be5ad401ae913d8ff665d92680664ed",
    "tags": [
      "my-tag"
    ]
  }'

CreateResourceInstanceOptions createResourceInstanceOptions = new CreateResourceInstanceOptions.Builder()
  .name(resourceInstanceName)
  .target(targetRegion)
  .resourceGroup(resourceGroup)
  .resourcePlanId(resourcePlanId)
  .build();
Response<ResourceInstance> response = service.createResourceInstance(createResourceInstanceOptions).execute();
ResourceInstance resourceInstance = response.getResult();
System.out.printf("createResourceInstance() response:\n%s\n", resourceInstance.toString());

const params = {
  name: resourceInstanceName,
  target: targetRegion,
  resourceGroup: resourceGroupGuid,
  resourcePlanId: resourcePlanId,
};
resourceControllerService.createResourceInstance(params)
  .then(res => {
    instanceGuid = res.result.guid;
    console.log('createResourceInstance() response:\n' + JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
   });

resource_instance = resource_controller_service.create_resource_instance(
    name=resource_instance_name,
    target=target_region,
    resource_group=resource_group,
    resource_plan_id=resource_plan_id
).get_result()
print('\ncreate_resource_instance() response:\n',
      json.dumps(resource_instance, indent=2))

createResourceInstanceOptions := resourceControllerService.NewCreateResourceInstanceOptions(
  resourceInstanceName,
  targetRegion,
  resourceGroup,
  resourcePlanID,
)
resourceInstance, response, err := resourceControllerService.CreateResourceInstance(createResourceInstanceOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(resourceInstance, "", "  ")
fmt.Printf("\nCreateResourceInstance() response:\n%s\n", string(b))

Installing software by using the API

You can install software only through the console or CLI. To see the steps, switch to the UI or CLI instructions.

Creating new resource instances by using Terraform

Before you can create new resource instances 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.

You can create new resource instances by using Terraform.

1. Create an argument in your main.tf file. The following example creates a new resource instance by using the ibm_resource_instance resource, where name is a unique, descriptive name to identify the resource instance.

   data "ibm_resource_group" "group" {
   name = "test"
   }
   resource "ibm_resource_instance" "resource_instance" {
    name              = "test"
    service           = "cloud-object-storage"
    plan              = "lite"
    location          = "global"
    resource_group_id = data.ibm_resource_group.group.id
    tags              = ["tag1", "tag2"]
    //User can increase timeouts
    timeouts {
    create = "15m"
    update = "15m"
    delete = "15m"
    }
   }
   

   You can specify tags associated with the resource instance. For more information, see the argument reference details on the Terraform Resource 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
      

Refining your search results

View all catalog results

Use this option to view a filtered catalog search. The first five results are displayed by name. If you want a more detailed search criteria for catalog entries, such as searching the description, you can click this link and get a filtered catalog results view. This option helps you find the offerings that you want to create faster. This appears if it matches to a catalog result. This field doesn't appear if your search query starts with tag:.

Search support cases

Use this option to filter by your open support cases across the platform, including infrastructure resources. This shows up at the end of the search if you search for anything, including if you search by tag:.

Search in IBM Cloud docs

Use this option to get a filtered search of the documentation. This shows up at the end of any search, including if you search by tag:.

Press the Forward Slash key (/) to navigate your cursor to the search field.

Searching with the CLI

You can also search across all your resources by using Lucene query syntax, with a single command by using the IBM Cloud CLI, starting with version 0.6.7. You can search for the following attributes:

name

The user-defined name of the resource.

region

The geographical location where the resource is created. The allowed values are, for example, us-south, us-east, au-syd, eu-gb, eu-de, and jp-tok.

service_name

The name of the service as it appears in the Name column of the output of ibmcloud catalog service-marketplace.

family

The cloud component to which your resource belongs. The allowed values are: cloud_foundry, containers, container-registry, vmware, resource_controller, is, atracker, ims, iam.

resource_group_id

The ID of the resource group.

type

The resource type. The allowed values are: k8-cluster, k8-location, namespace, resource-instance, resource-group, vmware-solutions, vpc, volume, vpn, load-balancer, security-group, key, image, subnet, public-gateway, floating-ip, network-acl, flow-log-collector, instance, instance-group, dedicated-host, endpoint-gateway, snapshot, share, backup-policy, vpn-server, virtual-network-interface, placement-group, route, target, cloud-object-storage-infrastructure, block-storage, file-storage, cloud-backup, cdn-powered-by-akamai, direct-link-cloud-exchange, direct-link-cloud-connect, direct-link-colocation, direct-link-network-service-provider, hardware-firewall, hardware-firewall-dedicated, fortigate-security-appliance-1gb, fortigate-security-appliance-10gb, virtual-router-appliance-copy, network-gateway-byoa, network-gateway-juniper-vsrx, ibm-cloud-load-balancer, virtual-server, bare-metal, citrix-virtual-app-desktop, bare-metal-server, serviceid.

creation_date

The date on which the resource is created.

modification_date

The last modification date of the resource.

tags

The tags that have been attached to the resource.

tagReferences.tag.name

The tags that have been attached to a classic infrastructure resource. Requires you to specify -p classic-infrastructure parameter.

_objectType:

The object type of the classic infrastructure resource. Allowed values are: SoftLayer_Virtual_DedicatedHost, SoftLayer_Hardware, SoftLayer_Network_Application_Delivery_Controller, SoftLayer_Network_Subnet_IpAddress, SoftLayer_Network_Vlan, SoftLayer_Network_Vlan_Firewall, SoftLayer_Virtual_Guest. Requires you to specify -p classic-infrastructure parameter.

The usage of -p classic-infrastructure for _objectType SoftLayer_Virtual_DedicatedHost, SoftLayer_Network_Vlan_Firewall, SoftLayer_Virtual_Guest and SoftLayer_Hardware (for the classic infrastructure bare metal servers only) is deprecated since now they are searchable as all other not classic infrastructure resources.

Search by using the API

To search for resources, call The Global Search and Tagging - Search API. The following example searches for all resources with tag "project:myproject" attached.

Use the SearchOptions.Builder to create a SearchOptions object that contains the parameter values for the search method.

Instantiate the SearchOptions struct and set the fields to provide parameter values for the Search method.

curl -X POST -H "Authorization: {iam_token}" -H "Accept: application/json" -H "Content-Type: application/json" -d '{"query": "tags:project\\:myproject OR access_tags:project\\:myproject", "fields": ["*"]}' "api.global-search-tagging.cloud.ibm.com/v3/resources/search"

SearchOptions searchOptions = new SearchOptions.Builder()
  .query("GST-sdk-*")
  .fields(new java.util.ArrayList<String>(java.util.Arrays.asList("*")))
  .searchCursor(searchCursor)
  .build();

Response<ScanResult> response = service.search(searchOptions).execute();
ScanResult scanResult = response.getResult();

System.out.println(scanResult);

const params = {
  query: 'GST-sdk-*',
  fields: ['*'],
  searchCursor: searchCursor,
};

globalSearchService.search(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });

response = global_search_service.search(query='GST-sdk-*',
                    fields=['*'])
scan_result = response.get_result()

print(json.dumps(scan_result, indent=2))

searchOptions := globalSearchService.NewSearchOptions()
searchOptions.SetLimit(10)
searchOptions.SetQuery("GST-sdk-*")
searchOptions.SetFields([]string{"*"})

scanResult, response, err := globalSearchService.Search(searchOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(scanResult, "", "  ")
fmt.Println(string(b))

Deleting resources in the console

You can delete a resource in the console by using the following steps:

1. From your dashboard, click View resources in the Resources summary widget.
2. Expand the sections to locate the service instance that you want to delete.
3. Click the Actions icon > Delete for the row.

Deleting resources by using the CLI

You can delete a resource by using the IBM Cloud® Command Line Interface. For detailed information about managing IBM Cloud resources, see Working with resources and resource groups.

1. Log in, and select the account.

   ibmcloud login
   

2. Delete a service instance by running the ibmcloud resource service-instance-delete command, where NAME is the name of the service instance, exclusive with ID, and ID is the ID of the service instance, exclusive with NAME.

   ibmcloud resource service-instance-delete (NAME|ID) [-f, --force] [--recursive]
   

   For example, the following command deletes a resource service-instance that's named my-service-instance:

   ibmcloud resource service-instance-delete my-service-instance
   

Deleting resource instances by using the API

You can programmatically delete a resource instance by calling the Resource Controller API as shown in the following sample request. For detailed information about the API, see Resource Controller API.

curl -X DELETE \
https://resource-controller.cloud.ibm.com/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94 \
  -H 'Authorization: Bearer <>'

DeleteResourceInstanceOptions deleteResourceInstanceOptions = new DeleteResourceInstanceOptions.Builder()
  .id(instanceGuid)
  .recursive(false)
  .build();

Response<Void> response = service.deleteResourceInstance(deleteResourceInstanceOptions).execute();

System.out.printf("deleteResourceInstance() response status code: %d\n", response.getStatusCode());

const params = {
  id: instanceGuid,
  recursive: false,
};

resourceControllerService.deleteResourceInstance(params)
  .then(res => {
    console.log('deleteResourceInstance() response status code: ' + res.status);
  })
  .catch(err => {
    console.warn(err)
   });

response = resource_controller_service.delete_resource_instance(
    id=instance_guid,
    recursive=False
)

print('\ndelete_resource_instance() response status code: ',
      response.get_status_code())

deleteResourceInstanceOptions := resourceControllerService.NewDeleteResourceInstanceOptions(
  instanceGUID,
)
deleteResourceInstanceOptions.SetRecursive(false)

response, err := resourceControllerService.DeleteResourceInstance(deleteResourceInstanceOptions)
if err != nil {
  panic(err)
}
fmt.Printf("\nDeleteResourceInstance() response status code: %d\n", response.StatusCode)

Deleting resource instances by using Terraform

Use the following steps to delete resource instances by using Terraform.

1. You can delete a resource instance by removing the following code block from your terraform file. You must have created the resource_instance using the terraform file.

   data "ibm_resource_group" "group" {
   name = "test"
   }
   resource "ibm_resource_instance" "resource_instance" {
    name              = "test"
    service           = "cloud-object-storage"
    plan              = "lite"
    location          = "global"
    resource_group_id = data.ibm_resource_group.group.id
    tags              = ["tag1", "tag2"]
    //User can increase timeouts
    timeouts {
    create = "15m"
    update = "15m"
    delete = "15m"
    }
   }
   

   For more information, see the argument reference details on the Terraform Resource 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
      

You can also delete a resource instance by running the following terraform destroy command:

terraform destroy -target RESOURCE_TYPE.NAME -target RESOURCE_TYPE2.NAME