Blueprints
Displays all the blueprints on the tenant, according to the user’s permissions and the blueprints visibility levels. The data can be displayed as a table or a catalog.
Features
Blueprint basic information
The following information is displayed:
- Icon image file
- Name
- Visibility level
- Creation time
- Last update time
- Creator user-name
- Main blueprint file name (as the blueprint archive can contain multiple files)
- Number of deployments derived from the blueprint
Blueprint actions
There are also action buttons to upload a blueprint, create deployment, delete blueprint or edit blueprint copy in Cloudify Composer.
Uploading a Blueprint
Using marketplace
- Click the Upload button.
- In the menu, click Upload from Marketplace option.
- On the Blueprint Marketplace page select a blueprint category tab (e.g.
AWS
). - Click Upload icon on one of the blueprints shown in a table.
Using blueprint package
- Click the Upload button.
- In the menu, click Upload a blueprint package option.
- In the Upload Blueprint dialog, provide the URL of the remote archive in which the blueprint is located or select a local blueprint archive.
- Enter the
Blueprint name
andBlueprint YAML file
.
Blueprint name
is the name with which you want to identify this blueprint once uploaded.
Blueprint YAML file
is the name of the YAML file in the archive that you want to upload as the main blueprint - as there can be multiple files in the archive. If a blueprint filename field is omitted, the defaultblueprint.yaml
filename is used, but if a file under that name does not exist in the archive, an error message will appear. - (Optional) Provide a .png file URL or select a local one, to appear as an icon in the catalog or table view next to the blueprint name.
- Choose the blueprint’s visibility by clicking on the icon in the top right corner:
.
The default visibility is “Tenant”, and according to the logged-in user’s permissions you can also choose other levels of resource visibilities. - Click Upload.
Using Terraform module
- Click the Upload button.
- In the menu, click Upload from Terraform module option.
- Create blueprint from Terraform modal will appear.
- Provide the
Blueprint name
and optionallyBlueprint description
.Blueprint name
is the name with which you want to identify this blueprint once uploaded. - Select
Terraform version
(by default, one of the Terraform versions will be selected). - Provide
Terraform module details
, which consists of:Terraform module source
- ZIP archive URL, Git repository URL or local ZIP archive containing Terraform modules.Terraform module folder
- selectable field from which you can select Terraform module contained in the providedTerraform module source
.
By default this field is disabled, until theTerraform module source
is provided.- (Optional) Credentials required for accessing
Terraform module source
.
- (Optional) To add
Variables
orEnvironment variables
:- Click the
Variables
orEnvironment variables
section. - Click the Add button.
- Fill the row fields:
Variable
- name of the variable.Source
- type of the variable, which may be selected from a dropdown.
Currently available values are:Secret
,Input
,Static
.Name
- depending on selectedSource
it has different meaning:
forInput
source it’s an input name.
forSecret
source it’s a secret key.Value
- depending on selectedSource
it has different meaning:
forStatic
source it’s a static value.
forInput
source it’s a default input value.
forSecret
source it’s a secret value.
- Click the
- (Optional) To add
Outputs
:- Click the
Outputs
section. - Click the Add button.
- Fill the row fields:
Output
- name of the output.Output type
- type of the output, which may be selected from a dropdown.
Currently available values are:Output
,Capability
.Terraform output
- value of the output, which will be added to the generated blueprint.
- Click the
- Click Upload.
Using Cloudify Composer
- Click the Upload button.
- In the menu, click Generate in the Composer option.
- Cloudify Composer will be opened in a new tab and there you can create a blueprint.
Deploying a Blueprint
- Click the deploy icon .
- In the Deploy Blueprint dialog, specify a name for your deployment.
- Specify environment on which the blueprint should be deployed on - this option is presented only when the blueprint is using get_environment_capability intrinsic function.
- Specify the required deployment inputs.
The names of the default input values appear in the inputs fields. You can leave these defaults or override them with new values. Input’s description (on hovering help icon ) might help you understand how to fill-in the proper value. An alternative for providing the inputs is to specify a .yaml file containing the relevant values. - Select Deploy in the drop-down to deploy the blueprint or click Install to deploy and execute
install
workflow on it.
Deleting a Blueprint
Click the delete icon and confirm deletion in the displayed dialog.
Blueprint details
When you click the blueprint row (element) in the blueprints table (catalog), a blueprint-specific page opens (it’s also called blueprint’s drill-down page).
The page displays the following widgets with details about the selected blueprint:
- Blueprint Action Buttons
- Blueprint Topology
- Blueprint Deployments
- Blueprint Inputs
- Blueprint Outputs/Capabilities
- Blueprint Sources
See Settings section for details on how to turn on/off this feature.
Settings
Refresh time interval
- The time interval in which the widget’s data will be refreshed, in seconds. Default: 10 secondsList of fields to show
- The fields that are presented in the blueprints list. Default: Created, Updated, Creator, State, Deployments.Enable click to drill down
- Enables redirecting to the blueprint’s drill-down page upon clicking on a specific blueprint. Default: YesDisplay style
- Defines how the blueprints list should be displayed. Can be either Catalog or Table. Default: TableHide failed blueprints
- Allows to hide blueprints not uploaded successfully. Default: OffShow Composer options
- Allows to show Cloudify Composer options in menu and in the blueprints list for users with permission. Default: OnLabel filter rules
- Allows to define blueprint labels’ filter rules. See blueprint filters for more details. Default: empty