Added docs for observe and update workflows
Signed-off-by: Amit Kumar Das <amitkumar.das@mayadata.io>
This commit is contained in:
parent
e318c208e6
commit
31d1a29bfa
Binary file not shown.
|
After Width: | Height: | Size: 91 KiB |
|
|
@ -3,3 +3,40 @@ id: observe
|
|||
title: How to Observe/Track a Workflow
|
||||
sidebar_label: Observe
|
||||
---
|
||||
|
||||
## Observe a Workflow
|
||||
|
||||
---
|
||||
|
||||
After scheduling a workflow, the user can track the status of the workflow from the Browse Workflow section. The status that are currently displayed are :
|
||||
- Failed
|
||||
- Running
|
||||
- Succeeded
|
||||
|
||||
### 1. Workflow Analysis
|
||||
|
||||
The user can analyze a workflow using two methods:
|
||||
|
||||
#### a. Visualize the workflow graph
|
||||
After scheduling a workflow, the user can click on the **Show the workflow** option to see the real-time graph of the workflow.
|
||||
<figure>
|
||||
<img src={require('./assets/experiment-graph.png').default} width="800" />
|
||||
<i>Fig 1 : Graph of Kube Proxy Chaos workflow with chaos logs and chaos result of node-cpu-hog experiment.</i>
|
||||
</figure>
|
||||
|
||||
The graph consists of useful information such as :
|
||||
- Phase of individual nodes.
|
||||
- Total time taken for the nodes to execute.
|
||||
- Structure of the experiments (Serial or Parallel experiments).
|
||||
- **Logs of individual nodes**: The user can click on the nodes to get the logs of that particular step. If the revert-chaos step is disabled, the complete logs are available which include the runner pod logs and the chaos logs.
|
||||
- **Chaos Results** : Once the experiment completes, the Chaos Results are also available alongside the logs. The Chaos results are directly fetched from the ChaosResult CRD.
|
||||
|
||||
#### b. Analytics from the workflow table
|
||||
|
||||
Once the workflow execution completes, the user can click the **Show the analytics** option which opens up a time series graph of the workflow. This graph can be crucial to analyse the Cron Workflows. Each bar in the graph represents one run of the workflow.
|
||||
On hovering over the bar, the user can view the following information related to the workflow run:
|
||||
- Resilience Score
|
||||
- Passed Tests
|
||||
- Failed Tests
|
||||
|
||||
On clicking the bar, a table is shown below the graph which displays all the experiments present in the workflow run and their individual result points. These result points are then used to calculate the **Resilience Score** of the workflow which is displayed at the end of the table.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
id: update
|
||||
title: How to Update a Workflow
|
||||
sidebar_label: Update
|
||||
---
|
||||
|
||||
## Update a Workflow
|
||||
|
||||
---
|
||||
|
||||
After scheduling a workflow, the user can update the scheduled configuration of the workflow by clicking on Schedules tab.
|
||||
Here the user can view several options like:
|
||||
- Re-Run schedule
|
||||
- Edit Schedule
|
||||
- Delete Schedule
|
||||
- Download Manifest
|
||||
|
||||
### 1. Re-Run Schedule
|
||||
This option allows the user to re-run a workflow with the same configuration as earlier. This option is only available when the workflow is scheduled once.
|
||||
|
||||
### 2. Edit Schedule
|
||||
This option allows the user to edit the schedule configuration of the workflow. The user can either disable the workflow or change the Cron Syntax by changing the schedule timings.
|
||||
The disable workflow option adds a label **suspend: true** that disables any scheduled workflow.
|
||||
This option is only available if the workflow is a Cron Worklfow i.e a recurring workflow.
|
||||
|
||||
### 3. Delete Schedule
|
||||
This option allows the user to delete a scheduled workflow. This is an irreversible proccess and once the delete option is selected, all the workflow configuration and the schedules are deleted from the portal.
|
||||
|
||||
### 4. Download Manifest
|
||||
This option allows the user to download the manifest of the workflow. The manifest consists of all the configurations that the user has added while workflow creation. The user can then alter changes in this manifest and upload it with the portal to schedule a new workflow.
|
||||
|
|
@ -11,7 +11,7 @@ module.exports = {
|
|||
Installation: ["litmus-install", "agent-install"],
|
||||
},
|
||||
{
|
||||
"How To": ["create", "schedule", "observe"],
|
||||
"How To": ["create", "schedule", "observe", "update"],
|
||||
},
|
||||
"uninstall",
|
||||
],
|
||||
|
|
|
|||
Loading…
Reference in New Issue