Building a Stack

Create the entire collection of resources defined in the template (YAML format) all at once. Manage the created set of resources as a stack.

Note: To build a stack, the "System Owner role (cpf_systemowner)" of the project where you want to build the stack must be assigned in advance to the user of this function.

In addition to the parameter settings for the resources to be created, you can include the following information in the template file.

  • A structure that includes resource dependency

    Example: Create block storage first, attach it to a virtual server, and then start the virtual server.

  • A structure that uses multiple templates by calling one template from another
Note: If the user applies a template that includes the parameters section, the user needs to configure the values when building the stack.

To build a stack, specify the following items:

Table 1. List of Items That Can Be Set for a Stack
Item Description Required
Stack Name

Specify a name to identify the stack to be created.

Important: The name must begin with an alphabetic character.
 Yes
Project ID Specify the ID of the project where you want to build the stack. Yes
Template URL

Specify the URL where the template can be acquired.

Note: Specify either "Template URL" or "Template."
  
Template

Specify a template character string.

Note: Specify either "Template URL" or "Template."
Important: If you specify both "Template URL" and "Template," this item will be given priority.
  
environment This item changes the resource type defined in the template to a different resource type. Use the JSON format to specify this item.  
files

Specify in the JSON format the mapping between file names and the content of the files.

Note: Add this information when using the get_file section in the template.
  
param_name-n

Specify in the "n" part the name of the input parameter to be passed to the template.

Note: Add this information when using the get_param section in the template.
  
param_value-n

Specify in the "n" part the value of the input parameter to be passed to the template.

Note: Add this information when using the get_param section in the template.
  
Creation Timeout Specify the time, in minutes, to wait for the stack building process before timeout occurs. The default setting is 60 minutes.  
Rollback Settings

Configure these settings so that rollback is not carried out when the stack building process fails.

  • "true" (default): the created resources are not deleted
  • "false": the created resources included in the stack are deleted
  
Note: When deployment of virtual servers fails, ports may not be deleted even if rollback is performed.

Creating a Template

For details, refer to Example of Setting Auto-Scaling.