Skip to content

Commit 804ea3a

Browse files
author
Neelanjan Manna
authored
added chaos-operator and chaos-runner flow diagrams to chaos execution plane and centered monitoring diagrams (#129)
Signed-off-by: neelanjan00 <[email protected]>
1 parent 14c3ecf commit 804ea3a

8 files changed

+28
-4
lines changed

website/docs/architecture/chaos-execution-plane.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,18 @@ Litmus Backend Execution Infrastructure components orchestrate the execution of
3333

3434
4. **Chaos Operator:** A Kubernetes custom-controller that manages the lifecycle of certain resources or applications intending to validate their "desired state". It helps reconcile the state of the ChaosEngine by performing specific actions upon CRUD of the ChaosEngine. It also defines a secondary resource (the ChaosEngine Runner pod), which is created & managed by it to implement the reconcile functions.
3535

36+
<div style={{textAlign: 'center'}}>
37+
<img src={require("../assets/chaos-execution-plane-chaos-operator.png").default} alt="Chaos Operator" />
38+
</div>
39+
3640
5. **ChaosResult CR:** Holds the results of a chaos experiment, such as ChaosEngine reference, Experiment State, Verdict of the experiment (on completion), salient application/result attributes. It also acts as a source for metrics collection for observability.
3741

3842
6. **Chaos Runner:** Acts as a bridge between the Chaos Operator and Chaos Experiments. It is a lifecycle manager for the chaos experiments that creates Experiment Jobs for the execution of experiment business logic and monitors the experiment pods (jobs) until completion.
3943

44+
<div style={{textAlign: 'center'}}>
45+
<img src={require("../assets/chaos-execution-plane-chaos-runner.png").default} alt="Chaos Runner" />
46+
</div>
47+
4048
7. **Experiment Jobs:** Refers to the pods that execute the experiment logic. One experiment pod is created per chaos experiment in the workflow.
4149

4250
## Standard Chaos Execution Plane Flow

website/docs/architecture/chaos-observability-flow-monitoring.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ Monitoring is a key part to effectively watch and understand the state of the sy
1212

1313
## Metrics Monitoring
1414

15-
<img src={require("../assets/chaos-observability-flow-metrics.png").default} alt="Chaos Observability Flow Metrics" />
15+
<div style={{textAlign: 'center'}}>
16+
<img src={require("../assets/chaos-observability-flow-metrics.png").default} alt="Chaos Observability Flow Metrics" />
17+
</div>
1618

1719
Metrics Monitoring enables the users to monitor the chaos metrics generated during chaos injection, which is exported by the chaos exporter to be consumed as time-series information.
1820

@@ -25,7 +27,9 @@ Metrics Monitoring enables the users to monitor the chaos metrics generated duri
2527

2628
## Events Monitoring
2729

28-
<img src={require("../assets/chaos-observability-flow-events.png").default} alt="Chaos Observability Flow Events" />
30+
<div style={{textAlign: 'center'}}>
31+
<img src={require("../assets/chaos-observability-flow-events.png").default} alt="Chaos Observability Flow Events" />
32+
</div>
2933

3034
Events Monitoring enables the users to monitor the Kubernetes events that are created as part of the orchestration of chaos injection by Litmus. These events occur through different points in the lifetime of a Chaos Experiment's execution to accomplish.
3135

76.7 KB
Loading
51.2 KB
Loading

website/versioned_docs/version-2.0.0/architecture/chaos-execution-plane.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,18 @@ Litmus Backend Execution Infrastructure components orchestrate the execution of
3333

3434
4. **Chaos Operator:** A Kubernetes custom-controller that manages the lifecycle of certain resources or applications intending to validate their "desired state". It helps reconcile the state of the ChaosEngine by performing specific actions upon CRUD of the ChaosEngine. It also defines a secondary resource (the ChaosEngine Runner pod), which is created & managed by it to implement the reconcile functions.
3535

36+
<div style={{textAlign: 'center'}}>
37+
<img src={require("../assets/chaos-execution-plane-chaos-operator.png").default} alt="Chaos Operator" />
38+
</div>
39+
3640
5. **ChaosResult CR:** Holds the results of a chaos experiment, such as ChaosEngine reference, Experiment State, Verdict of the experiment (on completion), salient application/result attributes. It also acts as a source for metrics collection for observability.
3741

3842
6. **Chaos Runner:** Acts as a bridge between the Chaos Operator and Chaos Experiments. It is a lifecycle manager for the chaos experiments that creates Experiment Jobs for the execution of experiment business logic and monitors the experiment pods (jobs) until completion.
3943

44+
<div style={{textAlign: 'center'}}>
45+
<img src={require("../assets/chaos-execution-plane-chaos-runner.png").default} alt="Chaos Runner" />
46+
</div>
47+
4048
7. **Experiment Jobs:** Refers to the pods that execute the experiment logic. One experiment pod is created per chaos experiment in the workflow.
4149

4250
## Standard Chaos Execution Plane Flow

website/versioned_docs/version-2.0.0/architecture/chaos-observability-flow-monitoring.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ Monitoring is a key part to effectively watch and understand the state of the sy
1212

1313
## Metrics Monitoring
1414

15-
<img src={require("../assets/chaos-observability-flow-metrics.png").default} alt="Chaos Observability Flow Metrics" />
15+
<div style={{textAlign: 'center'}}>
16+
<img src={require("../assets/chaos-observability-flow-metrics.png").default} alt="Chaos Observability Flow Metrics" />
17+
</div>
1618

1719
Metrics Monitoring enables the users to monitor the chaos metrics generated during chaos injection, which is exported by the chaos exporter to be consumed as time-series information.
1820

@@ -25,7 +27,9 @@ Metrics Monitoring enables the users to monitor the chaos metrics generated duri
2527

2628
## Events Monitoring
2729

28-
<img src={require("../assets/chaos-observability-flow-events.png").default} alt="Chaos Observability Flow Events" />
30+
<div style={{textAlign: 'center'}}>
31+
<img src={require("../assets/chaos-observability-flow-events.png").default} alt="Chaos Observability Flow Events" />
32+
</div>
2933

3034
Events Monitoring enables the users to monitor the Kubernetes events that are created as part of the orchestration of chaos injection by Litmus. These events occur through different points in the lifetime of a Chaos Experiment's execution to accomplish.
3135

76.7 KB
Loading
51.2 KB
Loading

0 commit comments

Comments
 (0)