Skip to main content
Made with pop, a Python implementation of Plugin Oriented Programming Made with Python

Soluble is a tool for setting up, managing, and tearing down ephemeral Salt minions on remote systems u sing a streamlined Python-based approach. It simplifies the deployment of temporary nodes that can execute Salt commands and clean up afterward, making it ideal for transient infrastructure needs.

About

Soluble is designed aims to streamline the deployment of ephemeral nodes with Salt leveraging 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.

What is POP?

This project is built with pop, a Python-based implementation of Plugin Oriented Programming (POP). POP seeks to bring together concepts and wisdom from the history of computing in new ways to solve modern computing problems.

For more information:

Getting Started

Prerequisites

  • Python 3.10+

  • git (if installing from source, or contributing to the project)

  • SaltStack installed on the master node

  • salt-ssh and salt-key commands available

Installation

If wanting to use soluble, you can do so by either installing from PyPI or from source.

Install from PyPI

If package is available via PyPI, include the directions.

pip install soluble

Install from source

# 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 -R /path/to/roster 'test.ping'

In this example: - The -R flag specifies the path to the roster file for salt-ssh. - The first positional argument (test.ping) is the Salt command to be executed on the ephemeral minions.

Examples

Here are a few more examples of how you can use Soluble:

# 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

Metadata

Release files for soluble 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for soluble 0.4.0
File Size Uploaded
soluble-0.4.0.tar.gz 13.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for soluble 0.4.0
File Interpreter ABI Platform
soluble-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 25.6 kB

Release files / soluble-0.4.0.tar.gz

Download URL soluble-0.4.0.tar.gz
Size 13.2 kB
Tags Source
SHA-256 checksum
How to use checksums
cdb388a04ba4158d060ab118f0b96a92513952ae4c61d8f1651556b181e43a86
BLAKE2b-256 checksum
How to use checksums
9c77ad8f21d617a48b8467f7a0c6e101c29286c781b97bd9361f590fd64c7b08
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.0rc1

Release files / soluble-0.4.0-py3-none-any.whl

Download URL soluble-0.4.0-py3-none-any.whl
Size 12.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d2bc08d3dc753927b7b527addcec1c1386b15b0a104b3c44579681958d890e9c
BLAKE2b-256 checksum
How to use checksums
b0633d19f8616b399a98b4200c025908d190698463c56c74c1a10a604b29f76c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.0rc1

Release history Release notifications | RSS feed

3.0.0

2 release files

2.0.0

2 release files

1.0.0

2 release files

This release

0.4.0 This release

2 release files

0.2.0

1 release file

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page