Widgets

This section provides a description of all the widgets that are included by default in the Cloudify Manager (out-of-the-box).

For more details about adding widgets, placing them on a page and changing configuration, see Edit Mode page.

The following widgets descriptions are listed in an alphabetical order, as they do in the widgets catalog:

Agents Management

Displays the following information about a specific agent: Id - unique identifier of the agent IP - IP address of the agent host Deployment - Deployment ID associated with agent Node - Node ID associated with agent System - agent host operation system Version - agent version Install Method - agent installation method (one of described here) By clicking buttons above the table you can execute the following operations:

Blueprint Action Buttons

Buttons that allow performing actions on the blueprint currently set in the context - creating a deployment from it, deleting the blueprint or editing a copy of the blueprint in Composer (available only as part of the Premium edition). See notes for more information on resource context. Settings Show the "Edit a copy in Composer" button - Defines whether “Edit a copy in Composer” button should be displayed. Default: Off

Blueprint deployments

Displays the list of the deployments in the current tenant, according to the user’s permissions. The data can be displayed as a table or list. Features Deployment basic information The Deployments widget displays a list of deployments in the current tenant. The displayed information is: Deployment name, the blueprint which the deployment is derived from, the deployments creation and last update dates, the name of the user who created the deployment, and the number of node instances per state.

Blueprint Info

Displays the following information about a specific blueprint: Picture Name Visibility level Creation time Last update time Creator user-name Main blueprint file name (as the blueprint archive can contain multiple files) Settings Refresh time interval - The time interval in which the widget’s data will be refreshed, in seconds. Default: 10 seconds Blueprint ID - The blueprint ID must be passed to the widget. This can be done either setting blueprint in the context (see notes for more information on resource context), or by specifying the blueprint ID in this configuration field.

Blueprint Sources

Displays all the source files 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. You can also open the file in full mode by clicking on the gray box presenting its name in the top right corner of the widget. If blueprint imports another blueprint, then all imported blueprint will be listed under Imported blueprints node in tree view.

Blueprint upload button

This button allows uploading a blueprint to the manager. Clicking on it opens a dialog for providing the following details: Blueprint visibility (optional) - represented by a colourful icon in the upper right corner, and can be set by clicking on it. See resource’s visibility. Default: tenant Blueprint package - single YAML file or blueprint archive (local or URL). Blueprint Name - unique name to identify the blueprint on the manager.

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.

Blueprints Catalog

Displays blueprints from a repository under a configurable Github account or from an HTTP endpoint providing JSON response. By default, the widget presents the blueprints listed in JSON file taken from widget configuration. The widget includes an upload option for each of the blueprints, which lets you easily upload it to the current tenant on the manager. After uploading a blueprint from the catalog, you will be able to see it under the Blueprints widget.

Button link

Opens the specified URL: in a separate tab/window if URL starts with ‘http’ in the same tab/window in other case You can define the button styling in widget configuration. Settings URL address - The URL to be opened upon clicking on the button. Default: “ Label - The label displayed in the button. Default: ‘Button Link’ Color - The color of the button. Available colors list can be found at: Theming - Semantic UI React.

Cluster Status

Displays the status of the Cloudify Manager cluster divided into 3 cluster services: Manager, Database, Message Broker. Cluster services can have the following statuses: OK - service type cell background is green, Degraded - service type cell background is yellow, Fail - service type cell background is red. Each cluster node is presented with: Node Name, Status - on hovering status icon you can see popup with details, you can copy raw info about node status to clipboard to get even more details, Private IP, Public IP / Load Balancer IP - in case of Manager node, you can click on the IP to go to Cloudify Management Console of that specific node, Version.

Composer link

Opens the Cloudify Composer, which allows creating blueprints with a graphical drag-and-drop tool. The Cloudify Composer comes as part of the Cloudify Premium Manager, and is only available for users with certain roles. Settings None

Create deployment button

Allows creating a deployment of a chosen blueprint. After choosing a name for the deployment, the desired blueprint and the visibility of the deployment (private/tenant), a screen will open, allowing to specify values for the inputs required by the chosen blueprint. Settings None

Deployment action buttons

Buttons which allow running workflows of the deployment currently set in the context, updating it or deleting it. See notes for more information on resource context. Settings None

Deployment Info

