From ed7b155ddf89c5a790279de3f3dabca8422d4f4c Mon Sep 17 00:00:00 2001 From: Matthew Williams Date: Mon, 25 Mar 2013 09:42:52 -0700 Subject: [PATCH 1/3] add docs for new pillar and tops modules fix inconsistency in modules/service.py docs --- doc/ref/pillar/all/index.rst | 1 + doc/ref/pillar/all/salt.pillar.cobbler.rst | 6 ++++++ doc/ref/tops/all/index.rst | 2 ++ doc/ref/tops/all/salt.tops.cobbler.rst | 6 ++++++ 4 files changed, 15 insertions(+) create mode 100644 doc/ref/pillar/all/salt.pillar.cobbler.rst create mode 100644 doc/ref/tops/all/salt.tops.cobbler.rst diff --git a/doc/ref/pillar/all/index.rst b/doc/ref/pillar/all/index.rst index aeb65e7ed6..e8fe8a780b 100644 --- a/doc/ref/pillar/all/index.rst +++ b/doc/ref/pillar/all/index.rst @@ -16,3 +16,4 @@ Full list of builtin pillar modules mongo pillar_ldap puppet + cobbler diff --git a/doc/ref/pillar/all/salt.pillar.cobbler.rst b/doc/ref/pillar/all/salt.pillar.cobbler.rst new file mode 100644 index 0000000000..927fba933e --- /dev/null +++ b/doc/ref/pillar/all/salt.pillar.cobbler.rst @@ -0,0 +1,6 @@ +=================== +salt.pillar.cobbler +=================== + +.. automodule:: salt.pillar.cobbler + :members: diff --git a/doc/ref/tops/all/index.rst b/doc/ref/tops/all/index.rst index 7a42938464..9119d5cef1 100644 --- a/doc/ref/tops/all/index.rst +++ b/doc/ref/tops/all/index.rst @@ -11,3 +11,5 @@ Full list of builtin master tops modules :template: autosummary.rst.tmpl ext_nodes + cobbler + mongo diff --git a/doc/ref/tops/all/salt.tops.cobbler.rst b/doc/ref/tops/all/salt.tops.cobbler.rst new file mode 100644 index 0000000000..f5f44ffa7c --- /dev/null +++ b/doc/ref/tops/all/salt.tops.cobbler.rst @@ -0,0 +1,6 @@ +================= +salt.tops.cobbler +================= + +.. automodule:: salt.tops.cobbler + :members: From 89a474d5aab776695c3f73a503380f3c69ea46b1 Mon Sep 17 00:00:00 2001 From: Matthew Williams Date: Mon, 25 Mar 2013 09:43:26 -0700 Subject: [PATCH 2/3] fix inconsistency in modules/service.py docs (for real) --- salt/modules/service.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/salt/modules/service.py b/salt/modules/service.py index 3c3db4d221..1795884add 100644 --- a/salt/modules/service.py +++ b/salt/modules/service.py @@ -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:: From 8c0a32f335ab29308948b314e90d1b1596558e2d Mon Sep 17 00:00:00 2001 From: Matthew Williams Date: Mon, 25 Mar 2013 09:57:26 -0700 Subject: [PATCH 3/3] fix docstrings for cobbler pillar and tops modules --- doc/ref/tops/all/salt.tops.mongo.rst | 6 ++++++ salt/pillar/cobbler.py | 24 +++++++++++++++++------- salt/tops/cobbler.py | 13 ++++++++----- 3 files changed, 31 insertions(+), 12 deletions(-) create mode 100644 doc/ref/tops/all/salt.tops.mongo.rst diff --git a/doc/ref/tops/all/salt.tops.mongo.rst b/doc/ref/tops/all/salt.tops.mongo.rst new file mode 100644 index 0000000000..b2548e259a --- /dev/null +++ b/doc/ref/tops/all/salt.tops.mongo.rst @@ -0,0 +1,6 @@ +=============== +salt.tops.mongo +=============== + +.. automodule:: salt.tops.mongo + :members: \ No newline at end of file diff --git a/salt/pillar/cobbler.py b/salt/pillar/cobbler.py index 61b9278e82..28da93bd41 100644 --- a/salt/pillar/cobbler.py +++ b/salt/pillar/cobbler.py @@ -2,18 +2,28 @@ 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. - - only: [parameters] # Add only these keys to pillar. - 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 + ext_pillar: + - cobbler: + - key: cobbler # Nest results within this key. By default, values are not nested. + - only: [parameters] # Add only these keys to pillar. + + 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 diff --git a/salt/tops/cobbler.py b/salt/tops/cobbler.py index 0f6c4f0c91..379b4afec2 100644 --- a/salt/tops/cobbler.py +++ b/salt/tops/cobbler.py @@ -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 + 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