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

Merge pull request #30599 from multani/fix/docs

Browse source 
Documentation formatting fixes
This commit is contained in:
Nicole Thomas 2016-01-25 08:37:46 -07:00
commit 3a55d11916
11 changed files with 106 additions and 125 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/ref/index.rst
View file

@ -35,3 +35,4 @@ Reference
engines/all/index
sdb/all/index
serializers/all/index
queues/all/index

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

@ -1,4 +1,4 @@
.. _all-salt.modules:
.. _all-salt_modules:
======================================
Full list of builtin execution modules
@ -236,7 +236,6 @@ Full list of builtin execution modules
redismod
reg
rest_package
rest_sample
rest_service
ret
rh_ip
@ -291,7 +290,6 @@ Full list of builtin execution modules
sysrc
system
system_profiler
system_rest_sample
systemd
temp
test

6
doc/ref/modules/all/salt.modules.rest_sample.rst
View file

@ -1,6 +0,0 @@
========================
salt.modules.rest_sample
========================
.. automodule:: salt.modules.rest_sample
:members:

6
doc/ref/modules/all/salt.modules.system_rest_sample.rst
View file

@ -1,6 +0,0 @@
===============================
salt.modules.system_rest_sample
===============================
.. automodule:: salt.modules.system_rest_sample
:members:

13
doc/ref/queues/all/index.rst Normal file
View file

@ -0,0 +1,13 @@
.. _all-salt.queues:
===========================
Full list of builtin queues
===========================
.. currentmodule:: salt.queues
.. autosummary::
:toctree:
:template: autosummary.rst.tmpl
sqlite_queue

14
doc/topics/cloud/gce.rst
View file

@ -60,13 +60,13 @@ Google Compute Engine Setup
#. Key Format
*If you are using ``libcloud >= 0.17.0`` it is recommended that you use the ``JSON
format`` file you downloaded above and skip to the `Provider Configuration`_ section
below, using the JSON file **_in place of 'NEW.pem'_** in the documentation.
If you are using an older version of libcloud or are unsure of the version you
have, please follow the instructions below to generate and format a new P12 key.*
.. note:: If you are using ``libcloud >= 0.17.0`` it is recommended that you use the ``JSON
format`` file you downloaded above and skip to the `Provider Configuration`_ section
below, using the JSON file **in place of 'NEW.pem'** in the documentation.
If you are using an older version of libcloud or are unsure of the version you
have, please follow the instructions below to generate and format a new P12 key.
In the new *Service Account* section, click *Generate new P12 key*, which
will automatically download a ``.p12`` private key file. The ``.p12``
private key needs to be converted to a format compatible with libcloud.

6
doc/topics/troubleshooting/yaml_idiosyncrasies.rst
View file

@ -272,8 +272,8 @@ This shell command can find wrong characters in your SLS files:
Alternatively you can toggle the `yaml_utf8` setting in your master configuration
file. This is still an experimental setting but it should manage the right
encoding conversion in salt after yaml states compilations.
file. This is still an experimental setting but it should manage the right
encoding conversion in salt after yaml states compilations.
Underscores stripped in Integer Definitions
===========================================
@ -339,4 +339,4 @@ string with quotes:
return datetime.date(year, month, day)
ValueError: month must be in 1..12
>>> yaml.safe_load('"4017-16-20"')
'4017-16-20'
'4017-16-20'

95
salt/modules/ipmi.py
View file