Displays the following information about a specific deployment: Name Description Visibility level Blueprint name Site name Creation time Last update time Creator username Settings Refresh time interval - Time interval in which widget’s data will be refreshed, in seconds. Default: 10 seconds Show blueprint name - Defines whether deployment’s blueprint name should be displayed. Default: On Show site name - Defines whether deployment’s site name should be displayed.

Deployment Inputs

Presents the names and values of the inputs of the deployment currently set in the context. See notes for more information on resource context. If only a blueprint is set in the context, the widget will present the default values for the inputs, defined in the blueprint itself. Settings Refresh time interval - The time interval in which the widget’s data will be refreshed, in seconds. Default: 30 seconds

Deployment Outputs/Capabilities

Presents the names and values of the outputs and capabilities of the deployment currently set in the context. See notes for more information on resource context. If only a blueprint is set in the context, the widget will present the default values for the outputs, defined in the blueprint itself. Settings Refresh time interval - The time interval in which the widget’s data will be refreshed, in seconds. Default: 10 seconds Show capabilities - Specify if deployment capabilities should be visible in table.

Deployment wizard buttons

Allows installing a deployment of a Hello World example or chosen blueprint. After clicking on one of the buttons user is guided step by step through the process from selecting blueprint, through providing necessary data - plugins, secrets and inputs, to running install workflow. Steps Details about the steps in wizard are described below. Infrastructure step (only in Hello World Wizard) In the first step, the Hello World blueprint is already selected from the blueprint examples.

Deployments View

Presents information about deployments in a single view. Contains: a table showing the deployments in the system (the left side) The deployments can be further filtered. See Filtering deployments. a pane with the deployment details divided into tabs (the right side) a map showing the deployments locations (on the top, opened using the Map button or automatically, if the widget configuration is changed) Table The table shows deployments that match the current filter.

Deployments View (drilled-down)

The Deployments View (drilled-down) widget is a drilled-down version of the regular Deployments View widget. It should be used only inside pages that were drilled-down to when using the Deployments View widget. Using this widget on other pages will result in errors being shown. Please refer to the regular Deployments View widget documentation for more information.

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 choose to indicate in colors success and failure messages. You can sort events/logs by Timestamp (default), Blueprint, Deployment, Node Id, Node Instance Id, Workflow, Operation and Type. Sometimes error logs may contain additional information about error cause or the event/log message is truncated (see Maximum message length before truncation setting below).

Events and Logs Filter

Displays a filter pane for events and logs. The following filtering options are available: Type - Logs/Events Event Types - predefined event types: Policy end successfully started, Policy failed, Processing trigger, Task ended successfully, Task failed, Task received, Task rescheduled, Task retried, Task sent, Task started, Trigger failed, Trigger succeeded, Workflow cancelled, Workflow ended successfully, Workflow event, Workflow failed, Workflow initializing node, Workflow initializing policies, Workflow node event, Workflow received, Workflow staged, Workflow started.

Executions

Displays data about the executions in the current tenant, according to the user’s permissions. Features Executions list By default, the presented details include the blueprint and deployment of the execution, name of the workflow, the time that it was created and ended, execution creator, execution attributes, its status and actions menu. Attributes In Attributes column you can see one of these icons: - Dry-run execution - System-wide execution Actions In the actions menu on the right side of the execution row (click to open) you can perform additional actions on the execution:

Executions Statuses Graph

Displays the number of executions per status as a bar chart graph. Settings Refresh time interval - The time interval in which the widget’s data will be refreshed, in seconds. Default: 5 seconds.

Filters

Displays the list of defined filters. The table has 5 columns: Filter name - filter ID Creator - filter creator Created - filter creation date and time System - system filter indicator - checked when given filter is a system filter, unchecked otherwise Actions column The actions column contains the following action icons: Clone filter opens the filter clone modal allowing to create a modified copy of the selected filter (see defining filter rules for details on rule definition) Edit filter available only to user filters, opens the filter rules edit modal (see defining filter rules for details on rule definition) Delete filter available only to non-system filters, removes the selected filter (see note below) Filters used as a default filter in the Deployments View widget cannot be deleted.

Labels

Displays the list of labels defined for the deployment which is currently in the context (see notes for more information on resource context). The table has 3 columns: Key - label key Value - label value Actions column, containing value edit and label delete action icons, available only to users with deployment_create permission By clicking buttons above the table you can execute the following operations: Add - opens the labels add modal, available only to users with deployment_create permission Export - export the table content into a JSON file You can learn more about labels here.

Maintenance Mode button

