Manage products - Service Catalog - Alibaba Cloud Documentation Center

Create, update, and delete products in Service Catalog. This topic uses an ECS product as an example.

Prerequisites

Make sure you have administrator permissions for Service Catalog. For more information, see Grant permissions to an administrator.

Background

A product represents a single cloud resource or a combination of resources in Service Catalog. Administrators define compliant products and manage multiple versions.

Products allow administrators to group resources for unified lifecycle management. For example, if multiple employees need to manage ECS instances, an administrator can create a product that defines the required ECS resources, add it to a product portfolio, and grant permissions to those employees. This approach centralizes management and reduces costs. After creating a product, the administrator can create versions and define guidance for each version.

Service Catalog supports Terraform and ROS templates. Use a custom template or start with a Getting Started Example template. For more information about Terraform and ROS templates, see Terraform template syntax and ROS template structure.

Create a product

Create from a Getting Started Example template

Log on to the Service Catalog console as the administrator.
In the left-side navigation pane, choose Administrator > Product management.
On the Product management page, click Create product.
On the Create product page, set the product parameters.
1. In the Basic information section, enter the Name, Provider, and Product description.
2. Select a template type.
  
  You can select ROS or Terraform.
3. In the Version details section, configure the initial product version.
  1. Enter a Version name.
  2. Enter a Product version description.
  3. Select a creation method.
    
    You can select Custom or Getting Started Example to quickly create a product from a custom template or a sample template. This example uses Getting Started Example.
  4. Service Catalog provides multiple Getting Started Examples. Select one that meets your requirements.
  5. Review the template content. You can modify it as needed.
    - Terraform template: Use the File List View to review the template's files and content. In the Parameter View, configure parameter properties like basic attributes, validation rules, and parameter options.
    - ROS template: View the template content in JSON or YAML format.
Click Parameter preview to verify that the parameter configuration is correct.
Click Confirm.

Create from a custom template

Create a product from a custom ROS or Terraform template. This example shows how to write a Terraform template (for example, create_ecs) and upload its folder to the Service Catalog console.

Template content

The sample template includes two files: main.tf and variables.tf. The resource block defines the cloud resources to create (a VPC, a vSwitch, a security group, and an ECS instance), the output block defines values visible to end users after instance creation (VPC ID, vSwitch ID, and ECS instance ID), and the variable block uses AllowedValues to define selectable ECS instance types.

Note

In main.tf, instance_type = var.instance_type references the instance_type parameter defined in variables.tf.
To prevent instance creation failure due to a region mismatch, an authorized end user who launches the product must select the China (Beijing) region.

main.tf


resource "alicloud_vpc" "vpc" {
  name       = "tf_test_foo"
  cidr_block = "172.16.0.0/12"
}

resource "alicloud_vswitch" "vsw" {
  vpc_id            = alicloud_vpc.vpc.id
  cidr_block        = "172.16.0.0/21"
  availability_zone = "cn-beijing-h"
}

resource "alicloud_security_group" "default" {
  name = "default"
  vpc_id = alicloud_vpc.vpc.id
}

resource "alicloud_instance" "instance" {
  # cn-beijing
  availability_zone = "cn-beijing-h"
  security_groups = alicloud_security_group.default.*.id
  # series III
  instance_type        = var.instance_type
  system_disk_category = "cloud_efficiency"
  image_id             = "ubuntu_18_04_64_20G_alibase_20190624.vhd"
  instance_name        = "test_foo"
  vswitch_id = alicloud_vswitch.vsw.id
  internet_max_bandwidth_out = 10
}

resource "alicloud_security_group_rule" "allow_all_tcp" {
  type              = "ingress"
  ip_protocol       = "tcp"
  nic_type          = "intranet"
  policy            = "accept"
  port_range        = "1/65535"
  priority          = 1
  security_group_id = alicloud_security_group.default.id
  cidr_ip           = "0.0.0.0/0"
}

output "vpc_id" {
  value       = alicloud_vpc.vpc.id
  description = "The ID of the VPC."
}

output "vswitch_id" {
  value       = alicloud_vswitch.vsw.id
  description = "The ID of the vSwitch."
}

output "instance_id" {
  value       = alicloud_instance.instance.id
  description = "The ECS instance ID."
}

variables.tf

variable "instance_type" {
  type = string
  description = <<EOT
  {
    "AssociationProperty": "ALIYUN::ECS::Instance::InstanceType",
    "AllowedValues": ["ecs.s6-c1m1.small", "ecs.s6-c1m2.small", "ecs.s6-c1m2.large", "ecs.s6-c1m2.xlarge", "ecs.s6-c1m2.2xlarge"],
    "Label": "ECS instance type"
  }
  EOT
}

Procedure

Log on to the Service Catalog console as the administrator.
In the left-side navigation pane, choose Administrator > Product management.
On the Product management page, click Create product.
Select Terraform as the template type.
On the Create product page, set the product parameters.
1. In the Basic information section, enter the Name, Provider, and Product description.
2. In the Version details section, configure the initial product version.
  1. Enter a Version name.
  2. Enter a Product version description.
  3. Select a creation method.
    
    For this example, select Custom.
  4. Click Upload Folder to upload the template folder from your local machine.
    
    This example uploads the create_ecs template folder.
  5. Review the template content. You can modify it as needed.
    
    Use the File List View to review the template's files and content. In the Parameter View, configure parameter properties like basic attributes, validation rules, and parameter options.
Click Parameter preview to verify that the parameter configuration is correct.
Click Confirm.

Update product information

In the left-side navigation pane, choose Administrator > Product management.
On the Product management page, find the target product and click Edit in the Operation column.
In the Modify product information dialog box, update the Name, Provider, and Description.
Click Confirm.

Delete a product

Warning

Before you delete a product, ensure it is no longer in use. Otherwise, end users cannot manage its resources. If the product belongs to a product portfolio, deleting it also removes it from the portfolio.

In the left-side navigation pane, choose Administrator > Product management.
On the Product management page, find the target product and click Delete in the Operation column.
In the Delete product dialog box, verify the information and click Confirm.