CloudCenter-Defined Parameters

Overview

Automated parameters are defined in the CloudCenter platform and contain the following characteristics:

  • Values provided by CloudCenter.
  • Designed to cover unknown, dynamically generated values or system-dependent values.
  • Reusable in application profiles to automate jobs without writing extensive scripts (examples include timestamp, dynamically-generated IP address, private IP address, IP address of a tier, environment variables, automation policy parameters, number of nodes in a cluster, deployment name, and so forth).

Using CloudCenter-Defined Parameters

To use a system-defined parameter, follow this procedure:

  1. Use the parameter name to reference this parameter inside a configuration script or configuration file as a macro using the CloudCenter platform convention. For example:
    • Parameter name: XYZ_TIER_IP
    • Macro reference for this parameter: %XYZ_TIER_IP%
  2. Reference the macro inside the Application Profile.

List of Defined Parameters

This section lists all parameters, macros, and environment variables defined for the CloudCenter platform for use in CloudCenter deployments.

Reference

CloudCenter-Defined
Parameter/Macro/Variable

Description

Standard IP Address Replacement

These parameters are available at the application level. Some parameters are specific to some application profiles as identified in the Description column.

(ensures backward compatibility with previously-modeled applications)

Use the same case and format (UPPER_CASE)

 

 

 

 

 

 

%XYZ_TIER_IP%

  • Private IP address of a custom tier. XYZ is custom tier name
  • If the tier name is Custom1, then macro name will be %Custom1_TIER_IP%

%DB_TIER_IP%

  • Private IP address of the database tier.
  • The tier name must be Database

%NOSQL_TIER_IP%

Private IP address of NoSQL Database tier

%MB_TIER_IP%

Private IP address of Message BUS

$CliqrTier_{Tiername}_IP

Private IP of tier named XYZ

%BC_TIER_IP%

Private IP address of Backend Cache

Other Macros – Input Parameters for Script

These parameters are available at the application level. Some parameters are specific to some application profiles as identified in the Description column.

Use the same case and format (UPPER_CASE)

See VM Name Config for the pre-defined macros that you can use for the CliQr Macro Replacement Option.


 

 

 

 

 

 

 

 

 

%OUTPUT_DIR%

Path for output directory:
/shared/output

%JOB_NAME%Name of the deployment
%USER_NAME%Name of the user deploying the application
%FIRST_NAME%First name of the user deploying the application
%LAST_NAME%Last name of the user deploying the application
%EMAIL_ADDRESS%Email address of the user deploying the application

%USER_EXTERNAL_ID% or

%userExternalId%

External ID of the user deploying the application (if using SSO)

Both versions of this macro are the same – the CloudCenter 4.8.0.1 implementation uses %userExternalId% as a macro that is replaced by the user's external ID in the URL for webservice (see Using Parameters > Parameter Type for additional details on webservice)

%DEPLOYMENT_ENV%

Name of the deployment environment

%DEP_ENV_NAME%Name of the Puppet or Chef environment

%TIME%

Time stamp string in yyyyMMddHHmmss format

%TASK_INDEX%

  • Task index starting from 1
  • Applies to Batch Compute Application Profiles

%NODE_INDEX%

  • Node index starting from 1
  • Applies to: 
    • Cluster Compute Application Profiles
    • Parallel Execution Application Profile

%HOST_IPS%

  • Host IP address list delimit by comma 
  • Applies to Cluster Compute Application Profiles

%NUM_CPU%

Number of CPUs on the application VM

$VM_NODE_INDEX

This is an additional macro to create VMs using a sequential number for each VM that is newly created. For example, if you use this macro to launch an N-Tier app with 3 nodes:

  • The VM_NODE_INDEX is set as 1, 2, and 3.
  • If you remove Node 2 and add one more node, the VM_NODE_INDEX is set as1, 3, 4, and 5.
  • For Tiers with only one node the VM_NODE_INDEX is set to 1.

This macro is exported as part of userenv file. To consume this macro, add $VM_NODE_INDEX to your scripts and source the userenv(/usr/local/osmosix/etc/userenv) file use the variables as part of your scripts.

Cluster-Based Environment Variables

(Cluster Compute Application Profiles)

CliqrTier_<job_name>_IPPrivate IP address for the tier
CliqrTier_<job_name>_PUBLIC_IPPublic IP address for the tier
CliqrTier_<job_name>_HOSTNAMEHostname for the tier
SSH Keys
sshUserNameThe SSH user name for the current cloud VM
sshKeyThe SSH private key for the current cloud VM
sshPublicKeyThe SSH public key for the current cloud VM
Parameters as Environment Variables

These parameters are available as environment variables. Some parameters are specific to some application profiles as identified in the Description column.

Use the same case and format (InitCaps or camelCase)

 

 

 

 

 

 

$UseBatchTaskList

  • Applies to Batch Execution Application Profile.
  • When set to:
    • 1 = command is read from a task list file
    • 0 = command is an execution command line

$NumTasks

  • Only applicable when UseBatchTaskList=0.
  • Represents the number of tasks to be performed (number of times to repeat a series of execution commands).
  • Applies to Batch Compute Application Profiles

$numClusterNodes

Number of nodes in the tier

$minClusterSize

Minimum number of nodes in a cluster

$maxClusterSize

Maximum number of nodes in a cluster

$minAppClusterSize

Maximum number of nodes for java container-based tiers

VM-Based Environment Variables

(also part of the application and password parameters list)

cliqrNodeId
  • The Node ID of the VM for which the external initialization script is executed.
  • Used for the external, pre-init, Deployment Lifecycle Script.

