soluble 0.1.0

About

Soluble is designed to replace the discontinued Heist project by SaltStack/VMware/Broadcom, which aimed to streamline the deployment of ephemeral nodes with Salt. Soluble leverages salt-ssh for setting up and tearing down temporary Salt minions, allowing users to execute Salt commands on these minions before safely removing them. The entire process is managed by a Python script, ensuring ease of use, flexibility, and integration with existing Python-based infrastructure.

Getting Started

pip install soluble

# clone repo
git clone git@<your-project-path>/soluble.git
cd soluble

# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Usage

Soluble is designed to simplify the process of setting up ephemeral Salt minions, running commands, and then cleaning up those minions. Here’s a basic usage example:

# Example usage of soluble.py
./soluble.py -r /path/to/roster -m /path/to/minion.conf 'state.highstate' -- -c /etc/salt --verbose

In this example: - The -R flag specifies the path to the roster file for salt-ssh. - The –minion-config flag specifies the minion configuration template. If not provided, it defaults to /etc/salt/minion. - The first positional argument (state.highstate) is the Salt command to be executed on the ephemeral minions.

# Install a package on ephemeral nodes
soluble minion '*' 'pkg.install vim'

# Apply a state file
soluble '*' 'state.apply my_state'

# Ping minions
soluble minion '*' 'test.ping'

Roadmap

Reference the open issues for a list of proposed features (and known issues).

The project roadmap includes: - Expanding support for additional Salt modules and functions. - Enhancing error handling and logging for more robust operation. - Integration with other infrastructure management tools.

Acknowledgements

• Img Shields for making repository badges easy.