Run-Time Micro Template Reference
You can find sample run-time micro templates at sagdevops-templates
alias: sag-<product> #REQUIRED A unique alias for the template. Validated, do not use ^\w+[\w\-\.]*$
description: #OPTIONAL Description, not validated.
environments: #Input parameters for the template.
default: #Default parameters for the product instance.
product.instance.name: default #Name of the product instance.
product.license.key.alias: ${} #REQUIRED The alias of the product license key file.
product.http.port: #The number of the HTTP port.
product.https.port: #The number of the HTTPS port.
product.jmx.port: #The number of the JMX port.
product.memory.max: #Maximum memory size.
product.fixes: #A list of fixes to apply for the product.
- ...
param1: ${@credentials.credentialsAlias.username} # OPTIONAL Existing credentials alias that matches the username for different sets
# of credentials, such as repo or product user credentials.
param2: ${@credentials.credentialsAlias.password} # OPTIONAL Existing credentials alias that matches the password for different sets
# of credentials, such as repo or product user credentials.
spm.username: ${@credentials.credentialsAlias.username} # OPTIONAL Existing credentials alias that matches the username that Command Central
# uses to connect to Platform Manager nodes.
spm.password: ${@credentials.credentialsAlias.password} # OPTIONAL Existing credentials alias that matches the password that Command Central
# uses to connect to Platform Manager nodes.
layers:
runtime: #REQUIRED The definition of the run-time layer.
productAdministrator:
credentials: <administratorCredentialsAlias> #OPTIONAL The credentials alias defined for the administrator user credentials for the products in the layer.
#Default: ADMINISTRATOR.
changeOnFirstLogin: true|false #OPTIONAL Indicates whether the product requires administrator password change on the first login.
#Valid values: true (password change required)| false (password change not required). Default: false
productRepo: ${repo.product} #A repository from which to install the products.
fixRepo: ${repo.fix} #A repository from which to install the fixes for the products.
assetRepo: ${repo.asset} #A repository from which to install assets for the products.
templates:
- product #The alias of the porudct inline template defined in the "templates" section.
#Command Central creates the product instance first and then provisions
#the hosted component on the existing product instance.
- hosted-component #An inline template for a component hosted by the product.
#For example, Application Platform on Integration Server.
templates: #REQUIRED Defines the inline templates for the product and its hosted components.
product: #REQUIRED An alias for the product inline template. Validated, do not use ^\w+[\w\-\.]*$
licenses: #The license alias for the product license key.
"target/licenseKey": "${alias}"
fixes: ${product.fixes} #List of fixes to apply for the product.
products: #The product to install from "productRepo: ${repo.product}"
productID: #REQUIRED The ID of the product.
#To retrieve a list of product IDs, run this command: cc list repository products content <repositoryName>
${product.instance.name}: #REQUIRED The name of the product instance. You must define only one product instance.
http.port: ${product.http.port} #Specify parameters for the product instance.
https.port: ${product.https.port}
jmx.port: ${product.jmx.port}
configuration: #Specify the configuration settings for productID/${product.instance.name}
runtimeComponentID: #The ID of a run-time component.
CONFIG-TYPE1: #A configuration type supported by "runtimeComponentID".
COMMON-TYPE1-instance1: #A new or existing configuration instance of CONFIG-TYPE1.
<field>:
<field>:
hosted-component: #REQUIRED An alias for the inline template of the hosted component.
#Validated, do not use ^\w+[\w\-\.]*$
fixes: ${hosted.component.fixes} #Fixes to apply for the hosted component.
products:
hostedComponentID: #REQUIRED The ID of the hosted component.
productID: #The ID of the product that hosts the component.
${product.instance.name}: #The name of the product instance created by the "product" inline template.
package.list: #The name of the package of the hosted component to provision on the existing product instance.
provision:
default:
runtime: ${nodes} #A list of nodes on which to install the "runtime" layer.