https://github.com/salt-extensions/salt-describe

Salt Describe is a Salt Extension used to automate the generation of infrastructure as code files using Salt to query target machines.
https://github.com/salt-extensions/salt-describe

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/salt-extensions/salt-describe
• Owner: salt-extensions
• License: apache-2.0
• Created: 2024-02-22T21:41:09.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T19:02:27.000Z (4 months ago)
• Last Synced: 2024-09-19T03:22:00.127Z (4 months ago)
• Language: Python
• Size: 554 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog/.template.jinja
  • 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