Skip to content

Fix components readme link #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
glenn-operant merged 2 commits into from
Jun 12, 2024
Merged

Fix components readme link #67

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb26a92
Fixing components dir link in README
glenn-operant Jun 12, 2024
2cd5cc7
Formatting README
glenn-operant Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,13 @@ Each experiment is defined by a `experiment` file which allows you to tweak your
For a full list of experiments you can run, see the [experiments][experiments-dir-url] directory.

``` sh
secops-chaos experiment run -f experiments/host_path_volume.yaml
$ secops-chaos experiment run -f experiments/host_path_volume.yaml
```

Once you've successfully run the experiment, you can verify if it was sucessful or not:

```sh
secops-chaos experiment verify -f experiments/host_path_volume.yaml
$ secops-chaos experiment verify -f experiments/host_path_volume.yaml
```

You can also output in various formats using `-o json` or `-o yaml`
Expand All @@ -77,14 +77,11 @@ You can also output in various formats using `-o json` or `-o yaml`

Some experiments require additional applications installed to run or enhance their functionality.

These can be added by providing a YAML file, see the [components](components-dir-url) directory for examples.
These can be added by providing a YAML file, see the [components][components-dir-url] directory for examples.

```sh
secops-chaos component install -f components/secops-chaos-ai.yaml
```

```sh
secops-chaos component uninstall -f components/secops-chaos-ai.yaml
$ secops-chaos component install -f components/secops-chaos-ai.yaml
$ secops-chaos component uninstall -f components/secops-chaos-ai.yaml
```

Experiments that need a component will warn you, and allow for installation during runtime.
Expand Down