Salt Describe

Salt Describe is a Salt Extension used to automate the generation of infrastructure as code files using Salt to query target machines.

Quickstart

To get started with your new project:

# Create a new venv
python3 -m venv env --prompt salt-describe
source env/bin/activate

# On mac, you may need to upgrade pip
python -m pip install --upgrade pip

# On WSL or some flavors of linux you may need to install the `enchant`
# library in order to build the docs
sudo apt-get install -y enchant

# Install extension + test/dev/doc dependencies into your environment
python -m pip install -e .[tests,dev,docs]

# Run tests!
python -m nox -e tests-3

# skip requirements install for next time
export SKIP_REQUIREMENTS_INSTALL=1

# Build the docs, serve, and view in your web browser:
python -m nox -e docs && (cd docs/_build/html; python -m webbrowser localhost:8000; python -m http.server; cd -)

# Run the pkg describe function
salt-run describe.pkg <minion-tgt>

# Run the file describe function
salt-run describe.file <minion-tgt> <file name>

# Generate the top file for the minion target based off of previously generated SLS files.
salt-run describe.top <minion-tgt>