2017-10-19 149 views
7

我有盐状态的仓库用于配置我的服务器集群在云中。随着时间的推移,我不断增加更多的州 - .sls文件 - 进入这个回购。现在我开始努力什么是什么,什么是地方。盐栈生成文档指出

我想知道如果有一个有一些软件工具/包,将生成文档了我州库中,最好的HTML页面,这样我就可以浏览他们,看到他们的相互依存关系。

UPDATE:

状态SLS文件看起来是这样的:

include: 
    - states.core.pip 

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

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

而另一SLS例如:

{% 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 
+0

在什么格式是您的SLS文件? YAML? – Tschallacka

+0

@Tschallacka是的。我已经更新了这个问题并添加了示例。 – dopstar

回答

0

我做了一些研究,发现盐栈创造一。它也可以用作HTML页面。根据文件。如果你已经安装了python,安装Sphinx就像做 C:\> pip install sphinx
盐堆栈文档可以找到here。据制作HTML文档的文档是那么容易,因为这样做的:

cd /path/to/salt/doc 
make HTML 

我希望这个答案是什么你要找的人!

+0

这不是我正在寻找的。我正在寻找能解析sls文件并为我生成文档的东西。这看起来像解析盐模块的文档。 – dopstar

0

这需要这需要编写一个自定义插件。 没有直接可用来呈现SLS文件的插件。

有一些可用于渲染YAML文件的插件,可能是你可以修改以适合您的要求是相同的。