Skip to content

Commit 2408ba4

Browse files
Improving litmus-docs by some characteristics and experiment creation
1 parent 5db556a commit 2408ba4

File tree

2 files changed

+1362
-1181
lines changed

2 files changed

+1362
-1181
lines changed

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

+29-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,13 @@ sidebar_label: Create a Resilience Probe
66

77
## Before you begin
88

9-
You can learn about the concept of resilience probes [here](../concepts/probes.md) and chaos experiments [here](../concepts/chaos-workflow.md). For this user guide, we will use a HTTP probe.
9+
You can learn about the concept of resilience probes [here](../concepts/probes.md) and chaos experiments [here](../concepts/chaos-workflow.md).
10+
11+
Here are some characterstics of resilience probes.
12+
- **Unique Identifier**: Each Resilience Probe is identified by a unique name, serving as its identifier.Probe names cannot be reused.
13+
- **Deletion Behavior**: Deleting a Resilience Probe will disable it from further use but does not delete it from the system. This ensures that the probe's history and configuration remain intact for reference and analysis.
14+
15+
For this user guide, we will use a HTTP probe.
1016

1117
## 1. Go to the Resilience Probes section
1218

@@ -41,3 +47,25 @@ Configure the details for the probe you are creating, once completed, click the
4147
The new probe will appear in the list as shown:
4248

4349
<img src={require('../assets/user-guides/resilience-probes/create-probe/step-6.png').default} />
50+
51+
### Experiment Creation
52+
53+
When creating an experiment, it's imperative to include the Resilience Probe as part of the setup. This step is now mandatory to ensure accurate chaos injection and monitoring during the experiment. Follow these steps to add the probe to the experiment configuration:
54+
55+
1. **Identify Chaos Injection Points**: Determine the points within your system where chaos will be injected.
56+
57+
2. **Select Resilience Probe**: Choose the appropriate Resilience Probe that aligns with your experimentation goals and the type of chaos you want to inject as discussed above.
58+
59+
3. **Integrate Probe into Experiment YAML**: Add the Resilience Probe configuration to your experiment YAML file. Ensure that the probe is properly configured and referenced within the experiment setup.
60+
61+
4. **Validate Experiment Configuration**: Before initiating the experiment, validate the experiment configuration to ensure that the Resilience Probe is correctly included and configured.
62+
63+
### Annotations for Experiment Configuration
64+
65+
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:
66+
67+
1. **Identify Probe to Associate**: Determine the Resilience Probe that you want to associate with the experiment.
68+
69+
2. **Add probeRef in Annotations**: In the experiment YAML configuration, include a `probeRef` field in annotations and specify the name of the Resilience Probe. Ensure that the `probeRef` is correctly formatted and matches the name of the chosen probe.
70+
71+
3. **Validate Annotations**: Before initiating the experiment, validate the experiment YAML configuration to ensure that the `probeRef` is properly included and associated with the Resilience Probe.

0 commit comments

Comments
 (0)