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

Update autodoc topics for new modules added in develop

Browse source 
Also adjusted versionadded tags as necessary on the files that
are getting new autodoc files added.
This commit is contained in:
rallytime 2017-01-30 21:49:56 +00:00
parent 8cd74af1e4
commit d398c5f7ee
74 changed files with 330 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/ref/beacons/all/index.rst
View file

@ -20,6 +20,7 @@ beacon modules
inotify
journald
load
log
memusage
network_info
network_settings

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

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

2
doc/ref/engines/all/index.rst
View file

@ -14,12 +14,14 @@ engine modules
hipchat
http_logstash
ircbot
junos_syslog
logentries
logstash
reactor
redis_sentinel
slack
sqs_events
stalekey
test
thorium
webhook

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

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

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

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

15
doc/ref/modules/all/index.rst
View file

@ -24,6 +24,7 @@ execution modules
apache
apcups
apf
apk
aptpkg
archive
artifactory
@ -37,6 +38,7 @@ execution modules
bigip
blockdev
bluez
boto3_elasticache
boto_apigateway
boto_asg
boto_cfn
@ -47,11 +49,13 @@ execution modules
boto_datapipeline
boto_dynamodb
boto_ec2
boto_efs
boto_elasticache
boto_elasticsearch_domain
boto_elb
boto_iam
boto_iot
boto_kinesis
boto_kms
boto_lambda
boto_rds
@ -123,6 +127,7 @@ execution modules
file
firewalld
freebsd_sysctl
freebsd_update
freebsdjail
freebsdkmod
freebsdpkg
@ -138,6 +143,7 @@ execution modules
glusterfs
gnomedesktop
gpg
grafana4
grains
groupadd
grub_legacy
@ -145,6 +151,7 @@ execution modules
hadoop
haproxyconn
hashutil
heat
hg
hipchat
hosts
@ -153,6 +160,7 @@ execution modules
ifttt
ilo
img
incinga2
incron
influx
influx08
@ -218,6 +226,7 @@ execution modules
makeconf
marathon
match
mattermost
mdadm
mdata
memcached
@ -235,6 +244,11 @@ execution modules
nacl
nagios
nagios_rpc
namecheap_dns
namecheap_domains
namecheap_ns
namecheap_ssl
namecheap_users
napalm_bgp
napalm_network
napalm_ntp
@ -354,6 +368,7 @@ execution modules
solarisips
solarispkg
solr
solrcloud
splunk
splunk_search
sqlite3

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3
doc/ref/pillar/all/index.rst
View file

@ -35,6 +35,7 @@ pillar modules
nodegroups
pepa
pillar_ldap
postgres
puppet
reclass_adapter
redismod
@ -47,3 +48,5 @@ pillar modules
varstack_pillar
vault
virtkey
vmware_pillar

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

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

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

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

1
doc/ref/renderers/all/index.rst
View file

@ -20,6 +20,7 @@ renderer modules
json5
mako
msgpack
pass
py
pydsl
pyobjects

6
doc/ref/renderers/all/salt.renderers.pass.rst Normal file
View file

@ -0,0 +1,6 @@
salt.renderers.pass module
==========================
.. automodule:: salt.renderers.pass
:members:
:undoc-members:

2
doc/ref/returners/all/index.rst
View file

@ -18,11 +18,13 @@ returner modules
django_return
elasticsearch_return
etcd_return
highstate_return
hipchat_return
influxdb_return
kafka_return
local
local_cache
mattermost_returner
memcache_return
mongo_future_return
mongo_return

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

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

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

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

1
doc/ref/runners/all/index.rst
View file

@ -28,6 +28,7 @@ runner modules
launchd
lxc
manage
mattermost
mine
nacl
net

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

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

3
doc/ref/sdb/all/index.rst
View file

@ -19,4 +19,7 @@ sdb modules
memcached
rest
sqlite3
tism
vault
yaml

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

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

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

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

13
doc/ref/states/all/index.rst
View file