@ -200,46 +200,56 @@ def set_channel_access(channel=14, access_update_mode='non_volatile',
- 'volatile' = set volatile (active) setting of Channel Access
:param alerting: PEF Alerting Enable/Disable
- True = enable PEF Alerting
- False = disable PEF Alerting on this channel
(Alert Immediate command can still be used to generate alerts)
(Alert Immediate command can still be used to generate alerts)
:param per_msg_auth: Per-message Authentication
- True = enable
- False = disable Per-message Authentication. [Authentication required to
activate any session on this channel, but authentication not
used on subsequent packets for the session.]
activate any session on this channel, but authentication not used on
subsequent packets for the session.]
:param user_level_auth: User Level Authentication Enable/Disable.
- True = enable User Level Authentication. All User Level commands are
to be authenticated per the Authentication Type that was
negotiated when the session was activated.
to be authenticated per the Authentication Type that was
negotiated when the session was activated.
- False = disable User Level Authentication. Allow User Level commands to
be executed without being authenticated.
If the option to disable User Level Command authentication is
accepted, the BMC will accept packets with Authentication Type
set to None if they contain user level commands.
For outgoing packets, the BMC returns responses with the same
Authentication Type that was used for the request.
be executed without being authenticated.
If the option to disable User Level Command authentication is
accepted, the BMC will accept packets with Authentication Type
set to None if they contain user level commands.
For outgoing packets, the BMC returns responses with the same
Authentication Type that was used for the request.
:param access_mode: Access Mode for IPMI messaging
(PEF Alerting is enabled/disabled separately from IPMI messaging)
* disabled = disabled for IPMI messaging
* pre_boot = pre-boot only channel only available when system is in a
powered down state or in BIOS prior to start of boot.
powered down state or in BIOS prior to start of boot.
* always = channel always available regardless of system mode.
BIOS typically dedicates the serial connection to the BMC.
BIOS typically dedicates the serial connection to the BMC.
* shared = same as always available, but BIOS typically leaves the
serial port available for software use.
serial port available for software use.
:param privilege_update_mode: Channel Privilege Level Limit.
This value sets the maximum privilege level
that can be accepted on the specified channel.
This value sets the maximum privilege level that can be accepted on the
specified channel.
* dont_change = don't set or change channel Privilege Level Limit
* non_volatile = non-volatile Privilege Level Limit according
* volatile = volatile setting of Privilege Level Limit
:param privilege_level: Channel Privilege Level Limit
* reserved = unused
* callback
* user
@ -358,37 +368,38 @@ def set_user_access(uid, channel=14, callback=True, link_auth=True, ipmi_msg=Tru
:param channel: number [1:7]
:parm callback: User Restricted to Callback
False = User Privilege Limit is determined by the User Privilege Limit
parameter, below, for both callback and non-callback connections.
True = User Privilege Limit is determined by the User Privilege Limit
parameter for callback connections, but is restricted to Callback
level for non-callback connections. Thus, a user can only initiate
a Callback when they 'call in' to the BMC, but once the callback
connection has been made, the user could potentially establish a
session as an Operator.
- False = User Privilege Limit is determined by the User Privilege Limit
parameter, below, for both callback and non-callback connections.
- True = User Privilege Limit is determined by the User Privilege Limit
parameter for callback connections, but is restricted to Callback
level for non-callback connections. Thus, a user can only initiate
a Callback when they 'call in' to the BMC, but once the callback
connection has been made, the user could potentially establish a
session as an Operator.
:param link_auth: User Link authentication
enable/disable (used to enable whether this
user's name and password information will be used for link
authentication, e.g. PPP CHAP) for the given channel. Link
authentication itself is a global setting for the channel and is
enabled/disabled via the serial/modem configuration parameters.
enable/disable (used to enable whether this
user's name and password information will be used for link
authentication, e.g. PPP CHAP) for the given channel. Link
authentication itself is a global setting for the channel and is
enabled/disabled via the serial/modem configuration parameters.
:param ipmi_msg: User IPMI Messaging:
(used to enable/disable whether
this user's name and password information will be used for IPMI
Messaging. In this case, 'IPMI Messaging' refers to the ability to
execute generic IPMI commands that are not associated with a
particular payload type. For example, if IPMI Messaging is disabled for
a user, but that user is enabled for activating the SOL
payload type, then IPMI commands associated with SOL and session
management, such as Get SOL Configuration Parameters and Close Session
are available, but generic IPMI commands such as Get SEL Time are
unavailable.)
(used to enable/disable whether this user's name and password
information will be used for IPMI Messaging. In this case, 'IPMI
Messaging' refers to the ability to execute generic IPMI commands that
are not associated with a particular payload type. For example, if IPMI
Messaging is disabled for a user, but that user is enabled for
activating the SOL payload type, then IPMI commands associated with SOL
and session management, such as Get SOL Configuration Parameters and
Close Session are available, but generic IPMI commands such as Get SEL
Time are unavailable.)
:param privilege_level: User Privilege Limit.
(Determines the maximum privilege level that the user is allowed to
switch to on the specified channel.)
:param privilege_level:
User Privilege Limit. (Determines the maximum privilege level that the
user is allowed to switch to on the specified channel.)
- callback
- user
- operator

6
salt/modules/osquery.py
View file

@ -425,7 +425,7 @@ def last(attrs=None, where=None):
def listening_ports(attrs=None, where=None):
r'''
Return listening_ports_ information from osquery
Return listening_ports information from osquery
CLI Example:
@ -438,7 +438,7 @@ def listening_ports(attrs=None, where=None):
def logged_in_users(attrs=None, where=None):
r'''
Return logged_in_users_ information from osquery
Return logged_in_users information from osquery
CLI Example:
@ -451,7 +451,7 @@ def logged_in_users(attrs=None, where=None):
def mounts(attrs=None, where=None):
r'''
Return mounts_ information from osquery
Return mounts information from osquery
CLI Example:

79
salt/modules/parted.py
View file

@ -123,8 +123,6 @@ def probe(*devices):
def list_(device, unit=None):
'''
partition.list device unit
Prints partition information of given <device>
CLI Examples:
@ -191,8 +189,6 @@ def list_(device, unit=None):
def align_check(device, part_type, partition):
'''
partition.align_check device part_type partition
Check if partition satisfies the alignment constraint of part_type.
Type must be "minimal" or "optimal".
@ -225,8 +221,6 @@ def align_check(device, part_type, partition):
def check(device, minor):
'''
partition.check device minor
Checks if the file system on partition <minor> has any errors.
CLI Example:
@ -251,11 +245,9 @@ def check(device, minor):
def cp(device, from_minor, to_minor): # pylint: disable=C0103
'''
partition.check device from_minor to_minor
Copies the file system on the partition <from-minor> to partition
<to-minor>, deleting the original contents of the destination
partition.
<to-minor>, deleting the original contents of the destination
partition.
CLI Example:
@ -280,8 +272,6 @@ def cp(device, from_minor, to_minor): # pylint: disable=C0103
def get_id(device, minor):
'''
partition.get_id
Prints the system ID for the partition. Some typical values are::
b: FAT32 (vfat)
@ -313,8 +303,6 @@ def get_id(device, minor):
def set_id(device, minor, system_id):
'''
partition.set_id
Sets the system ID for the partition. Some typical values are::
b: FAT32 (vfat)
@ -372,12 +360,9 @@ def system_types():
def mkfs(device, fs_type):
'''
partition.mkfs device fs_type
Makes a file system <fs_type> on partition <device>, destroying all data
that resides on that partition. <fs_type> must be one of "ext2",
"fat32", "fat16", "linux-swap" or "reiserfs" (if libreiserfs is
installed)
that resides on that partition. <fs_type> must be one of "ext2", "fat32",
"fat16", "linux-swap" or "reiserfs" (if libreiserfs is installed)
CLI Example:
@ -401,9 +386,8 @@ def mkfs(device, fs_type):
def mklabel(device, label_type):
'''
partition.mklabel device label_type
Create a new disklabel (partition table) of label_type.
Type should be one of "aix", "amiga", "bsd", "dvh", "gpt", "loop", "mac",
"msdos", "pc98", or "sun".
@ -428,11 +412,9 @@ def mklabel(device, label_type):
def mkpart(device, part_type, fs_type=None, start=None, end=None):
'''
partition.mkpart device part_type fs_type start end
Make a part_type partition for filesystem fs_type, beginning at start and
ending at end (by default in megabytes). part_type should be one of
"primary", "logical", or "extended".
ending at end (by default in megabytes). part_type should be one of
"primary", "logical", or "extended".
CLI Examples:
@ -477,13 +459,12 @@ def mkpart(device, part_type, fs_type=None, start=None, end=None):
def mkpartfs(device, part_type, fs_type, start, end):
'''
partition.mkpartfs device part_type fs_type start end
Make a <part_type> partition with a new filesystem of <fs_type>, beginning
at <start> and ending at <end> (by default in megabytes). <part_type>
should be one of "primary", "logical", or "extended". <fs_type> must be
one of "ext2", "fat32", "fat16", "linux-swap" or "reiserfs" (if
libreiserfs is installed)
at <start> and ending at <end> (by default in megabytes).
<part_type> should be one of "primary", "logical", or "extended". <fs_type>
must be one of "ext2", "fat32", "fat16", "linux-swap" or "reiserfs" (if
libreiserfs is installed)
CLI Example:
@ -516,10 +497,8 @@ def mkpartfs(device, part_type, fs_type, start, end):
def name(device, partition, name):
'''
partition.name device partition name
Set the name of partition to name. This option works only on Mac, PC98,
and GPT disklabels. The name can be placed in quotes, if necessary.
Set the name of partition to name. This option works only on Mac, PC98, and
GPT disklabels. The name can be placed in quotes, if necessary.
CLI Example:
@ -550,11 +529,9 @@ def name(device, partition, name):
def rescue(device, start, end):
'''
partition.rescue device start end
Rescue a lost partition that was located somewhere between start and end.
If a partition is found, parted will ask if you want to create an
entry for it in the partition table.
If a partition is found, parted will ask if you want to create an
entry for it in the partition table.
CLI Example:
@ -573,13 +550,12 @@ def rescue(device, start, end):
def resize(device, minor, start, end):
'''
partition.resize device minor, start, end
Resizes the partition with number <minor>.
Resizes the partition with number <minor>. The partition will start <start>
from the beginning of the disk, and end <end> from the beginning of the
disk. resize never changes the minor number. Extended partitions can be
resized, so long as the new extended partition completely contains all
logical partitions.
The partition will start <start> from the beginning of the disk, and end
<end> from the beginning of the disk. resize never changes the minor number.
Extended partitions can be resized, so long as the new extended partition
completely contains all logical partitions.
CLI Example:
@ -609,8 +585,6 @@ def resize(device, minor, start, end):
def rm(device, minor): # pylint: disable=C0103
'''
partition.rm device minor
Removes the partition with number <minor>.
CLI Example:
@ -635,11 +609,10 @@ def rm(device, minor): # pylint: disable=C0103
def set_(device, minor, flag, state):
'''
partition.set device minor flag state
Changes a flag on the partition with number <minor>.
Changes a flag on the partition with number <minor>. A flag can be either
"on" or "off". Some or all of these flags will be available, depending
on what disk label you are using.
A flag can be either "on" or "off". Some or all of these flags will be
available, depending on what disk label you are using.
CLI Example:
@ -670,8 +643,6 @@ def set_(device, minor, flag, state):
def toggle(device, partition, flag):
'''
partition.toggle device partition flag
Toggle the state of <flag> on <partition>
CLI Example:
@ -700,8 +671,6 @@ def toggle(device, partition, flag):
def exists(device=''):
'''
partition.exists device
Check to see if the partition exists
CLI Example:

1
salt/states/module.py
View file

@ -47,6 +47,7 @@ argument, to avoid a collision with the ``name`` argument.
Here is a list of keywords hidden by the state system, which must be prefixed
with ``m_``:
* fun
* name
* names