Skip to content

Commit

Permalink
Update create-resilience-probe.md
Browse files Browse the repository at this point in the history
Signed-off-by: Your Full Name <[email protected]>
  • Loading branch information
anshikavashistha authored and Your Full Name committed Feb 26, 2024
1 parent 17a229a commit 0e9fc71
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion website/docs/user-guides/create-resilience-probe.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,39 @@ When creating an experiment, it's imperative to include the Resilience Probe as

### Annotations for Experiment Configuration

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:
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.

Example YAML manifest:
``` yaml
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
name: example-chaos-engine
namespace: litmus
spec:
appinfo:
appns: 'litmus'
applabel: 'app=nginx'
chaosServiceAccount: litmus-admin
monitoring: false
jobCleanUpPolicy: retain
experiments:
- name: pod-delete
spec:
components:
env:
- name: TOTAL_CHAOS_DURATION
value: "30"
- name: CHAOS_INTERVAL
value: "10"
- name: FORCE
value: "true"
annotationCheck: 'true'
components:
- name: runner
value: "go"
```
> **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.
1. **Identify Probe to Associate**: Determine the Resilience Probe that you want to associate with the experiment.
Expand Down

0 comments on commit 0e9fc71

Please sign in to comment.