Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated readmesConfig.json to get latest version of documentation
Updated widgets' README.md files
- Loading branch information
Showing
42 changed files
with
122 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| ### 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](https://docs.cloudify.co/staging/dev/install_maintain/agents/installation)) | ||
|
|
||
|  | ||
|
|
||
| By clicking buttons above the table you can execute the following operations: | ||
|
|
||
| * `Install` - executes `install_new_agents` workflow on selected deployment. Allows to define Manager IP, Manager Certificate, stop old agents and filter by node(s), node instance(s) and install method(s). | ||
| * `Validate` - executes `validate_agents` workflow on selected deployment. Allows to filter by node(s), node instance(s) and install method(s). | ||
|
|
||
| You can find more about agents [here](https://docs.cloudify.co/staging/dev/install_maintain/agents/index.html). | ||
|
|
||
|
|
||
| #### Widget Settings | ||
|
|
||
| * `Refresh time interval` - The time interval in which the widget’s data will be refreshed, in seconds. Default: 15 seconds | ||
| * `List of fields to show in the table` - List of columns to be shown in list of agents table. Some of the fields may be hidden depending on the context, eg. when Deployment ID is set in context then Deployment field will be hidden. | ||
| * `Filter Agents by Install Method` - Install Methods to filter Agents. Unset all options to disable this type of filtering. Default: No filtering by Install Methods. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| ### 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. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| #### Widget Settings | ||
| * `Content pane initial width in %` - sets the default size of the source part of the window in percent of screen width. Default: 65%. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| ### Composer link | ||
| Opens the Cloudify Composer, which allows creating blueprints with a graphical drag-and-drop tool. The Composer comes as part of the Cloudify Premium edition, and is only available for users with certain roles. | ||
|
|
||
| For more information regarding the Composer, see [Cloudify Composer](https://docs.cloudify.co/4.5.0/developer/composer/index.html). | ||
| For more information regarding the Composer, see [Cloudify Composer](https://docs.cloudify.co/staging/dev/developer/composer/index.html). | ||
|
|
||
|  | ||
|  | ||
|
|
||
| #### Widget Settings | ||
| None |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,11 @@ | ||
| ### 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. In the case of a list view, the status of each deployment is also displayed. For information about deployment status, [click here](https://docs.cloudify.co/4.5.0/working_with/console/deployments-page) | ||
| 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. In the case of a list view, the status of each deployment is also displayed. For information about deployment status, [click here](https://docs.cloudify.co/staging/dev/working_with/console/deployments-page) | ||
|
|
||
|  | ||
|  | ||
|
|
||
| #### Widget Settings | ||
| * `Refresh time interval` - The time interval in which the widget’s data will be refreshed, in seconds. Default: 10 seconds | ||
| * `Enable click to drill down` - This option enables redirecting to the deployment’s drill down page upon clicking on a specific deployments. Default: True | ||
| * `Blueprint ID to filter by` - TAllows filtering the deployments in this list to those derived from a specific blueprint, by providing its ID (the blueprint ID is its name). Default: empty | ||
| * `Enable click to drill down` - This option enables redirecting to the deployment’s drill down page upon clicking on a specific deployments. Default: On | ||
| * `Show execution status label` - Allows showing last execution workflow ID and status near last execution status icon. Default: Off | ||
| * `Blueprint ID to filter by` - Allows filtering the deployments in this list to those derived from a specific blueprint, by providing its ID (the blueprint ID is its name). Default: empty | ||
| * `Display style` - Can be either list or table. The deployments status column is only available in list mode. Default: List |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,24 @@ | ||
| ### 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. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| #### Widget Settings | ||
| * `Refresh time interval` - The time interval in which the widget’s data will be refreshed, in seconds. Default: 2 seconds | ||
| * `List of fields to show in the table` You can choose which fields to present. By default, these are the fields presented: | ||
| * `List of fields to show in the table` - You can choose which fields to present. By default, these are the fields presented: | ||
|
|
||
| * Icon | ||
| * Timestamp | ||
| * Blueprint | ||
| * Deployment | ||
| * Node Id | ||
| * Node Instance Id | ||
| * Workflow | ||
| * Operation | ||
| * Node Name | ||
| * Node Id | ||
| * Message | ||
|
|
||
| You can also choose to add the field “Type”, which will present the log level in case of a log, and event type in case of an event. | ||
|
|
||
| * `Color message based on type` - when marked as “on”, successful events will be coloured in blue, and failures in red. Default: On | ||
| * `Maximum message length before truncation`- Allow to define the length of the messages presented in the table. Default: 200. Please note that even if the message is being truncated in the table itself, you can see the full message upon overing. | ||
|
|
||
| * `Maximum message length before truncation` - Allow to define the length of the messages presented in the table. Default: 200. Please note that even if the message is being truncated in the table itself, you can see the full message upon overing. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,15 @@ | ||
| ### Events and Logs Filter | ||
| Displays a filter pane for events and logs. The following filtering options are available: | ||
|
|
||
| * **Type:** Logs/Events | ||
| * **Blueprint** (multiple selection available) | ||
| * **Deployment** (multiple selection available) | ||
| * **Event Type** In case of “Type” was selected as event (Workflow started, Task sent, Task started, Task ended successfully,Workflow ended successfully, Workflow staged, Workflow node event, Task failed, Workflow failed, Task rescheduled) | ||
| * **Log Levels** In case “Type” was selected as log (Debug, Info, Warning. Error, Critical) | ||
| * **Message text** | ||
| * **Time Filter** | ||
| * **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. | ||
| You can also specify your log level by typing in text. Multiselection available. | ||
| * **Log Levels** - predefined log levels: Debug, Info, Warning. Error, Critical. | ||
| You can also specify your log level by typing in text. Multiselection available. | ||
| * **Message Text** - part of log/event message | ||
| * **Time Range** - time range to get log/events | ||
|
|
||
|  | ||
|  | ||
|
|
||
| #### Widget Settings | ||
| * `Refresh time interval` - The time interval in which the widget’s data will be refreshed, in seconds. Default: 10 seconds | ||
| None |
Oops, something went wrong.