ironswarm 0.0.2

██╗██████╗  ██████╗ ███╗   ██╗    ███████╗██╗    ██╗ █████╗ ██████╗ ███╗   ███╗
██║██╔══██╗██╔═══██╗████╗  ██║    ██╔════╝██║    ██║██╔══██╗██╔══██╗████╗ ████║
██║██████╔╝██║   ██║██╔██╗ ██║    ███████╗██║ █╗ ██║███████║██████╔╝██╔████╔██║
██║██╔══██╗██║   ██║██║╚██╗██║    ╚════██║██║███╗██║██╔══██║██╔══██╗██║╚██╔╝██║
██║██║  ██║╚██████╔╝██║ ╚████║    ███████║╚███╔███╔╝██║  ██║██║  ██║██║ ╚═╝ ██║
╚═╝╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═══╝    ╚══════╝ ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝     ╚═╝

Table of Contents

• Installation
• Usage
• Docker
• Development
• License

Installation

pip install ironswarm

Usage

usage: ironswarm [-h] [-b BOOTSTRAP] [-H HOST] [-p PORT] [-j JOB] [-v | --verbose | --no-verbose] [--log-file LOG_FILE]

options:
  -h, --help            show this help message and exit
  -b, --bootstrap BOOTSTRAP
                        bootstrap node(s) to initially connect to
  -H, --host HOST       network interface to bind to local/public or IP address (default: public)
  -p, --port PORT       port to bind to (default: 42042)
  -j, --job JOB         job to run (default: None)
  -v, --verbose, --no-verbose
                        enable verbose logging
  --log-file LOG_FILE   Optional path to write logs to a file.

Run a single node with no bootstrap

ironswarm -H local

Run multiple nodes in a tmux session

./example/multi.sh

Run a single node bootstrapping to another node

ironswarm -H local -b tcp://127.0.0.1:42042

Docker

Pull the latest image:

docker pull ghcr.io/ryan-h265/ironswarm:latest

Run the latest image:

docker run -it ghcr.io/ryan-h265/ironswarm:latest ironswarm -H local

Running with Custom Scenario Files

To run the container with your own scenario files, copy them into the running container:

1. Start the container with a name:

docker run -d --name ironswarm-node ghcr.io/ryan-h265/ironswarm:latest tail -f /dev/null

2. Copy your scenario file into the container:

docker cp examples/http_scenario.py ironswarm-node:/usr/src/app/http_scenario.py

3. Execute ironswarm with your scenario:

docker exec -it ironswarm-node ironswarm -j http_scenario:scenario -H local

4. Clean up when done:

docker stop ironswarm-node
docker rm ironswarm-node

Development

Useful hatch commands

hatch run types:check
hatch test --cover

License

This project is licensed under the MIT License. See the LICENSE file for details.