@ -26,6 +26,7 @@ state modules
beacon
bigip
blockdev
boto3_eleasticache
boto_apigateway
boto_asg
boto_cfn
@ -42,6 +43,7 @@ state modules
boto_iam
boto_iam_role
boto_iot
boto_kinesis
boto_kms
boto_lambda
boto_lc
@ -91,20 +93,28 @@ state modules
gnomedesktop
gpg
grafana
grafana4_dashboard
grafana4_datasource
grafana4_org
grafana4_user
grafana_dashboard
grafana_datasource
grains
group
heat
hg
hipchat
host
htpasswd
http
icinga2
ifttt
incron
influxdb08_database
influxdb08_user
influxdb_continuous_query
influxdb_database
influxdb_retention_policy
influxdb_user
infoblox
ini_manage
@ -124,6 +134,7 @@ state modules
libcloud_dns
linux_acl
locale
logrotate
lvm
lvs_server
lvs_service
@ -215,6 +226,7 @@ state modules
smartos
smtp
snapper
solrcloud
splunk
splunk_search
sqlite3
@ -260,6 +272,7 @@ state modules
win_snmp
win_system
win_update
win_wua
winrepo
x509
xmpp

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2
salt/beacons/log.py
View file

@ -2,7 +2,7 @@
'''
Beacon to fire events at specific log messages.
.. code-block:: yaml
.. versionadded:: Nitrogen
'''

2
salt/modules/boto_kinesis.py
View file

@ -2,7 +2,7 @@
'''
Connection module for Amazon Kinesis
.. versionadded:: develop
.. versionadded:: Nitrogen
:configuration: This module accepts explicit Kinesis credentials but can also
utilize IAM roles assigned to the instance trough Instance Profiles.

2
salt/modules/freebsd_update.py
View file

@ -2,6 +2,8 @@
'''
Support for freebsd-update utility on FreeBSD.
.. versionadded:: Nitrogen
:maintainer: George Mamalakis <mamalos@gmail.com>
:maturity: new
:platform: FreeBSD

2
salt/modules/grafana4.py
View file

@ -2,6 +2,8 @@
'''
Module for working with the Grafana v4 API
.. versionadded:: Nitrogen
:depends: requests
:configuration: This module requires a configuration profile to be configured

2
salt/modules/heat.py
View file

@ -2,6 +2,8 @@
'''
Module for handling OpenStack Heat calls
.. versionadded:: Nitrogen
:depends: - heatclient Python module
:configuration: This module is not usable until the user, password, tenant, and
auth URL are specified either in a pillar or in the minion's config file.

2
salt/modules/icinga2.py
View file

@ -2,6 +2,8 @@
'''
Module to provide icinga2 compatibility to salt.
.. versionadded:: Nitrogen
:depends: - icinga2 server
'''

2
salt/modules/mattermost.py
View file

@ -2,6 +2,8 @@
'''
Module for sending messages to Mattermost
.. versionadded:: Nitrogen
:configuration: This module can be used by either passing an api_url and hook
directly or by specifying both in a configuration profile in the salt
master/minion config.

2
salt/modules/namecheap_ns.py
View file

@ -2,6 +2,8 @@
'''
Namecheap management
.. versionadded:: Nitrogen
General Notes
-------------

2
salt/pillar/postgres.py
View file

@ -2,6 +2,8 @@
'''
Retrieve Pillar data by doing a postgres query
.. versionadded:: Nitrogen
:maturity: new
:depends: psycopg2
:platform: all

2
salt/renderers/pass.py
View file

@ -4,6 +4,8 @@ Pass Renderer for Salt
[pass](https://www.passwordstore.org/)
.. versionadded:: Nitrogen
# Setup
__Note__: `<user>` needs to be replaced with the user salt-master will be
running as

2
salt/returners/highstate_return.py
View file

@ -3,6 +3,8 @@
Return the results of a highstate (or any other state function that returns
data in a compatible format) via an HTML email or HTML file.
.. versionadded:: Nitrogen
Similar results can be achieved by using smtp returner with a custom template,
except an attempt at writing such a template for the complex data structure
returned by highstate function had proven to be a challenge, not to mention

3
salt/returners/mattermost_returner.py
View file

@ -1,6 +1,9 @@
# -*- coding: utf-8 -*-
'''
Return salt data via mattermost
.. versionadded:: Nitrogen
The following fields can be set in the minion conf file::
.. code-block:: yaml
mattermost.hook (required)

