Monday, October 30, 2017

Generating documentation for salt stack states

Leave a Comment

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.

1 Answers

Answers 1

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!

If You Enjoyed This, Take 5 Seconds To Share It

0 comments:

Post a Comment