cliqrNodeHostname
  • The hostname of the VM for which the external initialization script is  executed.
  • Used for the external, pre-init, Deployment Lifecycle Script.

cliqrNodePublicIpThe Public IP of the VM for which the external initialization script is executed.
cliqrNodePrivateIpThe Private IP of the VM for which the external initialization script is executed.
$cliqrWindowsPassword
Automation Policy Parameters

These parameters are only applicable when defining custom action policies and are not available at the application level.

Use the same case and format (camelCase)

 

 

 

 

 

 

 

 

%myEmail%

User's email address

%firstName%

User first name

%vendorName%

Tenant name to send notifications, if any

%jobName%

Name of the deployment job

%jobUrl%

The URL for the deployment

%jobType%

Type of deployment job (for example, benchmark)

%appName%

Name of the application

%owner%

Owner of the deployment job

%status%

Current status of the job (for example, Running)

%cloudName%

Name of the cloud (for example, Amazon US East (Virginia))

%paramCloudType%Identifies the cloud in which the node is launched
Environment Variables for N-Tier deployments

These parameters are available at the application level. Some parameters are specific to some application profiles as identified in the Description column.

These values cannot be overridden

Use the same case and format (InitCaps)

 


 

$CliqrDependents

Comma separated list of connected top tiers name of the tier

$CliqrDependencies

Comma separated list of top tier names connected to bottom tier names

$CliqrDepEnvName

Deployment environment name

$CliqrDepEnvId
  • Helpful on the restore side of the migration as it is available from the source (where the backup is being run).
  • For example: To backup, use <path>/$CliqrDepEnvId 
$CliqrDeploymentId
  • Current deployment ID that ties the pre- and post-migration operations together for scripting purposes (backups and so forth)
  • For example: To backup, use <path>/$CliqrDeploymentId 
$migrateFromDepId
  • Only available for post-migrate operations and points to the previous deployment ID.
  • For example: To restore, <path>/$migrateFromDepId

$CliqrTag_{Tagname}

Job tags defined during run time with value

ScaleType
  • The value can be either ScaleUp or ScaleDown.
  • Displays the type of scaling on the tier with the name $CliqrTier_scalingTierName)
CliqrTier_scalingTierName
  • The tier name on which the scaling operation occurred.
CliqrTier_{$CliqrTier_scalingTierName}_scaleUpPublicIps
  • ScaleUp parameter.
  • The public IPs of the VMs that are scaled up on the tier with the name $CliqrTier_scalingTierName.
CliqrTier_{$CliqrTier_scalingTierName}_scaleUpNodeIds
  • ScaleUp parameter.
  • The nodeIds of the nodes that are scaled up on the tier with name $CliqrTier_scalingTierName.
CliqrTier_{$CliqrTier_scalingTierName}_scaleUpPrivateIps
  • ScaleUp parameter.
  • The private IPs of the nodes that are scaled up on the tier with name $CliqrTier_scalingTierName.

CliqrTier_{$CliqrTier_scalingTierName}_scaleUpHostnames

  • ScaleUp parameter.
  • The hostnames of the nodes that are scaled up on the tier with name $CliqrTier_scalingTierName.
CliqrTier_{$CliqrTier_scalingTierName}_scaleDownPublicIps
  • ScaleDown parameter.
  • The public IPs of the nodes that are scaled down on the tier with name $CliqrTier_scalingTierName.
CliqrTier_{$CliqrTier_scalingTierName}_scaleDownNodeIds
  • ScaleDown parameter.
  • The nodeIds of the nodes that are scaled down on the tier with name $CliqrTier_scalingTierName.
CliqrTier_{$CliqrTier_scalingTierName}_scaleDownPrivateIps
  • ScaleDown parameter.
  • The private IPs of the nodes that are scaled down on the tier with name $CliqrTier_scalingTierName.
CliqrTier_{$CliqrTier_scalingTierName}_scaleDownHostnames
  • ScaleDown parameter.
  • The hostnames of the nodes that are scaled down on the tier with name $CliqrTier_scalingTierName.
Docker Custom Services

Right before your script is executed, CloudCenter supplies all the application-specific parameters as environment variables.

$region

Identifies the region information in the environment variables for External Services.
$CloudFamily

Identifies the cloud family in the environment variables for External Services.

cliqrContainerExecuteScriptTimeoutLimits the Docker container from running forever if an external service falls into an infinite loop. See External Service > Script Timer.
External Service Environment Variables
CLIQR_EXECUTE_SCRIPTThe execution command/script for the current Docker container run.
externalServiceBundleThe path/URL to the external service bundle (configured on the CCO Wizard Properties)
actionTypeThe action type of the current external service action, the possible values: SCRIPT or URL or CMD
serviceNameThe name of the External Service.
CUSTOM_REPO_URLThe CloudCenter custom bundle store  URL (configured on the CCO Wizard Properties)
Docker Container Environment Variables
Cloud_Setting_CloudFamilyThe cloud family of the region in the CloudCenter platform.
Cloud_Setting_cloudThe region name, for example: Amazon-us-west-2.
CliqrTier_NameListThe names list of all tiers in the application.
CliqrCloud_RegionEndPointThe region endpoint, example: ec2.us-west-2.amazonaws.com.
CliqrDepEnvIdThe Deployment environment ID created by the CloudCenter platform.
cliqrAppNameThe application Name in the CloudCenter platform.
launchUserNameThe launch username in the CloudCenter platform., for example: cliqradmin
cliqrAppTypeThe type of application in the CloudCenter platform, for example: n-tier
CliqrDepEnvNameThe deployment environment name n the CloudCenter platform
  • No labels