2
salt/runners/mattermost.py
View file

@ -2,6 +2,8 @@
'''
Module for sending messages to Mattermost
.. versionadded:: Nitrogen
:configuration: This module can be used by either passing an api_url and hook
directly or by specifying both in a configuration profile in the salt
master/minion config.

2
salt/sdb/tism.py
View file

@ -6,7 +6,7 @@ tISM - the Immutalbe Secrets Manager SDB Module
:maturity: New
:platform: all
.. versionadded:: TBD
.. versionadded:: Nitrogen
This module will decrypt PGP encrypted secrets against a tISM server.

2
salt/states/boto_kinesis.py
View file

@ -3,7 +3,7 @@
Manage Kinesis Streams
======================
.. versionadded:: develop
.. versionadded:: Nitrogen
Create and destroy Kinesis streams. Be aware that this interacts with Amazon's
services, and so may incur charges.

2
salt/states/grafana4_dashboard.py
View file

@ -2,6 +2,8 @@
'''
Manage Grafana v4.0 Dashboards
.. versionadded:: Nitrogen
.. code-block:: yaml
grafana:

2
salt/states/grafana4_datasource.py
View file

@ -2,6 +2,8 @@
'''
Manage Grafana v4.0 data sources
.. versionadded:: Nitrogen
Token auth setup
.. code-block:: yaml

2
salt/states/grafana4_org.py
View file

@ -2,6 +2,8 @@
'''
Manage Grafana v4.0 orgs
.. versionadded:: Nitrogen
Token auth setup
.. code-block:: yaml

2
salt/states/grafana4_user.py
View file

@ -2,6 +2,8 @@
'''
Manage Grafana v4.0 users
.. versionadded:: Nitrogen
Token auth setup
.. code-block:: yaml

4
salt/states/heat.py
View file

@ -1,7 +1,9 @@
# -*- coding: utf-8 -*-
'''
Management of Heat
=======================================
==================
.. versionadded:: Nitrogen
:depends: - heat Python module
:configuration: See :py:mod:`salt.modules.heat` for setup instructions.

4
salt/states/icinga2.py
View file

@ -1,9 +1,9 @@
# -*- coding: utf-8 -*-
'''
Icinga2 state
==========================
=============
.. versionadded:: TODO
.. versionadded:: Nitrogen
:depends: - Icinga2 Python module
:configuration: See :py:mod:`salt.modules.icinga2` for setup instructions.

2
salt/states/influxdb_continuous_query.py
View file

@ -3,6 +3,8 @@
Management of Influxdb continuous queries
=========================================
.. versionadded:: Nitrogen
(compatible with InfluxDB version 0.9+)
'''

2
salt/states/influxdb_retention_policy.py
View file

@ -3,6 +3,8 @@
Management of Influxdb retention policies
=========================================
.. versionadded:: Nitrogen
(compatible with InfluxDB version 0.9+)
'''

3
salt/states/logrotate.py
View file

@ -1,6 +1,9 @@
# -*- coding: utf-8 -*-
'''
Module for managing logrotate.
.. versionadded:: Nitrogen
'''
# Import python libs

8
salt/states/solrcloud.py
View file

@ -1,9 +1,13 @@
# -*- coding: utf-8 -*-
'''
States for solrcloud alias and collection configuration
'''
from __future__ import absolute_import
.. versionadded:: Nitrogen
'''
# Import Python libs
from __future__ import absolute_import
import json

2
salt/states/win_wua.py
View file

@ -2,6 +2,8 @@
'''
Installation of Windows Updates using the Windows Update Agent
.. versionadded:: Nitrogen
Salt can manage Windows updates via the "wua" state module. Updates can be
installed and removed. Update management declarations are as follows: