Generating documentation for salt stack states

Question

I have a repository with salt states for provisioning my cluster of servers in the cloud. Over time, I kept on adding more states - the .sls files - into this repo. Now im starting to struggle what is what and what is where.

I am wondering if there is a there is some software utility/package that will generate documentation off my states repository, preferably as html pages, so that I can browse them and see their interdependencies.

UPDATE:

The state sls files look like this:

include:
    - states.core.pip

virtualenv:
    pip.installed:
        - require:
            - sls: states.core.pip

virtualenvwrapper:
    pip.installed:
        - require:
            - sls: states.core.pip

And another sls example:

{% set user_home = '/home/username' %}

my_executable_virtualenv:
    virtualenv.managed:
        - name: {{ user_home }}/.virtualenvs/my_executable_virtualenv
        - user: username
        - system_site_packages: False
        - pip_pkgs:
            - requests
            - numpy
        - pip_upgrade: True
        - require:
            - sls: states.core

my_executable_supervisor_entry:
    file.managed:
        - name: /etc/supervisor/conf.d/my_executable.conf
        - source: salt://files/supervisor_config/my_executable.conf
        - user: username
        - group: username
        - mode: 644
        - makedirs: False
        - require:
            - sls: states.core

@Tschallacka Yes. I have updated the question and added examples. — dopstar

NicksWorld NicksWorld · Accepted Answer · 2017-10-30T12:54:18

I did some research and found that salt stack has created one. It does work as HTML pages too. According to the documentation. If you have python installed installing Sphinx is as easy as doing C:\> pip install sphinx
Salt-stacks docs on this can be found here. According to the docs making the HTML documentation is as easy as doing:

cd /path/to/salt/doc
make HTML

I hope this answer is what you were looking for!

Generating documentation for salt stack states

2 Answers