2017-10-19 23 views
7

Mam repozytorium ze stanami solnymi do obsługi mojego klastra serwerów w chmurze. Z biegiem czasu ciągle dodawałem kolejne stany - pliki .sls - do tego repozytorium. Teraz zaczynam walczyć o to, co jest i co jest gdzie.Generowanie dokumentacji dla stanów stosów soli

Zastanawiam się, czy istnieje jakieś narzędzie/pakiet oprogramowania, które wygeneruje dokumentację z mojego repozytorium stanów, najlepiej jako strony html, dzięki czemu mogę je przeglądać i widzieć ich współzależności.

UPDATE:

pañstwa sls pliki wyglądać następująco:

include: 
    - states.core.pip 

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

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

I kolejny przykład 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

W jakim formacie są twoje pliki sls? yaml? – Tschallacka

+0

@Tschallacka Tak. Zaktualizowałem pytanie i dodałem przykłady. – dopstar

Odpowiedz

0

Zrobiłem rozeznanie i okazało się, że sól stos stworzył jeden. Działa również jako strony HTML. Zgodnie z dokumentacją. Jeśli masz zainstalowany Python, instalowanie Sphinx jest tak proste, jak wykonanie C:\> pip install sphinx
Dokumentację dotyczącą solnych stosów można znaleźć pod tym numerem: here. Według dokumentów tworzenie dokumentacji w formacie HTML jest tak proste jak:

Mam nadzieję, że ta odpowiedź jest tym, czego szukałeś!

+0

Nie tego szukam. Szukam czegoś, co sparsuje pliki sls i generuje dokumenty dla mnie. Wygląda na to, że analizuje docstruje modułów soli. – dopstar

0

Wymaga to niestandardowej wtyczki, która musi zostać napisana. Brak dostępnych wtyczek do renderowania plików SLS.

Istnieje kilka dostępnych wtyczek do renderowania plików YAML, możesz je zmodyfikować tak, aby spełnić wymagania.