mirror of
https://github.com/krkn-chaos/krkn.git
synced 2026-04-15 06:57:28 +00:00
d0d289fb7c
Updated references from chaos-kubox to redhat-chaos. Signed-off-by: Sandro Bonazzola <sbonazzo@redhat.com>
56 lines
2.1 KiB
Markdown
56 lines
2.1 KiB
Markdown
## Getting Started Running Chaos Scenarios
|
|
|
|
#### Adding New Scenarios
|
|
Adding a new scenario is as simple as adding a new config file under [scenarios directory](https://github.com/redhat-chaos/krkn/tree/main/scenarios) and defining it in the main kraken [config](https://github.com/redhat-chaos/krkn/blob/main/config/config.yaml#L8).
|
|
You can either copy an existing yaml file and make it your own, or fill in one of the templates below to suit your needs.
|
|
|
|
### Templates
|
|
#### Pod Scenario Yaml Template
|
|
For example, for adding a pod level scenario for a new application, refer to the sample scenario below to know what fields are necessary and what to add in each location:
|
|
```
|
|
# yaml-language-server: $schema=../plugin.schema.json
|
|
- id: kill-pods
|
|
config:
|
|
namespace_pattern: ^<namespace>$
|
|
label_selector: <pod label>
|
|
kill: <number of pods to kill>
|
|
- id: wait-for-pods
|
|
config:
|
|
namespace_pattern: ^<namespace>$
|
|
label_selector: <pod label>
|
|
count: <expected number of pods that match namespace and label>
|
|
```
|
|
|
|
#### Node Scenario Yaml Template
|
|
|
|
```
|
|
node_scenarios:
|
|
- actions: # Node chaos scenarios to be injected.
|
|
- <chaos scenario>
|
|
- <chaos scenario>
|
|
node_name: <node name> # Can be left blank.
|
|
label_selector: <node label>
|
|
instance_kill_count: <number of nodes on which to perform action>
|
|
timeout: <duration to wait for completion>
|
|
cloud_type: <cloud provider>
|
|
```
|
|
|
|
|
|
#### Time Chaos Scenario Template
|
|
```
|
|
time_scenarios:
|
|
- action: 'skew_time' or 'skew_date'
|
|
object_type: 'pod' or 'node'
|
|
label_selector: <label of pod or node>
|
|
```
|
|
|
|
|
|
### Common Scenario Edits
|
|
If you just want to make small changes to pre-existing scenarios, feel free to edit the scenario file itself.
|
|
|
|
#### Example of Quick Pod Scenario Edit:
|
|
If you want to kill 2 pods instead of 1 in any of the pre-existing scenarios, you can either edit the number located at filters -> randomSample -> size or the runs under the config -> runStrategy section.
|
|
|
|
#### Example of Quick Nodes Scenario Edit:
|
|
If your cluster is build on GCP instead of AWS, just change the cloud type in the node_scenarios_example.yml file.
|