. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式
+*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre}
\ No newline at end of file
diff --git a/docs/rts/umn/public_sys-resources/danger_3.0-en-us.png b/docs/rts/umn/public_sys-resources/danger_3.0-en-us.png
new file mode 100644
index 00000000..47a9c723
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/danger_3.0-en-us.png differ
diff --git a/docs/rts/umn/public_sys-resources/delta.gif b/docs/rts/umn/public_sys-resources/delta.gif
new file mode 100644
index 00000000..0d1b1f67
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/delta.gif differ
diff --git a/docs/rts/umn/public_sys-resources/deltaend.gif b/docs/rts/umn/public_sys-resources/deltaend.gif
new file mode 100644
index 00000000..cc7da0fc
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/deltaend.gif differ
diff --git a/docs/rts/umn/public_sys-resources/icon-arrowdn.gif b/docs/rts/umn/public_sys-resources/icon-arrowdn.gif
new file mode 100644
index 00000000..37942803
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/icon-arrowdn.gif differ
diff --git a/docs/rts/umn/public_sys-resources/icon-arrowrt.gif b/docs/rts/umn/public_sys-resources/icon-arrowrt.gif
new file mode 100644
index 00000000..6aaaa11c
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/icon-arrowrt.gif differ
diff --git a/docs/rts/umn/public_sys-resources/icon-caution.gif b/docs/rts/umn/public_sys-resources/icon-caution.gif
new file mode 100644
index 00000000..079c79b2
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/icon-caution.gif differ
diff --git a/docs/rts/umn/public_sys-resources/icon-danger.gif b/docs/rts/umn/public_sys-resources/icon-danger.gif
new file mode 100644
index 00000000..079c79b2
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/icon-danger.gif differ
diff --git a/docs/rts/umn/public_sys-resources/icon-huawei.gif b/docs/rts/umn/public_sys-resources/icon-huawei.gif
new file mode 100644
index 00000000..a31d60f8
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/icon-huawei.gif differ
diff --git a/docs/rts/umn/public_sys-resources/icon-note.gif b/docs/rts/umn/public_sys-resources/icon-note.gif
new file mode 100644
index 00000000..31be2b03
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/icon-note.gif differ
diff --git a/docs/rts/umn/public_sys-resources/icon-notice.gif b/docs/rts/umn/public_sys-resources/icon-notice.gif
new file mode 100644
index 00000000..40907065
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/icon-notice.gif differ
diff --git a/docs/rts/umn/public_sys-resources/icon-tip.gif b/docs/rts/umn/public_sys-resources/icon-tip.gif
new file mode 100644
index 00000000..c47bae05
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/icon-tip.gif differ
diff --git a/docs/rts/umn/public_sys-resources/icon-warning.gif b/docs/rts/umn/public_sys-resources/icon-warning.gif
new file mode 100644
index 00000000..079c79b2
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/icon-warning.gif differ
diff --git a/docs/rts/umn/public_sys-resources/note_3.0-en-us.png b/docs/rts/umn/public_sys-resources/note_3.0-en-us.png
new file mode 100644
index 00000000..57a0e1f5
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/note_3.0-en-us.png differ
diff --git a/docs/rts/umn/public_sys-resources/notice_3.0-en-us.png b/docs/rts/umn/public_sys-resources/notice_3.0-en-us.png
new file mode 100644
index 00000000..fa4b6499
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/notice_3.0-en-us.png differ
diff --git a/docs/rts/umn/public_sys-resources/popup.js b/docs/rts/umn/public_sys-resources/popup.js
new file mode 100644
index 00000000..a550862e
--- /dev/null
+++ b/docs/rts/umn/public_sys-resources/popup.js
@@ -0,0 +1 @@
+var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!==null&&typeof document.body!=="undefined"){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(e){if(document.body===null||typeof document.body==="undefined"){return}if(i==0){return}clickFlag=true;var f=Json.parse("jsonData."+e);var a=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var b=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){b=0}var c=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=f;dhtmlgoodies_tooltip.style.left=c+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+b+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=c+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+b+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var d=dhtmlgoodies_tooltip.offsetWidth;if(d
a){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if((dhtmlgoodies_tooltip!==null&&typeof dhtmlgoodies_tooltip!=="undefined")&&+(dhtmlgoodies_tooltip.style!==null&&typeof dhtmlgoodies_tooltip.style!=="undefined")){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}};
\ No newline at end of file
diff --git a/docs/rts/umn/public_sys-resources/warning_3.0-en-us.png b/docs/rts/umn/public_sys-resources/warning_3.0-en-us.png
new file mode 100644
index 00000000..def5c356
Binary files /dev/null and b/docs/rts/umn/public_sys-resources/warning_3.0-en-us.png differ
diff --git a/docs/rts/umn/rts_01_0001.html b/docs/rts/umn/rts_01_0001.html
new file mode 100644
index 00000000..5ede15f7
--- /dev/null
+++ b/docs/rts/umn/rts_01_0001.html
@@ -0,0 +1,21 @@
+
+
+Service Overview
+
+
+
diff --git a/docs/rts/umn/rts_01_0003.html b/docs/rts/umn/rts_01_0003.html
new file mode 100644
index 00000000..ceb51637
--- /dev/null
+++ b/docs/rts/umn/rts_01_0003.html
@@ -0,0 +1,17 @@
+
+
+Advantages
+RTS allows you to model and configure cloud computing resources in a unified way. With RTS, you only need to create a template that describes the required resources and dependencies between those resources. Then, RTS automatically creates and configures all resources in the template using an orchestration engine, simplifying management of cloud resources. RTS has the following advantages:
+
Providing Template Examples
RTS provides common template examples, and you only need to set values of several parameters such as region and stack name.
+
+
Flexibly Combining Multiple Cloud Services
RTS supports many core cloud services, such as ECS, EVS, VPC, ELB, SFS, RDS, AS, and Cloud Eye. You can flexibly combine cloud services using templates to meet automatic O&M requirements in different O&M scenarios.
+
+
Allowing Batch Operations and Simplifying Resource Management
By defining multiple resource types and resource dependencies in a template, you can deploy all services in a template in batches, which simplifies deployment and saves your time cost. You can also dynamically adjust the stack template based on service requirements. If you do not need a group of resources, you can delete them by one click.
+
+
Supported Resources
+RTS supports 44 types of resources, including compute, storage, and network resources. Table 1 describes resource types supported by RTS. You can also log in to the RTS management console and view those resource types on the Resource Types page.
+
For details about resource types, see Resource Type Reference.
+
OSE is the abbreviation of OpenStack Extension. In Table 1, OSE indicates an extended resource type except for default resource types of OpenStack Heat, or a user-defined resource type.
+
+
+
+
Constraints
+Limitations
- RTS does not support snapshot-related APIs and the following operations: suspend, restore, discard, and adopt.
- The Availability Zone (AZ) attribute cannot be updated in a stack life cycle.
- Names of resources must be unique in the same nesting level.
+
+
Specification Limitations
- Each tenant can create a maximum of 100 stacks.
- A maximum of 1000 resources can be created in a stack.
- Each stack contains a maximum of 1000 operation logs.
- A maximum of seven stacks can be nested together.
- The maximum size of a decompressed template file is 512 KB.
+
+
Heat Client
+Overview
The Heat client is a subproject of OpenStack Client, functioning as a command line client targeted for Heat. You can use this client to access cloud services by running commands.
+
RTS supports Heat 1.5.1.
+
+
+
Installing OpenStack Client
To install OpenStack Client, you need to install and run the python-openstackclient plug-in and ensure that the plug-in is running properly.
+
OpenStack Client can be used on all OSs as long as python-openstackclient is running properly. Operation methods vary depending on the OS you use. The 64-bit Ubuntu 16.04 OS is recommended. This section describes how to install and configure OpenStack Client by using the 64-bit Ubuntu 16.04 OS as an example.
+
To install OpenStack Client, perform the following operations as user root:
+
- Run the following commands to update the OS:
apt-get update
+apt-get upgrade
+ - Install Python.
Install Python and pip based on the type of the OS. Python 2.7 is supported.
+Ubuntu 16.04 includes Python 2.7. If Python is not installed, perform the following steps to install it:
+Run the following command to install Python:
+apt-get install python
+Run the following command to install Setuptools:
+apt-get install python-setuptools
+Run the following command to install pip:
+apt-get install python-pip
+If Ubuntu supports Setuptools and pip of earlier versions, you can install them offline.
+Run the following command to install Dev:
+apt-get install python-dev
+ - Install python-openstackclient and its dependent components.
The following python-openstackclient versions are supported by default:
+- python-openstackclient: 3.2.1
- python-novaclient: 6.0.2
- python-glanceclient: 2.5.0
- python-keystoneclient: 3.5.1
- python-neutronclient: 6.0.1
- python-cinderclient: 1.9.0
- python-heatclient: 1.5.1
- python-designateclient: 2.3.0
- openstacksdk: 0.9.5
- cliff: 2.2.0
- os-client-config: 1.21.1
- osc-lib: 1.1.0
+Run the following command to install python-openstackclient using pip:
+pip install python-openstackclient==3.2.1
+After the installation is complete, run the following command to verify the installation:
+openstack -h
+Check whether help information is displayed. The installation is successful if help information is displayed.
+Other components can be installed in sequence using the same command.
+
+
+
Configuration
You can configure OpenStack Client either as user root or as a common user.
+
- Switch to the directory where OpenStack Client is installed and create an environment variable file, for example, novarc.
- Use a text editor to edit the environment variable file and enter the username, password, region, IAM IP address, and port number.
The following is an example:
+export OS_USERNAME="user_name"
+export OS_USER_DOMAIN_NAME=user_domain_name
+export OS_PASSWORD=*******
+export TENANT_ID=********
+
+# Only change these for a different region
+export OS_TENANT_NAME=az1
+export OS_PROJECT_NAME=az1
+export OS_AUTH_URL=https://iam.az1.domainname.com:443/v3
+
+# No changes needed beyond this point
+export NOVA_ENDPOINT_TYPE=publicURL
+export OS_ENDPOINT_TYPE=publicURL
+export CINDER_ENDPOINT_TYPE=publicURL
+export OS_VOLUME_API_VERSION=2
+export OS_IDENTITY_API_VERSION=3
+export OS_IMAGE_API_VERSION=2
+Environment variables to be configured include the username, password, IAM URL, and port number. Table 1 describes the required environment variables.
+
+Table 1 Environment variablesParameter
+ |
+Description
+ |
+
|---|
+
+OS_USERNAME
+ |
+Specifies the username for logging in to the management console.
+ |
+
+OS_USER_DOMAIN_NAME
+ |
+Specifies the enterprise account for logging in to the management console.
+ |
+
+OS_PASSWORD
+ |
+Specifies the password for logging in to the management console.
+ |
+
+TENANT_ID
+ |
+Specifies the project ID provided in the project list on the My Credentials page.
+ |
+
+OS_TENANT_NAME
+ |
+Specifies the project name provided in the project list on the My Credentials page.
+ |
+
+OS_PROJECT_NAME
+ |
+The value is the same as the OS_TENANT_NAME value.
+ |
+
+OS_AUTH_URL
+ |
+The parameter value is in the format of https://IAM URL:Port number/API version, for example, https://iam.example.com:443/v3.
+
+ |
+
+
+
+
- Run the following command to set environment variables:
source novarc
+
+
The Heat client becomes available after OpenStackClient is installed and configured. For more information, see Creating Resources Using a Template (Using the Heat Client).
+
+
User Permissions
+The cloud system provides two types of user permissions by default, user management and resource management.
+
- User management refers to management of users, user groups, and user group permissions.
- Resource management refers to control of operations on cloud service resources.
+
For details, see Permissions.
+
Getting Started
+
+
+
diff --git a/docs/rts/umn/rts_02_0002.html b/docs/rts/umn/rts_02_0002.html
new file mode 100644
index 00000000..3485eb9e
--- /dev/null
+++ b/docs/rts/umn/rts_02_0002.html
@@ -0,0 +1,63 @@
+
+
+Creating Resources Using a Template (Using the Heat Client)
+After the Heat client is installed and configured, you can use this client to create an ECS.
+
The required operations are as follows:
+
- Compile a Template: A template is a collection of resources and a blueprint for resource orchestration. Before creating a resource, compile a template according to syntax requirements.
- Create Resources: To create an ECS, run commands on the Heat client to create an ECS stack.
- View Resources: To view resources, run commands on the Heat client to view all resource stacks and details of a specified resource stack.
- Delete Resources: To delete resources, run commands on the Heat client to delete the resource stack if the stack is no longer used.
+
Compile a Template
Create a template and name it server_instance.yaml. The template content is as follows:
+
heat_template_version: 2014-10-16
+description: Create a simple ECS instance.
+parameters:
+ name:
+ type: string
+ description: Specifies the ECS name.
+ image:
+ type: string
+ description: Specifies the image used for creating ECS. The value can be the name or ID of the image.
+ flavor:
+ type: string
+ description: Specifies the flavor used for creating ECS.
+ key:
+ type: string
+ description: Specifies the key pair used for creating ECS. The value can be the name of the key pair.
+ network_id:
+ type: string
+ description: Specifies the network used for creating ECS. The value can be the name or ID of the network.
+ availability_zone:
+ type: string
+ description: Specifies the name of the AZ to which the ECS belong.
+
+resources:
+ nova_serer:
+ type: OS::Nova::Server
+ properties:
+ name: { get_param: name }
+ image: { get_param: image }
+ flavor: { get_param: flavor }
+ key_name: { get_param: key }
+ networks:
+ - network: { get_param: network_id }
+ availability_zone: { get_param: availability_zone }
+
This YAML file contains four first-level fields:
+
- heat_template_version: indicates the template version. This field is mandatory.
- description: provides a description for the template. This field is optional.
- parameters: defines template parameters. In this example template, this field defines the ECS name, image name or ID, key pair, specifications, VPC, and AZ. All of these can be used by function get_param in resources.
- resources: defines resources to be created by the template. In this example, the resources is an ECS.
- type: defines the resource. You need to enter parameters in properties when creating a resource. For details, see Create Resources.
+
+
Create Resources
Run the following command on the Heat client to create a resource stack:
+
heat stack-create -f server_instance.yaml -P 'name=ecs_name;image=Redhat-6.9;flavor=m1.medium;key=keypair_name;network_id=external-network3;availability_zone=az_name' ecsStack
+
In this command,
+
- server_instance.yaml: indicates the name of the template file.
- ecsStack: indicates the name of the resource stack to be created. The value can be user-defined.
- Other variables are values of the parameters defined in the template.
+
+
View Resources
Perform the following operations to check whether the resource stack is created:
- Run the following command to query all stacks and check whether the new stack is included:
heat stack-list
+ - (Optional) Run the following command to view details of the new stack:
heat stack-show ecsStack
+
+
+
+
Delete Resources
If you do not need a resource stack any longer, run the following command to delete it:
+
heat stack-delete ecsStack
+
+
Creating Resources Using a Template (Using the Console)
+With RTS, you can orchestrate a stack that contains a collection of resources using a template and maintain these resources by managing stacks on the console. This section describes how to orchestrate a complex application with RTS by creating an example Elastic Cloud Server (ECS). After the operations in this section are complete, you can view a created ECS on the ECS console.
+
The required operations are as follows:
+
- Create a Key Pair: Create a key pair for logging in to an ECS through SSH. If you already have a key pair, skip this step.
- Create an ECS Stack: Compile a template for creating an ECS.
+
Create a Key Pair
To create an ECS using RTS, you need to create a key pair first for identity authentication during SSH login.
+
If you already have a key pair, skip this step.
+
+
- Log in to the management console.
- Click
in the upper left corner to select the desired region and project. - Under Computing, click Elastic Cloud Server.
- In the navigation tree on the left, choose Key Pairs and click Create Key Pair.
- Enter a key pair name and click OK.
A key pair name consists of two parts: KeyPair and four random digits. You can enter an easy-to-remember name, for example, KeyPair-xxxx_ecs.
+ - Manually or automatically download the private key file. The file name is a specified key pair name with a suffix of .pem. Securely store the private key file. In the displayed dialog box, click OK.
This is the only opportunity for you to save the private key file. Keep it secure. When creating an ECS stack, provide the name of your desired key pair. Each time you log in to the ECS using SSH, provide the private key.
+
+
+
Create an ECS Stack
- Log in to the management console.
- Click in the upper left corner to select the desired region and project.
- Under Management & Deployment, click Resource Template Service.
- Click Create Stack.
Figure 1 Create Stack
+ - Confirm the desired region and project.
If the region or project is incorrect, click the drop-down list for correction.
+ - Select Manually specify to enter the template content.
The details of an example ECS template are as follows:
+heat_template_version: 2014-10-16
+
+description: Create a simple ECS instance.
+
+parameters:
+ name:
+ type: string
+ label: ECS Name
+ description: Specifies the ECS name.
+ image:
+ type: string
+ label: Image Name or ID
+ description: Specifies the image used for creating ECS. The value can be the name or ID of the image.
+ constraints:
+ - custom_constraint: glance.image
+ key_name:
+ type: string
+ label: Key Pair
+ description: Specifies the key pair used for creating ECS. The value can be the name of the key pair.
+ constraints:
+ - custom_constraint: nova.keypair
+ flavor:
+ type: string
+ label: Flavor Name
+ description: Specifies the flavor used for creating ECS.
+ constraints:
+ - custom_constraint: nova.flavor
+ networks:
+ type: string
+ label: Network Name or ID
+ description: Specifies the network used for creating ECS. The value can be the name or ID of the network.
+ constraints:
+ - custom_constraint: neutron.network
+ availability_zone:
+ type: string
+ label: AZ Name
+ description: Specifies the name of the AZ to which the ECS belong.
+
+parameter_groups:
+ - label: ECS
+ parameters:
+ - name
+ - image
+ - key_name
+ - flavor
+ - networks
+ - availability_zone
+
+resources:
+ nova_serer:
+ type: OS::Nova::Server
+ properties:
+ name: { get_param: name }
+ image: { get_param: image }
+ flavor: { get_param: flavor }
+ key_name: { get_param: key_name }
+ networks:
+ - network: { get_param: networks }
+ availability_zone: { get_param: availability_zone }
+This YAML file contains five first-level fields:
+- heat_template_version: indicates the template version.
- description: provides a description for the template.
- parameters: defines template parameters. In this example template, this field defines the ECS name, image name or ID, key pair, specifications, VPC, and AZ. All of these can be used by function get_param in resources.
- parameter_groups: indicates the parameter groups and the parameter sequence.
- resources: defines resources to be created by the template. In this example, the resources is an ECS. type defines the resource type. Function get_param in properties directly uses parameters defined in parameters.
+
+Enter and verify template content and click Next.
+ - Specify details. Enter the stack name, ECS name, image, key pair, specifications, VPC, and AZ. Click Next.
Figure 2 Specifying details
+ - Confirm the information and create Next.
It takes some time to complete the creation. After the stack is created, click Stack Management in the left pane to view the stack status. You can also access the ECS console to view the created ECS.
+
+
For more information about stack management and templates, see Stack Management and Example Templates.
+
+
Template Syntax
+
+
+
diff --git a/docs/rts/umn/rts_02_0009.html b/docs/rts/umn/rts_02_0009.html
new file mode 100644
index 00000000..6f6cc876
--- /dev/null
+++ b/docs/rts/umn/rts_02_0009.html
@@ -0,0 +1,59 @@
+
+
+Template Structure
+Templates are blueprints for describing infrastructure and architecture and can be used to create stacks. The compiler defines resource requirements and configuration details in the template and describes the dependency between resources.
+
A template must be in the YAML format and consists of the following parts:
+
heat_template_version: xxxx-xx-xx
+# Indicates the template version. This field is mandatory.
+description:
+# Provides template information, template application scenarios, and architecture. This field is optional.
+parameter_groups:
+# Indicates the parameter groups and parameter sequence. This field is optional.
+parameters:
+# Indicates the parameters to be input. Using parameters improves template flexibility and reusability. This field is optional.
+resources:
+# Indicates user-defined resources (such as VMs, networks, and volumes), dependencies among resources, and configuration details. This field is optional.
+outputs:
+# Indicates outputs of the created resources. This field is optional.
+conditions:
+# Indicates the conditions that stack creation time and update time must meet. This field is optional.
+
The following is an example template for creating an ECS.
+
heat_template_version: 2013-05-23
+
+description: Simple template to deploy a single compute instance
+
+parameters:
+ key_name:
+ type: string
+ label: Key Name
+ description: Name of key-pair to be used for compute instance
+ image_id:
+ type: string
+ label: Image ID
+ description: Image to be used for compute instance
+ instance_type:
+ type: string
+ label: Instance Type
+ description: Type of instance (flavor) to be used
+ net_id:
+ type: string
+ label: Network UUID
+ description: The network to be used
+
+resources:
+ my_instance:
+ type: OS::Nova::Server
+ properties:
+ key_name: { get_param: key_name }
+ image: { get_param: image_id }
+ flavor: { get_param: instance_type }
+ networks: [ { network: { get_param: net_id } } ]
+
Description:
+
- heat_template_version: indicates the HOT template version. The value is a specified version. For details, see Template Version.
- description: describes resources to be created using the template. This field is optional and can be user-defined.
- parameters: defines some parameters, which are used in function get_param to define resource attributes. This field is optional.
- resources: defines all resources to be created by RTS and dependencies between these resources. This field is the core of the template. type: indicates the resource type.
+
Template Version
+The heat_template_version field indicates the template version. Each HOT template includes the heat_template_version field that specifies the template version. Different HOT template versions support different internal functions. RTS supports the following HOT template versions:
+
- heat_template_version 2013-05-23:
The heat_template_version 2013-05-23 template supports the following internal functions:
+get_attr, get_file, get_param, get_resource, list_join, resource_facade, str_replace, Fn::Base64, Fn::GetAZs, Fn::Join, Fn::MemberListToMap, Fn::Replace, Fn::ResourceFacade, Fn::Select, Fn::Split, and Ref
+
+
- heat_template_version 2014-10-16:
The heat_template_version 2014-10-16 template supports the following internal functions:
+get_attr, get_file, get_param, get_resource, list_join, resource_facade, str_replace, and Fn::Select
+ - heat_template_version 2015-04-30:
The heat_template_version 2015-04-30 template supports the following internal functions:
+get_attr, get_file, get_param, get_resource, list_join, repeat, digest, resource_facade, str_replace, and Fn::Select
+ - heat_template_version 2015-10-15:
The heat_template_version 2015-10-15 template supports the following internal functions:
+get_attr, get_file, get_param, get_resource, list_join, repeat, digest, resource_facade, str_replace, and str_split
+ - heat_template_version 2016-04-08:
The heat_template_version 2016-04-08 template supports the following internal functions:
+digest, get_attr, get_file, get_param, get_resource, list_join, map_merge, repeat, resource_facade, str_replace, and str_split
+
+
Template Description
+Template description is specified in the description field. This field is used to further describe resources that can be deployed using the current template. If the description cannot be displayed in one line, it can go over several lines.
+
description: >
+ This is how you can provide a longer description
+ of your template that goes over several lines.
+
Parameters
+Parameters
Parameters are specified in the parameters field. Using parameters improves template flexibility and reusability. Some parameters in the template can be replaced as needed during stack creation.
+
You can use defined parameters in resources and outputs fields by invoking internal function get_param.
+
The following provides an example:
+
parameters:
+ name:
+ type: string
+ label:
+ description:
+ default: Parameter default value
+
Description:
+
- type: indicates the value type of a parameter, including string and number.
- label: indicates the name of the parameter label displayed on the console.
- description: indicates an explanation of this parameter.
- default: indicates the default value of the parameter.
+
+
Parameter Groups
A parameter group is specified in the parameter_groups field. This field is used to group entered parameters and specify their sequence. This field is optional.
+
The following provides an example:
+
heat_template_version: 2014-10-16
+description: Create a serious of random strings
+parameters:
+ name:
+ type: string
+ default: random1
+ length:
+ type: number
+ default: 4
+ length1:
+ type: number
+ default: 5
+ length2:
+ type: number
+ default: 4
+parameter_groups:
+ - label: length
+ parameters:
+ - length
+ - length2
+ - length1
+resources:
+ random1:
+ type: OS::Heat::RandomString
+ properties:
+ length: 5
+ random2:
+ type: OS::Heat::RandomString
+ properties:
+ length: 5
+
The parameter group includes three parameters: length, length1, and length2. Set label to length and define these parameters in the Parameters area. After a template is uploaded, parameters are classified into two types: length Parameters and Other Parameters on the Specify Details page.
+
Figure 1 Parameter information
+
+
Parameter Constraints
When compiling a template, you can configure custom_constraint to obtain the list of values on the Specify Details page. You only need to select a value from the drop-downlist, reducing configuration time.
+
The custom_constraint attribute currently supports the following types:
+
- glance.image
- cinder.volume
- neutron.network
- neutron.router
- neutron.subnet
- nova.flavor
- nova.keypair
+
For example, custom_constraint is configured for parameters image, key_name, flavor, and networks in the template for creating an ECS. The list of values of four parameters on the Specify Details page. For details, see Creating Resources Using a Template (Using the Console).
+
+
Valid Parameter Values
Valid-value constraints can be applied to numeric or string-type parameters, which specify a set of parameter values that a parameter may have. During the deployment, user-supplied values must match an element in the list of valid values.
+
The syntax is as follows:
+
allowed_values: [<value 1>, <value 2>, ...]
+
Or the following format:
+
allowed_values:
+- <value 1>
+- <value 2>
+ - ...
+
+
Resources
+Resources are specified in the resources field. This field includes user-defined resources (such as VMs, networks, and volumes) and dependencies between them. Each resource has a unique name. Different resources must be placed in different paragraphs. The format is as following:
+
resources:
+ <resource ID>:
+ type: <resource type>
+ properties:
+ <property name>: <property value>
+ metadata:
+ <resource specific metadata>
+ depends_on: <resource ID or list of ID>
+ update_policy: <update policy>
+ deletion_policy: <deletion policy>
+
Syntax
resource ID
+
Indicates the resource ID, which must be unique in the template. You can use this resource ID to create other fields of a template.
+
type
+
Indicates the type of the resource which is being declared. For example, OS::Nova::Server indicates an ECS instance. For resource types supported by RTS and their details, see Supported Resources.
+
properties
+
The resource attribute is in the key-value format and is an additional option for a resource. For example, you must specify a flavor name for each ECS instance.
+
An example is provided as follows:
+
resources:
+ my_instance:
+ type: OS::Nova::Server
+ properties:
+ flavor: m1.small
+
If no attribute needs to be declared for a resource, resource attributes can be ignored.
+
depends_on
+
In the template, you can set depends_on to specify that a specific resource is created after the other resource is created. For example, after depends_on is set for a resource, this resource can only be created after the resource specified in depends_on is created.
+
As shown in the following code segment, WebServer is created only after DatabaseServer is created.
+
heat_template_version: 2013-05-23
+resources:
+ WebServer:
+ type: OS::Nova::Server
+ depends_on: DatabaseServer
+ DatabaseServer:
+ type: OS::Nova::Server
+ properties:
+ flavor: m1.small
+ image: CentOS 7.6 64bit
+
update_policy and deletion_policy
+
In the template, you can set update_policy or deletion_policy to declare that a resource is retained when the resource stack is updated or deleted. For example, if you want to retain the ECS instance when deleting the stack, you can declare as the following code segment shows:
+
resources:
+ ecs_instance:
+ type: OS::Nova::Server
+ properties:
+ flavor: m1.small
+ image: CentOS 7.6 64bit
+ deletion_policy: Retain
+
In this example, if a stack using the template is deleted, the ecs_instance resource is retained.
+
+
Outputs
+Outputs are specified in the outputs field. This field is used to display the output of created resources. This field is optional. For example, the following code segment defines the IP address of an ECS instance. You can view the IP address from the response of a stack querying request.
+
outputs:
+ instance_ip:
+ description: The IP address of the deployed instance
+ value: { get_attr: [my_instance, first_address] }
+
Syntax
outputs consists of three parts: output item, description, and value. If multiple output items are declared, use commas (,) to separate them. The following is an example code segment.
+
outputs:
+ ECSName:
+ description: The Name of the ECS instance newly created.
+ value: { get_attr: [server, name] }
+ floating_ip:
+ description: The floating ip address of the server.
+ value: { get_attr: [floating_ip, floating_ip_address] }
+
In this command,
+
- ECSName and floating_ip are both output items, which are unique in the template.
- description: describes the meaning of ECSName. This field is optional.
- value: indicates the attribute value returned when the stack querying API is invoked, or the output value viewed on the management console. The value value can be obtained using internal functions, such as get_attr in this example.
+
+
Conditions
+Conditions are specified in the conditions field. This field indicates the conditions that must be met during stack creation and update. You can define one or more conditions based on the parameters entered during stack creation and update.
+
Conditions can be associated with resources, resource attributes, and outputs. For example, you can create resources, set different attribute values, and provide stack outputs based on conditions.
+
Syntax
The syntax of conditions is as follows:
+
conditions:
+ <condition name1>: {expression1}
+ <condition name2>: {expression2}
+ ...
+
condition name
+
Indicates the condition name, which is unique in the template.
+
expression
+
Indicates an expression that is expected to return True or False. Generally, conditional functions can be used as expressions, such as EQUALS, NOT, and AND.
+
The following provides an example:
+
parameters:
+ env_type:
+ default: test
+ type: string
+conditions:
+ create_prod_res: {equals : [{get_param: env_type}, "prod"]}
+resources:
+ volume:
+ type: OS::Cinder::Volume
+ condition: create_prod_res
+ properties:
+ size: 1
+outputs:
+ vol_size:
+ value: {get_attr: [my_volume, size]}
+ condition: create_prod_res
+
volume in resources and vol_size in outputs are both associated with the create_prod_res condition. It can be judged according to the definition of the create_prod_res condition that, volume is created and vol_size is output only when env_type is set to prod.
+
+
Internal Function
+Internal functions are used in a template to implement specific functions. For example, internal functions can be used to obtain external input parameters and attribute information about specified resources. Internal functions can only be used in the resources or outputs field.
+
Internal functions include get_attr, get_file, get_param, and get_resource. The internal functions supported by different template versions are different. For details, see Template Version. For syntax and examples of internal functions, see OpenStack Official Website.
+
Stack Management
+
+
+
diff --git a/docs/rts/umn/rts_02_0018.html b/docs/rts/umn/rts_02_0018.html
new file mode 100644
index 00000000..f0f55a4f
--- /dev/null
+++ b/docs/rts/umn/rts_02_0018.html
@@ -0,0 +1,41 @@
+
+
+Scenarios
+- To perform operations on a stack using the Heat client, you only need to compile a template file.
- To perform operations on a stack using the RTS console, you need to not only compile a template file, but also package the file in the required format if you create a stack by uploading a template. However, packaging the template file is not required if you choose to compile a template online. Compiling a template online is suitable if only one template is required. Uploading a template fits a wider range of templates: a single template or nested templates.
+
+
Table 1 Scenario descriptionMethod
+ |
+How to Prepare a Template
+ |
+
|---|
+
+Heat client
+ |
+Use a text editor (like Notepad++) to compile a template and save it in the YAML format.
+ |
+
+Management console
+ |
+Entering template content
+ |
+Compile a template using a text editor and copy template content to the text box when creating a stack.
+ |
+
+Uploading a file
+ |
+Compile a template using a text editor and then pack it in the format provided in Template Package Structure. Example Template Packages provides examples for your reference.
+ |
+
+
+
+
+
Template files can be in the YAML or JSON format.
+
You can compile a template by following instructions in Template Syntax. If you are not familiar with how to compile a template, you can refer to our examples.
+
+
Template Package Structure
+You need to prepare a .zip package. For the package structure, see Figure 1.
+
Figure 1 Package structure
+
- Resources Directory
This directory is used to store the files referenced by template files in the root directory. You can save the template files, configuration files, and script files used by the template in this directory. Templates of a nested stack must be placed in this directory. Do not change the name and structure of the directory.
+Figure 2 Structure of Resources directory
+ - File logo.png
The default file name logo is recommended, and there are no restrictions on the logo file name. However, if the file name is different from the default logo.png file, you need to ensure that the logo file name in the package is consistent with the Logo value in file manifest.yaml.
+ File logo.png is not supported and will be supported in later versions.
+
+ - File manifest.yaml
File manifest. yaml describes basic information of the package. The default file format is recommended. The following is an example file:
+Format: Heat.HOT/1.0
+Type: Application
+FullName: Reserved
+Name: Auto Scaling Group
+Description: "Heat template to deploy a stack."
+Author: RTS
+Tags:
+ - hot-based
+Logo: logo.png
+ The file name is fixed and cannot be user-defined.
+
+ - random.yaml and template.yaml
random.yaml and template.yaml are two example templates. You can define your own template based on these example templates. random.yaml is a template file that can be used to create random strings. This file can be used to create two random strings. template.yaml is a nested template file, which contains a nested template (random1.yaml). The sub-template is in the Resources/HotFiles directory.
+The following is an example manifest.yaml file:
+heat_template_version: 2014-10-16
+description: Create a serious of random string
+
+parameters:
+ length:
+ type: number
+ default: 4
+
+resources:
+ random1:
+ type: OS::Heat::RandomString
+ properties:
+ length: {get_param: length}
+ random2:
+ type: OS::Heat::RandomString
+ properties:
+ length: {get_param: length}
+
+The following is an example template.yaml file:
+heat_template_version: 2014-10-16
+description: Create a serious of random string
+
+parameters:
+ length:
+ type: number
+ default: 4
+
+resources:
+ random1:
+ type: OS::Heat::RandomString
+ properties:
+ length: {get_param: length}
+ random2:
+ type: OS::Heat::RandomString
+ properties:
+ length: {get_param: length}
+ random3:
+ type: random1.yaml
+
+
- A valid package name contains a maximum of 32 characters, including letters, digits, hyphens (-), and underscores (_). The name must start with a letter and end with .zip.
- The structure of directory Resources/HotFiles is fixed and cannot be changed.
- When you use a .zip package, all template files in the root directory are displayed on the console, and you can select any template to create a stack.
- If necessary, you can add a file named environment.yaml to the root directory configured on the console.
- The logo file and the manifest.yaml file are mandatory and must be stored in the root directory.
- If file get_file: abc.txt is used in the template, this file must be placed in directory Resources/HotFiles.
- Other restrictions are as follows:
- The maximum size of a template file is 100 KB.
- The maximum size of a .zip package cannot exceed 80 KB.
- The maximum nesting depth is restricted to seven.
- The maximum number of files is 50.
+
+
+
Template File Packaging
+After you have prepared all template files and completed the required configuration, you can use compression software to package them into .zip files. The following is an example of using WinRAR to package a template package.
+
- Select all files, right-click, and choose Add to archive.
Figure 1 Packaging template files
+ - Select the .zip format.
Figure 2 Package type
+ - Produce a package.
Figure 3 Compression format
+
+
A template package is prepared. The size of a .zip template package cannot exceed 80 KB. A template package can contain one or more template files.
+
Example Template Packages
+The following are example template packages:
+
+
Creating a stack
+With RTS, you can create a collection of cloud resources using a template. These resources are defined as a stack. This section uses creating a random string as an example to describe how to create a stack on the RTS console.
+
Prerequisite
You have prepared a stack template.
+
+
Procedure
- Log in to the management console.
- Click in the upper left corner to select the desired region and project.
- Under Management & Deployment, click Resource Template Service.
- Click Create Stack in the upper right corner.
The process of creating a stack is displayed.
+ - Upload a template.
- For a single template, you can create a stack by entering template content online.
- Template Source: Select Manually specify.
- Template Content: Enter template content online or copy content of an existing template to the text box.
The template must comply with the JSON or YAML format and uses the UTF-8 encoding format.
+
+ - Click Next to check syntax.
If the syntax check succeeds, the Specify Details page is displayed. If the syntax check fails, modify the template as prompted.
+
+ - For a single or nested template, you can create a stack by uploading a template package.
Figure 1 Uploading a template file
+- Template Source: Select Upload template.
- Stack Template: Click
, select the prepared template package, and click Upload. - Main File: Select a template file as the main file based on the resources you want to create. A template package may contain multiple template files.
- After selecting a main file, click Next to check the syntax.
If the syntax check succeeds, the Specify Details page is displayed. If the syntax check fails, modify the template as prompted.
+
+
+ - On the Specify Details page, enter a stack name, set parameters based on the required resource information, and click Next.
The stack name:
+
- Contains 1 to 255 characters.
- Starts with a letter.
- Can contain digits, hyphens (-), dots (.), and underlines (_).
+
+ - Confirm that stack configurations are correct and click Submit.
It takes some time to complete the creation.
+
+
+
Result
You can view the stack creation result in the stack list or details or query events.
+
You can click Events on the Specify Details page to view each operation occurring during stack creation. All operations are displayed in the time sequence, and the latest operation is in the first row.
+
+
Viewing Details of a Stack
+- Log in to the management console.
- Click in the upper left corner to select the desired region and project.
- Under Management & Deployment, click Resource Template Service.
- In the stack list, locate the target stack and click its name.
The stack details page is displayed.
+ - View stack information, such as the name, ID, stack description, creation time, and status.
If Parameter and Output are not empty, you can click View Details to see more information.
+ - You can also click Resources, Events, and Template to view stack details.
+
+
Updating a Stack
+If the existing stack cannot meet your service requirements, you can use the update function to modify the stack. The procedure for updating a stack is the same as that for creating a stack.
+
- Log in to the management console.
- Click in the upper left corner to select the desired region and project.
- Under Management & Deployment, click Resource Template Service.
- In the stack list, locate the target stack and click Update in the Operation column.
The process of updating a stack is displayed.
+ - Upload a template.
You can modify the template content or upload a new template file to update the stack. Note that you can replace the template content with another template or upload a new template package to rebuild the stack.
+ - Configure parameters based on the template that you use.
Updating the stack name is not supported.
+
+ - Confirm that stack configurations are correct and click Submit.
It takes some time to complete the update.
+
+
Result
Go back to the stack list and check whether stack status changes to Update complete. You can also view the updated template and resource information on the stack details page and the entire life cycle of the stack on the Events page.
+
+
Deleting a Stack
+If you no longer use a stack, you can delete it.
+
- Log in to the management console.
- Click in the upper left corner to select the desired region and project.
- Under Management & Deployment, click Resource Template Service.
- In the stack list, select the target stack and click Delete in the Operation column.
Deleting a stack deletes all resources in the stack. Exercise caution when performing this operation.
+
+
+
Resource Type Reference
+
+
+
diff --git a/docs/rts/umn/rts_02_0037.html b/docs/rts/umn/rts_02_0037.html
new file mode 100644
index 00000000..1c888c6a
--- /dev/null
+++ b/docs/rts/umn/rts_02_0037.html
@@ -0,0 +1,26 @@
+
+
+Example Templates
+This section introduces typical example templates.
+
OS::Cinder::Volume
+A resource that implements Cinder volumes.
+
Cinder volume is a storage in the form of block devices. It can be used, for example, for providing storage to instance. Volume supports creation from snapshot, backup or image. Also volume can be created only by size.
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+availability_zone
+ |
+The availability zone in which the volume will be created.
+String value expected.
+Updates cause replacement.
+ |
+
+backup_id
+ |
+If specified, the volume to create from the backup.
+The parameter backup_restore can specify how to restore the backup.
+String value expected.
+Can be updated without replacement.
+ |
+
+backup_restore
+ |
+The method of restoring a backup during the creation of a volume. The value is heat or vbs. The default value is heat.
+- When specified as heat, the native recovery method is used, which is to restore a volume from backup.
- When specified as vbs, after the volume is created, the API of the VBS service is called for recovery.
+String value expected.
+Updates cause replacement.
+ |
+
+description
+ |
+A description of the volume.
+String value expected.
+Can be updated without replacement.
+ |
+
+image
+ |
+If specified, the name or ID of the image to create the volume from.
+String value expected.
+Updates cause replacement.
+Value must be of type glance.image
+ NOTE: image, imageRef, snapshot_id and source_volid cannot appear at the same time, otherwise the stack will fail to create.
+
+ |
+
+imageRef
+ |
+The ID of the image to create the volume from.
+String value expected.
+Updates cause replacement.
+ |
+
+metadata
+ |
+Key/value pairs to associate with the volume.
+Map value expected.
+Can be updated without replacement.
+ |
+
+name
+ |
+A name used to distinguish the volume.
+String value expected.
+Can be updated without replacement.
+ |
+
+size
+ |
+The size of the volume in GB. On update only increase in size is supported.
+- This parameter is ignored when backup_id is specified and backup_restore is set to heat.
- This parameter is not required when source_volid or snapshot_id is specified.
+Integer value expected.
+Can be updated without replacement.
+The value must be at least 1.
+ |
+
+snapshot_id
+ |
+If specified, the snapshot to create the volume from.
+String value expected.
+Updates cause replacement.
+ |
+
+source_volid
+ |
+If specified, the volume to use as source.
+String value expected.
+Updates cause replacement.
+ |
+
+volume_type
+ |
+If specified, the type of volume to use, mapping to a specific backend.
+String value expected.
+Can be updated without replacement.
+ |
+
+multiattach
+ |
+Whether allow the volume to be attached more than once.
+Boolean value expected.
+Updates cause replacement.
+Defaults to "False".
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+availability_zone
+ |
+The availability zone in which the volume is located.
+ |
+
+bootable
+ |
+Boolean indicating if the volume can be booted or not.
+ |
+
+created_at
+ |
+The timestamp indicating volume creation.
+ |
+
+display_description
+ |
+Description of the volume.
+ |
+
+display_name
+ |
+Name of the volume.
+ |
+
+metadata
+ |
+Key/value pairs associated with the volume.
+ |
+
+metadata_values
+ |
+Key/value pairs associated with the volume in raw dict form.
+ |
+
+multiattach
+ |
+Boolean indicating whether allow the volume to be attached more than once.
+ |
+
+size
+ |
+The size of the volume in GB.
+ |
+
+snapshot_id
+ |
+The snapshot the volume was created from, if any.
+ |
+
+source_volid
+ |
+The volume used as source, if any.
+ |
+
+status
+ |
+The current status of the volume.
+ |
+
+volume_type
+ |
+The type of the volume mapping to a backend, if any.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Cinder::Volume
+ properties:
+ availability_zone: String
+ backup_id: String
+ description: String
+ image: String
+ metadata: {...}
+ name: String
+ size: Integer
+ volume_type: String
+
+
OS::Cinder::VolumeAttachment
+Resource for associating volume to instance.
+
Resource for associating existing volume to instance. Also, the location where the volume is exposed on the instance can be specified.
+
Do not attach multiple volumes to one VM at the same time in the template.
+
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+instance_uuid
+ |
+The ID of the server to which the volume attaches.
+String value expected.
+Can be updated without replacement.
+ |
+
+volume_id
+ |
+The ID of the volume to be attached.
+String value expected.
+Can be updated without replacement.
+Value must be of type cinder.volume
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+mountpoint
+ |
+The location where the volume is exposed on the instance. This assignment may not be honored and it is advised that the path /dev/disk/by-id/virtio- be used instead.
+String value expected.
+Can be updated without replacement.
+Detailed information about resource.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Cinder::VolumeAttachment
+ properties:
+ instance_uuid: String
+ mountpoint: String
+ volume_id: String
+
+
OS::Heat::AutoScalingGroup
+An autoscaling group that can scale arbitrary resources.
+
An autoscaling group allows the creation of a desired count of similar resources, which are defined with the resource property in HOT format. If there is a need to create many of the same resources (e.g. one hundred sets of Server, WaitCondition and WaitConditionHandle or even Neutron Nets), AutoScalingGroup is a convenient and easy way to do that.
+
- During the scaling process, you are not allowed to create members. Otherwise, the scaling action fails.
- Cross-AZ automatic scaling is not supported.
+
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+max_size
+ |
+Maximum number of resources in the group.
+Integer value expected.
+Can be updated without replacement.
+The value must be at least 0.
+ |
+
+min_size
+ |
+Minimum number of resources in the group.
+Integer value expected.
+Can be updated without replacement.
+The value must be at least 0.
+ |
+
+resource
+ |
+Resource definition for the resources in the group, in HOT format. The value of this property is the definition of a resource just as if it had been declared in the template itself.
+Map value expected.
+Can be updated without replacement.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+cooldown
+ |
+Cooldown period, in seconds.
+Integer value expected.
+Can be updated without replacement.
+ |
+
+desired_capacity
+ |
+Desired initial number of resources.
+Integer value expected.
+Can be updated without replacement.
+ |
+
+rolling_updates
+ |
+Policy for rolling updates for this scaling group.
+Map value expected.
+Can be updated without replacement.
+Defaults to "{max_batch_size: 1, min_in_service: 0, pause_time: 0}".
+Map properties:
+- max_batch_size
The maximum number of resources to replace at once.
+Integer value expected.
+Can be updated without replacement.
+Defaults to "1".
+The value must be at least 1.
+ - min_in_service
The minimum number of resources in service while rolling updates are being executed.
+Integer value expected.
+Can be updated without replacement.
+Defaults to "0".
+The value must be at least 0.
+ - pause_time
The number of seconds to wait between batches of updates.
+Number value expected.
+Can be updated without replacement.
+Defaults to "0".
+The value must be at least 0.
+
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+outputs
+ |
+A map of resource names to the specified attribute of each individual resource that is part of the AutoScalingGroup. This map specifies output parameters that are available once the AutoScalingGroup has been instantiated.
+ |
+
+outputs_list
+ |
+A list of the specified attribute of each individual resource that is part of the AutoScalingGroup. This list of attributes is available as an output once the AutoScalingGroup has been instantiated. Detailed information about resource.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::AutoScalingGroup
+ properties:
+ cooldown: Integer
+ desired_capacity: Integer
+ max_size: Integer
+ min_size: Integer
+ resource: {...}
+ rolling_updates: {"max_batch_size": Integer, "pause_time": Number, "min_in_service": Integer}
+
+
OS::Heat::CloudConfig
+A configuration resource for representing cloud-init cloud-config.
+
This resource allows cloud-config YAML to be defined and stored by the config API. Any intrinsic functions called in the config will be resolved before storing the result.
+
This resource will generally be referenced by OS::Nova::Server user_data, or OS::Heat::MultipartMime parts config. Since cloud-config is boot-only configuration, any changes to the definition will result in the replacement of all servers which reference it.
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+cloud_config
+ |
+Map representing the cloud-config data structure which will be formatted as YAML.
+Map value expected.
+Updates cause replacement.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::CloudConfig
+ properties:
+ cloud_config: {...}
+
+
OS::Heat::MultipartMime
+Assembles a collection of software configurations as a multi-part mime.
+
Parts in the message can be populated with inline configuration or references to other config resources. If the referenced resource is itself a valid multi-part mime message, that will be broken into parts and those parts appended to this message.
+
The resulting multi-part mime message will be stored by the configs API and can be referenced in properties such as OS::Nova::Server user_data.
+
This resource is generally used to build a list of cloud-init configuration elements including scripts and cloud-config. Since cloud-init is boot-only configuration, any changes to the definition will result in the replacement of all servers which reference it.
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+parts
+ |
+Parts belonging to this message.
+List value expected.
+Updates cause replacement.
+Defaults to "[]".
+List contents:
+
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::MultipartMime
+ properties:
+ parts: [{"filename": String, "subtype": String, "config": String, "type": String}, {"filename": String, "subtype": String, "config": String, "type": String}, ...]
+
+
OS::Heat::RandomString
+A resource which generates a random string.
+
This is useful for configuring passwords and secrets on services. Random string can be generated from specified character sequences, which means that all characters will be randomly chosen from specified sequences, or with some classes, e.g. letterdigits, which means that all character will be randomly chosen from union of ascii letters and digits. Output string will be randomly generated string with specified length (or with length of 32, if length property doesnt specified).
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+character_classes
+ |
+A list of character class and their constraints to generate the random string from.
+List value expected.
+Updates cause replacement.
+Defaults to "[{class: lettersdigits, min: 1}]".
+List contents:
+
+ |
+
+character_sequences
+ |
+A list of character sequences and their constraints to generate the random string from.
+List value expected.
+Updates cause replacement.
+List contents:
+
+ |
+
+length
+ |
+Length of the string to generate.
+Integer value expected.
+Updates cause replacement.
+Defaults to "32".
+The value must be in the range 1 to 512, include 1 and 512.
+ |
+
+salt
+ |
+Value which can be set or changed on stack update to trigger the resource for replacement with a new random string. The salt value itself is ignored by the random generator.
+String value expected.
+Updates cause replacement.
+ |
+
+sequence
+ |
+Sequence of characters to build the random string from.
+String value expected.
+Updates cause replacement.
+Allowed values: lettersdigits, letters, lowercase, uppercase, digits, hexdigits, octdigits
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+value
+ |
+The random string generated by this resource. This value is also available by referencing the resource.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::RandomString
+ properties:
+ character_classes: [{"class": String, "min": Integer}, {"class": String, "min": Integer}, ...]
+ character_sequences: [{"min": Integer, "sequence": String}, {"min": Integer, "sequence": String}, ...]
+ length: Integer
+ salt: String
+ sequence: String
+
+
OS::Heat::ResourceGroup
+Creates one or more identically configured nested resources.
+
In addition to the refs attribute, this resource implements synthetic attributes that mirror those of the resources in the group. When getting an attribute from this resource, however, a list of attribute values for each resource in the group is returned. To get attribute values for a single resource in the group, synthetic attributes of the form resource.{resource index}.{attribute name} can be used. The resource ID of a particular resource in the group can be obtained via the synthetic attribute resource.{resource index}. Note, that if you get attribute without {resource index}, e.g. [resource, {attribute_name}], you will get a list of this attributes value for all resources in group.
+
While each resource in the group will be identically configured, this resource does allow for some index-based customization of the properties of the resources in the group. For example:
+
resources:
+ my_indexed_group:
+ type: OS::Heat::ResourceGroup
+ properties:
+ count: 3
+ resource_def:
+ type: OS::Nova::Server
+ properties:
+ # create a unique name for each server
+ # using its index in the group
+ name: my_server_%index%
+ image: CentOS 6.5
+ flavor: 4GB Performance
+
would result in a group of three servers having the same image and flavor, but names of my_server_0, my_server_1, and my_server_2. The variable used for substitution can be customized by using the index_var property.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+resource_def
+ |
+Resource definition for the resources in the group. The value of this property is the definition of a resource just as if it had been declared in the template itself.
+Map value expected.
+Can be updated without replacement.
+Map properties:
+- metadata
Supplied metadata for the resources in the group.
+Map value expected.
+Can be updated without replacement.
+ - properties
Property values for the resources in the group.
+Map value expected.
+Can be updated without replacement.
+ - type
The type of the resources in the group.
+String value expected.
+Can be updated without replacement.
+
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+count
+ |
+The number of resources to create.
+Integer value expected.
+Can be updated without replacement.
+Defaults to "1".
+The value must be at least 0.
+ |
+
+index_var
+ |
+A variable that this resource will use to replace with the current index of a given resource in the group. Can be used, for example, to customize the name property of grouped servers in order to differentiate them when listed with nova client.
+String value expected.
+Updates cause replacement.
+Defaults to "%index%".
+The length must be at least 3.
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+attributes
+ |
+A map of resource names to the specified attribute of each individual resource. Requires heat_template_version: 2014-10-16.
+ |
+
+refs
+ |
+A list of resource IDs for the resources in the group.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::ResourceGroup
+ properties:
+ count: Integer
+ index_var: String
+ removal_policies: [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...]
+ resource_def: {"type": String, "properties": {...}, "metadata": {...}}
+
+
OS::Heat::ScalingPolicy
+A resource to manage scaling of OS::Heat::AutoScalingGroup.
+
Resource to manage scaling for OS::Heat::AutoScalingGroup, i.e. define which metric should be scaled and scaling adjustment, set cooldown etc.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+adjustment_type
+ |
+Type of adjustment (absolute or percentage).
+String value expected.
+Can be updated without replacement.
+Allowed values: change_in_capacity, exact_capacity, percent_change_in_capacity
+ |
+
+auto_scaling_group_id
+ |
+AutoScaling group ID to apply policy to.
+String value expected.
+Updates cause replacement.
+ |
+
+scaling_adjustment
+ |
+Size of adjustment.
+Number value expected.
+Can be updated without replacement.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+cooldown
+ |
+Cooldown period, in seconds.
+Number value expected.
+Can be updated without replacement.
+ |
+
+min_adjustment_step
+ |
+Minimum number of resources that are added or removed when the AutoScaling group scales up or down. This can be used only when specifying percent_change_in_capacity for the adjustment_type property.
+Integer value expected.
+Can be updated without replacement.
+The value must be at least 0.
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+alarm_url
+ |
+A signed url to handle the alarm.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::ScalingPolicy
+ properties:
+ adjustment_type: String
+ auto_scaling_group_id: String
+ cooldown: Number
+ min_adjustment_step: Integer
+ scaling_adjustment: Number
+
+
OS::Heat::SoftwareComponent
+A resource for describing and storing a software component.
+
This resource is similar to OS::Heat::SoftwareConfig. In contrast to SoftwareConfig which allows for storing only one configuration (e.g. one script), SoftwareComponent allows for storing multiple configurations to address handling of all lifecycle hooks (CREATE, UPDATE, DELETE) for a software component in one place.
+
This resource is backed by the persistence layer and the API of the SoftwareConfig resource, and only adds handling for the additional configs property and attribute.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+configs
+ |
+The list of configurations for the different lifecycle actions of the represented software component.
+List value expected.
+Updates cause replacement.
+The length must be at least 1.
+List contents:
+
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+inputs
+ |
+Schema representing the inputs that this software config is expecting.
+List value expected.
+Updates cause replacement.
+List contents:
+
+ |
+
+options
+ |
+Map containing options specific to the configuration management tool used by this resource.
+Map value expected.
+Updates cause replacement.
+ |
+
+outputs
+ |
+Schema representing the outputs that this software config will produce.
+List value expected.
+Updates cause replacement.
+List contents:
+
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+config
+ |
+The config value of the software config.
+The config is generally read from a script file and often contains some parameter substitutions. The config value is the script content that actually runs in the virtual machine.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::SoftwareComponent
+ properties:
+ configs: [{"config": String, "tool": String, "actions": [String, String, ...]}, {"config": String, "tool": String, "actions": [String, String, ...]}, ...]
+ inputs: [{"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, {"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, ...]
+ options: {...}
+ outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
+
+
OS::Heat::SoftwareConfig
+A resource for describing and storing software configuration.
+
The software_configs API which backs this resource creates immutable configs, so any change to the template resource definition will result in a new config being created, and the old one being deleted.
+
Configs can be defined in the same template which uses them, or they can be created in one stack, and passed to another stack via a parameter.
+
A config resource can be referenced in other resource properties which are config-aware. This includes the properties OS::Nova::Server user_data, OS::Heat::SoftwareDeployment config and OS::Heat::MultipartMime parts config.
+
Along with the config script itself, this resource can define schemas for inputs and outputs which the config script is expected to consume and produce. Inputs and outputs are optional and will map to concepts which are specific to the configuration tool being used.
+
If the software configuration function is used, the cloud-init tool must be installed on images.
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+config
+ |
+Configuration script or manifest which specifies what actual configuration is performed.
+String value expected.
+Updates cause replacement.
+ |
+
+group
+ |
+Namespace to group this software config by when delivered to a server. This may imply what configuration tool is going to perform the configuration.
+String value expected.
+Updates cause replacement.
+Defaults to "Heat::Ungrouped".
+ |
+
+inputs
+ |
+Schema representing the inputs that this software config is expecting.
+List value expected.
+Updates cause replacement.
+List contents:
+
+ |
+
+options
+ |
+Map containing options specific to the configuration management tool used by this resource.
+Map value expected.
+Updates cause replacement.
+ |
+
+outputs
+ |
+Schema representing the outputs that this software config will produce.
+List value expected.
+Updates cause replacement.
+List contents:
+
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+config
+ |
+The config value of the software config.
+The config is generally read from a script file and often contains some parameter substitutions. The config value is the script content that actually runs in the virtual machine.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::SoftwareConfig
+ properties:
+ config: String
+ group: String
+ inputs: [{"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, {"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, ...]
+ options: {...}
+ outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
+
+
OS::Heat::SoftwareDeployment
+This resource associates a server with some configuration.
+
The configuration is to be deployed to that server.
+
A deployment allows input values to be specified which map to the inputs schema defined in the config resource. These input values are interpreted by the configuration tool in a tool-specific manner.
+
Whenever this resource goes to an IN_PROGRESS state, it creates an ephemeral config that includes the inputs values plus a number of extra inputs which have names prefixed with deploy_. The extra inputs relate to the current state of the stack, along with the information and credentials required to signal back the deployment results.
+
Unless signal_transport=NO_SIGNAL, this resource will remain in an IN_PROGRESS state until the server signals it with the output values for that deployment. Those output values are then available as resource attributes, along with the default attributes deploy_stdout, deploy_stderr and deploy_status_code.
+
Specifying actions other than the default CREATE and UPDATE will result in the deployment being triggered in those actions. For example this would allow cleanup configuration to be performed during action DELETE. A config could be designed to only work with some specific actions, or a config can read the value of the deploy_action input to allow conditional logic to perform different configuration for different actions.
+
If the software deployment function is used, the cloud-init, heat-config, os-collect-config, os-refresh-config, os-apply-config, and heat-config-script tools must be installed on images.
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+actions
+ |
+Which lifecycle actions of the deployment resource will result in this deployment being triggered.
+List value expected.
+Can be updated without replacement.
+Defaults to "[CREATE, UPDATE]".
+Allowed values: CREATE, UPDATE, DELETE
+ |
+
+config
+ |
+ID of software configuration resource to execute when applying to the server.
+String value expected.
+Can be updated without replacement.
+ |
+
+input_values
+ |
+Input values to apply to the software configuration on this server.
+Map value expected.
+Can be updated without replacement.
+ |
+
+server
+ |
+ID of resource to apply configuration to. Normally this should be a Nova server ID.
+String value expected.
+Updates cause replacement.
+ |
+
+name
+ |
+Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to a server.
+String value expected.
+Can be updated without replacement.
+ |
+
+signal_transport
+ |
+How the server should signal to heat with the deployment output values.
+- TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT.
- NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.
+String value expected.
+Updates cause replacement.
+Defaults to "TEMP_URL_SIGNAL".
+Allowed values: TEMP_URL_SIGNAL, NO_SIGNAL
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+deploy_status_code
+ |
+Returned status code from the configuration execution.
+ |
+
+deploy_stderr
+ |
+Captured stderr from the configuration execution.
+ |
+
+deploy_stdout
+ |
+Captured stdout from the configuration execution.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::SoftwareDeployment
+ properties:
+ actions: [Value, Value, ...]
+ config: String
+ input_values: {...}
+ name: String
+ server: String
+ signal_transport: String
+
+
OS::Heat::StructuredConfig
+A resource which has same logic with OS::Heat::SoftwareConfig.
+
This resource is like OS::Heat::SoftwareConfig except that the config property is represented by a Map rather than a String.
+
This is useful for configuration tools which use YAML or JSON as their configuration syntax. The resulting configuration is transferred, stored and returned by the software_configs API as parsed JSON.
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+config
+ |
+Map representing the configuration data structure which will be serialized to JSON format.
+Map value expected.
+Updates cause replacement.
+ |
+
+group
+ |
+Namespace to group this software config by when delivered to a server. This may imply what configuration tool is going to perform the configuration.
+String value expected.
+Updates cause replacement.
+Defaults to "Heat::Ungrouped".
+ |
+
+inputs
+ |
+Schema representing the inputs that this software config is expecting.
+List value expected.
+Updates cause replacement.
+List contents:
+
+ |
+
+options
+ |
+Map containing options specific to the configuration management tool used by this resource.
+Map value expected.
+Updates cause replacement.
+ |
+
+outputs
+ |
+Schema representing the outputs that this software config will produce.
+List value expected.
+Updates cause replacement.
+List contents:
+
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+config
+ |
+The config value of the software config.
+The config is generally read from a script file and often contains some parameter substitutions. The config value is the script content that actually runs in the virtual machine.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::StructuredConfig
+ properties:
+ config: {...}
+ group: String
+ inputs: [{"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, {"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, ...]
+ options: {...}
+ outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
+
+
OS::Heat::WaitCondition
+Resource for handling signals received by WaitConditionHandle.
+
Resource takes WaitConditionHandle and starts to create. Resource is in CREATE_IN_PROGRESS status until WaitConditionHandle doesnt receive sufficient number of successful signals (this number can be specified with count property) and successfully creates after that, or fails due to timeout.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+handle
+ |
+A reference to the wait condition handle used to signal this wait condition.
+String value expected.
+Updates cause replacement.
+ |
+
+timeout
+ |
+The number of seconds to wait for the correct number of signals to arrive.
+Number value expected.
+Updates cause replacement.
+The value must be in the range 1 to 43200, include 1 and 43200.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+count
+ |
+The number of success signals that must be received before the stack creation process continues.
+Integer value expected.
+Can be updated without replacement.
+Defaults to "1".
+The value must be at least 1.
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+data
+ |
+JSON string containing data associated with wait condition signals sent to the handle.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::WaitCondition
+ properties:
+ count: Integer
+ handle: String
+ timeout: Number
+
+
OS::Heat::WaitConditionHandle
+Resource for managing instance signals.
+
The main points of this resource are:
+
- have no dependencies (so the instance can reference it).
- create credentials to allow for signaling from the instance.
- handle signals from the instance, validate and store result.
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+signal_transport
+ |
+How the client will signal the wait condition.
+- TOKEN_SIGNAL will allow and HTTP POST to a Heat API endpoint with the provided keystone token.
- NO_SIGNAL will result in the resource going to a signalled state without waiting for any signal.
+String value expected.
+Updates cause replacement.
+Defaults to "TOKEN_SIGNAL".
+Allowed values: TOKEN_SIGNAL, NO_SIGNAL
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+curl_cli
+ |
+Convenience attribute, provides curl CLI command prefix, which can be used for signaling handle completion or failure when signal_transport is set to TOKEN_SIGNAL. You can signal success by adding –data-binary {"status": "SUCCESS"} , or signal failure by adding –data-binary {"status": "FAILURE"}. This attribute is set to None for all other signal transports.
+ |
+
+endpoint
+ |
+Endpoint/url which can be used for signaling handle when signal_transport is set to TOKEN_SIGNAL. None for all other signal transports.
+ |
+
+token
+ |
+Token for stack-user which can be used for signaling handle when signal_transport is set to TOKEN_SIGNAL. None for all other signal transports.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Heat::WaitConditionHandle
+ properties:
+ signal_transport: String
+
+
OS::Neutron::FloatingIP
+A resource for managing Neutron floating IP addresses.
+
Floating IP addresses can change their association between routers by action of the user. One of the most common use cases for floating IP addresses is to provide public IP addresses to a private cloud, where there are a limited number of IP addresses available. Another is for a cloud system user to have a "static" IP address that can be reassigned when an instance is upgraded or moved.
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+floating_network
+ |
+Network to allocate floating IP from.
+String value expected.
+Updates cause replacement.
+ |
+
+fixed_ip_address
+ |
+IP address to use if the port has multiple addresses.
+String value expected.
+Can be updated without replacement.
+ |
+
+port_id
+ |
+ID of an existing port with at least one IP address to associate with this floating IP. The port must be associated to a Nova instance.
+String value expected.
+Can be updated without replacement.
+ |
+
+value_specs
+ |
+Extra parameters to include in the "floatingip" object in the creation request. Parameters are often specific to installed hardware or extensions.
+Map value expected.
+Updates cause replacement.
+Defaults to "{}".
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+fixed_ip_address
+ |
+IP address of the associated port, if specified.
+ |
+
+floating_ip_address
+ |
+The allocated address of this IP.
+ |
+
+floating_network_id
+ |
+ID of the network in which this IP is allocated.
+The network ID used during floating IP address assignment is a fixed external network ID. You can use GET /v2.0/networks?router:external=True or neutron net-external-list to obtain the external network information.
+ |
+
+port_id
+ |
+ID of the port associated with this IP.
+ |
+
+router_id
+ |
+ID of the router used as gateway, set when associated with a port.
+ |
+
+show
+ |
+Detailed information about resource.
+ |
+
+tenant_id
+ |
+The tenant owning this floating IP.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::FloatingIP
+ properties:
+ fixed_ip_address: String
+ floating_ip_address: String
+ floating_network: String
+ port_id: String
+ value_specs: {...}
+
+
OS::Neutron::FloatingIPAssociation
+A resource for associating floating IP addresses and ports.
+
This resource allows associating a floating IP to a port with at least one IP address to associate with this floating IP.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+floatingip_id
+ |
+ID of the floating IP to associate.
+String value expected.
+Can be updated without replacement.
+ |
+
+port_id
+ |
+ID of an existing port with at least one IP address to associate with this floating IP. The port must be associated to a Nova instance.
+String value expected.
+Can be updated without replacement.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+fixed_ip_address
+ |
+IP address to use if the port has multiple addresses.
+String value expected.
+Can be updated without replacement.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::FloatingIPAssociation
+ properties:
+ fixed_ip_address: String
+ floatingip_id: String
+ port_id: String
+
+
OS::Neutron::Net
+A resource for managing Neutron net.
+
A network is a virtual isolated layer-2 broadcast domain which is typically reserved to the tenant who created it, unless the network has been explicitly configured to be shared.
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+A boolean value specifying the administrative status of the network.
+Boolean value expected.
+Can be updated without replacement.
+Defaults to "True".
+ |
+
+dhcp_agent_ids
+ |
+The IDs of the DHCP agent to schedule the network. Note that the default policy setting in Neutron restricts usage of this property to administrative users only.
+List value expected.
+Can be updated without replacement.
+ |
+
+name
+ |
+A string specifying a symbolic name for the network, which is not required to be unique.
+String value expected.
+Can be updated without replacement.
+ |
+
+shared
+ |
+Whether this network should be shared across all tenants. Note that the default policy setting restricts usage of this attribute to administrative users only.
+Boolean value expected.
+Can be updated without replacement.
+Defaults to "False".
+ |
+
+tenant_id
+ |
+The ID of the tenant which will own the network. Only administrative users can set the tenant identifier; this cannot be changed using authorization policies.
+String value expected.
+Updates cause replacement.
+ |
+
+value_specs
+ |
+Extra parameters to include in the request. Parameters are often specific to installed hardware or extensions.
+Map value expected.
+Can be updated without replacement.
+Defaults to "{}".
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+The administrative status of the network.
+ |
+
+name
+ |
+The name of the network.
+ |
+
+show
+ |
+Detailed information about resource.
+ |
+
+status
+ |
+The status of the network.
+ |
+
+subnets
+ |
+Subnets of this network.
+ |
+
+tenant_id
+ |
+The tenant owning this network.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::Net
+ properties:
+ admin_state_up: Boolean
+ dhcp_agent_ids: [Value, Value, ...]
+ name: String
+ shared: Boolean
+ tenant_id: String
+ value_specs: {...}
+
+
OS::Neutron::Port
+A resource for managing Neutron ports.
+
A port represents a virtual switch port on a logical network switch. Virtual instances attach their interfaces into ports. The logical port also defines the MAC address and the IP address(es) to be assigned to the interfaces plugged into them. When IP addresses are associated to a port, this also implies the port is associated with a subnet, as the IP address was taken from the allocation pool for a specific subnet.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+network
+ |
+Network this port belongs to. If you plan to use current port to assign Floating IP, you should specify fixed_ips with subnet. Note if this changes to a different network update, the port will be replaced.
+String value expected.
+Updates cause replacement.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+The administrative state of this port.
+Boolean value expected.
+Can be updated without replacement.
+Defaults to "True".
+ |
+
+allowed_address_pairs
+ |
+Additional MAC/IP address pairs allowed to pass through the port.
+List value expected.
+Can be updated without replacement.
+List contents:
+
+ |
+
+device_id
+ |
+Device ID of this port.
+String value expected.
+Can be updated without replacement.
+ |
+
+device_owner
+ |
+Name of the network owning the port. The value is typically network:floatingip or network:router_interface or network:dhcp.
+String value expected.
+Can be updated without replacement.
+ |
+
+fixed_ips
+ |
+Desired IP addresses for this port.
+List value expected.
+Can be updated without replacement.
+List contents:
+
+ |
+
+mac_address
+ |
+MAC address to give to this port.
+String value expected.
+Updates cause replacement.
+ |
+
+name
+ |
+A symbolic name for this port.
+String value expected.
+Can be updated without replacement.
+ |
+
+network_id
+ |
+Network ID this port belongs to.
+String value expected.
+Updates cause replacement.
+ |
+
+security_groups
+ |
+Security group IDs to associate with this port.
+List value expected.
+Can be updated without replacement.
+ |
+
+value_specs
+ |
+Extra parameters to include in the request.
+Map value expected.
+Can be updated without replacement.
+Defaults to "{}".
+ |
+
+replacement_policy
+ |
+Policy on how to respond to a stack-update for this resource. REPLACE_ALWAYS will replace the port regardless of any property changes. AUTO will update the existing port for any changed update-allowed property.
+String value expected.
+Can be updated without replacement.
+Defaults to "AUTO".
+Allowed values: AUTO, REPLACE_ALWAYS
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+The administrative state of this port.
+ |
+
+allowed_address_pairs
+ |
+Additional MAC/IP address pairs allowed to pass through a port.
+ |
+
+device_id
+ |
+Unique identifier for the device.
+ |
+
+device_owner
+ |
+Name of the network owning the port.
+ |
+
+fixed_ips
+ |
+Fixed IP addresses.
+ |
+
+mac_address
+ |
+MAC address of the port.
+ |
+
+name
+ |
+Friendly name of the port.
+ |
+
+network_id
+ |
+Unique identifier for the network owning the port.
+ |
+
+security_groups
+ |
+A list of security groups for the port.
+ |
+
+show
+ |
+Detailed information about resource.
+ |
+
+status
+ |
+The status of the port.
+ |
+
+subnets
+ |
+A list of all subnet attributes for the port.
+ |
+
+tenant_id
+ |
+Tenant owning the port.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::Port
+ properties:
+ admin_state_up: Boolean
+ allowed_address_pairs: [{"mac_address": String, "ip_address": String}, {"mac_address": String, "ip_address": String}, ...]
+ device_id: String
+ device_owner: String
+ fixed_ips: [{"subnet_id": String, "ip_address": String, "subnet": String}, {"subnet_id": String, "ip_address": String, "subnet": String}, ...]
+ mac_address: String
+ name: String
+ network: String
+ network_id: String
+ security_groups: [Value, Value, ...]
+ value_specs: {...}
+ replacement_policy: String
+
+
OS::Neutron::Router
+A resource that implements Neutron router.
+
Router is a physical or virtual network device that passes network traffic between different networks.
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+The administrative state of the router.
+Boolean value expected.
+Can be updated without replacement.
+Defaults to "True".
+ |
+
+external_gateway_info
+ |
+External network gateway configuration for a router.
+You can use GET /v2.0/networks?router:external=True or neutron net-external-list to query the network information.
+Map value expected.
+Can be updated without replacement.
+Map properties:
+- enable_snat
Enables Source NAT on the router gateway. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.
+Boolean value expected.
+Can be updated without replacement.
+ - network
ID or name of the external network for the gateway.
+String value expected.
+Can be updated without replacement.
+
+ |
+
+l3_agent_ids
+ |
+ID list of the L3 agent. User can specify multi-agents for highly available router. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.
+String value expected.
+Can be updated without replacement.
+ |
+
+name
+ |
+The name of the router.
+String value expected.
+Can be updated without replacement.
+ |
+
+value_specs
+ |
+Extra parameters to include in the creation request.
+Map value expected.
+Can be updated without replacement.
+Defaults to "{}".
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+Administrative state of the router.
+ |
+
+external_gateway_info
+ |
+Gateway network for the router.
+ |
+
+name
+ |
+Friendly name of the router.
+ |
+
+show
+ |
+Detailed information about resource.
+ |
+
+status
+ |
+The status of the router.
+ |
+
+tenant_id
+ |
+Tenant owning the router.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::Router
+ properties:
+ admin_state_up: Boolean
+ external_gateway_info: {"network": String, "enable_snat": Boolean}
+ l3_agent_ids: String
+ name: String
+ value_specs: {...}
+
+
OS::Neutron::RouterInterface
+A resource for managing Neutron router interfaces.
+
Router interfaces associate routers with existing subnets or ports.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+router_id
+ |
+The router id.
+String value expected.
+Updates cause replacement.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+port_id
+ |
+The port id, either subnet or port_id should be specified.
+String value expected.
+Updates cause replacement.
+ |
+
+subnet
+ |
+The subnet, either subnet or port should be specified.
+String value expected.
+Updates cause replacement.
+Value must be of type neutron.subnet
+ |
+
+subnet_id
+ |
+String value expected.
+Updates cause replacement.
+
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::RouterInterface
+ properties:
+ port_id: String
+ router_id: String
+ subnet: String
+ subnet_id: String
+
+
OS::Neutron::SecurityGroup
+A resource for managing Neutron security groups.
+
Security groups are sets of IP filter rules that are applied to an instances networking. They are project specific, and project members can edit the default rules for their group and add new rules sets. All projects have a "default" security group, which is applied to instances that have no other security group defined.
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+description
+ |
+Description of the security group.
+String value expected.
+Can be updated without replacement.
+ |
+
+name
+ |
+A string specifying a symbolic name for the security group, which is not required to be unique.
+String value expected.
+Can be updated without replacement.
+ |
+
+rules
+ |
+List of security group rules.
+List value expected.
+Can be updated without replacement.
+Defaults to "[]".
+List contents:
+
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::SecurityGroup
+ properties:
+ description: String
+ name: String
+ rules: [{"remote_group_id": String, "port_range_max": Integer, "remote_ip_prefix": String, "protocol": String, "port_range_min": Integer, "ethertype": String, "direction": String, "remote_mode": String}, {"remote_group_id": String, "port_range_max": Integer, "remote_ip_prefix": String, "protocol": String, "port_range_min": Integer, "ethertype": String, "direction": String, "remote_mode": String}, ...]
+
+
OS::Neutron::Subnet
+The resource is not allowed to be updated.
+
A resource for managing Neutron subnets.
+
A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances. Each subnet must have a CIDR and must be associated with a network. IP addresses can be either selected from the whole subnet CIDR, or from "allocation pools" that can be specified by the user.
+
A network can only have one subnet.
+
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+cidr
+ |
+The CIDR.
+String value expected.
+Updates cause replacement.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+allocation_pools
+ |
+The start and end addresses for the allocation pools.
+List value expected.
+Can be updated without replacement.
+List contents:
+
+ |
+
+dns_nameservers
+ |
+A specified set of DNS name servers to be used.
+List value expected.
+Can be updated without replacement.
+Defaults to "[]".
+ |
+
+enable_dhcp
+ |
+Set to true if DHCP is enabled and false if DHCP is disabled.
+Boolean value expected.
+Can be updated without replacement.
+Defaults to "True".
+ |
+
+gateway_ip
+ |
+The gateway IP address. Set to any of [ null | ~ | "" ] to create/update a subnet without a gateway. If omitted when creation, neutron will assign the first free IP address within the subnet to the gateway automatically. If remove this from template when update, the old gateway IP address will be detached.
+String value expected.
+Can be updated without replacement.
+ |
+
+host_routes
+ |
+A list of host route dictionaries for the subnet.
+List value expected.
+Can be updated without replacement.
+List contents:
+
+ |
+
+ip_version
+ |
+The IP version, which is 4 or 6.
+Integer value expected.
+Updates cause replacement.
+Defaults to "4".
+Allowed values: 4, 6
+ NOTE: Do not update this attribute. Otherwise, the network update will fail.
+
+ |
+
+name
+ |
+The name of the subnet.
+String value expected.
+Can be updated without replacement.
+ |
+
+network
+ |
+The name of the attached network.
+String value expected.
+Updates cause replacement.
+ |
+
+network_id
+ |
+The ID of the attached network.
+String value expected.
+Updates cause replacement.
+ NOTE: In the template, network and network_id cannot appear at the same time, otherwise the stack will fail to create.
+
+ |
+
+tenant_id
+ |
+The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own.
+String value expected.
+Updates cause replacement.
+ NOTE: Do not update this attribute. Otherwise, the network update will fail.
+
+ |
+
+value_specs
+ |
+Extra parameters to include in the request.
+Map value expected.
+Can be updated without replacement.
+Defaults to "{}".
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+allocation_pools
+ |
+Ip allocation pools and their ranges.
+ |
+
+cidr
+ |
+CIDR block notation for this subnet.
+ |
+
+dns_nameservers
+ |
+List of dns nameservers.
+ |
+
+enable_dhcp
+ |
+true if DHCP is enabled for this subnet; false otherwise.
+ |
+
+gateway_ip
+ |
+Ip of the subnets gateway.
+ |
+
+host_routes
+ |
+Additional routes for this subnet.
+ |
+
+ip_version
+ |
+Ip version for the subnet.
+ |
+
+name
+ |
+Friendly name of the subnet.
+ |
+
+network_id
+ |
+Parent network of the subnet.
+ |
+
+show
+ |
+Detailed information about resource.
+ |
+
+tenant_id
+ |
+Tenant owning the subnet.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::Subnet
+ properties:
+ allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...]
+ cidr: String
+ dns_nameservers: [Value, Value, ...]
+ enable_dhcp: Boolean
+ gateway_ip: String
+ host_routes: [{"destination": String, "nexthop": String}, {"destination": String, "nexthop": String}, ...]
+ ip_version: Integer
+ name: String
+ network: String
+ network_id: String
+ tenant_id: String
+ value_specs: {...}
+
+
OS::Nova::KeyPair
+A resource for creating Nova key pairs.
+
A keypair is an SSH key that can be injected into a server on launch.
+
Note that if a new key is generated setting save_private_key to True results in the system saving the private key which can then be retrieved via the private_key attribute of this resource.
+
Setting the public_key property means that the private_key attribute of this resource will always return an empty string regardless of the save_private_key setting since there will be no private key data to save.
+
The Server template does not support key pair update. If the key pair is updated, Servers will be rebuilt.
+
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+name
+ |
+The name of the key pair.
+String value expected.
+Updates cause replacement.
+The length must be in the range 1 to 255, include 1 and 255.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+public_key
+ |
+The optional public key. This allows users to supply the public key from a pre-existing key pair. If not supplied, a new key pair will be generated.
+String value expected.
+Updates cause replacement.
+ |
+
+save_private_key
+ |
+True if the system should remember a generated private key; False otherwise.
+Boolean value expected.
+Updates cause replacement.
+Defaults to "False".
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+private_key
+ |
+The private key if it has been saved.
+ |
+
+public_key
+ |
+The public key.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Nova::KeyPair
+ properties:
+ name: String
+ public_key: String
+ save_private_key: Boolean
+
+
OS::Nova::Server
+A resource for managing Nova instances.
+
A Server resource manages the running virtual machine instance within an OpenStack cloud.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+flavor
+ |
+The ID or name of the flavor to boot onto.
+String value expected.
+Can be updated without replacement.
+Value must be of type nova.flavor
+ NOTE: The Server flavor does not support the replace parameter (When updating the stack, resources need to be deleted and rebuilt).
+
+ |
+
+networks
+ |
+An ordered list of NICs to be added to this server, with information about connected networks, fixed IP addresses, port, and others.
+List value expected.
+Can be updated without replacement.
+List contents:
+
+ NOTE: - When creating a VM that has multiple NICs, ensure that all subnets used by the NICs are in the same VPC.
- When changing the subnets of NICs on a VM, ensure that the new subnets must be in the same VPC as the original ones.
+
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_pass
+ |
+The administrator password for the server.
+String value expected.
+Can be updated without replacement.
+ NOTE: This parameter is invalid in the current version.
+ For Linux ECSs, if you need to inject passwords, you can only use user_data for injection. For Windows ECSs, if you need to inject passwords, you can only use the metadata admin_pass to inject.
+
+ |
+
+availability_zone
+ |
+Name of the availability zone for server placement. Obtain the value from Regions and Endpoints.
+String value expected.
+Updates cause replacement.
+ NOTE: Do not update this attribute. Otherwise, the ECS update will fail.
+
+ |
+
+block_device_mapping
+ |
+Block device mappings for this server.
+List value expected.
+Updates cause replacement.
+List contents:
+
+ NOTE: Do not update this attribute. Otherwise, the VM update will fail.
+ If the template contains information about disks attached to Servers, you are not allowed to update the disks. Otherwise, Servers will be rebuilt.
+
+ |
+
+block_device_mapping_v2
+ |
+Block device mappings v2 for this server.
+List value expected.
+Updates cause replacement.
+List contents:
+
+ NOTE: Do not update this attribute. Otherwise, the VM update will fail.
+ If the template contains information about disks attached to Servers, you are not allowed to update the disks. Otherwise, Servers will be rebuilt.
+
+ |
+
+config_drive
+ |
+If True, enable config drive on the server.
+Boolean value expected.
+Updates cause replacement.
+ NOTE: Do not update this attribute. Otherwise, the VM update will fail.
+
+ |
+
+diskConfig
+ |
+Control how the disk is partitioned when the server is created.
+String value expected.
+Updates cause replacement.
+Allowed values: AUTO, MANUAL
+ NOTE: Do not update this attribute. Otherwise, the VM update will fail.
+
+ |
+
+flavor_update_policy
+ |
+Policy on how to apply a flavor update; either by requesting a server resize or by replacing the entire server.
+String value expected.
+Can be updated without replacement.
+Defaults to "RESIZE".
+Allowed values: RESIZE
+ |
+
+image
+ |
+The ID or name of the image to boot with.
+String value expected.
+Can be updated without replacement.
+Value must be of type glance.image
+ NOTE: If you use the system volume to create an ECS, this parameter is not required. If you do not use a volume to create an ECS, you must set imageRef to a valid UUID. Otherwise, the API will return error code 400.
+
+ |
+
+image_update_policy
+ |
+Policy on how to apply an image-id update; either by requesting a server rebuild or by replacing the entire server.
+String value expected.
+Can be updated without replacement.
+Defaults to "REBUILD".
+Allowed values: REBUILD
+ |
+
+key_name
+ |
+Name of keypair to inject into the server.
+String value expected.
+Updates cause replacement.
+Value must be of type nova.keypair
+ NOTE: Do not update this attribute. Otherwise, the VM update will fail.
+
+ |
+
+metadata
+ |
+Arbitrary key/value metadata to store for this server. Both keys and values must be 255 characters or less. Non-string values will be serialized to JSON (and the serialized string must be 255 characters or less).
+Map value expected.
+Can be updated without replacement.
+ |
+
+name
+ |
+Server name.
+String value expected.
+Can be updated without replacement.
+ |
+
+personality
+ |
+A map of files to create/overwrite on the server upon boot. Keys are file names and values are the file contents.
+Map value expected.
+Updates cause replacement.
+Defaults to "{}".
+ NOTE: Do not update this attribute. Otherwise, the VM update will fail.
+
+ |
+
+reservation_id
+ |
+A UUID for the set of servers being requested.
+String value expected.
+Updates cause replacement.
+ NOTE: Do not update this attribute. Otherwise, the VM update will fail.
+
+ |
+
+scheduler_hints
+ |
+Arbitrary key-value pairs specified by the client to help boot a server.
+Map value expected.
+Updates cause replacement.
+ NOTE: Do not update this attribute. Otherwise, the VM update will fail.
+
+ |
+
+security_groups
+ |
+List of security group names or IDs. Cannot be used if neutron ports are associated with this server; assign security groups to the ports instead.
+List value expected.
+Updates cause replacement.
+Defaults to "[]".
+ NOTE: Do not update this attribute. Otherwise, the VM update will fail.
+
+ |
+
+software_config_transport
+ |
+How the server should receive the metadata required for software configuration.
+POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling.
+String value expected.
+Can be updated without replacement.
+Defaults to "POLL_TEMP_URL".
+ |
+
+tags
+ |
+Server tags.
+List value expected.
+Can be updated without replacement.
+List contents:
+
+ |
+
+user_data
+ |
+User data script to be executed by cloud-init.
+String value expected.
+Can be updated without replacement.
+Defaults to "".
+ NOTE: You are not advised to update user_data. Otherwise, VMs may be rebuilt.
+
+ |
+
+user_data_format
+ |
+How the user_data should be formatted for the server.
+- For HEAT_CFNTOOLS, the user_data is bundled as part of the heat-cfntools cloud-init boot configuration data.
- For RAW the user_data is passed to Nova unmodified.
- For SOFTWARE_CONFIG user_data is bundled as part of the software config data, and metadata is derived from any associated SoftwareDeployment resources.
+String value expected.
+Updates cause replacement.
+Defaults to "HEAT_CFNTOOLS".
+Allowed values: HEAT_CFNTOOLS, RAW, SOFTWARE_CONFIG
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+accessIPv4
+ |
+The manually assigned alternative public IPv4 address of the server.
+ |
+
+accessIPv6
+ |
+The manually assigned alternative public IPv6 address of the server.
+ |
+
+addresses
+ |
+A dict of all network addresses with corresponding port_id. Each network will have two keys in dict, they are network name and network id. The port ID may be obtained through the following expression: "{get_attr: [<server>, addresses, <network name_or_id>, 0, port]}".
+ |
+
+first_address
+ |
+Convenience attribute to fetch the first assigned network address, or an empty string if nothing has been assigned at this time. Result may not be predictable if the server has addresses from more than one network.
+ |
+
+instance_name
+ |
+Name of the instance.
+ |
+
+name
+ |
+Name of the server.
+ |
+
+networks
+ |
+A dict of assigned network addresses of the form: {"public": [ip1, ip2...], "private": [ip3, ip4], "public_uuid": [ip1, ip2...], "private_uuid": [ip3, ip4]}. Each network will have two keys in dict, they are network name and network id.
+ |
+
+show
+ |
+Detailed information about resource.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Nova::Server
+ properties:
+ admin_pass: String
+ availability_zone: String
+ block_device_mapping: [{"snapshot_id": String, "volume_id": String, "delete_on_termination": Boolean, "volume_size": Integer, "device_name": String}, {"snapshot_id": String, "volume_id": String, "delete_on_termination": Boolean, "volume_size": Integer, "device_name": String}, ...]
+ block_device_mapping_v2: [{"disk_bus": String, "swap_size": Integer, "device_name": String, "device_type": String, "delete_on_termination": Boolean, "volume_id": String, "snapshot_id": String, "boot_index": Integer, "image_id": String, "volume_size": Integer}, {"disk_bus": String, "swap_size": Integer, "device_name": String, "device_type": String, "delete_on_termination": Boolean, "volume_id": String, "snapshot_id": String, "boot_index": Integer, "image_id": String, "volume_size": Integer}, ...]
+ config_drive: Boolean
+ diskConfig: String
+ flavor: String
+ flavor_update_policy: String
+ image: String
+ image_update_policy: String
+ key_name: String
+ metadata: {...}
+ name: String
+ networks: [{"network": String, "uuid": String, "fixed_ip": String, "port": String, "floating_ip": String, "subnet": String, "port_extra_properties": {"qos_policy": String, "mac_address": String, "binding:vnic_type": String, "admin_state_up": Boolean, "port_security_enabled": Boolean, "allowed_address_pairs": [{"mac_address": String, "ip_address": String}, {"mac_address": String, "ip_address": String}, ...], "value_specs": {...}}}, {"network": String, "uuid": String, "fixed_ip": String, "port": String, "floating_ip": String, "subnet": String, "port_extra_properties": {"qos_policy": String, "mac_address": String, "binding:vnic_type": String, "admin_state_up": Boolean, "port_security_enabled": Boolean, "allowed_address_pairs": [{"mac_address": String, "ip_address": String}, {"mac_address": String, "ip_address": String}, ...], "value_specs": {...}}}, ...]
+ personality: {...}
+ reservation_id: String
+ scheduler_hints: {...}
+ security_groups: [Value, Value, ...]
+ software_config_transport: String
+ user_data: String
+ user_data_format: String
+
+
OS::Nova::ServerGroup
+A resource for managing a Nova server group.
+
Server groups allow you to make sure instances are on the same hypervisor host or on a different one.
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+name
+ |
+Server Group name.
+String value expected.
+Updates cause replacement.
+ |
+
+policies
+ |
+A list of string policies to apply. Defaults to anti-affinity.
+List value expected.
+Updates cause replacement.
+Defaults to "['anti-affinity']".
+Allowed values: anti-affinity, affinity
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+show
+ |
+Detailed information about resource.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2015-04-30
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Nova::ServerGroup
+ properties:
+ name: String
+ policies: [String, String, ...]
+
+
OSE::AS::ScalingConfig
+A resource for managing autoscaling configuration.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+scaling_configuration_name
+ |
+Autoscaling configuration name.
+String value expected.
+Updates cause replacement.
+It is allowed to start with numbers, letters, _, and - characters. It is allowed to include numbers, letters, _, and - characters, and the string length is 1 to 64.
+ |
+
+instance_config
+ |
+Instance configuration.
+Map value expected.
+Updates cause replacement.
+Map properties:
+- instance_id
Cloud server ID, if instance_id is specified, it will use this existing instance as a bus dtemplate to create an autoscaling configuration. The flavorRef, imageRef, and disk fields do not take effect at this time. The flavorRef, imageRef, and disk fields are required when the instance_id field is not passed in.
+String value expected.
+Updates cause replacement.
+ - flavorRef
Cloud server specification ID, which defines the cloud server CPUs and memory size.
+String value expected.
+Updates cause replacement.
+ - imageRef
Image ID.
+String value expected.
+Updates cause replacement.
+ - disk
Disk group information, system disk must be selected, data disk is optional.
+List value expected.
+Updates cause replacement.
+List contents:
+- *
Map value expected.
+Updates cause replacement.
+Map properties:
+- size
+Disk size, in GB.
+Integer value expected.
+Updates cause replacement.
+The size of system disk is range from 140 to 32768, include 140 and 32768.
+The size of data disk is range from 10 to 32768, include 10 and 32768.
+- volume_type
+The type of volume.
+String value expected.
+Updates cause replacement.
+Allowed values: SSD, SATA, SAS, uh-l1 (Ultra-high I/O (Latency optimized)).
+- disk_type
+Disk type, system disk or data disk.
+String value expected.
+Updates cause replacement.
+Allowed values: SYS, DATA
+
+ - key_name
SSH key name to logon server, which mutually exclusive with adminPass.
+String value expected.
+Updates cause replacement.
+ - adminPass
Initial password for administrator account.
+String value expected.
+Updates cause replacement.
+The length is range from 8 to 26. The password can only contain letters, numbers, and special characters, namely "!@$%^-_=+[{}]:,./?". It must contain at least three of the four characters. The password can not contain user name or the reverse of it.
+ - personality
File inject content.
+List value expected.
+Updates cause replacement.
+Only support the injection of text files, the maximum is five. The maximum size of each file is 1KB.
+List contents:
+- *
Map value expected.
+Updates cause replacement.
+Map properties:
+- path
+Path of the injected file.
+String value expected.
+Updates cause replacement.
+- content
+Content of the injected file.
+String value expected.
+Updates cause replacement.
+The content must be encoded by base64.
+
+ - public_ip
Elastic IP information.
+Map value expected.
+Updates cause replacement.
+Map properties:
+- eip
Elastic IP configuration parameters.
+Map value expected.
+Updates cause replacement.
+Map properties:
+- ip_type
+The type of IP.
+String value expected.
+Updates cause replacement.
+Allowed values: 5_bgp, 5_lxbgp, 5_telcom, 5_union
+- bandwidth
+IP address bandwidth.
+Map value expected.
+Updates cause replacement.
+Map properties:
+- size
+The size of bandwidth.
+Integer value expected.
+Updates cause replacement.
+Range from 1 to 300, include 1 and 300.
+- share_type
+The share type of bandwidth.
+String value expected.
+Updates cause replacement.
+Allowed values: PER
+- charging_mode
+The charging mode of bandwidth.
+String value expected.
+Updates cause replacement.
+Allowed values: bandwidth, traffic
+
+ - user_data
Cloud-init user data.
+String value expected.
+Updates cause replacement.
+ - metadata
Metadata for creating cloud server.
+Map value expected.
+Updates cause replacement.
+
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::AS::ScalingConfig
+ properties:
+ scaling_configuration_name: String
+ instance_config:
+ key_name: String
+ flavorRef: String
+ imageRef: String
+ disk: [{"disk_type": String, "size": Integer, "volume_type": String}, {"disk_type": String, "size": Integer, "volume_type": String},…]
+ personality: [{"path": String, "content": String}, {"path": String, "content": String},…]
+ public_ip: {"eip": {"ip_type": String, "bandwidth": {"size": Integer, "share_type": String, "charging_mode": String}}}
+ user_data: String
+ metadata: {…}
+
+
OSE::AS::ScalingGroup
+A resource for managing autoscaling group.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+scaling_group_name
+ |
+Autoscaling group name.
+String value expected.
+Can be updated without replacement.
+It is allowed to start with numbers, letters, _, and - characters. It is allowed to include numbers, letters, _, and - characters, and the string length is 1 to 64.
+ |
+
+scaling_configuration_id
+ |
+AS configuration ID.
+String value expected.
+Can be updated without replacement.
+ |
+
+networks
+ |
+An ordered list of networks used to create instances, which are in same VPC defined in the vpc_id parameter.
+List value expected.
+Can be updated without replacement.
+List contents:
+
+ |
+
+security_groups
+ |
+An ordered list of security groups used to create instances.
+List value expected.
+Can be updated without replacement.
+List contents:
+
+ |
+
+vpc_id
+ |
+Virtual private cloud ID.
+String value expected.
+Updates cause replacement.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+desire_instance_number
+ |
+Desired instance number allowed in autoscaling group.
+Integer value expected.
+Can be updated without replacement.
+ |
+
+min_instance_number
+ |
+The minimum instance number allowed in autoscaling group.
+Integer value expected.
+Can be updated without replacement.
+ |
+
+max_instance_number
+ |
+The max instance number allowed in autoscaling group.
+Integer value expected.
+Can be updated without replacement.
+ NOTE: The max instance number can not be smaller than the minimum instance number, can be equal. The value must be greater than 0.
+
+ |
+
+cool_down_time
+ |
+Cool down period, in seconds.
+Integer value expected.
+Can be updated without replacement.
+Range from 0 to 86400, include 0 and 86400.
+ |
+
+lb_listener_id
+ |
+ELB listener ID.
+String value expected.
+Can be updated without replacement.
+ |
+
+lbaas_listeners
+ |
+Lbaas listener, which is mutually exclusive with lb_listener_id.
+List value expected.
+Can be updated without replacement.
+List contents:
+
+ |
+
+available_zones
+ |
+An ordered list of available zones used to create instances.
+List value expected.
+Can be updated without replacement.
+ |
+
+health_periodic_audit_method
+ |
+The health periodic audit method, when the lb_listener_id and lbaas_listeners parameter is set, the default is ELB_AUDIT, otherwise, it defaults to NOVA_AUDIT.
+String value expected.
+Can be updated without replacement.
+Allowed values: ELB_AUDIT, NOVA_AUDIT
+ |
+
+health_periodic_audit_time
+ |
+The health periodic audit time, in minutes.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: 5, 15, 60, 180
+ |
+
+instance_terminate_policy
+ |
+The policy of terminating instances.
+String value expected.
+Can be updated without replacement.
+Allowed values: OLD_CONFIG_OLD_INSTANCE, OLD_CONFIG_NEW_INSTANCE, OLD_INSTANCE, NEW_INSTANCE
+- OLD_CONFIG_OLD_INSTANCE: The oldest instance created based on the oldest configuration is removed from the AS group first.
- OLD_CONFIG_NEW_INSTANCE: The latest instance created based on the oldest configuration is removed from the AS group first.
- OLD_INSTANCE: The oldest instance is removed from the AS group first.
- NEW_INSTANCE: The latest instance is removed from the AS group first.
+ |
+
+delete_publicip
+ |
+Whether to delete the elastic ip when terminating instances.
+Boolean value expected.
+Can be updated without replacement.
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+instances
+ |
+A list of all instances information. The information of instances may be obtained through the following expression: "{ get_attr: [<autoscaling_group_resource_name>, instances] }".
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::AS::ScalingGroup
+ properties:
+ scaling_group_name: String
+ scaling_configuration_id: String
+ desire_instance_number: Integer
+ min_instance_number: Integer
+ max_instance_number: Integer
+ cool_down_time: Integer
+ lb_listener_id: String
+ available_zones: [String, String,…]
+ networks: [String, String,…]
+ security_groups: [{"id": String}, {"id": String},…]
+ vpc_id: String
+ health_periodic_audit_method: String
+ health_periodic_audit_time: Integer
+ instance_terminate_policy: String
+ notifications: [String, String,…]
+ delete_publicip: Boolean
+
+
OSE::AS::ScalingPolicy
+A resource for managing autoscaling policy.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+scaling_policy_name
+ |
+Autoscaling policy name.
+String value expected.
+Can be updated without replacement.
+It is allowed to start with numbers, letters, _, and - characters. It is allowed to include numbers, letters, _, and - characters, and the string length is 1 to 64.
+ |
+
+scaling_group_id
+ |
+Autoscaling group ID.
+String value expected.
+Updates cause replacement.
+ |
+
+scaling_policy_type
+ |
+The type of autoscaling policy.
+String value expected.
+Can be updated without replacement.
+Allowed values: ALARM, SCHEDULED, RECURRENCE
+- ALARM: AS automatically increases or decreases the number of instances in an AS group or sets the number of instances to a specified value if Cloud Eye (CES) generates an alarm for a configured metric, such as CPU usage.
- SCHEDULED: AS automatically increases or decreases the number of instances in an AS group or sets the number of instances to a specified value at a specified time.
- RECURRENCE: AS increases or decreases the number of instances in an AS group or sets the number of instances to a specified value at a configured interval, such as one day, one week, or month.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+alarm_id
+ |
+CES alarm rule ID, which must be selected when scaling_policy_type is ALARM.
+String value expected.
+Can be updated without replacement.
+ |
+
+scheduled_policy
+ |
+The scheduled policy, which must be set when scaling_policy_type is SCHEDULED or RECURRENCE.
+Map value expected.
+Can be updated without replacement.
+Map properties:
+- launch_time
The launch time of scheduled policy. If scaling_policy_type is SCHEDULED, the format is: YYYY-MM-DDThh: mmZ, else if scaling_policy_type is RECURRENCE, the format is: hh: mm.
+String value expected.
+Can be updated without replacement.
+ - recurrence_type
The recurrence type of scheduled policy, must be specified when scaling_policy_type is RECURRENCE.
+String value expected.
+Can be updated without replacement.
+Allowed values: Daily, Weekly and Monthly.
+ - recurrence_value
The recurrence value of scheduled policy. When the recurrence type is Daily, the recurrence value is null, indicating that it is executed every day. When the recurrence type is Weekly, the recurrence value is in the range 1-7 (1 for Sunday). When the recurrence type is Monthly, the recurrence value is in the range of 1-31.
+String value expected.
+Can be updated without replacement.
+ - start_time
The start time of scheduled policy, the format is: YYYY-MM-DDThh: mmZ.
+String value expected.
+Can be updated without replacement.
+ - end_time
The end time of scheduled policy, the format is: YYYY-MM-DDThh: mmZ, must be specified when scaling_policy_type is RECURRENCE.
+String value expected.
+Can be updated without replacement.
+
+ |
+
+scaling_policy_action
+ |
+Strategy to perform specific actions.
+Map value expected.
+Can be updated without replacement.
+Map properties:
+- operation
The operation of scheduled policy action.
+String value expected.
+Can be updated without replacement.
+Allowed values: ADD, REMOVE and SET
+Default value: ADD.
+ - instance_number
The instance number per operation.
+Integer value expected.
+Can be updated without replacement.
+Default value: 1
+
+ |
+
+cool_down_time
+ |
+Cool down period, in seconds.
+Integer value expected.
+Can be updated without replacement.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::AS::ScalingPolicy
+ properties:
+ scaling_policy_name: String
+ scaling_group_id: String
+ scaling_policy_type: String
+ alarm_id: String
+ scheduled_policy: String
+ scaling_policy_action: {"operation": String, "instance_number": Integer}
+ cool_down_time: Integer
+
+
OSE::CES::Alarm
+A resource of CES.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+evaluation_periods
+ |
+Consecutive count.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: from 1 to 5, include 1 and 5.
+ |
+
+comparison_operator
+ |
+Operator used to compare specified statistic with threshold.
+String value expected.
+Can be updated without replacement.
+Allowed values: gt, lt, ge, le, eq
+ |
+
+meter_name
+ |
+Metric name.
+String value expected.
+Updates cause replacement.
+Allowed values: cpu_util, mem_util, network_incoming_bytes_rate_inband, and network_outgoing_bytes_rate_inband.
+- cpu_util: CPU Usage.
- mem_util: Memory Usage.
- network_incoming_bytes_rate_inband: Inband Incoming Rate.
- network_outgoing_bytes_rate_inband: Inband Outgoing Rate.
+ |
+
+period
+ |
+Period (seconds) to evaluate over.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: 300, 1200, 3600, 14400, 86400
+During alarm interconnection with CES, the native attribute period can be any value. However, CES supports only the preceding fixed values. Otherwise, alarm resource creation fails.
+ |
+
+resource_id
+ |
+ID of the group.
+String value expected.
+Updates cause replacement.
+This attributed is required by Cloud Eye (CES) for filtering.
+ |
+
+statistic
+ |
+Way to data aggregation.
+String value expected.
+Updates cause replacement.
+Allowed values: avg, min, max, variance.
+ |
+
+threshold
+ |
+Threshold value of the alarm.
+Integer value expected.
+Can be updated without replacement.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+action_enabled
+ |
+Whether to enable this alarm to trigger actions.
+Boolean value expected.
+Can be updated without replacement.
+Defaults to "True".
+ |
+
+alarm_actions
+ |
+A list of URLs (webhooks) to invoke when state transitions to alarm.
+List value expected.
+Can be updated without replacement.
+ |
+
+description
+ |
+Description for the alarm.
+String value expected.
+Can be updated without replacement.
+Allowed pattern: ^[^\&\"\'\(\)]{0,256}$
+ |
+
+enabled
+ |
+Whether to enable alarm.
+Boolean value expected.
+Can be updated without replacement.
+Defaults to "True".
+ |
+
+name
+ |
+Name of the alarm.
+String value expected.
+Can be updated without replacement.
+It is allowed to start with numbers, letters, _, and - characters. It is allowed to include numbers, letters, _, and - characters, and the string length is 1 to 128.
+ |
+
+unit
+ |
+Unit of data.
+String value expected.
+Can be updated without replacement.
+The string length allowed is 0 to 32.
+ |
+
+matching_metadata
+ |
+Meter should match this resource metadata (key=value) additionally to the meter_name.
+Map value expected.
+Can be updated without replacement.
+Defaults to "{}".
+ NOTE: This parameter is invalid in the current version.
+
+ |
+
+resource_type
+ |
+Alarm type of resource.
+String value expected.
+Updates cause replacement.
+Defaults to "RTS.Group".
+Allowed values: RTS.Group, AS.Group
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::CES::Alarm
+ properties:
+ action_enabled: Boolean
+ alarm_actions: […]
+ comparison_operator: String
+ description: String
+ enabled: Boolean
+ evaluation_periods: Integer
+ meter_name: String
+ name: String
+ period: Integer
+ resource_id: String
+ statistic: String
+ threshold: Integer
+ unit: String
+
+
OSE::ELB::LoadBalancer
+A resource for ELB Loadbalancer.
+
In later version, the API for using the LBaaS v2 load balancers will be provided, and you can create native LBaaS v2 load balancers. However, created load balancer cannot be changed to LBaaS v2 load balancers.
+
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+The admin state of the load balancer.
+Boolean value expected.
+Can be updated without replacement.
+Defaults to "True".
+ |
+
+name
+ |
+The name of the load balancer.
+String value expected.
+Can be updated without replacement.
+It is allowed to start with numbers, letters, _, and - characters. It is allowed to include numbers, letters, _, and - characters, and the string length is 1 to 64.
+ |
+
+type
+ |
+The type of the load balancer.
+String value expected.
+Updates cause replacement.
+Allowed values: External, Internal
+ |
+
+vpc_id
+ |
+The ID of vpc.
+String value expected.
+Updates cause replacement.
+ NOTE: You must specify the VPC ID when using the RTS to perform operations on ELB.
+ - Only one VPC is supported for each tenant.
- You must add the VPC ID in the Heat template. (You can query the VPC using the API.)
+
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+az
+ |
+The ID or name of the availability zone.
+String value expected.
+Updates cause replacement.
+ NOTE: - The AZ attribute is mandatory, and you need to specify it.
- If the AZ attribute is not specified, calls are made to the Nova API to randomly select an AZ.
+
+ |
+
+bandwidth
+ |
+The bandwidth of the load balancer, in Mbit/s.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: from 1 to 300, include 1 and 300
+ NOTE: The default bandwidth size value of an ELB listener is 300, and you can use only the default value.
+
+ |
+
+description
+ |
+The description of the load balancer.
+String value expected.
+Can be updated without replacement.
+It is allowed to start with numbers, letters, _, and - characters. It is allowed to include numbers, letters, _, and - characters, and the string length is 1 to 128.
+ |
+
+security_group
+ |
+The ID of the security group.
+String value expected.
+Updates cause replacement.
+ |
+
+vip_subnet_id
+ |
+The ID of the network on which to allocate the VIP.
+String value expected.
+Updates cause replacement.
+Value must be of type neutron.network
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+status
+ |
+The status of the load balancer.
+ |
+
+vip_address
+ |
+The VIP address of the load balancer.
+ |
+
+vip_subnet_id
+ |
+The VIP subnet of the load balancer.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::ELB::LoadBalancer
+ properties:
+ admin_state_up: Boolean
+ az: String
+ bandwidth: Integer
+ description: String
+ name: String
+ security_group: String
+ type: String
+ vip_subnet_id: String
+ vpc_id: String
+
+
OSE::ELB::Listener
+A resource for ELB Listener.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+name
+ |
+The name of the listener.
+String value expected.
+Can be updated without replacement.
+It is allowed to start with numbers, letters, _, and - characters. It is allowed to include numbers, letters, _, and - characters, and the string length is 1 to 64.
+ |
+
+loadbalancer_id
+ |
+The ID of load balancer associated.
+String value expected.
+Updates cause replacement.
+Value must be of type elb.lb
+ |
+
+protocol
+ |
+The protocol of the listener.
+String value expected.
+Updates cause replacement.
+Allowed values: HTTP, HTTPS, TCP
+ NOTE: Do not update this attribute. Otherwise, the listener update will fail.
+
+ |
+
+backend_protocol
+ |
+The backend protocol of the listener.
+String value expected.
+Updates cause replacement.
+Allowed values: HTTP, TCP
+ NOTE: Do not update this attribute. Otherwise, the listener update will fail.
+
+ |
+
+port
+ |
+The port of the listener.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: from 1 to 65535, include 1 and 65535
+ |
+
+backend_port
+ |
+The backend port of the listener.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: from 1 to 65535, include 1 and 65535
+ |
+
+lb_algorithm
+ |
+The algorithm used to distribute load.
+String value expected.
+Can be updated without replacement.
+Allowed values: roundrobin, leastconn, source
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+certificate_id
+ |
+The ID of certificate.
+String value expected.
+Updates cause replacement.
+ NOTE: Do not update this attribute. Otherwise, the listener update will fail.
+
+ |
+
+cookie_timeout
+ |
+The timeout of cookie in minute.
+Integer value expected.
+Updates cause replacement.
+Allowed values: from 1 to 1440, include 1 and 1440
+ NOTE: Do not update this attribute. Otherwise, the listener update will fail.
+
+ |
+
+description
+ |
+The description of the listener.
+String value expected.
+Can be updated without replacement.
+It is not allowed to start with the <> character. The <> character is not allowed and the string length is 1 to 128.
+ |
+
+session_sticky
+ |
+Whether to keep the session.
+Boolean value expected.
+Updates cause replacement.
+ NOTE: Do not update this attribute. Otherwise, the listener update will fail.
+
+ |
+
+sticky_session_type
+ |
+The way of handing cookie.
+String value expected.
+Updates cause replacement.
+Allowed values: insert
+ NOTE: Do not update this attribute. Otherwise, the listener update will fail.
+
+ |
+
+tcp_timeout
+ |
+The timeout of TCP session in minute.
+Integer value expected.
+Updates cause replacement.
+Allowed values: from 1 to 5, include 1 and 5. The default value is 5.
+ NOTE: Do not update this attribute. Otherwise, the listener update will fail.
+
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+member_number
+ |
+The number of the members listened by this listener.
+ |
+
+status
+ |
+The status of the listener.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::ELB::Listener
+ properties:
+ backend_port: Integer
+ backend_protocol: Integer
+ certificate_id: String
+ cookie_timeout: Integer
+ description: String
+ lb_algorithm: String
+ loadbalancer_id: String
+ name: String
+ port: Integer
+ protocol: String
+ session_sticky: Boolean
+ sticky_session_type
+ tcp_timeout: Integer
+
+
OSE::ELB::HealthCheck
+A resource for ELB Health Check.
+
You must configure health checks for load balancers.
+
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+listener_id
+ |
+The ID of listener associated.
+String value expected.
+Updates cause replacement.
+Value must be of type elb.ls
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+healthcheck_connect_port
+ |
+The port of the health check.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: from 1 to 65535, include 1 and 65535.
+ |
+
+healthcheck_interval
+ |
+The interval between the health checks in seconds.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: from 1 to 5, include 1 and 5.
+ |
+
+healthcheck_protocol
+ |
+The protocol of the health check.
+String value expected.
+Can be updated without replacement.
+Allowed values: HTTP, TCP
+ |
+
+healthcheck_timeout
+ |
+The timeout of the health check in seconds.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: from 1 to 50, include 1 and 50.
+ |
+
+healthcheck_uri
+ |
+The HTTP path used in the HTTP request to check a member health.
+String value expected.
+Can be updated without replacement.
+It is allowed to start with / characters. It is allowed to include numbers, letters, -/.%?#& characters, and the string length is 1 to 80.
+ |
+
+healthy_threshold
+ |
+The number of the successful threshold before change the member status to healthy.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: from 1 to 10, include 1 and 10. The default value is 3.
+ |
+
+unhealthy_threshold
+ |
+The number of the failure threshold before change the member status to unhealthy.
+Integer value expected.
+Can be updated without replacement.
+Allowed values: from 1 to 10, include 1 and 10.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::ELB::HealthCheck
+ properties:
+ healthcheck_connect_port: Integer
+ healthcheck_interval: Integer
+ healthcheck_protocol: String
+ healthcheck_timeout: Integer
+ healthcheck_uri: String
+ healthy_threshold: Integer
+ listener_id: String
+ unhealthy_threshold: Integer
+
+
OSE::ELB::Member
+A resource for member.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+listener_id
+ |
+The ID of listener associated.
+String value expected.
+Updates cause replacement.
+Value must be of type elb.ls
+ |
+
+members
+ |
+The servers to add as members.
+List value expected.
+Can be updated without replacement.
+Value length: from 1 to 6, include 1 and 6.
+List contents:
+
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::ELB::Member
+ properties:
+ listener_id: String
+ members: [{"address": String, "server_id": String}, {"address": String, "server_id": String}, …]
+
+
OSE::ELB::Certificate
+A resource for certificate.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+certificate
+ |
+PEM-formatted certificate chain.
+String value expected.
+Updates cause replacement.
+ |
+
+private_key
+ |
+PEM-formatted private_key chain.
+String value expected.
+Updates cause replacement.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+description
+ |
+The description of the certificate.
+String value expected.
+Can be updated without replacement.
+ |
+
+name
+ |
+The name of the certificate.
+String value expected.
+Can be updated without replacement.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::ELB::Certificate
+ properties:
+ certificate: String
+ description: String
+ name: String
+ private_key: String
+
+
OS::Neutron::LBaaS::HealthMonitor
+A resource to handle load balancer health monitors.
+
This resource creates and manages Neutron LBaaS v2 healthmonitors, which watches status of the load balanced servers.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+delay
+ |
+The minimum time in milliseconds between regular connections of the member.
+Integer value expected.
+Can be updated without replacement.
+The value must be in the range 0 to 2147483647, include 0 and 2147483647.
+ |
+
+max_retries
+ |
+Number of permissible connection failures before changing the member status to INACTIVE.
+Integer value expected.
+Can be updated without replacement.
+The value must be in the range 1 to 10, include 1 and 10.
+ |
+
+pool
+ |
+ID or name of the load balancing pool.
+String value expected.
+Updates cause replacement.
+Value must be of type neutron.lbaas.pool
+ |
+
+timeout
+ |
+Maximum number of milliseconds for a monitor to wait for a connection to be established before it times out.
+Integer value expected.
+Can be updated without replacement.
+The value must be in the range 0 to 2147483647, include 0 and 2147483647.
+ |
+
+type
+ |
+One of predefined health monitor types.
+String value expected.
+Updates cause replacement.
+Allowed values: PING, TCP, HTTP
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+The administrative state of the health monitor.
+Boolean value expected.
+Updates are not supported.
+Allowed values: True
+ |
+
+expected_codes
+ |
+The HTTP status codes expected in response from the member to declare it healthy.
+Specify one of the following values:
+- a single value, such as 200.
- a list, such as 200, 202.
- a range, such as 200 to 204.
+String value expected.
+Can be updated without replacement.
+Defaults to "200".
+ |
+
+http_method
+ |
+The HTTP method used for requests by the monitor of type HTTP.
+String value expected.
+Can be updated without replacement.
+Defaults to "GET".
+Allowed values: GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, PATCH
+ |
+
+tenant_id
+ |
+ID of the tenant who owns the health monitor.
+String value expected.
+Updates cause replacement.
+ |
+
+url_path
+ |
+The HTTP path used in the HTTP request used by the monitor to test a member health. A valid value is a string that begins with a forward slash (/).
+String value expected.
+Can be updated without replacement.
+Defaults to "/".
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+pools
+ |
+The list of Pools related to this monitor.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::LBaaS::HealthMonitor
+ properties:
+ admin_state_up: Boolean
+ delay: Integer
+ expected_codes: String
+ http_method: String
+ max_retries: Integer
+ pool: String
+ tenant_id: String
+ timeout: Integer
+ type: String
+ url_path: String
+
+
OS::Neutron::LBaaS::Listener
+A resource for managing LBaaS v2 Listeners.
+
This resource creates and manages Neutron LBaaS v2 Listeners, which represent a listening endpoint for the vip.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+loadbalancer
+ |
+ID or name of the load balancer with which listener is associated.
+String value expected.
+Updates cause replacement.
+Value must be of type neutron.lbaas.loadbalancer
+ |
+
+protocol
+ |
+Protocol on which to listen for the client traffic. It must be the same as the value of OS::Neutron::LBaaS::Pool's protocol.
+String value expected.
+Updates cause replacement.
+Allowed values: TCP, HTTP
+ |
+
+protocol_port
+ |
+TCP or UDP port on which to listen for client traffic.
+Integer value expected.
+Updates cause replacement.
+The value must be in the range 1 to 65535, include 1 and 65535.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+The administrative state of this listener.
+Boolean value expected.
+Updates are not supported.
+Allowed values: True
+ |
+
+connection_limit
+ |
+The maximum number of connections permitted for this load balancer. Defaults to -1, which is infinite.
+Integer value expected.
+Can be updated without replacement.
+Defaults to "-1".
+The value must be in the range -1 to 2147483647, include -1 and 2147483647.
+ |
+
+description
+ |
+Description of this listener.
+String value expected.
+Can be updated without replacement.
+Defaults to " ".
+ |
+
+name
+ |
+Name of this listener.
+String value expected.
+Can be updated without replacement.
+ |
+
+tenant_id
+ |
+The ID of the tenant who owns the listener.
+String value expected.
+Updates cause replacement.
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+default_pool_id
+ |
+ID of the default pool this listener is associated to.
+ |
+
+loadbalancers
+ |
+ID of the load balancer this listener is associated to.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::LBaaS::Listener
+ properties:
+ admin_state_up: Boolean
+ connection_limit: Integer
+ default_tls_container_ref: String
+ description: String
+ loadbalancer: String
+ name: String
+ protocol: String
+ protocol_port: Integer
+ sni_container_refs: [Value, Value, ...]
+ tenant_id: String
+
+
OS::Neutron::LBaaS::LoadBalancer
+A resource for creating LBaaS v2 Load Balancers.
+
This resource creates and manages Neutron LBaaS v2 Load Balancers, which allows traffic to be directed between servers.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+vip_subnet
+ |
+The name or ID of the subnet on which to allocate the VIP address.
+String value expected.
+Updates cause replacement.
+Value must be of type neutron.subnet
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+The administrative state of this Load Balancer.
+Boolean value expected.
+Updates are not supported.
+Allowed values: True
+ |
+
+description
+ |
+Description of this Load Balancer.
+String value expected.
+Can be updated without replacement.
+Defaults to " ".
+ |
+
+name
+ |
+Name of this Load Balancer.
+String value expected.
+Can be updated without replacement.
+ |
+
+provider
+ |
+Provider for this Load Balancer.
+String value expected.
+Updates are not supported.
+Allowed values: vlb
+ |
+
+tenant_id
+ |
+The ID of the tenant who owns the Load Balancer. Only administrative users can specify a tenant ID other than their own.
+String value expected.
+Updates cause replacement.
+Value must be of type keystone.project
+ |
+
+vip_address
+ |
+IP address for the VIP.
+String value expected.
+Updates cause replacement.
+Value must be of type ip_addr
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+vip_address
+ |
+The VIP address of the LoadBalancer.
+ |
+
+vip_port_id
+ |
+The VIP port of the LoadBalancer.
+ |
+
+vip_subnet_id
+ |
+The VIP subnet of the LoadBalancer.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::LBaaS::LoadBalancer
+ properties:
+ admin_state_up: Boolean
+ description: String
+ name: String
+ provider: String
+ tenant_id: String
+ vip_address: String
+ vip_subnet: String
+
+
OS::Neutron::LBaaS::Pool
+The resource is not allowed to be updated.
+
A resource for managing LBaaS v2 Pools.
+
This resources manages Neutron-LBaaS v2 Pools, which represent a group of nodes. Pools define the subnet where nodes reside, balancing algorithm, and the nodes themselves.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+lb_algorithm
+ |
+The algorithm used to distribute load between the members of the pool.
+String value expected.
+Can be updated without replacement.
+Allowed values: ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP
+ |
+
+listener
+ |
+Listener name or ID to be associated with this pool.
+String value expected.
+Updates cause replacement.
+Value must be of type neutron.lbaas.listener
+ |
+
+protocol
+ |
+Protocol of the pool. It must be the same as the value of OS::Neutron::LBaaS::Listener's protocol.
+String value expected.
+Can not be updated.
+Allowed values: TCP, HTTP
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+The administrative state of this pool.
+Boolean value expected.
+Updates are not supported.
+Allowed values: True
+ |
+
+description
+ |
+Description of this pool.
+String value expected.
+Can be updated without replacement.
+Defaults to " ".
+ |
+
+name
+ |
+Name of this pool.
+String value expected.
+Can be updated without replacement.
+ |
+
+session_persistence
+ |
+Configuration of session persistence.
+Map value expected.
+Updates cause replacement.
+Map properties:
+- cookie_name
Name of the cookie, required if type is APP_COOKIE. It only support cookie_name in the 'APP_COOKIE' type.
+String value expected.
+Updates cause replacement.
+ - type
Method of implementation of session persistence feature.
+String value expected.
+Updates cause replacement.
+Allowed values: SOURCE_IP, HTTP_COOKIE, APP_COOKIE
+
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+healthmonitor_id
+ |
+ID of the health monitor associated with this pool.
+ |
+
+listeners
+ |
+Listener associated with this pool.
+ |
+
+members
+ |
+Members associated with this pool.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::LBaaS::Pool
+ properties:
+ admin_state_up: Boolean
+ description: String
+ lb_algorithm: String
+ listener: String
+ name: String
+ protocol: String
+ session_persistence: {"type": String, "cookie_name": String}
+
+
OS::Neutron::LBaaS::PoolMember
+A resource for managing LBaaS v2 Pool Members.
+
A pool member represents a single backend node.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+address
+ |
+IP address of the pool member on the pool network.
+String value expected.
+Updates cause replacement.
+Value must be of type ip_addr
+ |
+
+pool
+ |
+Name or ID of the load balancing pool.
+String value expected.
+Updates cause replacement.
+Value must be of type neutron.lbaas.pool
+ |
+
+protocol_port
+ |
+Port on which the pool member listens for requests or connections.
+Integer value expected.
+Updates cause replacement.
+The value must be in the range 1 to 65535, include 1 and 65535.
+ |
+
+subnet
+ |
+Subnet name or ID of this member.
+String value expected.
+Updates cause replacement.
+Value must be of type neutron.subnet
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+admin_state_up
+ |
+The administrative state of the pool member.
+Boolean value expected.
+Updates are not supported.
+Allowed values: True
+ |
+
+weight
+ |
+Weight of pool member in the pool (default to 1).
+Integer value expected.
+Can be updated without replacement.
+Defaults to "1".
+The value must be in the range 0 to 256, include 0 and 256.
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+address
+ |
+The IP address of the pool member.
+ |
+
+pool_id
+ |
+The ID of the pool to which the pool member belongs.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OS::Neutron::LBaaS::PoolMember
+ properties:
+ address: String
+ admin_state_up: Boolean
+ pool: String
+ protocol_port: Integer
+ subnet: String
+ weight: Integer
+
+
OSE::RDS::Instance
+A resource for creating a relational database (Relational Database Service) instances.
+
A relational database service is a reliable, scalable, and easy-to-manage web service in the cloud.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+name
+ |
+Instance name
+String value expected.
+Updates cause replacement.
+The instance name of the same type instances under the same tenant must be unique.
+Value range: The value is a string of 4 to 64 characters, case insensitive, which must start with a letter. An instance name can contain letters, digits, hyphens (-), or underscores (_). Other special characters cannot be included.
+ |
+
+datastore_type
+ |
+Database engine
+String value expected.
+Updates cause replacement.
+Allowed value: MySQL, PostgreSQL, or SQLServer
+ |
+
+datastore_version
+ |
+Instance version
+String value expected.
+Updates cause replacement.
+Value range: The value contains a maximum of 64 characters and cannot be fewer than four characters.
+ |
+
+flavor
+ |
+Flavor ID
+String value expected.
+Can be updated without replacement.
+Value range: The value cannot be empty. The length of the character string is verified and the regular UUID regular check is performed.
+
+ |
+
+volume
+ |
+Disk information
+Map value expected.
+Map properties:
+- type
Disk type
+String value expected.
+Updates cause replacement.
+Allowed value: Common (SATA) and ULTRAHIGH (SSD), which are case sensitive.
+ - size
Disk size
+Integer value expected.
+Unit: GB
+Can be updated without replacement.
+Value range: The value ranges from 100 to 2000 and must be an integer multiple of 10.
+
+ |
+
+region
+ |
+Area ID
+String value expected.
+Updates cause replacement.
+Value range: The value cannot be empty.
+ |
+
+availability_zone
+ |
+ID of an available zone
+String value expected.
+Updates cause replacement.
+Value range: The value cannot be empty.
+ |
+
+nics
+ |
+Subnet information
+Map value expected.
+Map properties:
+
+ |
+
+vpc
+ |
+ID of a VPC
+String value expected.
+Updates cause replacement.
+Value range: The value cannot be empty. The length of the character string must be verified through the regular UUID check.
+ |
+
+security_group
+ |
+Security group to which an instance belongs
+String value expected.
+Updates cause replacement.
+Value range: The value cannot be empty. The length of the character string must be verified through the regular UUID check.
+ |
+
+password
+ |
+Password of the database root user
+String value expected.
+Updates cause replacement.
+Value range: The value is a string of 8 to 32 characters consisting of uppercase letters, lowercase letters, digits, and special characters ~!@#%^*-_=+?. The password must contain uppercase letters, lowercase letters, digits, and at least one special character.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+db_port
+ |
+Port number of the database
+Integer value expected.
+The default value is 8036.
+Cannot be updated.
+ |
+
+backup_strategy
+ |
+Advanced backup policy
+Map value expected.
+Map properties:
+- start_time
Start time: Automatic backup will be triggered within one hour of the start time.
+String value expected.
+Updates cause replacement.
+Value range: The value cannot be empty. The value must be in hh:mm:ss format and valid. The current time is the UTC time.
+ - days
The number of days for which backup files can be saved.
+Integer value expected.
+Updates cause replacement.
+Value range: 0 to 35. When this parameter is set to the default value or 0, the automatic backup policy is not configured.
+
+ |
+
+ha
+ |
+HA configuration parameter, which is used for creating an HA instance.
+Map value expected.
+Map properties:
+- enable
HA configuration parameters
+Boolean value expected.
+Updates cause replacement.
+ - replication_mode
Synchronization parameter of the standby node
+String value expected.
+Updates cause replacement.
+Value range: The value cannot be empty. - MySQL : The value can be async or semisync.
- PostgreSQL: The value can be async or sync.
+
+ NOTICE: Microsoft SQL Server does not support the creation of HA instances. Therefore, this parameter is not involved.
+
+ |
+
+replica_of
+ |
+Read-only copy configuration parameter (mandatory when a read-only copy is created).
+String value expected.
+Cannot be updated.
+Value range: instance ID of the primary instance
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+name
+ |
+Database instance name
+ |
+
+flavor
+ |
+Specification information
+ |
+
+hostname
+ |
+Connection address of an instance. The value exists only after an ECS is created successfully. In other cases, the value is an empty string.
+ |
+
+type
+ |
+Instance type. The value can be master, slave, or readreplica.
+ |
+
+backupStrategy
+ |
+Advanced backup policy
+ |
+
+slaveId
+ |
+ID of the secondary instance.
+ |
+
+ha
+ |
+HA information. This parameter is returned when the HA instance is obtained.
+ |
+
+replicaOf
+ |
+This parameter is returned only when a read-only copy is obtained.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ the_resource:
+ type: OSE::RDS::Instance
+ properties:
+ name: String
+ region: String
+ availability_zone: String
+ nics:
+ subnet: String
+ volume:
+ type: String
+ size: Number
+ security_group: String
+ vpc: String
+ datastore_type: String
+ datastore_version: String
+ flavor: String
+ password: String
+
+
OSE::VPC::Vpc
+A resource for managing Virtual Private Cloud (VPC) resources
+
A VPC can be used to build an isolated, user-configured, and managed virtual network environment for your ECSs.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+name
+ |
+Name of a VPC
+String value expected.
+Can be updated without replacement.
+Value range: The value is a string of 1 to 64 characters, including digits, letters, underscores (_), and hyphens (-).
+ NOTE: If the name is not empty, the name of a tenant must be unique.
+
+ |
+
+cidr
+ |
+Range of available subnets in a VPC
+String value expected.
+Can be updated without replacement.
+The value can be updated without replacing the template.
+Value range: 10.0.0.0/8 to 10.255.255.0/24, 172.16.0.0/12 to 172.31.255.0/24, or 192.168.0.0/16 to 192.168.255.0/24. The value must be in the CIDR format. For example: 192.168.0.0/16.
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+name
+ |
+Name of a VPC
+ |
+
+cidr
+ |
+Range of available subnets in a VPC
+ |
+
+status
+ |
+Status of a VPC
+ |
+
+neutron_router_id
+ |
+UUID of a router
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::VPC::Vpc
+ properties:
+ name: String
+ cidr: String
+
+
OSE::VPC::Subnet
+A resource for managing subnets
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+name
+ |
+Subnet name
+String value expected.
+Can be updated without replacement.
+Value range: 1 to 64, which can contain digits, letters, underscores (_), and hyphens (-)
+ |
+
+cidr
+ |
+Network segment of a subnet
+String value expected.
+Updates cause replacement.
+Value range: The value must be within the CIDR range of the VPC. The value must be in the CIDR format. The mask length cannot exceed 28 characters.
+ |
+
+gateway_ip
+ |
+Gateway of a subnet
+String value expected.
+Updates cause replacement.
+Value range: IP addresses in the subnet segment. The IP address must be valid.
+ |
+
+vpc_id
+ |
+ID of the VPC to which the subnet belongs
+String value expected.
+Updates cause replacement.
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+dhcp_enable
+ |
+Whether the DHCP function is enabled on a subnet
+String value expected.
+Can be updated without replacement.
+Allowed value: true and false
+Default value: true
+ |
+
+primary_dns
+ |
+Subnet DNS server address 1
+String value expected.
+Can be updated without replacement.
+The value must be a valid IP address.
+ |
+
+secondary_dns
+ |
+Subnet DNS server address 2
+String value expected.
+Can be updated without replacement.
+The value must be a valid IP address.
+ |
+
+dnsList
+ |
+A set of subnet DNS server addresses
+Use this field if you want to use more than two DNS servers. This field is the parent set of subnet DNS server address 1 and subnet DNS server address 2.
+List value.
+Can be updated without replacement.
+The value in the set must be a valid IP address.
+ |
+
+availability_zone
+ |
+ID of the AZ where the subnet is located
+String value expected.
+Updates cause replacement.
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::VPC::Subnet
+ properties:
+ name: String
+ cidr: String
+ gateway_ip: String
+ vpc_id: String
+ dhcp_enable: Boolean
+ primary_dns: String
+ secondary_dns: String
+ dnsList: [...]
+ availability_zone: String
+
+
OSE::SFS::Share
+A resource for creating file sharing resources
+
Scalable File Service (SFS) provides users with a fully hosted shared file storage, which can be scaled to PB scale, providing high availability and durability, and providing powerful support for massive data and high-bandwidth applications. SFS applies to various application scenarios, including media processing, file sharing, content management, and web services.
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+share_proto
+ |
+File system sharing protocol
+String value expected.
+Updates cause replacement.
+Allowed value: NFS
+ |
+
+size
+ |
+Shared capacity
+Integer value expected.
+Can be updated without replacement.
+Unit: GB
+ NOTE: The size cannot exceed the quota. Otherwise, the shared storage fails to be created.
+
+ |
+
+name
+ |
+Name of the sharing storage
+String value expected.
+Can be updated without replacement.
+Value range: 1 to 255. The value can contain only digits, letters, underscores (_), and hyphens (-).
+ |
+
+
+
+
+
+
Optional Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+description
+ |
+Description for a sharing file system
+String value expected.
+Can be updated without replacement.
+Length: 0 to 255
+ |
+
+is_public
+ |
+Sharing range
+Boolean value expected.
+Updates cause replacement.
+The default value is false.
+ NOTE: The Boolean value can be true/false, yes/no, or on/off.
+
+ |
+
+availability_zone
+ |
+AZ name
+String value expected.
+Updates cause replacement.
+Length: 0 to 255.
+ NOTE: If no AZ information is entered, the default AZ is used. If no storage resource is available in the default AZ, creating a sharing storage fails.
+
+ |
+
+metadata
+ |
+Key-value pair of one to more dictionary form
+Map value expected.
+Updates cause replacement.
+The default value is {}.
+ |
+
+
+
+
+
+
Attributes
+
Name
+ |
+Description
+ |
+
|---|
+
+name
+ |
+Sharing file system name
+ |
+
+export_location
+ |
+Sharing file system mount path
+ |
+
+metadata
+ |
+Key-value pair of one to more dictionary form
+ |
+
+host
+ |
+Shared host name
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::SFS::Share
+ properties:
+ share_proto: String
+ size: Integer
+ name: String
+ description: String
+ availability_zone: String
+ metadata:
+ key1: value1
+ key2: value2
+
+
OSE::SFS::ShareAccessRule
+A resource for creating file sharing access rules
+
Required Properties
+
Name
+ |
+Description
+ |
+
|---|
+
+share_id
+ |
+Sharing ID of access rules
+String value expected.
+Updates cause replacement.
+Value range: Valid shared ID, which is strictly checked using the UUID regular expression.
+ |
+
+allow_access
+ |
+Sharing file system access policy
+Map value expected.
+Map properties:
+- access_level
Access pPermission level
+String value expected.
+Allowed value: ro (read-only), rw (read/write)
+ - access_type
Specifies the type of a access rule. NFS sharing supports only the cert type.
+String value expected.
+ NOTE: If the NFS sharing access rule type is cert, set access_to to the VPC ID.
+
+ - access_to
Specifies the value of an access rule. Currently, only the VPC ID is supported.
+String value expected.
+Value range: The value cannot be empty. The length of the character string must be verified through the regular UUID check.
+ NOTE: Only one VPC ID can be added to a sharing file system. If two or more VPC IDs are added, the sharing file system cannot be mounted.
+
+
+ |
+
+
+
+
+
+
HOT Syntax
heat_template_version: 2014-10-16
+...
+resources:
+ ...
+ the_resource:
+ type: OSE::SFS::ShareAccessRule
+ properties:
+ share_id: String
+ allow_access:
+ access_level: String
+ access_type: String
+ access_to: String
+
+
Creating an ECS
+Application Scenarios
This template is used to create an ECS.
+
+
Example Template
heat_template_version: 2014-10-16
+description: Create a simple ECS instance.
+resources:
+ nova_serer:
+ type: OS::Nova::Server
+ properties:
+ name: ECS Name
+ image: Image Name or ID
+ flavor: Flavor Name
+ key_name: Key Pair
+ networks:
+ - network: Network Name or ID
+ availability_zone: AZ Name
+
+
Creating an ECS and Binding an EIP to the ECS
+Application Scenarios
This template is used to create an ECS and bind an EIP to this ECS.
+
+
Example Template
heat_template_version: 2014-10-16
+description: Create an EIP and bind it to ECS.
+resources:
+ server:
+ type: OS::Nova::Server
+ properties:
+ image: Image Name or ID
+ flavor: Flavor Name
+ key_name: Key Pair
+ networks:
+ - port: { get_resource: server_port }
+ availability_zone: AZ Name
+ server_port:
+ type: OS::Neutron::Port
+ properties:
+ network: Network Name or ID
+ floating_ip:
+ type: OS::Neutron::FloatingIP
+ depends_on: server
+ properties:
+ floating_network: admin_external_net
+ port_id: { get_resource: server_port }
+outputs:
+ floating_ip:
+ description: The floating ip address of the server.
+ value: { get_attr: [floating_ip, floating_ip_address] }
+
+
Creating an ECS with EVS Disks Mounted
+Application Scenarios
This template is used to create an ECS and EVS disk and attach the EVS disk to the ECS.
+
+
Example Template
heat_template_version: 2014-10-16
+description: Create an ECS and EVS disk and attach the EVS disk to the ECS.
+resources:
+ neutron_port:
+ type: OS::Neutron::Port
+ properties:
+ network: Network Name or ID
+ data_volume:
+ type: OS::Cinder::Volume
+ properties:
+ name: EVS Name
+ size: Size of Volume
+ availability_zone: AZ Name
+ nova_server:
+ type: OS::Nova::Server
+ properties:
+ name: ECS Name
+ image: Image Name or ID
+ flavor: Flavor Name
+ key_name: Key Pair
+ networks:
+ - port: { get_resource: neutron_port }
+ availability_zone: AZ Name
+ volume_attach:
+ type: OS::Cinder::VolumeAttachment
+ properties:
+ volume_id: { get_resource: data_volume }
+ instance_uuid: { get_resource: nova_server }
+
+
Creating an ECS Group
+Application Scenarios
This template is used to create a group of ECSs.
+
+
Example Template
heat_template_version: 2014-10-16
+description: Create a group of ECSs.
+resources:
+ instance_group:
+ type: OS::Heat::ResourceGroup
+ properties:
+ count: Number of resource
+ resource_def:
+ type: OS::Nova::Server
+ properties:
+ name: aaaa-%index%
+ image: Image Name or ID
+ flavor: Flavor Name
+ key_name: Key Pair
+ networks:
+ - network: Network Name or ID
+ availability_zone: AZ Name
+
+
Creating an ECS in a Specified Security Group
+Application Scenarios
This template is used to create a security group and create an ECS in the security group.
+
+
Example Template
heat_template_version: 2014-10-16
+description: This example creates an ECS security group for the instance to give you SSH access.
+resources:
+ server:
+ type: OS::Nova::Server
+ properties:
+ name: ECS Name
+ image: Image Name or ID
+ flavor: Flavor Name
+ key_name: Key Pair
+ networks:
+ - port: { get_resource: server_port }
+ availability_zone: AZ Name
+ security_groups:
+ - { get_resource: neutron_security_group }
+ server_port:
+ type: OS::Neutron::Port
+ properties:
+ network: Network Name or ID
+ floating_ip:
+ type: OS::Neutron::FloatingIP
+ depends_on: server
+ properties:
+ floating_network: admin_external_net
+ port_id: { get_resource: server_port }
+ neutron_security_group:
+ type: OS::Neutron::SecurityGroup
+ properties:
+ name: neutron_security_group
+ rules:
+ - protocol: tcp
+ port_range_min: 22
+ port_range_max: 22
+ remote_ip_prefix: 0.0.0.0/0
+outputs:
+ ECSName:
+ description: The Name of the ECS instance newly created.
+ value: { get_attr: [server, name] }
+ floating_ip:
+ description: The floating ip address of the server.
+ value: { get_attr: [floating_ip, floating_ip_address] }
+
+
Creating an AS Group
+Application Scenarios
This template is used to perform the following operations:
+
- Create an AS group that contains 1 to 2 ECSs.
- Create a security group in which ECSs in the AS group are created.
+
+
Example Template
heat_template_version: 2014-10-16
+description: Create an AS instance.
+resources:
+ auto_scaling_config:
+ type: OSE::AS::ScalingConfig
+ properties:
+ scaling_configuration_name: Scaling Configuration Name
+ instance_config:
+ key_name: Key Pair
+ flavorRef: Flavor ID
+ imageRef: Image ID
+ disk:
+ - disk_type: SYS
+ size: 200
+ volume_type: SATA
+ - disk_type: DATA
+ size: 100
+ volume_type: SATA
+ personality:
+ - path: /etc/sample.txt
+ content: input_sample_content
+ public_ip:
+ eip:
+ ip_type: 5_bgp
+ bandwidth:
+ size: 5
+ share_type: PER
+ charging_mode: traffic
+ user_data: sampleTest
+ metadata: #NA
+ test: sampleTest
+ auto_scaling_group:
+ type: OSE::AS::ScalingGroup
+ properties:
+ scaling_group_name: Scaling Group Name
+ scaling_configuration_id: { get_resource: auto_scaling_config }
+ desire_instance_number: 1
+ min_instance_number: 1
+ max_instance_number: 2
+ cool_down_time: 900
+ available_zones:
+ - AZ Name
+ networks:
+ - id: Network ID
+ security_groups:
+ - id: Security Groups ID
+ vpc_id: VPC ID
+ health_periodic_audit_method: NOVA_AUDIT
+ health_periodic_audit_time: 15
+ instance_terminate_policy: OLD_INSTANCE
+ delete_publicip: true
+
+
Creating a Load Balancer
+Application Scenarios
This template is used to create ECSs and a load balancer and add all ECSs to the load balancer.
+
+
Example Template
heat_template_version: 2014-10-16
+description: Create an ELB instance.
+resources:
+ elb_loadbalancer:
+ type: OSE::ELB::LoadBalancer
+ properties:
+ name: loadbalancer
+ vpc_id: VPC ID
+ type: External
+ bandwidth: 300
+ admin_state_up: true
+ elb_listener:
+ type: OSE::ELB::Listener
+ properties:
+ name: elb_listener
+ loadbalancer_id: { get_resource: elb_loadbalancer }
+ protocol: HTTP
+ port: 8080
+ backend_protocol: HTTP
+ backend_port: 8080
+ lb_algorithm: leastconn
+ sticky_session_type: insert
+ elb_healthcheck:
+ type: OSE::ELB::HealthCheck
+ properties:
+ listener_id: { get_resource: elb_listener }
+ healthcheck_protocol: HTTP
+ healthcheck_timeout: 2
+ unhealthy_threshold: 3
+ healthcheck_interval: 5
+ healthy_threshold: 3
+ healthcheck_connect_port: 8080
+ healthcheck_uri: /
+ elb_member:
+ type: OSE::ELB::Member
+ properties:
+ listener_id: { get_resource: elb_listener }
+ members:
+ - server_id: { get_resource: nova_server1 }
+ address: { get_attr: [nova_server1, first_address] }
+ server_port:
+ type: OS::Neutron::Port
+ properties:
+ network: Network Name or ID
+ nova_server1:
+ type: OS::Nova::Server
+ properties:
+ name: ECS Name
+ image: Image Name or ID
+ flavor: Flavor Name
+ networks:
+ - port: { get_resource: server_port }
+ availability_zone: AZ Name
+
+
Creating Network Resources
+Application Scenarios
This template is used to create a VPC, a subnet, a route, and a route interface in the VPC.
+
+
Example Template
heat_template_version: 2014-10-16
+description: Create a VPC instance.
+resources:
+ vpc_network:
+ type: OS::Neutron::Net
+ properties:
+ name: network
+ vpc_subnet:
+ type: OS::Neutron::Subnet
+ depends_on: vpc_router
+ properties:
+ name: subnet
+ network_id: { get_resource: vpc_network }
+ cidr: CIDR
+ dns_nameservers:
+ - DNS server
+ vpc_router:
+ type: OS::Neutron::Router
+ properties:
+ name: router
+ external_gateway_info:
+ network: Fip_pool
+ vpc_router-interface:
+ type: OS::Neutron::RouterInterface
+ properties:
+ router_id: { get_resource: vpc_router }
+ subnet: { get_resource: vpc_subnet }
+
+
How Are Router Resources in the Native OpenStack Mapped to VPC Resources on the Network Console?
+Symptom
The router ID cannot be found on the network console when you create a VPC stack using a template.
+
+
Solution
RTS uses the localized OpenStack network model, including routers, networks, and subnets. The router, router ID, network, and network ID are respectively mapped to the VPC, VPC ID, subnet, and network ID of the VPC service on the network console.
+
+
What's the Reason for the Failure to Delete the Stack?
+If you cannot delete a stack, the reason is that the stack is in operation. If the stack is being created, updated, or otherwise manipulated, the stack cannot be deleted until the operation succeeds or fails.
+
How to Obtain the flavor Value of Resource OSE::RDS::Instance?
+Method 1: By Using the Console
- Log in to the management console.
Google Chrome is recommended.
+ - Choose Database > Relational Database Service.
- In the upper right corner of the displayed page, click Create DB Instance.
- Press F12 and click Network.
- Refresh the page, find createInfo?regionCode=eu-de in the request list, and click Preview. Choose constant > flavors to obtain the flavor IDs and other information.
Figure 1 Obtaining flavor information
+ - Select the flavor ID based on the selected database type, backup policy, and required memory and CPU.
Determine the database type and HA policy based on field code of the flavor. For example, if field code of the flavor is rds.mysql.m1.large.ha, you can create MySQL primary/standby DB instances.
+
+
+
Method 2: By Calling the API
- Call the IAM API to obtain the token.
curl -i -k -X POST https://auth.otc-tsi.de:31943/v3/auth/tokens -d '{"auth": {"identity": {"methods": ["password"],"password": {"user": {"name": "*****","domain": {"name": "****"},"password": "****"}}},"scope": {"project": {"name": "eu-de"}}}}' -H "Content-Type: application/json"
+ - Save the token information.
Save the token obtained in 1 and import variables.
+The following is an example command:
+export token=MIIF5gY*******cNxyvq4=
+ - Invoke the RDS API for obtaining the database version.
URI format: GET /rds/{versionId}/{project_id}/datastores/{datastore_name}/versions
+The following is an example command:
+curl -i -X GET https://rds.eu-de.otc.t-systems.com/rds/v1/3160d79af34b45e78fad478a046d7615/datastores/PostgreSQL/versions -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'User-Agent: python-heatclient' -k -H "X-Auth-Token: $token" -H 'X-Language: en-us'
+ In the URI, datastore_name indicates the type of the database to be created. Currently, the following database types are supported: MySQL, PostgreSQL, and SQLServer. These types are case sensitive.
+
+ - Invoke the RDS API for obtaining specifications of all DB instances.
URI format: GET /rds/{versionId}/{project_id}/flavors
+Example command: curl -i -k -X GET "https://rds.eu-de.otc.t-systems.com/rds/v1/3160d79af34b45e78fad478a046d7615/flavors?dbId=c66772dd-bd7a-11e7-a4c9-00ffa8375c2a®ion=eu-de" -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'User-Agent: python-heatclient' -H "X-Auth-Token: $token" -H "X-Language: en-us"
+ dbId indicates the ID of the DB engine version ID obtained in 3.
+
+ - Select the flavor ID based on the selected backup policy and required memory and CPU.
Determine the database type and HA policy based on field specCode of the flavor. For example, if field specCode of the flavor is rds.mysql.m1.large.ha, you can create MySQL primary/standby DB instances.
+
+
+
