https://github.com/saltstack/salt-describe
Automated infrastructure-as-code using Salt
https://github.com/saltstack/salt-describe
Last synced: 4 months ago
JSON representation
Automated infrastructure-as-code using Salt
- Host: GitHub
- URL: https://github.com/saltstack/salt-describe
- Owner: saltstack
- License: apache-2.0
- Created: 2021-12-21T14:42:46.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-08T22:27:39.000Z (about 2 years ago)
- Last Synced: 2025-01-29T11:21:53.822Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 429 KB
- Stars: 13
- Watchers: 17
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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
# Run the file describe function
salt-run describe.file
# Generate the top file for the minion target based off of previously generated SLS files.
salt-run describe.top