This Button allows to activate Maintenance Mode. Maintenance Mode can only be activated by admin users. You can activate Maintenance Mode by clicking Activate Maintenance Mode button. To enter Maintenance Mode, click Yes in the Are you sure you want to enter maintenance mode? dialog. In order for Maintenance Mode to be activated, all running workflows must be stopped. During the Maintenance Mode activation process, the Cloudify Manager waits for all running executions to finish.

Nodes List

Displays a list of the existing nodes in the current tenant, according to the user’s permissions. The node’s blueprint and deployment, type, connected nodes, number of instances, and nodes 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 widget, additional data about the node’s instances is displayed: instances names, statuses, relationships and runtime properties.

Nodes Statistics

Displays the number of node instances, according to their status. Settings Refresh time interval - The time interval in which the widget’s data will be refreshed, in seconds. Default: 10 seconds

Number of blueprints

Displays the total number of blueprints in the tenant, according to the user’s permissions and the blueprints’ visibility levels. The widget is clickable, and upon clicking will redirect by default to the Blueprints page. You can set the widget’s configuration to lead to a different page. Settings Refresh time interval - The time interval in which the widget’s data will be refreshed, in seconds. Default: 10 seconds. Page to open on click - The name of the page to be redirected to upon clicking on the widget.

Number of clouds

Displays the cloud icon. Settings None

Number of compute nodes

Displays the total number of compute nodes created on the tenant, according to the user’s permissions. Settings Refresh time interval - The time interval in which the widget’s data will be refreshed, in seconds. Default: 30 seconds.

Number of deployments

Displays the total number of deployments in the tenant, according to the user’s permissions and the blueprints’ visibility levels. The widget is clickable, and upon clicking will redirect by default to the Services page. You can set the widget’s configuration to lead to a different page. If the page contains Deployments View widget, then deployments will be filtered according to the filter selected in widget’s configuration. The label and image displayed along with deployments count are configurable.

Number of nodes

Displays the total number of nodes created on the tenant, according to the user’s permissions. Settings Refresh time interval - The time interval in which the widget’s data will be refreshed, in seconds. Default: 30 seconds.

Number of plugins

Displays the total number of plugins in the tenant, according to the user’s permissions and the blueprints’ visibility levels. The widget is clickable, and upon clicking will redirect by default to the Plugins page. You can set the widget’s configuration to lead to a different page. Settings Refresh time interval - The time interval in which the widget’s data will be refreshed, in seconds. Default: 30 seconds. Page to open on click - The name of the page to be redirected to upon clicking on the widget.

Number of running executions

Displays the total number of executions which are currently running, i.e, in one of the following statuses: ‘pending’, ‘started’, ‘cancelling’, ‘force_cancelling’, ‘kill_cancelling’ according to the user’s permissions. Settings Refresh time interval - The time interval in which the widget’s data will be refreshed, in seconds. Default: 10 seconds.

Only my resources

Shows a toggle allowing to filter only resources created by the logged in user. The supported resources are blueprints, deployments, plugins and snapshots. Settings None

Plugin upload button

Opens the plugin upload screen, from which permitted users can specify the plugin’s wagon and yaml file (URL or local files) and visibility level of the plugins they wish to upload to the current tenant. Settings None

Plugins Catalog

A widget listing all the latest releases of the certified plugins, allowing plugin upload to the current tenant. You can upload selected plugins or upload all plugins at once by clicking the Upload all plugins button. Settings Plugins Catalog JSON Source - The json file from which the widget reads the plugins list. Sort by name - if set to true, then plugins will be sorted by name. Default: No

Plugins List

Displays a list of all the plugins uploaded to the current tenant, according to the user’s permissions, and enables their management. From this widget you can upload, delete, and download the plugins. Features Plugins details The widget displays the following information: Plugin icon Plugin name Plugin Package name Plugin Package version Supported platform Distribution the plugin is supported on Distribution release Uploaded at Creator Upon hovering over ID label a pop up with the plugin’s ID will open, allowing you to copy it to the clipboard.

Resource Filter

This widget provides the ability to filter the data presented in other widgets on the page according to a specific resource. By default, the widget allows filtering by blueprint, deployment and execution, and you can also add fields to filter by node, node instance and more, by configuring the widget’s settings. It is discouraged to place the Resource Filter widget alongside the Deployments View widget on the same page. The Resource Filter widget does not influence the filtering performed in the Deployments View widget.

Secrets Store Management

