Skip to content

Commit 38df279

Browse files
committed
Improved create workflow tutorial and added images where necessary
Signed-off-by: Gbadebo Bello <gbahdeybohbello@gmail.com>
1 parent 8a58533 commit 38df279

File tree

7 files changed

+42
-3
lines changed

7 files changed

+42
-3
lines changed
462 KB
Loading
1.55 MB
Loading
1.1 MB
Loading
384 KB
Loading
1.32 MB
Loading

website/docs/create-workflow.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,16 @@ sidebar_label: Create Workflow
55
---
66

77
---
8+
Once you have litmus setup, and you are logged in on the litmus portal, you can then proceed to create a workflow on the portal.
89

9-
Click on the **Schedule your first workflow** button on the home page to get started. It will take you to the workflow page where you can choose or design your own workflow by doing the following steps:
10+
## Create a workflow
11+
12+
To create a workflow, click on the **Schedule your first workflow** button on the homepage. It will take you to the workflow page where you can choose or design your own workflow by going through the following steps:
13+
14+
<figure>
15+
<img src={require('./assets/create-workflow-button.png').default} width="800" />
16+
<i>Fig 1 : Click on the "Schedule Workflow" button to create a new workflow.</i>
17+
</figure>
1018

1119
### 1. Choose Target Agent
1220

@@ -29,6 +37,11 @@ In this step, you can create a workflow from different methods, these include:
2937

3038
- **Import workflow using YAML** : With this option, you can import a hand-crafted chaos workflow manifest and tune it according to the use-case.
3139

40+
<figure>
41+
<img src={require('./assets/select-workflow.png').default} width="800" />
42+
<i>Fig 2 : Choose a workflow.</i>
43+
</figure>
44+
3245
### 3. Workflow Settings
3346

3447
In this section, you can change the name of the workflow and also provide a description to the workflow. This section also consists information regarding the namespace where the workflow will be scheduled.
@@ -53,9 +66,20 @@ Some of the other features that are included with Litmus Portal 2.0 are :
5366

5467
2. **Defining the steady state for the application** : With this step, you can add probes to your experiments. Probes are some additional checks that you can provide in your experiments. To know more about probes, you can visit [here](https://docs.litmuschaos.io/docs/litmus-probe/).
5568

56-
### 5. Reliability score
69+
<figure>
70+
<img src={require('./assets/tune-workflow.png').default} width="800" />
71+
<i>Fig 3 : Tune a workflow.</i>
72+
</figure>
73+
74+
### 5. Reliability Score (Optional)
75+
76+
In this step, you can assign weights to the experiments present in the workflow. These weights will be then used for the calculation of the resilience score after the workflow completion. By default, 10 points are assigned to each experiment. This can be altered as per your use-case. After selecting weights click on the Next Button.
77+
78+
<figure>
79+
<img src={require('./assets/reliability.png').default} width="800" />
80+
<i>Fig 3 : Reliability score</i>
81+
</figure>
5782

58-
In this step, you can assign weights to the experiments present in the workflow. These weights will be then used for the calculation of the resilience score after the workflow completion. By default, 10 points are assigned to each experiment. This can be altered as per your use-case.
5983

6084
### 6. Schedule
6185

@@ -71,3 +95,9 @@ In this step, you can schedule the workflow in 2 ways:
7195
### 7. Verify and Commit
7296

7397
This is the final step in workflow creation process. In this step, you can validate all the changes related to the workflow like the workflow name, the experiment weights, workflow description, workflow manifest etc. Once you have verified all the changes, you can click the **Finish** button to start the schedule.
98+
99+
100+
<figure>
101+
<img src={require('./assets/workflow-summary.png').default} width="800" />
102+
<i>Fig 3 : Verify and commit.</i>
103+
</figure>

website/docs/glossary.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: create
3+
title: How to Create a Workflow
4+
sidebar_label: Create
5+
---
6+
7+
## Glossary
8+
9+
---

0 commit comments

Comments
 (0)