Template Cloud Parameters
The following sections detail common and standard template parameters and how they are used in Managed services. Note that the predominant classification is by cloud type, which reflects the differences among cloud types when provisioning cloud resources.
Global variables
Global variables appear once on a Terraform template and effect the template as a whole. Templates that deploy to specific clouds may have variables unique to that cloud type.
| Attribute | Description | Scope |
|---|---|---|
| ibm_stack_name | A unique stack name which is appended as a Chef Node Attribute. System generated. | all |
| allow_unverified_ssl | Boolean. Communication with vSphere server with self-signed certificate. | VMware |
| client_debug | True or False. If you enable it to true in the provider section, the logs are written to /home/terraform/.govmomi/debug directory. |
VMware |
| aws_ami_owner_id | The AMI owner ID, injected by the cloud connection. | AWS |
| aws_region | The AWS region, injected by the cloud connection. For example, us-east-1. | AWS |
| aws_sg_camc_name | The name of the AWS security group for automation content, injected by the cloud connection. | AWS |
| aws_vpc_name | The name of the AWS VPC, injected by the cloud connection. | AWS |
Content Runtime injected variables
The Content Runtime predefines a specific set of variables that are injected to the template at deployment time. These variables can not be modified in CAM Variables. They are listed as a reference only.
| Attribute | Description | Scope |
|---|---|---|
| ibm_sw_repo | IBM Software Repository root, described by a URL. | all |
| ibm_sw_repo_password | IBM Software Repository password, set by the HTTP Server on the software repository. | all |
| ibm_sw_repo_user | IBM Software Repository user name, used to secure the HTTP Server. | all |
| ibm_pm_private_ssh_key | Private CAMC SSH key (base64 encoded) used to connect to the virtual guest. | all |
| ibm_pm_public_ssh_key | Public CAMC SSH key name used to connect to the virtual guest. | all |
| ibm_pm_access_token | IBM Pattern Manager access token. | all |
| ibm_pm_service | IBM Pattern Manager service. | all |
Node variables - All clouds
Node variables appear once per node and can therefore appear multiple times on the same template. Node variables also have a name which is a merging of the variable name and the node name. For example, the os_admin_user field may appear in the template as MQV9Node01-os_admin_user, which is a combination of the variable and node name.
| Attribute | Description | Scope |
|---|---|---|
| domain | Domain Name of virtual machine. It is used in DNS searching on the node (resolv.conf on Linux devices). | all |
| runtime_domain | Domain Name of virtual machine. It is used in DNS searching on the node (resolv.conf on Linux devices). | all |
| image | Operating system image ID/template that should be used when creating the virtual image. | all |
| name | Short host name of the virtual machine. | all |
| user_public_ssh_key | User-defined public SSH key used to connect to the virtual machine. Set to None if not required. | all |
Node variables - VMware
The following is a list of node parameters that effect VMware-based templates only.
| Attribute | Description | Scope |
|---|---|---|
| os_password | Operating system password for the operating system user to access virtual machine, used by Terraform to bootstrap the node. | VMware |
| root_disk_controller_type | Type of template disk controller. For example, scsi-lsi-parallel. | VMware |
| root_disk_datastore | Data store or storage cluster name for target virtual machine's disks. | VMware |
| root_disk_type | Type of template disk volume. For example, eager_zeroed. | VMware |
| ipv4_gateway | IPv4 gateway for vNIC configuration. | VMware |
| ipv4_address | IPv4 address for vNIC configuration. | VMware |
| memory | Memory assigned to the virtual machine in megabytes. This value is required to be an increment of 1024. | VMware |
| ipv4_prefix_length | IPv4 prefix length for vNIC configuration. The value must be a number between 8 and 32. | VMware |
| number_of_vcpu | Number of virtual CPU for the virtual machine. The value must be a positive integer. | VMware |
| folder | Target vSphere folder for virtual machine. | VMware |
| datacenter | Target vSphere datacenter for virtual machine creation. | VMware |
| cluster | Data store or storage cluster name for target virtual machine's disks. | VMware |
| network_interface_label | vSphere port group or network label for virtual machine's vNIC. | VMware |
Node variables - AWS
The following table lists node parameters that effect AWS-based templates only.
| Attribute | Description | Scope |
|---|---|---|
| root_block_device_delete_on_termination | Boolean. AWS root block device delete on termination. | AWS |
| root_block_device_volume_size | AWS root block device volume size in gigabytes. | AWS |
| root_block_device_volume_type | AWS root block device volume type. For example: gp2, io1, st1, sc1. | AWS |
| subnet_name | AWS subnet name. | AWS |
| associate_public_ip_address | Boolean. Assign a public IP address. | AWS |
| flavor | AWS flavor of the virtual machine. For example, t2.small. | AWS |
| mgmt-network-public | Boolean. Expose and use public IP address of virtual machine for internal communication. | AWS |
Node variables - IBM Cloud
The following table lists node parameters that effect IBM Cloud-based templates only.
| Attribute | Description | Scope |
|---|---|---|
| local_disk | Boolean. User local disk or SAN disk. | ibm |
| datacenter | IBM Cloud datacenter where infrastructure resources is deployed. | ibm |
| dedicated_acct_host_only | Shared or dedicated host, where dedicated host usually means higher performance and cost. | ibm |
| hourly_billing | Billing cycle: hourly billed or monthly billed | ibm |
| network_speed | Bandwidth of network communication applied to the virtual machine. For example, 10. | ibm |
| private_network_only | Boolean. Provision the virtual machine with only private IP address. | ibm |
| memory | Amount of Memory (MBs), which is required to be one or more times of 1024. | ibm |
| number_of_cores | Number of CPU cores, which is required to be a positive integer. | ibm |
| root_disk_size | Root disk size in GB. For example, 25. | ibm |
| mgmt-network-public | Boolean. Expose and use public IP address of virtual machine for internal communication. | ibm |