Orchestration on CloudBolt Documentation

Rules

Mon, 01 Jan 0001 00:00:00 +0000

A rule lets Cloud Management Platform (CMP) administrators check the state of the environment and act on what they find. Use rules to enforce policy with corrective actions, respond to changes as they happen, or run health checks and tell the right people what needs attention.

How a rule works

A rule is a logical statement in two parts:

Condition (the “if”). One action that tests something and reports whether it found anything.
Actions (the “then”). One or more actions that run when the condition is met.

Both parts are CMP actions of type CloudBolt Plug-in. The condition is written a little differently from other plugins; see Write a condition plugin.

Flow control orchestration

Mon, 01 Jan 0001 00:00:00 +0000

Use flow control to prevent orders from starting or pause orders when known issues or scheduled downtime affect certain ecosystem integrations.

Enabling flow control

Go to Admin > Flow Control Actions.
Select Add, then select Create New.
In the Create Flow Control dialog, fill in the required fields (Label and Control Type) and any top-level filters, then select Save.

Top-level filters

Filter	Description
Groups	Select one or more groups to allow or pause orders with the group.
Blueprints	Select one or more blueprints to allow or pause orders for them.
Environments	Select one or more environments to allow or pause orders that have any items with any of the selected environments.
Resource Technologies	Select one or more resource technologies to allow or pause orders that have any items with any of the selected resource technologies.
Resource Handlers	Select one or more resource handlers to allow or pause orders that have any items with any of the selected resource handlers.

Once saved, a new flow control action is created with minimal action code to apply the top-level filters. The new action is created in the disabled state.

External orchestrators

Mon, 01 Jan 0001 00:00:00 +0000

Cloud Management Platform (CMP) supports two technologies: HP Operations Orchestration (HPOO) and vCenter/vRealize Orchestrator. Inputs defined on a flow appear on the order form.

External Orchestrators is disabled by default and does not appear under Admin. Contact CloudBolt to enable it on your instance.

Add an orchestrator

Go to Admin > External Orchestrators.
Select Add.
Choose the technology you are connecting to.
Fill in the connection details, then select Continue.
Give the orchestrator a Name and the folder or library path CMP should discover flows from, then select Done.

Connection details

Field	Description
Scheme	Protocol used to connect to the orchestration engine.
Host	IP address or hostname of the orchestrator.
Port	Port used to connect to it. The field is prefilled with the default port for the technology you chose.
Account	Username that runs the flows.
Password	Password for that account.

Name and flow location

Field	Description
Name	The name this orchestrator is shown under in CMP.
Base folder for discoverable flows	The folder CMP imports flows from. It must contain the workflows themselves; subfolders are not searched. Some technologies label this field as a library path.

Edit an orchestrator

The External Orchestrators page lists each connection with its Name, Technology, Username, and IP Address. Select a name to open it. From there you can:

Terraform operations

Mon, 01 Jan 0001 00:00:00 +0000

A Terraform Operation is a blueprint build item that points to a Terraform source, such as a zip file, a git repository, or a URL. When the blueprint is ordered, Cloud Management Platform (CMP) runs that source, stores the resulting state, and creates a resource representing what Terraform built. Values pass from CMP into Terraform through variable maps.

Add a Terraform Operation to a blueprint

Open Catalog and select the blueprint.
Open the Build tab.
Select Terraform Operation.

(opens full-size image in a new tab)
Complete the dialog and save.

Environment selection orchestration

Mon, 01 Jan 0001 00:00:00 +0000

A server tier in a blueprint can hand the choice of target Environment, OS Build, and additional Parameters to a plugin that runs at order time. Set this on the tier’s Environment Selection Orchestration attribute. Cloud Management Platform (CMP) then calls your plugin and provisions accordingly.

Set it on a server tier

Go to Catalog.
Edit a blueprint that has a server tier.
Open the Build tab.
Expand the server tier.
Under Environment Selection Orchestration, add a plugin.
Create a plugin, or select an existing one that implements determine_deployment_environment_and_parameters.
Select Save.

The function receives the order’s context and returns the environment to use. It can use any logic to determine the appropriate environment.

Schedule power on/off

Mon, 01 Jan 0001 00:00:00 +0000

Cloud Management Platform (CMP) can power servers off for set periods of the day, which saves cost and consumption on servers that, for example, do not need to run overnight. Set a schedule on a single server, or on a resource so that its servers are scheduled together.

Before you start

Power schedules are handled by two built-in recurring jobs: Auto-power control servers and Auto-power control resources. Both are disabled by default, so setting a schedule has no effect until you enable the corresponding job. See Built-in recurring jobs.