mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 01:18:58 +00:00
Merge pull request #4262 from mgwilliams/docs
docs for new pillar and tops modules
This commit is contained in:
commit
f0246e289b
@ -16,3 +16,4 @@ Full list of builtin pillar modules
|
||||
mongo
|
||||
pillar_ldap
|
||||
puppet
|
||||
cobbler
|
||||
|
6
doc/ref/pillar/all/salt.pillar.cobbler.rst
Normal file
6
doc/ref/pillar/all/salt.pillar.cobbler.rst
Normal file
@ -0,0 +1,6 @@
|
||||
===================
|
||||
salt.pillar.cobbler
|
||||
===================
|
||||
|
||||
.. automodule:: salt.pillar.cobbler
|
||||
:members:
|
@ -11,3 +11,5 @@ Full list of builtin master tops modules
|
||||
:template: autosummary.rst.tmpl
|
||||
|
||||
ext_nodes
|
||||
cobbler
|
||||
mongo
|
||||
|
6
doc/ref/tops/all/salt.tops.cobbler.rst
Normal file
6
doc/ref/tops/all/salt.tops.cobbler.rst
Normal file
@ -0,0 +1,6 @@
|
||||
=================
|
||||
salt.tops.cobbler
|
||||
=================
|
||||
|
||||
.. automodule:: salt.tops.cobbler
|
||||
:members:
|
6
doc/ref/tops/all/salt.tops.mongo.rst
Normal file
6
doc/ref/tops/all/salt.tops.mongo.rst
Normal file
@ -0,0 +1,6 @@
|
||||
===============
|
||||
salt.tops.mongo
|
||||
===============
|
||||
|
||||
.. automodule:: salt.tops.mongo
|
||||
:members:
|
@ -80,7 +80,7 @@ def stop(name):
|
||||
|
||||
def restart(name, **kwargs):
|
||||
'''
|
||||
Restart the named service
|
||||
Restart the specified service
|
||||
|
||||
CLI Example::
|
||||
|
||||
@ -106,7 +106,7 @@ def status(name, sig=None):
|
||||
|
||||
def reload(name):
|
||||
'''
|
||||
Restart the named service
|
||||
Restart the specified service
|
||||
|
||||
CLI Example::
|
||||
|
||||
@ -132,7 +132,7 @@ def get_all(name):
|
||||
|
||||
def available(name):
|
||||
'''
|
||||
Return if the names service is available
|
||||
Return if the specified service is available
|
||||
|
||||
CLI Example::
|
||||
|
||||
|
@ -2,10 +2,16 @@
|
||||
Cobbler Pillar
|
||||
==============
|
||||
A pillar module to pull data from Cobbler via its API into the pillar dictionary.
|
||||
|
||||
|
||||
Configuring the Cobbler ext_pillar
|
||||
================================
|
||||
|
||||
The same cobbler.* parameters are used for both the Cobbler tops and Cobbler pillar
|
||||
modules.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
ext_pillar:
|
||||
- cobbler:
|
||||
- key: cobbler # Nest results within this key. By default, values are not nested.
|
||||
@ -14,6 +20,10 @@ modules.
|
||||
cobbler.url: https://example.com/cobbler_api #default is http://localhost/cobbler_api
|
||||
cobbler.user: username # default is no username
|
||||
cobbler.password: password # default is no password
|
||||
|
||||
|
||||
Module Documentation
|
||||
====================
|
||||
'''
|
||||
|
||||
# Import python libs
|
||||
|
@ -7,13 +7,16 @@ from Cobbler via its API. The same cobbler.* parameters are used for both
|
||||
the Cobbler tops and Cobbler pillar modules.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
master_tops:
|
||||
cobbler: {}
|
||||
|
||||
cobbler.url: https://example.com/cobbler_api #default is http://localhost/cobbler_api
|
||||
cobbler.user: username # default is no username
|
||||
cobbler.password: password # default is no password
|
||||
|
||||
|
||||
Module Documentation
|
||||
====================
|
||||
'''
|
||||
|
||||
# Import python libs
|
||||
|
Loading…
Reference in New Issue
Block a user