Displays all the secrets visible to the logged-in user in the current tenant (including global secrets). The widget provides the following information: Secret key Secret visibility level represented by the icon next to the key. Permitted users (the secret’s creator, sys admins or tenant managers of the current tenant) can set the secret’s visibility by clicking on this icon. Secret value If the secret’s value is not hidden from the logged-in user, clicking on the “eye” icon will present its value, like in the following example, in which the logged-in user is a sys admin: If the secret’s value is hidden and the logged-in user isn’t the secret’s creator or has admin/manager permissions in the tenant, then the same clicking will result in a red “restricted” sign, as seen here:

Service button

Displays a button allowing to upload a blueprint from the configured blueprint marketplace. For more details about blueprint marketplace, check Blueprint Catalog widget. Settings Color - The color of the button. Available colors list can be found at: Theming - Semantic UI React. Default: “ Label - The label displayed in the button. Default: ‘Create a service’ Icon - Name of the icon displayed in the button. Available icons list can be found at: Icon - Semantic UI React.

Sites

Displays the list of sites and enables their management. Features Site basic information The widget provides the following information: Name Visibility level - Represented by the icon next to the name. Permitted users (the sites’s creator, sys admins or tenant managers of the current tenant) can set the site’s visibility by clicking on this icon. Location - The location of the site, represented by latitude and longitude. On hovering aim icon you can see popup with map and marked location.

Sites Map

Displays the world map with defined sites marked. Only sites with defined location are displayed on the map. This widget is available with Premium or Spire license. Site markers The color of the site marker on the map indicates the site’s health. It is derived from the status of the deployments attached to the site. After clicking the site marker on the map, the user is presented with a popup with the status breakdown of the deployments assigned with the site.

Snapshots List

Displays a list of snapshots of the Manager - both snapshots that were created on this manager, and snapshots uploaded to it. This widget is only available to users with the ‘admin’ role. Snapshots are always created with “private” visibility, which cannot be set to a different visibility level. Features Snapshot basic information The widget exposes the following information on each snapshot: Id - the name given to the snapshot upon creation Visibility - always “private” for snapshots Creation time Status - one of: created/creating/failed/uploading/uploaded Creator Snapshot actions In the right column of every snapshot, the widget exposes the following action buttons:

Spire Manager

Displays the list of the deployments created using Cloudify Spire plugin in the current tenant, according to the user’s permissions. The data is displayed in a table. The Cloudify Spire widget can only be used on a Cloudify Manager with the Cloudify Spire license. Features Presented data You can see IP addresses, names and status of the cluster created by Spire deployment. Detailed status about specific cluster is presented after hovering the status icon:

Tenant Management

Displays a list of tenants on the Manager and enables tenant management. This widget is only available to admin users. Features Tenants information The widget displays the following information regarding each of the tenants: Name Number of user-groups assigned to the tenant Number of users directly assigned to the tenant (not as part of groups) Tenants actions The hamburger menu on the right of every tenant allows performing the following operations:

Text

Displays text provided in the configuration of the widget in markdown syntax. Settings Header - the header to be presented as the textbox’s title Content - the text to be presented in the textbox itself, in Markdown syntax. Header text color - Can be picked out of the suggested colors Header text size (px) - Size of the header Header text font - Font of the header Content text color - Can be picked out of the suggested colors Content text size (px) - Size of the header Content text font - Font of the header

Topology

Displays the topology of the blueprint or the deployment currently set in the context. See notes for more information on resource context. Features Presentation Each of the blueprint’s nodes is displayed as a square container that can contain other nodes. Each node has a name, and an icon (upper right corner) to indicate its node type. Relationships between nodes are indicated with arrows that start at the connected node and end at the target node.

User Group Management

Displays the list of user groups and enables their management. This widget is only available to admin users. Features User Groups information The widget displays the following information regarding each of the user groups: Name LDAP group When working with an LDAP-based external authentication system, this field identifies the LDAP user group which is connected to the current Cloudify user-group. This column will not be visible if LDAP is disabled in Cloudify.

User Management

Displays the list of users and enables their management. This widget is only available to admin users. Features Users information The widget displays the following information regarding each of the user groups: Username Last login timestamp Admin - whether or not the user is sys admin on the Cloudify Manager (you can check and uncheck this filed to make changes) Active - whether or not the user is active (you can check and uncheck this field to make changes) # Groups - number of groups the user is a member of # Tenants - number of tenants the user is assigned with Users actions The hamburger menu on the right of every tenant allows performing the following operations: