Default Widgets Reference

This section provides a description of all the widgets that are included by default in Cloudify Manager (out-of-the-box). You can select these widgets from the widgets catalog.

To view the widgets catalog, from the dropdown menu next to your user name, select Edit Mode, then click the Add Widget button to display the list of widgets. If you do not see Edit mode in the dropdown menu, you do not have permissions to edit configuration.

For information about adding widgets, placing them on a page, and so on, see Configuring the Cloudify Console Display.

Notes:

To open a widget’s configuration dialog after you have added it to a page, click the gear icon in the top right of the widget.

The widgets are listed according to their category.

Blueprint Widgets

Blueprint Sources

Displays all the sources in a blueprint package in tree view, adjacent to the code. When you click an item in the tree, its code is displayed in the code panel.

blueprint-sources

Blueprint deployments

Displays the list of a deployments in the current tenant, according to the logged-in user’s permissions. The data can be displayed as a table or list. In the case of a list view, the status of each deployment is also displayed. For information about deployment status, click here

blueprint-deployments

Blueprint info

Displays information about a specific blueprint.

Configuration

The blueprint ID must be passed to the widget. This can be done either in the page’s context, by placing the widget in a blueprint drill-down page, or by specifying the blueprint ID in the widget’s configuration.

blueprint-info

Blueprints

Displays all the local blueprints on the Cloudify Manager in the context of the current tenant as a table or tile view, according to the logged-in user’s permissions. In the catalog view, each blueprint entry includes the icon PNG file with which it was uploaded or the Cloudify default icon if no PNG file was attached.

Configuration

In the widget configuration dialog, you can toggle on the Enable click to drill down option so that, when the blueprint is clicked, the drill down page is displayed for that blueprint.

blueprints-list

Blueprints Catalog

Displays blueprints (as a table or tile view) that exist in a repository under a Github account.

Configuration

You must specify the name of the user account in the widget’s settings. The widget includes an upload option for each of the blueprints, which lets you easily upload to the manager.

You can create a filter query in the configuration to specify the blueprints that appear.

You can also enter a Github credentials to let you fetch data. These parameters are pulled from secrets) as the github-username and github-password keys. You must enter those secrets to access private repositories.

blueprints-catalog

Deployment Widgets

Deployment Inputs

Displays the blueprint input values. You can hover over the values, to display them in a separate window, which is useful if the values include multi-line code.

deployment-inputs

Deployment Outputs

Displays the blueprint output values. You can hover over the values, to display them in a separate window, which is useful if the values include multi-line code.

deployment-outputs

Deployment Metric Graph

Displays a chart or charts (up to 5) presenting metric data for the current deployment. After you have added the widget to a page, you can select the metrics to be displayed, and define their properties in the widget’s configuration dialog.

Configuration

You must supply at least one metric or database query in the widget configuration. You also must enter the Deployment ID and Node instance ID, either in the page context or in the widget configuration.

The following list provides information regarding parameters that can be specified for this widget.

Examples

Events and Logs Widgets

Events and Logs

Displays the logs and events of all the executions in the current tenant, according to the user’s permissions. You can configure the fields that are displayed and can use colors to indicate success and failure messages.

Configuration

The fields that can be displayed are:

events-logs

Event and Logs Filter

Displays a filter pane for events and logs.

events-logs-filter

Execution Widgets

Executions

Displays data for about the executions in the current tenant, according to the user’s permissions. Data includes the blueprint and deployment of the execution, the time that it was created, and its current status.

executions

Filter Widgets

Resource Filter

Displays a filter to enable searching by blueprint, deployment, node, node instance or execution.

resource-filter

Configuration

Blueprints and deployments filters are always enabled. Node, node instance and execution filters are optional and can be enabled/disabled in widget’s configuration.

resource-filter-configuration

Event and Logs Filter

See Event and Logs Filter

Time Filter

Displays a time filter for deployment metric graphs. It allows to define:

The filter provides also the following features:

Time Filter

Cluster Widgets

High Availability

Displays the Manager’s status. In the event that there is one or more cluster on the Manager, shows the cluster-connected nodes. There is no click-through actions available from this widget.

list-nodes-in-cluster-2

Node Widgets

Nodes List

Displays a list of the existing nodes related to the blueprint topology. The type, containing node, connection, number of instances, and groups of which the node is part are displayed.

The nodes are listed by name. When you select a node, either by clicking its name in the table or by clicking it in the Topology pane, additional data about the node’s instances are displayed.

nodes-list

Nodes Statistics

Displays the number of node instances, according to their states. node-statistics

Miscellaneous Widgets

Number of Deployments/Plugins/Servers

Displays indicators that provide the total number of deployments, plugins and servers on the Manager.

deployments-plugins-servers

Plugins List

Displays a list of plugins and enables their management.

plugins-list

Secrets Store Management

Displays a list of secrets and enables their management. In the widget, you can hover your cursor over the eye icon to display the value of the secret.

Caution

Any user who has access to the Secrets Store Management widget can view the value of the secrets.

secrets-store

Snapshots List

Displays a list of snapshots of the Manager. This widget is only available to admin users.

snapshots-list

The parameters shown in the screenshot below can be specified during snapshot creation.

snapshots-list

When you restore snapshots, use the process for either your existing VM or a new VM.

Tenant Management

Displays a list of tenants on the Manager and enables tenant management. This widget is only available to admin users.

tenants-list

User Group Management

Displays the list of user groups and enables their management. This widget is only available to admin users.

manage-usergroups

User Management

Displays the list of users and enables their management. This widget is only available to admin users.

manage-users

Show Topology

Displays the topology of a blueprint or deployment.

show-topology

When executing a Workflow for a Deployment (e.g. the install workflow), the topology nodes show badges that reflect the workflow execution state.
See more details on executing workflows here.

Badges

Deployment Topology Node Badges

Workflow states represented by badges

Button Widgets

Blueprint action buttons

Displays buttons for displaying the creating a deployment or deleting a blueprint dialog.

blueprint-actions

Opens the specified URL in a separate tab. You can define the name that appears on the button.

Configuration

Specify the URL to open when the button is clicked and buttons label.

button-link

Deployment Action Buttons

Displays buttons for displaying the execute a workflow, update a deployment, and delete a deployment dialogs.

deployment-actions

New Deployment Button

Displays a button for displaying the creating a deployment dialog.

create-new-deployment