Skip to content

Commit

Permalink
add binary pdoc page
Browse files Browse the repository at this point in the history
Signed-off-by: Sylvain Hellegouarch <sh@defuze.org>
  • Loading branch information
Lawouach committed Apr 29, 2024
1 parent 0da915d commit 832f63c
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ nav:
- Common: drivers/addons.md
- Deployment:
- Local:
- Binary: deployment/local/binary.md
- Docker: deployment/local/docker.md
- AWS:
- ECS Task: deployment/aws/task.md
Expand Down
23 changes: 23 additions & 0 deletions sources/deployment/local/binary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Run Chaos Toolkit as binary

Chaos Toolkit is a Python package and therefore adopts a deployment suitable
for Python environments.

However, the Chaos Toolkit project also provides read-y-to-do binaries that
can be downloaded and executed as-is on supported environments such as
Linux, MacOSX or Windows.

You can find these binaries on the [bundler][bundler] project.

[bundler]: https://github.com/chaostoolkit/chaostoolkit-bundler/releases/latest

Simply download the appropriate file for your architecture, rename it to `chaos`
make it executable and run as-is.

It contains a set of common extensions.

!!! warning

The binary cannot see extensions that you have already on your machine. It
only knows about the ones bundled within. Therefore the binary may be
of limited use depending on your use case.

0 comments on commit 832f63c

Please sign in to comment.