Skip to content

Commit cf81223

Browse files
Update create-resilience-probe.md
1 parent be007b8 commit cf81223

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

website/docs/user-guides/create-resilience-probe.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,39 @@ When creating an experiment, it's imperative to include the Resilience Probe as
5757

5858
### Annotations for Experiment Configuration
5959

60-
When creating experiments, it's essential to include a `probeRef` in annotations to associate Resilience Probes with the experiment. This step allows for seamless integration of probes into the chaos engineering workflow, whether constructing experiments manually or uploading YAML configurations. Follow these instructions to include `probeRef` effectively for chaos injection:
60+
When creating experiments, it's crucial to include a probeRef in annotations to link Resilience Probes with the experiment. This step enables seamless integration of probes into the chaos engineering workflow, whether creating experiments manually or uploading YAML configurations.
61+
62+
Example YAML manifest:
63+
``` yaml
64+
apiVersion: litmuschaos.io/v1alpha1
65+
kind: ChaosEngine
66+
metadata:
67+
name: example-chaos-engine
68+
namespace: litmus
69+
spec:
70+
appinfo:
71+
appns: 'litmus'
72+
applabel: 'app=nginx'
73+
chaosServiceAccount: litmus-admin
74+
monitoring: false
75+
jobCleanUpPolicy: retain
76+
experiments:
77+
- name: pod-delete
78+
spec:
79+
components:
80+
env:
81+
- name: TOTAL_CHAOS_DURATION
82+
value: "30"
83+
- name: CHAOS_INTERVAL
84+
value: "10"
85+
- name: FORCE
86+
value: "true"
87+
annotationCheck: 'true'
88+
components:
89+
- name: runner
90+
value: "go"
91+
```
92+
> **Note:** Add essential annotations, like annotationCheck: 'true', in the experiment's spec section to connect the Resilience Probe with the experiment and activate validation of the experiment configuration.Feel free to customize the YAML manifest according to your specific experiment requirements and configuration.
6193
6294
1. **Identify Probe to Associate**: Determine the Resilience Probe that you want to associate with the experiment.
6395

0 commit comments

Comments
 (0)