mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
Added new modules, states, returners docs
This commit is contained in:
parent
75219efef1
commit
b54d4ee573
24 changed files with 125 additions and 12 deletions
|
@ -47,6 +47,7 @@ MOCK_MODULES = [
|
|||
'rpm',
|
||||
'rpmUtils',
|
||||
'rpmUtils.arch',
|
||||
'pycassa',
|
||||
]
|
||||
|
||||
for mod_name in MOCK_MODULES:
|
||||
|
|
|
@ -18,10 +18,13 @@ Full list of builtin modules
|
|||
cmd
|
||||
cp
|
||||
cron
|
||||
data
|
||||
disk
|
||||
ebuild
|
||||
file
|
||||
freebsdkmod
|
||||
freebsdpkg
|
||||
gentoo_service
|
||||
grains
|
||||
groupadd
|
||||
hosts
|
||||
|
@ -33,11 +36,14 @@ Full list of builtin modules
|
|||
mysql
|
||||
network
|
||||
pacman
|
||||
pip
|
||||
ps
|
||||
publish
|
||||
puppet
|
||||
pw_group
|
||||
pw_user
|
||||
rh_service
|
||||
saltutil
|
||||
selinux
|
||||
service
|
||||
shadow
|
||||
|
@ -45,8 +51,14 @@ Full list of builtin modules
|
|||
ssh
|
||||
state
|
||||
status
|
||||
systemd
|
||||
test
|
||||
tomcat
|
||||
useradd
|
||||
virt
|
||||
virtualenv
|
||||
win_disk
|
||||
win_service
|
||||
win_useradd
|
||||
yumpkg
|
||||
yumpkg5
|
||||
|
|
6
doc/ref/modules/all/salt.modules.data.rst
Normal file
6
doc/ref/modules/all/salt.modules.data.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
=================
|
||||
salt.modules.data
|
||||
=================
|
||||
|
||||
.. automodule:: salt.modules.data
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.freebsdkmod.rst
Normal file
6
doc/ref/modules/all/salt.modules.freebsdkmod.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
========================
|
||||
salt.modules.freebsdkmod
|
||||
========================
|
||||
|
||||
.. automodule:: salt.modules.freebsdkmod
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.gentoo_service.rst
Normal file
6
doc/ref/modules/all/salt.modules.gentoo_service.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
===========================
|
||||
salt.modules.gentoo_service
|
||||
===========================
|
||||
|
||||
.. automodule:: salt.modules.gentoo_service
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.pip.rst
Normal file
6
doc/ref/modules/all/salt.modules.pip.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
================
|
||||
salt.modules.pip
|
||||
================
|
||||
|
||||
.. automodule:: salt.modules.pip
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.rh_service.rst
Normal file
6
doc/ref/modules/all/salt.modules.rh_service.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
=======================
|
||||
salt.modules.rh_service
|
||||
=======================
|
||||
|
||||
.. automodule:: salt.modules.rh_service
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.saltutil.rst
Normal file
6
doc/ref/modules/all/salt.modules.saltutil.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
=====================
|
||||
salt.modules.saltutil
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.modules.saltutil
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.systemd.rst
Normal file
6
doc/ref/modules/all/salt.modules.systemd.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
====================
|
||||
salt.modules.systemd
|
||||
====================
|
||||
|
||||
.. automodule:: salt.modules.systemd
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.virtualenv.rst
Normal file
6
doc/ref/modules/all/salt.modules.virtualenv.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
=======================
|
||||
salt.modules.virtualenv
|
||||
=======================
|
||||
|
||||
.. automodule:: salt.modules.virtualenv
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.win_disk.rst
Normal file
6
doc/ref/modules/all/salt.modules.win_disk.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
=====================
|
||||
salt.modules.win_disk
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.modules.win_disk
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.win_service.rst
Normal file
6
doc/ref/modules/all/salt.modules.win_service.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
========================
|
||||
salt.modules.win_service
|
||||
========================
|
||||
|
||||
.. automodule:: salt.modules.win_service
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.win_useradd.rst
Normal file
6
doc/ref/modules/all/salt.modules.win_useradd.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
========================
|
||||
salt.modules.win_useradd
|
||||
========================
|
||||
|
||||
.. automodule:: salt.modules.win_useradd
|
||||
:members:
|
6
doc/ref/modules/all/salt.modules.yumpkg5.rst
Normal file
6
doc/ref/modules/all/salt.modules.yumpkg5.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
====================
|
||||
salt.modules.yumpkg5
|
||||
====================
|
||||
|
||||
.. automodule:: salt.modules.yumpkg5
|
||||
:members:
|
|
@ -11,5 +11,6 @@ Full list of builtin returners
|
|||
:template: autosummary.rst.tmpl
|
||||
|
||||
local
|
||||
cassandra_return
|
||||
mongo_return
|
||||
redis_return
|
||||
|
|
|
@ -0,0 +1,6 @@
|
|||
===============================
|
||||
salt.returners.cassandra_return
|
||||
===============================
|
||||
|
||||
.. automodule:: salt.returners.cassandra_return
|
||||
:members:
|
|
@ -17,8 +17,11 @@ Full list of builtin states
|
|||
host
|
||||
kmod
|
||||
mount
|
||||
mysql_database
|
||||
mysql_user
|
||||
pkg
|
||||
service
|
||||
ssh_auth
|
||||
sysctl
|
||||
user
|
||||
virtualenv
|
||||
|
|
6
doc/ref/states/all/salt.states.mysql_database.rst
Normal file
6
doc/ref/states/all/salt.states.mysql_database.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
==========================
|
||||
salt.states.mysql_database
|
||||
==========================
|
||||
|
||||
.. automodule:: salt.states.mysql_database
|
||||
:members:
|
6
doc/ref/states/all/salt.states.mysql_user.rst
Normal file
6
doc/ref/states/all/salt.states.mysql_user.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
======================
|
||||
salt.states.mysql_user
|
||||
======================
|
||||
|
||||
.. automodule:: salt.states.mysql_user
|
||||
:members:
|
6
doc/ref/states/all/salt.states.virtualenv.rst
Normal file
6
doc/ref/states/all/salt.states.virtualenv.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
======================
|
||||
salt.states.virtualenv
|
||||
======================
|
||||
|
||||
.. automodule:: salt.states.virtualenv
|
||||
:members:
|
|
@ -79,7 +79,7 @@ def stop(name):
|
|||
|
||||
CLI Example::
|
||||
|
||||
salt '*' service.stop <service name>
|
||||
salt '*' service.stop <service name>
|
||||
'''
|
||||
cmd = 'systemctl stop {0}.service'.format(name)
|
||||
return not __salt__['cmd.retcode'](cmd)
|
||||
|
|
|
@ -2,14 +2,14 @@
|
|||
Return data to a Cassandra ColumFamily
|
||||
|
||||
Here's an example Keyspace/ColumnFamily setup that works with this
|
||||
returner:
|
||||
returner::
|
||||
|
||||
create keyspace salt;
|
||||
use salt;
|
||||
create column family returns
|
||||
with key_validation_class='UTF8Type'
|
||||
and comparator='UTF8Type'
|
||||
and default_validation_class='UTF8Type';
|
||||
create keyspace salt;
|
||||
use salt;
|
||||
create column family returns
|
||||
with key_validation_class='UTF8Type'
|
||||
and comparator='UTF8Type'
|
||||
and default_validation_class='UTF8Type';
|
||||
'''
|
||||
|
||||
import logging
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
'''
|
||||
MySQL Database Management
|
||||
===============
|
||||
=========================
|
||||
The mysql_database module is used to create and manage MySQL databases, databases can be set
|
||||
as either absent or present
|
||||
|
||||
|
@ -58,4 +58,4 @@ def absent(name):
|
|||
|
||||
# fallback
|
||||
ret['comment'] = 'Database {0} is not present, so it cannot be removed'.format(name)
|
||||
return ret
|
||||
return ret
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
'''
|
||||
MySQL User Management
|
||||
===============
|
||||
=====================
|
||||
The mysql_database module is used to create and manage MySQL databases, databases can be set
|
||||
as either absent or present
|
||||
|
||||
|
@ -63,4 +63,4 @@ def absent(name,
|
|||
|
||||
# fallback
|
||||
ret['comment'] = 'User {0}@{1} is not present, so it cannot be removed'.format(name,host,)
|
||||
return ret
|
||||
return ret
|
||||
|
|
Loading…
Add table
Reference in a new issue