Saltstack module highstate_doc 详解

highstate_doc.read_file

output the contents of a file:

this is a workaround if the cp.push module does not work.
https://github.com/saltstack/salt/issues/37133

help the master output the contents of a document
that might be saved on the minions filesystem.

    #!/bin/python
    import os
    import salt.client
    s = salt.client.LocalClient()
    o = s.cmd(‘*‘, ‘highstate_doc.read_file‘, [‘/root/README.md‘])
    for m in o:
        d = o.get(m)
        if d and not d.endswith(‘is not available.‘):
            # mkdir m
            #directory = os.path.dirname(file_path)
            if not os.path.exists(m):
                os.makedirs(m)
            with open(m + ‘/README.md‘,‘wb‘) as fin:
                fin.write(d)
            print(‘ADDED: ‘ + m + ‘/README.md‘)

highstate_doc.markdown_default_jinja_template

Return text for a markdown jinja template that included a header

This function can be used from the `highstate_doc.render` modules `jinja_template_function` option.

highstate_doc.proccess_lowstates

return proccessed lowstate data that was not blacklisted

render_module_function is used to provide your own.
defaults to from_lowstate

highstate_doc.render

Render highstate to a text format (default Markdown)

if `jinja_template_text` is not set, `jinja_template_function` is used.

jinja_template_text: jinja text that the render uses to create the document.
jinja_template_function: a salt module call that returns template text.
    options:
        highstate_doc.markdown_basic_jinja_template
        highstate_doc.markdown_default_jinja_template
        highstate_doc.markdown_full_jinja_template

highstate_doc.markdown_basic_jinja_template

Return text for a simple markdown jinja template

This function can be used from the `highstate_doc.render` modules `jinja_template_function` option.

highstate_doc.markdown_full_jinja_template

Return text for an advanced markdown jinja template

This function can be used from the `highstate_doc.render` modules `jinja_template_function` option.

highstate_doc.proccesser_markdown

Takes low state data and returns a dict of proccessed data
that is by default used in a jinja template when rendering a markdown highstate_doc.

This `lowstate_item_markdown` given a lowstate item, returns a dict like:

    vars:       # the raw lowstate_item that was proccessed
    id:         # the ‘id‘ of the state.
    id_full:    # combo of the state type and id "state: id"
    state:      # name of the salt state module
    function:   # name of the state function
    name:       # value of ‘name:‘ passed to the salt state module
    state_function:    # the state name and function name
    markdown:          # text data to describe a state
        requisites:    # requisite like [watch_in, require_in]
        details:       # state name, parameters and other details like file contents

原文地址:https://www.cnblogs.com/randomlee/p/Saltstack_module_highstate_doc.html

时间: 2024-11-05 14:52:23

Saltstack module highstate_doc 详解的相关文章

Saltstack module artifactory 详解

artifactory.get_latest_snapshot Gets latest snapshot of the given artifact artifactory_url URL of artifactory instance repository Snapshot repository in artifactory to retrieve artifact from, for example: libs-snapshots group_id Group Id of the artif

Saltstack module introspect 详解

introspect.service_highstate Return running and enabled services in a highstate structure. By default also returns package dependencies for those services, which means that package definitions must be created outside this function. To drop the packag

Saltstack module inspector 详解

inspector.query Query the node for specific information. Parameters: * **scope**: Specify scope of the query. * **System**: Return system data. * **Software**: Return software information. * **Services**: Return known services. * **Identity**: Return

Saltstack module http 详解

http.query New in version 2015.5.0 Query a resource, and decode the return data Passes through all the parameters described in the :py:func:`utils.http.query function <salt.utils.http.query>`: .. autofunction:: salt.utils.http.query raise_error : Tr

Saltstack module ini 详解

ini.remove_option Remove a key/value pair from a section in an ini file. Returns the value of the removed key, or ``None`` if nothing was removed. API Example: import salt sc = salt.client.get_local_client() sc.cmd('target', 'ini.remove_option', [pat

Saltstack module glassfish 详解

glassfish.update_connector_c_pool Update a connection pool glassfish.update_jdbc_resource Update a JDBC resource glassfish.enum_connector_resource Enum connection resources glassfish.delete_jdbc_resource Delete a JDBC resource glassfish.enum_connecto

Saltstack module iosconfig 详解

iosconfig.diff_text Return the diff, as text, between the candidate and the running config. candidate_config The candidate configuration sent as text. This argument is ignored when ``candidate_path`` is set. candidate_path Absolute or remote path fro

Saltstack module grafana4 详解

grafana4.get_org Show a single organization. name Name of the organization. profile Configuration profile used to connect to the Grafana instance. Default is 'grafana'. CLI Example: salt '*' grafana4.get_org <name> grafana4.delete_user Delete a user

Saltstack module genesis 详解

genesis.mksls Convert an installation file/script to an SLS file. Currently supports ``kickstart``, ``preseed``, and ``autoyast``. CLI Examples: salt <minion> genesis.mksls kickstart /path/to/kickstart.cfg salt <minion> genesis.mksls kickstart