saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add autodoc topics for new modules added in Carbon (#36933)

Browse source 
Module formatting issues
Add list of new Carbon modules to release notes
This commit is contained in:
Jacob Hammons 2016-10-12 09:31:07 -06:00 • committed by Nicole Thomas
parent e5425f3e8c
commit dd21da4992
79 changed files with 686 additions and 218 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/conf.py
View file

@ -156,6 +156,8 @@ MOCK_MODULES = [
'netaddr.core.AddrFormatError',
'pyroute2',
'pyroute2.ipdb',
'avahi',
'dbus',
]
for mod_name in MOCK_MODULES:
@ -275,6 +277,7 @@ exclude_patterns = ['_build', '_incl/*', 'ref/cli/_includes/*.rst']
extensions = [
'saltdomain', # Must come early
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.autosummary',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',

6
doc/ref/beacons/all/salt.beacons.bonjour_announce.rst Normal file
View file

@ -0,0 +1,6 @@
salt.beacons.bonjour_announce module
====================================
.. automodule:: salt.beacons.bonjour_announce
:members:
:undoc-members:

6
doc/ref/beacons/all/salt.beacons.haproxy.rst Normal file
View file

@ -0,0 +1,6 @@
salt.beacons.haproxy module
===========================
.. automodule:: salt.beacons.haproxy
:members:
:undoc-members:

6
doc/ref/beacons/all/salt.beacons.status.rst Normal file
View file

@ -0,0 +1,6 @@
salt.beacons.status module
==========================
.. automodule:: salt.beacons.status
:members:
:undoc-members:

6
doc/ref/engines/all/salt.engines.hipchat.rst Normal file
View file

@ -0,0 +1,6 @@
salt.engines.hipchat module
===========================
.. automodule:: salt.engines.hipchat
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.boto_cloudwatch_event.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.boto_cloudwatch_event module
=========================================
.. automodule:: salt.modules.boto_cloudwatch_event
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.celery.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.celery module
==========================
.. automodule:: salt.modules.celery
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.ceph.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.ceph module
========================
.. automodule:: salt.modules.ceph
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.influx08.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.influx08 module
============================
.. automodule:: salt.modules.influx08
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.inspectlib.entities.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.inspectlib.entities module
=======================================
.. automodule:: salt.modules.inspectlib.entities
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.inspectlib.fsdb.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.inspectlib.fsdb module
===================================
.. automodule:: salt.modules.inspectlib.fsdb
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.inspectlib.kiwiproc.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.inspectlib.kiwiproc module
=======================================
.. automodule:: salt.modules.inspectlib.kiwiproc
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.inspector.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.inspector module
=============================
.. automodule:: salt.modules.inspector
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.libcloud_dns.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.libcloud_dns module
================================
.. automodule:: salt.modules.libcloud_dns
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.openstack_mng.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.openstack_mng module
=================================
.. automodule:: salt.modules.openstack_mng
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.servicenow.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.servicenow module
==============================
.. automodule:: salt.modules.servicenow
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.testinframod.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.testinframod module
================================
.. automodule:: salt.modules.testinframod
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.win_lgpo.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.win_lgpo module
============================
.. automodule:: salt.modules.win_lgpo
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.win_pki.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.win_pki module
===========================
.. automodule:: salt.modules.win_pki
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.win_psget.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.win_psget module
=============================
.. automodule:: salt.modules.win_psget
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.win_snmp.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.win_snmp module
============================
.. automodule:: salt.modules.win_snmp
:members:
:undoc-members:

6
doc/ref/modules/all/salt.modules.xbpspkg.rst Normal file
View file

@ -0,0 +1,6 @@
salt.modules.xbpspkg module
===========================
.. automodule:: salt.modules.xbpspkg
:members:
:undoc-members:

6
doc/ref/output/all/salt.output.pony.rst Normal file
View file

@ -0,0 +1,6 @@
salt.output.pony module
=======================
.. automodule:: salt.output.pony
:members:
:undoc-members:

6
doc/ref/pillar/all/salt.pillar.csvpillar.rst Normal file
View file

@ -0,0 +1,6 @@
salt.pillar.csvpillar module
============================
.. automodule:: salt.pillar.csvpillar
:members:
:undoc-members:

6
doc/ref/pillar/all/salt.pillar.http_json.rst Normal file
View file

@ -0,0 +1,6 @@
salt.pillar.http_json module
============================
.. automodule:: salt.pillar.http_json
:members:
:undoc-members:

6
doc/ref/pillar/all/salt.pillar.makostack.rst Normal file
View file

@ -0,0 +1,6 @@
salt.pillar.makostack module
============================
.. automodule:: salt.pillar.makostack
:members:
:undoc-members:

6
doc/ref/returners/all/salt.returners.zabbix_return.rst Normal file
View file

@ -0,0 +1,6 @@
salt.returners.zabbix_return module
===================================
.. automodule:: salt.returners.zabbix_return
:members:
:undoc-members:

6
doc/ref/runners/all/salt.runners.auth.rst Normal file
View file

@ -0,0 +1,6 @@
salt.runners.auth module
========================
.. automodule:: salt.runners.auth
:members:
:undoc-members:

6
doc/ref/runners/all/salt.runners.event.rst Normal file
View file

@ -0,0 +1,6 @@
salt.runners.event module
=========================
.. automodule:: salt.runners.event
:members:
:undoc-members:

6
doc/ref/runners/all/salt.runners.smartos_vmadm.rst Normal file
View file

@ -0,0 +1,6 @@
salt.runners.smartos_vmadm module
=================================
.. automodule:: salt.runners.smartos_vmadm
:members:
:undoc-members:

6
doc/ref/runners/all/salt.runners.vistara.rst Normal file
View file

@ -0,0 +1,6 @@
salt.runners.vistara module
===========================
.. automodule:: salt.runners.vistara
:members:
:undoc-members:

6
doc/ref/sdb/all/salt.sdb.env.rst Normal file
View file

@ -0,0 +1,6 @@
salt.sdb.env module
===================
.. automodule:: salt.sdb.env
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.boto_cloudwatch_event.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.boto_cloudwatch_event module
========================================
.. automodule:: salt.states.boto_cloudwatch_event
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.ceph.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.ceph module
=======================
.. automodule:: salt.states.ceph
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.csf.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.csf module
======================
.. automodule:: salt.states.csf
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.ethtool.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.ethtool module
==========================
.. automodule:: salt.states.ethtool
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.influxdb08_database.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.influxdb08_database module
======================================
.. automodule:: salt.states.influxdb08_database
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.influxdb08_user.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.influxdb08_user module
==================================
.. automodule:: salt.states.influxdb08_user
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.libcloud_dns.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.libcloud_dns module
===============================
.. automodule:: salt.states.libcloud_dns
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.snapper.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.snapper module
==========================
.. automodule:: salt.states.snapper
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.testinframod.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.testinframod module
===============================
.. automodule:: salt.states.testinframod
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.win_lgpo.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.win_lgpo module
===========================
.. automodule:: salt.states.win_lgpo
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.win_pki.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.win_pki module
==========================
.. automodule:: salt.states.win_pki
:members:
:undoc-members:

6
doc/ref/states/all/salt.states.win_snmp.rst Normal file
View file

@ -0,0 +1,6 @@
salt.states.win_snmp module
===========================
.. automodule:: salt.states.win_snmp
:members:
:undoc-members:

6
doc/ref/thorium/all/salt.thorium.calc.rst Normal file
View file

@ -0,0 +1,6 @@
salt.thorium.calc module
========================
.. automodule:: salt.thorium.calc
:members:
:undoc-members:

6
doc/ref/thorium/all/salt.thorium.key.rst Normal file
View file

@ -0,0 +1,6 @@
salt.thorium.key module
=======================
.. automodule:: salt.thorium.key
:members:
:undoc-members:

6
doc/ref/thorium/all/salt.thorium.runner.rst Normal file
View file

@ -0,0 +1,6 @@
salt.thorium.runner module
==========================
.. automodule:: salt.thorium.runner
:members:
:undoc-members:

6
doc/ref/thorium/all/salt.thorium.status.rst Normal file
View file

@ -0,0 +1,6 @@
salt.thorium.status module
==========================
.. automodule:: salt.thorium.status
:members:
:undoc-members:

6
doc/ref/thorium/all/salt.thorium.wheel.rst Normal file
View file

@ -0,0 +1,6 @@
salt.thorium.wheel module
=========================
.. automodule:: salt.thorium.wheel
:members:
:undoc-members:

2
doc/topics/blackout/index.rst
View file

@ -19,7 +19,7 @@ Salt also supports an explicit whitelist of additional functions that will be
allowed during blackout. This is configured with the special pillar key
``minion_blackout_whitelist``, which is formed as a list:
.. code_block:: yaml
.. code-block:: yaml
minion_blackout_whitelist:
- test.ping

91
doc/topics/releases/carbon.rst
View file

@ -274,6 +274,97 @@ Functionality Changes
- host2
- host3
New Modules
===========
Beacons
-------
- :mod:`salt.beacons.bonjour_announce <salt.beacons.bonjour_announce>`
- :mod:`salt.beacons.haproxy <salt.beacons.haproxy>`
- :mod:`salt.beacons.status <salt.beacons.status>`
Engines
-------
- :mod:`salt.engines.hipchat <salt.engines.hipchat>`
Modules
-------
- :mod:`salt.modules.boto_cloudwatch_event <salt.modules.boto_cloudwatch_event>`
- :mod:`salt.modules.celery <salt.modules.celery>`
- :mod:`salt.modules.ceph <salt.modules.ceph>`
- :mod:`salt.modules.influx08 <salt.modules.influx08>`
- :mod:`salt.modules.inspectlib.entities <salt.modules.inspectlib.entities>`
- :mod:`salt.modules.inspectlib.fsdb <salt.modules.inspectlib.fsdb>`
- :mod:`salt.modules.inspectlib.kiwiproc <salt.modules.inspectlib.kiwiproc>`
- :mod:`salt.modules.inspector <salt.modules.inspector>`
- :mod:`salt.modules.libcloud_dns <salt.modules.libcloud_dns>`
- :mod:`salt.modules.openstack_mng <salt.modules.openstack_mng>`
- :mod:`salt.modules.servicenow <salt.modules.servicenow>`
- :mod:`salt.modules.testinframod <salt.modules.testinframod>`
- :mod:`salt.modules.win_lgpo <salt.modules.win_lgpo>`
- :mod:`salt.modules.win_pki <salt.modules.win_pki>`
- :mod:`salt.modules.win_psget <salt.modules.win_psget>`
- :mod:`salt.modules.win_snmp <salt.modules.win_snmp>`
- :mod:`salt.modules.xbpspkg <salt.modules.xbpspkg>`
Outputters
----------
- :mod:`salt.output.pony <salt.output.pony>`
Pillar
------
- :mod:`salt.pillar.csvpillar <salt.pillar.csvpillar>`
- :mod:`salt.pillar.http_json <salt.pillar.http_json>`
- :mod:`salt.pillar.makostack <salt.pillar.makostack>`
Returners
---------
- :mod:`salt.returners.zabbix_return <salt.returners.zabbix_return>`
Runners
-------
- :mod:`salt.runners.auth <salt.runners.auth>`
- :mod:`salt.runners.event <salt.runners.event>`
- :mod:`salt.runners.smartos_vmadm <salt.runners.smartos_vmadm>`
- :mod:`salt.runners.vistara <salt.runners.vistara>`
SDB
---
- :mod:`salt.sdb.env <salt.sdb.env>`
States
------
- :mod:`salt.states.boto_cloudwatch_event <salt.states.boto_cloudwatch_event>`
- :mod:`salt.states.csf <salt.states.csf>`
- :mod:`salt.states.ethtool <salt.states.ethtool>`
- :mod:`salt.states.influxdb08_database <salt.states.influxdb08_database>`
- :mod:`salt.states.influxdb08_user <salt.states.influxdb08_user>`
- :mod:`salt.states.libcloud_dns <salt.states.libcloud_dns>`
- :mod:`salt.states.snapper <salt.states.snapper>`
- :mod:`salt.states.testinframod <salt.states.testinframod>`
- :mod:`salt.states.win_lgpo <salt.states.win_lgpo>`
- :mod:`salt.states.win_pki <salt.states.win_pki>`
- :mod:`salt.states.win_snmp <salt.states.win_snmp>`
Thorium
-------
- :mod:`salt.thorium.calc <salt.thorium.calc>`
- :mod:`salt.thorium.key <salt.thorium.key>`
- :mod:`salt.thorium.runner <salt.thorium.runner>`
- :mod:`salt.thorium.status <salt.thorium.status>`
- :mod:`salt.thorium.wheel <salt.thorium.wheel>`
Deprecations
============

2
salt/beacons/haproxy.py
View file

@ -41,7 +41,9 @@ def beacon(config):
'''
Check if current number of sessions of a server for a specific haproxy backend
is over a defined threshold.
.. code-block:: yaml
beacons:
haproxy:
- www-backend:

5
salt/engines/hipchat.py
View file

@ -6,8 +6,12 @@ via Hipchat by setting the control parameter to ``True`` and using command
prefaced with a ``!``. Only token key is required, but room and control
keys make the engine interactive.
.. versionadded: Carbon
:depends: hypchat
:configuration: Example configuration
.. code-block:: yaml
engines:
hipchat:
token: 'XXXXXX'
@ -25,7 +29,6 @@ keys make the engine interactive.
cmd: jobs.list_jobs
list_commands:
cmd: pillar.get salt:engines:hipchat:valid_commands target=saltmaster
:depends: hypchat
'''
from __future__ import absolute_import

6
salt/engines/http_logstash.py
View file

@ -6,8 +6,10 @@ HTTP Logstash engine
An engine that reads messages from the salt event bus and pushes
them onto a logstash endpoint via HTTP requests.
:configuration:
Example configuration
:configuration: Example configuration
.. code-block:: yaml
engines:
- http_logstash:
url: http://blabla.com/salt-stuff

16
salt/modules/apf.py
View file

@ -70,7 +70,9 @@ def running():
'''
Check apf status
CLI Example:
.. code-block:: bash
salt '*' apf.running
'''
return True if _status_apf() else False
@ -80,7 +82,9 @@ def disable():
'''
Stop (flush) all firewall rules
CLI Example:
.. code-block:: bash
salt '*' apf.disable
'''
if _status_apf():
@ -91,7 +95,9 @@ def enable():
'''
Load all firewall rules
CLI Example:
.. code-block:: bash
salt '*' apf.enable
'''
if not _status_apf():
@ -102,7 +108,9 @@ def reload():
'''
Stop (flush) & reload firewall rules
CLI Example:
.. code-block:: bash
salt '*' apf.reload
'''
if not _status_apf():
@ -113,7 +121,9 @@ def refresh():
'''
Refresh & resolve dns names in trust rules
CLI Example:
.. code-block:: bash
salt '*' apf.refresh
'''
return __apf_cmd('-e')
@ -123,7 +133,9 @@ def allow(ip, port=None):
'''
Add host (IP/FQDN) to allow_hosts.rules and immediately load new rule into firewall
CLI Example:
.. code-block:: bash
salt '*' apf.allow 127.0.0.1
'''
if port is None:
@ -134,7 +146,9 @@ def deny(ip):
'''
Add host (IP/FQDN) to deny_hosts.rules and immediately load new rule into firewall
CLI Example:
.. code-block:: bash
salt '*' apf.deny 1.2.3.4
'''
return __apf_cmd('-d {0}'.format(ip))
@ -144,7 +158,9 @@ def remove(ip):
'''
Remove host from [glob]*_hosts.rules and immediately remove rule from firewall
CLI Example:
.. code-block:: bash
salt '*' apf.remove 1.2.3.4
'''
return __apf_cmd('-u {0}'.format(ip))

36
salt/modules/boto_apigateway.py
View file

@ -489,7 +489,7 @@ def create_api_key(name, description, enabled=True, stageKeys=None,
salt myminion boto_apigateway.create_api_key name description enabled=False
salt myminion boto_apigateway.create_api_key name description \
salt myminion boto_apigateway.create_api_key name description \\
stageKeys='[{"restApiId": "id", "stageName": "stagename"}]'
'''
@ -514,7 +514,7 @@ def delete_api_key(apiKey, region=None, key=None, keyid=None, profile=None):
CLI Example:
.. code_block:: bash
.. code-block:: bash
salt myminion boto_apigateway.delete_api_key apikeystring
@ -567,7 +567,7 @@ def update_api_key_description(apiKey, description, region=None, key=None, keyid
CLI Example:
.. code_block:: bash
.. code-block:: bash
salt myminion boto_apigateway.update_api_key_description api_key description
@ -586,7 +586,7 @@ def enable_api_key(apiKey, region=None, key=None, keyid=None, profile=None):
CLI Example:
.. code_block:: bash
.. code-block:: bash
salt myminion boto_apigateway.enable_api_key api_key
@ -605,7 +605,7 @@ def disable_api_key(apiKey, region=None, key=None, keyid=None, profile=None):
CLI Example:
.. code_block:: bash
.. code-block:: bash
salt myminion boto_apigateway.enable_api_key api_key
@ -624,9 +624,10 @@ def associate_api_key_stagekeys(apiKey, stagekeyslist, region=None, key=None, ke
CLI Example:
.. code_block:: bash
.. code-block:: bash
salt myminion boto_apigateway.associate_stagekeys_api_key api_key '["restapi id/stage name", ...]'
salt myminion boto_apigateway.associate_stagekeys_api_key \\
api_key '["restapi id/stage name", ...]'
'''
try:
@ -644,9 +645,10 @@ def disassociate_api_key_stagekeys(apiKey, stagekeyslist, region=None, key=None,
CLI Example:
.. code_block:: bash
.. code-block:: bash
salt myminion boto_apigateway.disassociate_stagekeys_api_key api_key '["restapi id/stage name", ...]'
salt myminion boto_apigateway.disassociate_stagekeys_api_key \\
api_key '["restapi id/stage name", ...]'
'''
try:
@ -738,8 +740,8 @@ def create_api_deployment(restApiId, stageName, stageDescription='', description
.. code-block:: bash
salt myminion boto_apigateway.create_api_deployent restApiId stagename stageDescription='' \
description='' cacheClusterEnabled=True|False cacheClusterSize=0.5 variables='{"name": "value"}'
salt myminion boto_apigateway.create_api_deployent restApiId stagename stageDescription='' \\
description='' cacheClusterEnabled=True|False cacheClusterSize=0.5 variables='{"name": "value"}'
'''
try:
@ -868,7 +870,7 @@ def create_api_stage(restApiId, stageName, deploymentId, description='',
.. code-block:: bash
salt myminion boto_apigateway.create_api_stage restApiId stagename deploymentId \
salt myminion boto_apigateway.create_api_stage restApiId stagename deploymentId \\
description='' cacheClusterEnabled=True|False cacheClusterSize='0.5' variables='{"name": "value"}'
'''
@ -932,7 +934,7 @@ def create_api_method(restApiId, resourcePath, httpMethod, authorizationType,
.. code-block:: bash
salt myminion boto_apigateway.create_api_method restApiId resourcePath, httpMethod, authorizationType, \
salt myminion boto_apigateway.create_api_method restApiId resourcePath, httpMethod, authorizationType, \\
apiKeyRequired=False, requestParameters='{"name", "value"}', requestModels='{"content-type", "value"}'
'''
@ -1009,7 +1011,7 @@ def create_api_method_response(restApiId, resourcePath, httpMethod, statusCode,
.. code-block:: bash
salt myminion boto_apigateway.create_api_method_response restApiId resourcePath httpMethod \
salt myminion boto_apigateway.create_api_method_response restApiId resourcePath httpMethod \\
statusCode responseParameters='{"name", "True|False"}' responseModels='{"content-type", "model"}'
'''
@ -1148,7 +1150,7 @@ def update_api_model_schema(restApiId, modelName, schema, region=None, key=None,
CLI Example:
.. code_block:: bash
.. code-block:: bash
salt myminion boto_apigateway.update_api_model_schema restApiId modelName schema
@ -1330,7 +1332,7 @@ def create_api_integration(restApiId, resourcePath, httpMethod, integrationType,
.. code-block:: bash
salt myminion boto_apigateway.create_api_integration restApiId resourcePath httpMethod \
salt myminion boto_apigateway.create_api_integration restApiId resourcePath httpMethod \\
integrationType integrationHttpMethod uri credentials ['{}' ['{}']]
'''
@ -1367,7 +1369,7 @@ def create_api_integration_response(restApiId, resourcePath, httpMethod, statusC
.. code-block:: bash
salt myminion boto_apigateway.create_api_integration_response restApiId resourcePath httpMethod \
salt myminion boto_apigateway.create_api_integration_response restApiId resourcePath httpMethod \\
statusCode selectionPattern ['{}' ['{}']]
'''

28
salt/modules/csf.py
View file

@ -58,7 +58,9 @@ def exists(method,
based on the method supplied. Returns false if
not found.
CLI Example:
.. code-block:: bash
salt '*' csf.exists allow 1.2.3.4
salt '*' csf.exists tempdeny 1.2.3.4
'''
@ -343,7 +345,9 @@ def running():
'''
Check csf status
CLI Example:
.. code-block:: bash
salt '*' csf.running
'''
return _status_csf()
@ -353,7 +357,9 @@ def disable():
'''
Disable csf permanently
CLI Example:
.. code-block:: bash
salt '*' csf.disable
'''
if _status_csf():
@ -364,7 +370,9 @@ def enable():
'''
Activate csf if not running
CLI Example:
.. code-block:: bash
salt '*' csf.enable
'''
if not _status_csf():
@ -375,7 +383,9 @@ def reload():
'''
Restart csf
CLI Example:
.. code-block:: bash
salt '*' csf.reload
'''
return __csf_cmd('-r')
@ -387,7 +397,9 @@ def tempallow(ip=None, ttl=None, port=None, direction=None, comment=''):
See :func:`_access_rule`.
1- Add an IP:
CLI Example:
.. code-block:: bash
salt '*' csf.tempallow 127.0.0.1 3600 port=22 direction='in' comment='# Temp dev ssh access'
'''
return _tmp_access_rule('tempallow', ip, ttl, port, direction, comment)
@ -399,7 +411,9 @@ def tempdeny(ip=None, ttl=None, port=None, direction=None, comment=''):
See :func:`_access_rule`.
1- Add an IP:
CLI Example:
.. code-block:: bash
salt '*' csf.tempdeny 127.0.0.1 300 port=22 direction='in' comment='# Brute force attempt'
'''
return _tmp_access_rule('tempdeny', ip, ttl, port, direction, comment)
@ -418,7 +432,9 @@ def allow(ip,
See :func:`_access_rule`.
1- Add an IP:
CLI Example:
.. code-block:: bash
salt '*' csf.allow 127.0.0.1
salt '*' csf.allow 127.0.0.1 comment="Allow localhost"
'''
@ -445,7 +461,9 @@ def deny(ip,
See :func:`_access_rule`.
1- Deny an IP:
CLI Example:
.. code-block:: bash
salt '*' csf.deny 127.0.0.1
salt '*' csf.deny 127.0.0.1 comment="Too localhosty"
'''
@ -464,7 +482,9 @@ def unallow(ip):
See :func:`_access_rule`.
1- Deny an IP:
CLI Example:
.. code-block:: bash
salt '*' csf.unallow 127.0.0.1
'''
return _access_rule('unallow', ip)
@ -476,7 +496,9 @@ def undeny(ip):
See :func:`_access_rule`.
1- Deny an IP:
CLI Example:
.. code-block:: bash
salt '*' csf.undeny 127.0.0.1
'''
return _access_rule('undeny', ip)
@ -518,7 +540,9 @@ def allow_ports(ports, proto='tcp', direction='in'):
UDP_IN, UDP_OUT, etc.
CLI Example:
.. code-block:: bash
salt '*' csf.allow_ports ports="[22,80,443,4505,4506]" proto='tcp' direction='in'
'''
@ -546,7 +570,9 @@ def get_ports(proto='tcp', direction='in'):
e.g. - TCP_IN, TCP_OUT, UDP_IN, UDP_OUT, etc..
CLI Example:
.. code-block:: bash
salt '*' csf.allow_port 22 proto='tcp' direction='in'
'''
@ -590,7 +616,9 @@ def allow_port(port, proto='tcp', direction='both'):
Takes a single port instead of a list of ports.
CLI Example:
.. code-block:: bash
salt '*' csf.allow_port 22 proto='tcp' direction='in'
'''

4
salt/modules/napalm_bgp.py
View file

@ -13,9 +13,9 @@ Manages BGP configuration on network devices and provides statistics.
Dependencies
------------
- :doc:`napalm proxy minion (salt.proxy.napalm) </ref/proxy/all/salt.proxy.napalm>`
- :mod:`napalm proxy minion <salt.proxy.napalm>`
.. versionadded: Carbon
.. versionadded:: Carbon
'''
from __future__ import absolute_import

4
salt/modules/napalm_network.py
View file

@ -13,9 +13,9 @@ Basic methods for interaction with the network device through the virtual proxy
Dependencies
------------
- :doc:`napalm proxy minion (salt.proxy.napalm) </ref/proxy/all/salt.proxy.napalm>`
- :mod:`napalm proxy minion <salt.proxy.napalm>`
.. versionadded: Carbon
.. versionadded:: Carbon
'''
from __future__ import absolute_import

13
salt/modules/napalm_ntp.py
View file

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
'''
NAPALM NTP
===============
==========
Manages NTP peers of a network device.
@ -12,15 +12,12 @@ Manages NTP peers of a network device.
Dependencies
------------
- :mod:`napalm proxy minion <salt.proxy.napalm>`
- :doc:`napalm proxy minion (salt.proxy.napalm) </ref/proxy/all/salt.proxy.napalm>`
.. seealso::
:mod:`NTP peers management state <salt.states.netntp>`
See also
--------
- :doc:`NTP peers management state (salt.states.netntp) </ref/states/all/salt.states.netntp>`
.. versionadded: Carbon
.. versionadded:: Carbon
'''
from __future__ import absolute_import

4
salt/modules/napalm_probes.py
View file

@ -13,9 +13,9 @@ Manages RPM/SLA probes on the network device.
Dependencies
------------
- :doc:`napalm proxy minion (salt.proxy.napalm) </ref/proxy/all/salt.proxy.napalm>`
- :mod:`napalm proxy minion <salt.proxy.napalm>`
.. versionadded: Carbon
.. versionadded:: Carbon
'''
from __future__ import absolute_import

4
salt/modules/nxos.py
View file

@ -2,10 +2,10 @@
'''
Execution module for Cisco NX OS Switches Proxy minions
.. versionadded: Carbon
.. versionadded:: Carbon
For documentation on setting up the nxos proxy minion look in the documentation
for :doc:`salt.proxy.nxos</ref/proxy/all/salt.proxy.nxos>`.
for :mod:`salt.proxy.nxos <salt.proxy.nxos>`.
'''
from __future__ import absolute_import

2
salt/modules/openstack_mng.py
View file

@ -42,6 +42,7 @@ def start_service(service_name):
CLI Example:
.. code-block:: bash
salt '*' openstack_mng.start_service neutron
'''
@ -56,6 +57,7 @@ def stop_service(service_name):
CLI Example:
.. code-block:: bash
salt '*' openstack_mng.stop_service neutron
'''

2
salt/modules/smartos_nictagadm.py
View file

@ -6,7 +6,7 @@ Module for running nictagadm command on SmartOS
:depends: nictagadm binary, dladm binary
:platform: smartos
..versionadded: Carbon
..versionadded:: Carbon
'''
from __future__ import absolute_import

60
salt/output/pony.py
View file

@ -1,39 +1,41 @@
# -*- coding: utf-8 -*-
'''
r'''
Display Pony output data structure
=================================
==================================
Display output from a pony. Ponies are better than cows
because everybody wants a pony.
Example output::
Example output:
< {'local': True} >
-----------------
\
\
\
▄▄▄▄▄▄▄
▀▄▄████▄▄
▄▄▄█████▄█▄█▄█▄▄▄
██████▄▄▄█▄▄█████▄▄
▀▄▀ █████▄▄█▄▄█████
▄▄▄███████████▄▄▄
████▄▄▄▄▄▄███▄▄██ ▄▄▄▄▄▄▄
████▄████▄██▄▄███ ▄▄▄▄██▄▄▄▄▄▄
█▄███▄▄█▄███▄▄██▄▀ ▄▄███████▄▄███▄▄
▀▄██████████████▄▄ ▄▄█▄▀▀▀▄▄█████▄▄██
▀▀▀▀▀█████▄█▄█▄▄▄▄▄▄▄█ ▀▄████▄████
████▄███▄▄▄▄▄▄▄▄▄ ▄▄█████▄███
▀▄█▄█▄▄▄██▄▄▄▄▄██ ▄▄██▄██████
▀▄████████████▄▀ ▄▄█▄██████▄▀
██▄██▄▄▄▄█▄███▄ ███▄▄▄▄▄██▄▀
██████ ▀▄▄█████ ▀████████
▄▄▄▄███ ███████ ██████▄█▄▄
███████ ████████▀▄▀███▄▄█▄▄
▄██▄▄████ ████████ ▀▄██▀▄▄▀
█▄▄██████ █▄▄██████
█▄▄▄▄█ █▄▄▄▄█
.. code-block:: cfg
< {'local': True} >
-----------------
\
\
\
▄▄▄▄▄▄▄
▀▄▄████▄▄
▄▄▄█████▄█▄█▄█▄▄▄
██████▄▄▄█▄▄█████▄▄
▀▄▀ █████▄▄█▄▄█████
▄▄▄███████████▄▄▄
████▄▄▄▄▄▄███▄▄██ ▄▄▄▄▄▄▄
████▄████▄██▄▄███ ▄▄▄▄██▄▄▄▄▄▄
█▄███▄▄█▄███▄▄██▄▀ ▄▄███████▄▄███▄▄
▀▄██████████████▄▄ ▄▄█▄▀▀▀▄▄█████▄▄██
▀▀▀▀▀█████▄█▄█▄▄▄▄▄▄▄█ ▀▄████▄████
████▄███▄▄▄▄▄▄▄▄▄ ▄▄█████▄███
▀▄█▄█▄▄▄██▄▄▄▄▄██ ▄▄██▄██████
▀▄████████████▄▀ ▄▄█▄██████▄▀
██▄██▄▄▄▄█▄███▄ ███▄▄▄▄▄██▄▀
██████ ▀▄▄█████ ▀████████
▄▄▄▄███ ███████ ██████▄█▄▄
███████ ████████▀▄▀███▄▄█▄▄
▄██▄▄████ ████████ ▀▄██▀▄▄▀
█▄▄██████ █▄▄██████
█▄▄▄▄█ █▄▄▄▄█
'''

13
salt/proxy/nxos.py
View file

@ -4,11 +4,12 @@ Proxy Minion for Cisco NX OS Switches
.. versionadded: Carbon
The Cisco NX OS Proxy Minion uses the built in SSHConnection module in `salt.utils.vt_helper`
The Cisco NX OS Proxy Minion uses the built in SSHConnection module in :mod:`salt.utils.vt_helper <salt.utils.vt_helper>`
To configure the proxy minion, include the following in
To configure the proxy minion:
.. code-block:: yaml
proxy:
proxytype: nxos
host: 192.168.187.100
@ -224,8 +225,8 @@ def check_password(username, password, encrypted=False):
.. code-block: bash
salt '*' nxos.cmd check_password username=admin password=admin
salt '*' nxos.cmd check_password username=admin \
password='$5$2fWwO2vK$s7.Hr3YltMNHuhywQQ3nfOd.gAPHgs3SOBYYdGT3E.A' \
salt '*' nxos.cmd check_password username=admin \\
password='$5$2fWwO2vK$s7.Hr3YltMNHuhywQQ3nfOd.gAPHgs3SOBYYdGT3E.A' \\
encrypted=True
'''
hash_algorithms = {'1': 'md5',
@ -266,8 +267,8 @@ def set_password(username, password, encrypted=False, role=None, crypt_salt=None
.. code-block:: bash
salt '*' nxos.cmd set_password admin TestPass
salt '*' nxos.cmd set_password admin \
password='$5$2fWwO2vK$s7.Hr3YltMNHuhywQQ3nfOd.gAPHgs3SOBYYdGT3E.A' \
salt '*' nxos.cmd set_password admin \\
password='$5$2fWwO2vK$s7.Hr3YltMNHuhywQQ3nfOd.gAPHgs3SOBYYdGT3E.A' \\
encrypted=True
'''
password_line = get_user(username)

11
salt/returners/rawfile_json.py
View file

@ -1,19 +1,20 @@
# -*- coding: utf-8 -*-
'''
Take data from salt and "return" it into a raw file containing the json, with one line per event.
Take data from salt and "return" it into a raw file containing the json, with
one line per event.
Add the following to the minion or master configuration file.
... code-block: yaml
.. code-block:: yaml
rawfile_json.filename: <path_to_output_file>
Default is /var/log/salt/events.
Default is ``/var/log/salt/events``.
Common use is to log all events on the master. This can generate a lot of
noise, so you may wish to configure batch processing and/or configure the
event_return_whitelist or event_return_blacklist to restrict the events
that are written.
:conf_master:`event_return_whitelist` or :conf_master:`event_return_blacklist`
to restrict the events that are written.
'''
# Import python libs

14
salt/returners/splunk.py
View file

@ -4,13 +4,15 @@
Send json response data to Splunk via the HTTP Event Collector
Requires the following config values to be specified in config or pillar:
splunk_http_forwader:
token: <splunk_http_forwarder_token>
indexer: <hostname/IP of Splunk indexer>
sourcetype: <Destination sourcetype for data>
index: <Destination index for data>
.. code-block:: yaml
Run a test by using salt-call test.ping --return splunk
splunk_http_forwarder:
token: <splunk_http_forwarder_token>
indexer: <hostname/IP of Splunk indexer>
sourcetype: <Destination sourcetype for data>
index: <Destination index for data>
Run a test by using ``salt-call test.ping --return splunk``
Written by Scott Pack (github.com/scottjpack)

21
salt/returners/zabbix_return.py
View file

@ -1,16 +1,21 @@
# -*- coding: utf-8 -*-
'''
Return salt data to Zabbix
The following Type: "Zabbix trapper" with "Type of information" Text items are required
Key: salt.trap.info
Key: salt.trap.average
Key: salt.trap.warning
Key: salt.trap.high
Key: salt.trap.disaster
The following Type: "Zabbix trapper" with "Type of information" Text items are required:
.. code-block:: cfg
Key: salt.trap.info
Key: salt.trap.average
Key: salt.trap.warning
Key: salt.trap.high
Key: salt.trap.disaster
To use the Zabbix returner, append '--return zabbix' to the salt command. ex:
.. code-block:: bash
To use the Zabbix returner, append '--return zabbix' to the salt command. ex:
.. code-block:: bash
salt '*' test.ping --return zabbix
'''

4
salt/runners/event.py
View file

@ -2,7 +2,7 @@
'''
Module for sending events using the runner system.
.. versionadded:: TBD
.. versionadded:: Carbon
'''
from __future__ import absolute_import
@ -18,7 +18,7 @@ def send(tag, data=None):
'''
Send an event with the given tag and data.
.. versionadded:: TBD
.. versionadded:: Carbon
This is useful for sending events directly to the master from the shell
with salt-run. It is also quite useful for sending events in orchestration

2
salt/states/ceph.py
View file

@ -61,7 +61,7 @@ def quorum(name, **kwargs):
Example usage in sls file:
. code-block:: yaml
.. code-block:: yaml
quorum:
sesceph.quorum:

2
salt/states/cisconso.py
View file

@ -5,7 +5,7 @@ State module for Cisco NSO Proxy minions
.. versionadded: Carbon
For documentation on setting up the cisconso proxy minion look in the documentation
for :doc:`salt.proxy.cisconso</ref/proxy/all/salt.proxy.cisconso>`.
for :mod:`salt.proxy.cisconso <salt.proxy.cisconso>`.
'''

2
salt/states/csf.py
View file

@ -255,7 +255,7 @@ def ports_open(name, ports, proto='tcp', direction='in'):
def nics_skip(name, nics, ipv6):
'''
Alias for func::csf.nics_skipped
Alias for :mod:`csf.nics_skipped <salt.states.csf.nics_skipped>`
'''
return nics_skipped(name, nics=nics, ipv6=ipv6)

2
salt/states/netntp.py
View file

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
'''
Network NTP
===============
===========
Configure NTP peers on the device via a salt proxy.

213
salt/states/pcs.py
View file

@ -13,139 +13,151 @@ with the Pacemaker/Corosync configuration system(PCS)
Walkthrough of a complete pcs cluster setup:
Requirements:
PCS is installed, pcs service is started and
the password for the hacluster user is set and known.
PCS is installed, pcs service is started and
the password for the hacluster user is set and known.
Remark on the cibname variable used in the examples:
The use of the cibname varible is optional.
Use it only if you want to deploy your changes into a cibfile first and then push it.
This makes only sense if you want to deploy multiple changes (which require each other) at ones to the cluster.
The use of the cibname varible is optional.
Use it only if you want to deploy your changes into a cibfile first and then push it.
This makes only sense if you want to deploy multiple changes (which require each other) at ones to the cluster.
At first the cibfile must be created:
.. code-block:: yaml
mysql_pcs__cib_present_cib_for_galera:
pcs.cib_present:
- cibname: cib_for_galera
- scope: None
- extra_args: None
.. code-block:: yaml
mysql_pcs__cib_present_cib_for_galera:
pcs.cib_present:
- cibname: cib_for_galera
- scope: None
- extra_args: None
Then the cibfile can be modified by creating resources (creating only 1 resource for demonstration, see also 7.):
.. code-block:: yaml
mysql_pcs__resource_present_galera:
pcs.resource_present:
- resource_id: galera
- resource_type: "ocf:heartbeat:galera"
- resource_options:
- 'wsrep_cluster_address=gcomm://node1.example.org,node2.example.org,node3.example.org'
- '--master'
- cibname: cib_for_galera
.. code-block:: yaml
mysql_pcs__resource_present_galera:
pcs.resource_present:
- resource_id: galera
- resource_type: "ocf:heartbeat:galera"
- resource_options:
- 'wsrep_cluster_address=gcomm://node1.example.org,node2.example.org,node3.example.org'
- '--master'
- cibname: cib_for_galera
After modifying the cibfile it can be pushed to the live CIB in the cluster:
.. code-block:: yaml
mysql_pcs__cib_pushed_cib_for_galera:
pcs.cib_pushed:
- cibname: cib_for_galera
- scope: None
- extra_args: None
.. code-block:: yaml
mysql_pcs__cib_pushed_cib_for_galera:
pcs.cib_pushed:
- cibname: cib_for_galera
- scope: None
- extra_args: None
Create a cluster from scratch:
1. Authorize nodes to each other:
.. code-block:: yaml
pcs_auth__auth:
pcs.auth:
- nodes:
- node1.example.com
- node2.example.com
- pcsuser: hacluster
- pcspasswd: hoonetorg
- extra_args: []
.. code-block:: yaml
pcs_auth__auth:
pcs.auth:
- nodes:
- node1.example.com
- node2.example.com
- pcsuser: hacluster
- pcspasswd: hoonetorg
- extra_args: []
2. Do the initial cluster setup:
.. code-block:: yaml
pcs_setup__setup:
pcs.cluster_setup:
- nodes:
- node1.example.com
- node2.example.com
- pcsclustername: pcscluster
- extra_args:
- '--start'
- '--enable'
.. code-block:: yaml
pcs_setup__setup:
pcs.cluster_setup:
- nodes:
- node1.example.com
- node2.example.com
- pcsclustername: pcscluster
- extra_args:
- '--start'
- '--enable'
3. Optional: Set cluster properties:
.. code-block:: yaml
pcs_properties__prop_has_value_no-quorum-policy:
pcs.prop_has_value:
- prop: no-quorum-policy
- value: ignore
- cibname: cib_for_cluster_settings
.. code-block:: yaml
pcs_properties__prop_has_value_no-quorum-policy:
pcs.prop_has_value:
- prop: no-quorum-policy
- value: ignore
- cibname: cib_for_cluster_settings
4. Optional: Set resource defaults:
.. code-block:: yaml
pcs_properties__resource_defaults_to_resource-stickiness:
pcs.resource_defaults_to:
- default: resource-stickiness
- value: 100
- cibname: cib_for_cluster_settings
.. code-block:: yaml
pcs_properties__resource_defaults_to_resource-stickiness:
pcs.resource_defaults_to:
- default: resource-stickiness
- value: 100
- cibname: cib_for_cluster_settings
5. Optional: Set resource op defaults:
.. code-block:: yaml
pcs_properties__resource_op_defaults_to_monitor-interval:
pcs.resource_op_defaults_to:
- op_default: monitor-interval
- value: 60s
- cibname: cib_for_cluster_settings
.. code-block:: yaml
pcs_properties__resource_op_defaults_to_monitor-interval:
pcs.resource_op_defaults_to:
- op_default: monitor-interval
- value: 60s
- cibname: cib_for_cluster_settings
6. Configure Fencing (!is not optional on production ready cluster!):
.. code-block:: yaml
pcs_stonith__created_eps_fence:
pcs.stonith_present:
- stonith_id: eps_fence
- stonith_device_type: fence_eps
- stonith_device_options:
- 'pcmk_host_map=node1.example.org:01;node2.example.org:02'
- 'ipaddr=myepsdevice.example.org'
- 'power_wait=5'
- 'verbose=1'
- 'debug=/var/log/pcsd/eps_fence.log'
- 'login=hidden'
- 'passwd=hoonetorg'
- cibname: cib_for_stonith
.. code-block:: yaml
pcs_stonith__created_eps_fence:
pcs.stonith_present:
- stonith_id: eps_fence
- stonith_device_type: fence_eps
- stonith_device_options:
- 'pcmk_host_map=node1.example.org:01;node2.example.org:02'
- 'ipaddr=myepsdevice.example.org'
- 'power_wait=5'
- 'verbose=1'
- 'debug=/var/log/pcsd/eps_fence.log'
- 'login=hidden'
- 'passwd=hoonetorg'
- cibname: cib_for_stonith
7. Add resources to your cluster:
.. code-block:: yaml
mysql_pcs__resource_present_galera:
pcs.resource_present:
- resource_id: galera
- resource_type: "ocf:heartbeat:galera"
- resource_options:
- 'wsrep_cluster_address=gcomm://node1.example.org,node2.example.org,node3.example.org'
.. code-block:: yaml
mysql_pcs__resource_present_galera:
pcs.resource_present:
- resource_id: galera
- resource_type: "ocf:heartbeat:galera"
- resource_options:
- 'wsrep_cluster_address=gcomm://node1.example.org,node2.example.org,node3.example.org'
- '--master'
- cibname: cib_for_galera
8. Optional: Add constraints (locations, colocations, orders):
.. code-block:: yaml
haproxy_pcs__constraint_present_colocation-vip_galera-haproxy-clone-INFINITY:
pcs.constraint_present:
- constraint_id: colocation-vip_galera-haproxy-clone-INFINITY
- constraint_type: colocation
- constraint_options:
- 'add'
- 'vip_galera'
- 'with'
- 'haproxy-clone'
- cibname: cib_for_haproxy
.. code-block:: yaml
haproxy_pcs__constraint_present_colocation-vip_galera-haproxy-clone-INFINITY:
pcs.constraint_present:
- constraint_id: colocation-vip_galera-haproxy-clone-INFINITY
- constraint_type: colocation
- constraint_options:
- 'add'
- 'vip_galera'
- 'with'
- 'haproxy-clone'
- cibname: cib_for_haproxy
.. versionadded:: 2016.3.0
'''
@ -356,6 +368,7 @@ def auth(name, nodes, pcsuser='hacluster', pcspasswd='hacluster', extra_args=Non
Example:
.. code-block:: yaml
pcs_auth__auth:
pcs.auth:
- nodes:
@ -442,6 +455,7 @@ def cluster_setup(name, nodes, pcsclustername='pcscluster', extra_args=None):
Example:
.. code-block:: yaml
pcs_setup__setup:
pcs.cluster_setup:
- nodes:
@ -529,6 +543,7 @@ def cluster_node_present(name, node, extra_args=None):
Example:
.. code-block:: yaml
pcs_setup__node_add_node1.example.com:
pcs.cluster_node_present:
- node: node1.example.com
@ -626,6 +641,7 @@ def cib_present(name, cibname, scope=None, extra_args=None):
Example:
.. code-block:: yaml
mysql_pcs__cib_present_cib_for_galera:
pcs.cib_present:
- cibname: cib_for_galera
@ -741,6 +757,7 @@ def cib_pushed(name, cibname, scope=None, extra_args=None):
Example:
.. code-block:: yaml
mysql_pcs__cib_pushed_cib_for_galera:
pcs.cib_pushed:
- cibname: cib_for_galera
@ -815,6 +832,7 @@ def prop_has_value(name, prop, value, extra_args=None, cibname=None):
Example:
.. code-block:: yaml
pcs_properties__prop_has_value_no-quorum-policy:
pcs.prop_has_value:
- prop: no-quorum-policy
@ -852,6 +870,7 @@ def resource_defaults_to(name, default, value, extra_args=None, cibname=None):
Example:
.. code-block:: yaml
pcs_properties__resource_defaults_to_resource-stickiness:
pcs.resource_defaults_to:
- default: resource-stickiness
@ -890,6 +909,7 @@ def resource_op_defaults_to(name, op_default, value, extra_args=None, cibname=No
Example:
.. code-block:: yaml
pcs_properties__resource_op_defaults_to_monitor-interval:
pcs.resource_op_defaults_to:
- op_default: monitor-interval
@ -928,6 +948,7 @@ def stonith_present(name, stonith_id, stonith_device_type, stonith_device_option
Example:
.. code-block:: yaml
pcs_stonith__created_eps_fence:
pcs.stonith_present:
- stonith_id: eps_fence
@ -972,6 +993,7 @@ def resource_present(name, resource_id, resource_type, resource_options=None, ci
Example:
.. code-block:: yaml
mysql_pcs__resource_present_galera:
pcs.resource_present:
- resource_id: galera
@ -1011,6 +1033,7 @@ def constraint_present(name, constraint_id, constraint_type, constraint_options=
Example:
.. code-block:: yaml
haproxy_pcs__constraint_present_colocation-vip_galera-haproxy-clone-INFINITY:
pcs.constraint_present:
- constraint_id: colocation-vip_galera-haproxy-clone-INFINITY

27
salt/states/probes.py
View file

@ -13,7 +13,7 @@ Configure RPM (JunOS)/SLA (Cisco) probes on the device via NAPALM proxy.
Dependencies
------------
- :doc:`napalm probes management module (salt.modules.napalm_probes) </ref/modules/all/salt.modules.napalm_probes>`
- :mod:`napalm probes management module <salt.modules.napalm_probes>`
.. versionadded: Carbon
'''
@ -283,20 +283,21 @@ def managed(name, probes, defaults=None):
test_interval: 3
probe_type: icmp-ping
In the probes configuration, the only mandatory attribute is *target* (specified either in probes configuration,
either in the defaults dictionary).
All the other parameters will use the operating system defaults, if not provided:
In the probes configuration, the only mandatory attribute is *target*
(specified either in probes configuration, either in the defaults
dictionary). All the other parameters will use the operating system
defaults, if not provided:
* source: Specifies the source IP Address to be used during the tests.
If not specified will use the IP Address of the logical interface loopback0.
* target: Destination IP Address.
* probe_count: Total number of probes per test (1..15). System defaults: 1 on both JunOS & Cisco.
* probe_interval: Delay between tests (0..86400 seconds). System defaults: 3 on JunOS, 5 on Cisco.
* probe_type: Probe request type. Available options:
* source: Specifies the source IP Address to be used during the tests.
If not specified will use the IP Address of the logical interface loopback0.
* target: Destination IP Address.
* probe_count: Total number of probes per test (1..15). System defaults: 1 on both JunOS & Cisco.
* probe_interval: Delay between tests (0..86400 seconds). System defaults: 3 on JunOS, 5 on Cisco.
* probe_type: Probe request type. Available options:
* icmp-ping
* tcp-ping
* udp-ping
* icmp-ping
* tcp-ping
* udp-ping
Using the example configuration above, after running the state, on the device will be configured 4 probes,
with the following properties:

4
salt/states/snapper.py
View file

@ -75,8 +75,8 @@ Once you take a new snapshot and you update the baseline snapshot number to
include the change in ``/etc/hosts`` the ``hosts_entry`` rule will basically
do nothing. You are free to leave it there for documentation, to ensure that
the change is made in case the snapshot is wrong, but if you remove anything
that comes after the ``snapper.baseline_snapshot`` as it will have no effect:
by the moment the state is evaluated, the baseline state was already applied
that comes after the ``snapper.baseline_snapshot`` as it will have no effect;
by the moment the state is evaluated, the baseline state was already applied
and include this change.
.. warning::

2
salt/states/win_smtp_server.py
View file

@ -186,7 +186,7 @@ def connection_ip_list(name, addresses=None, grant_by_default=False, server=_DEF
Example of usage for creating a blacklist:
.. code-block:: yaml
.. code-block:: yaml
smtp-connection-blacklist:
win_smtp_server.connection_ip_list:

17
salt/thorium/calc.py
View file

@ -30,15 +30,14 @@ def calc(name, num, oper, minimum=0, maximum=0, ref=None):
Perform a calculation on the ``num`` most recent values. Requires a list.
Valid values for ``oper`` are:
- add: Add last ``num`` values together
- mul: Multiple last ``num`` values together
- mean: Calculate mean of last ``num`` values
- median: Calculate median of last ``num`` values
- median_low: Calculate low median of last ``num`` values
- median_high: Calculate high median of last ``num`` values
- median_grouped: Calculate grouped median of last ``num`` values
- mode: Calculate mode of last ``num`` values
- add: Add last ``num`` values together
- mul: Multiple last ``num`` values together
- mean: Calculate mean of last ``num`` values
- median: Calculate median of last ``num`` values
- median_low: Calculate low median of last ``num`` values
- median_high: Calculate high median of last ``num`` values
- median_grouped: Calculate grouped median of last ``num`` values
- mode: Calculate mode of last ``num`` values
USAGE: