Skip to content

Commit 832f63c

Browse files
committed
add binary pdoc page
Signed-off-by: Sylvain Hellegouarch <[email protected]>
1 parent 0da915d commit 832f63c

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ nav:
148148
- Common: drivers/addons.md
149149
- Deployment:
150150
- Local:
151+
- Binary: deployment/local/binary.md
151152
- Docker: deployment/local/docker.md
152153
- AWS:
153154
- ECS Task: deployment/aws/task.md

sources/deployment/local/binary.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Run Chaos Toolkit as binary
2+
3+
Chaos Toolkit is a Python package and therefore adopts a deployment suitable
4+
for Python environments.
5+
6+
However, the Chaos Toolkit project also provides read-y-to-do binaries that
7+
can be downloaded and executed as-is on supported environments such as
8+
Linux, MacOSX or Windows.
9+
10+
You can find these binaries on the [bundler][bundler] project.
11+
12+
[bundler]: https://github.com/chaostoolkit/chaostoolkit-bundler/releases/latest
13+
14+
Simply download the appropriate file for your architecture, rename it to `chaos`
15+
make it executable and run as-is.
16+
17+
It contains a set of common extensions.
18+
19+
!!! warning
20+
21+
The binary cannot see extensions that you have already on your machine. It
22+
only knows about the ones bundled within. Therefore the binary may be
23+
of limited use depending on your use case.

0 commit comments

Comments
 (0)