Génération de la documentation pour les états de pile de sel

J'ai un référentiel avec des états de sel pour provisionner ma grappe de serveurs dans le cloud. Au fil du temps, j'ai continué à ajouter plus d'états - les fichiers .sls - dans ce repo. Maintenant, je commence à lutter ce qui est quoi et où est-ce. Je me demande s'il y a un utilitaire/paquet logiciel qui va générer de la documentation sur mon dépôt d'états, de préférence en pages html, pour que je puisse les parcourir et voir leurs interdépendances.Génération de la documentation pour les états de pile de sel

MISE À JOUR:

fichiers sls L'état ressemblent à ceci:

include: 
    - states.core.pip 

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

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

Et un autre sls exemple:

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

Source

2017-10-19 dopstar

Dans quel format sont vos fichiers SLS? yaml? – Tschallacka

@Tschallacka Oui. J'ai mis à jour la question et ajouté des exemples. – dopstar

J'ai fait des recherches et a constaté que la pile de sel a créé un. Cela fonctionne aussi en tant que pages HTML. Selon la documentation. Si vous avez installé python l'installation de Sphinx est aussi facile que de le faire C:\> pip install sphinx
Vous trouverez des documents sur les piles de sel sur ce document here. Selon les documents faisant la documentation HTML est aussi facile que de faire:

cd /path/to/salt/doc 
make HTML

J'espère que cette réponse est ce que vous recherchez!

Source

2017-10-30 12:54:18 NicksWorld

Ce n'est pas ce que je cherche. Je cherche quelque chose qui va analyser les fichiers sls et générer des documents pour moi. Cela ressemble à analyser les docstrings des modules de sel. – dopstar

Cela nécessite un plugin personnalisé qui doit être écrit. Il n'y a pas de plugins directement disponibles pour rendre les fichiers SLS.

Certains plugins sont disponibles pour le rendu des fichiers YAML, vous pouvez peut-être les modifier pour répondre à vos besoins.

Source

2018-02-27 09:06:45

Génération de la documentation pour les états de pile de sel

Répondre

Questions connexes