Skip to content

Commit

Permalink
Merge pull request #4 from saltstack/man_pages_2019.2.4
Browse files Browse the repository at this point in the history
Update man pages 2019.2.4
  • Loading branch information
twangboy committed Apr 15, 2020
2 parents 7e52487 + 1737b40 commit a894d59
Show file tree
Hide file tree
Showing 15 changed files with 54 additions and 42 deletions.
2 changes: 1 addition & 1 deletion doc/man/salt-api.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-API" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-API" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-api \- salt-api Command
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-call.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CALL" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-CALL" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-call \- salt-call Documentation
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-cloud.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CLOUD" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-CLOUD" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-cloud \- Salt Cloud Command
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-cp.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CP" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-CP" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-cp \- salt-cp Documentation
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-key.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-KEY" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-KEY" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-key \- salt-key Documentation
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-master.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-MASTER" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-MASTER" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-master \- salt-master Documentation
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-minion.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-MINION" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-MINION" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-minion \- salt-minion Documentation
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-proxy.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-PROXY" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-PROXY" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-proxy \- salt-proxy Documentation
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-run.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-RUN" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-RUN" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-run \- salt-run Documentation
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-ssh.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-SSH" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-SSH" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-ssh \- salt-ssh Documentation
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-syndic.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-SYNDIC" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-SYNDIC" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-syndic \- salt-syndic Documentation
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt-unity.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-UNITY" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT-UNITY" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt-unity \- salt-unity Command
.
Expand Down
2 changes: 1 addition & 1 deletion doc/man/salt.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt \- salt
.
Expand Down
68 changes: 40 additions & 28 deletions doc/man/salt.7
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT" "7" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SALT" "7" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
salt \- Salt Documentation
.
Expand Down Expand Up @@ -8969,7 +8969,7 @@ The ext_pillar option allows for any number of external pillar interfaces to be
called when populating pillar data. The configuration is based on ext_pillar
functions. The available ext_pillar functions can be found herein:
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/salt/pillar\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/pillar\fP
.sp
By default, the ext_pillar interface is not configured to run.
.sp
Expand Down Expand Up @@ -30909,7 +30909,7 @@ The best place to find examples of renderers is in the Salt source code.
.sp
Documentation for renderers included with Salt can be found here:
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/salt/renderers\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/renderers\fP
.sp
Here is a simple YAML renderer example:
.INDENT 0.0
Expand Down Expand Up @@ -33669,7 +33669,7 @@ passed in are \fBcore\fP grains. This was added in the 2019.2.0 release.
The core module in the grains package is where the main grains are loaded by
the Salt minion and provides the principal example of how to write grains:
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/salt/grains/core.py\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/grains/core.py\fP
.SS Syncing Grains
.sp
Syncing grains can be done a number of ways, they are automatically synced when
Expand Down Expand Up @@ -36877,7 +36877,7 @@ To add custom runners, put them in a directory and add it to
.sp
Examples of runners can be found in the Salt distribution:
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/salt/runners\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/runners\fP
.sp
A simple runner that returns a well\-formatted list of the minions that are
responding to Salt calls could look like this:
Expand Down Expand Up @@ -36949,7 +36949,7 @@ engines_dirs:
.UNINDENT
.SS Writing an Engine
.sp
An example Salt engine, \fI\%https://github.com/saltstack/salt/blob/develop/salt/engines/test.py\fP, is available in the Salt source. To develop an engine, the only requirement is that your module implement the \fBstart()\fP function.
An example Salt engine, \fI\%https://github.com/saltstack/salt/blob/master/salt/engines/test.py\fP, is available in the Salt source. To develop an engine, the only requirement is that your module implement the \fBstart()\fP function.
.SS Understanding YAML
.sp
The default renderer for SLS files is the YAML renderer. YAML is a
Expand Down Expand Up @@ -83715,15 +83715,15 @@ Note that some of same the configuration options from the master are present in
the minion configuration file, these are used in masterless mode.
.sp
The source for the built\-in Salt pillars can be found here:
\fI\%https://github.com/saltstack/salt/blob/develop/salt/pillar\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/pillar\fP
.SH MASTER TOPS
.sp
Salt includes a number of built\-in subsystems to generate top file data, they
are listed at
all\-salt.tops\&.
.sp
The source for the built\-in Salt master tops can be found here:
\fI\%https://github.com/saltstack/salt/blob/develop/salt/tops\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/tops\fP
.SH SALT MODULE REFERENCE
.sp
This section contains a list of the Python modules that are used to extend the various subsystems within Salt.
Expand Down Expand Up @@ -180035,7 +180035,7 @@ Passes through all the parameters described in the
\fI\%utils.http.query function\fP:
.INDENT 7.0
.TP
.B salt.utils.http.query(url, method=u\(aqGET\(aq, params=None, data=None, data_file=None, header_dict=None, header_list=None, header_file=None, username=None, password=None, auth=None, decode=False, decode_type=u\(aqauto\(aq, status=False, headers=False, text=False, cookies=None, cookie_jar=None, cookie_format=u\(aqlwp\(aq, persist_session=False, session_cookie_jar=None, data_render=False, data_renderer=None, header_render=False, header_renderer=None, template_dict=None, test=False, test_url=None, node=u\(aqminion\(aq, port=80, opts=None, backend=None, ca_bundle=None, verify_ssl=None, cert=None, text_out=None, headers_out=None, decode_out=None, stream=False, streaming_callback=None, header_callback=None, handle=False, agent=u\(aqSalt/2019.2.2\-1\-gbca115f\(aq, hide_fields=None, raise_error=True, **kwargs)
.B salt.utils.http.query(url, method=u\(aqGET\(aq, params=None, data=None, data_file=None, header_dict=None, header_list=None, header_file=None, username=None, password=None, auth=None, decode=False, decode_type=u\(aqauto\(aq, status=False, headers=False, text=False, cookies=None, cookie_jar=None, cookie_format=u\(aqlwp\(aq, persist_session=False, session_cookie_jar=None, data_render=False, data_renderer=None, header_render=False, header_renderer=None, template_dict=None, test=False, test_url=None, node=u\(aqminion\(aq, port=80, opts=None, backend=None, ca_bundle=None, verify_ssl=None, cert=None, text_out=None, headers_out=None, decode_out=None, stream=False, streaming_callback=None, header_callback=None, handle=False, agent=u\(aqSalt/2019.2.3\-6\-g46e67b2\(aq, hide_fields=None, raise_error=True, **kwargs)
Query a resource, and decode the return data
.UNINDENT
.sp
Expand Down Expand Up @@ -337058,7 +337058,7 @@ done
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
See \fI\%https://github.com/saltstack/salt/blob/develop/tests/eventlisten.sh\fP for an example of usage within a shell
See \fI\%https://github.com/saltstack/salt/blob/master/tests/eventlisten.sh\fP for an example of usage within a shell
script.
.UNINDENT
.UNINDENT
Expand Down Expand Up @@ -415864,7 +415864,7 @@ For a full list of currently running test environments, go to
.sp
For testing Salt on Jenkins, SaltStack uses Salt\-Cloud to
spin up virtual machines. The script using Salt\-Cloud to accomplish this is
open source and can be found here: \fI\%https://github.com/saltstack/salt/blob/develop/tests/jenkins.py\fP
open source and can be found here: \fI\%https://github.com/saltstack/salt/blob/master/tests/jenkins.py\fP
.SS Writing Tests
.sp
The salt testing infrastructure is divided into two classes of tests,
Expand Down Expand Up @@ -416656,7 +416656,7 @@ appropriate test file to maintain Salt\(aqs testing directory structure.
In order for Salt\(aqs test suite to recognize tests within the newly
created directory, options to run the new integration tests must be added to
\fBtests/runtests.py\fP\&. Examples of the necessary options that must be added
can be found here: \fI\%https://github.com/saltstack/salt/blob/develop/tests/runtests.py\fP\&. The functions that need to be
can be found here: \fI\%https://github.com/saltstack/salt/blob/master/tests/runtests.py\fP\&. The functions that need to be
edited are \fBsetup_additional_options\fP, \fBvalidate_options\fP, and
\fBrun_integration_tests\fP\&.
.SS Writing Unit Tests
Expand Down Expand Up @@ -418175,7 +418175,7 @@ manpage.
.sp
All the documentation is contained in the main Salt repository. Speaking
broadly, most of the narrative documentation is contained within the
\fI\%https://github.com/saltstack/salt/blob/develop/doc\fP subdirectory and most of the reference and API documentation is
\fI\%https://github.com/saltstack/salt/blob/master/doc\fP subdirectory and most of the reference and API documentation is
written inline with Salt\(aqs Python code and extracted using a Sphinx extension.
.SS Style
.sp
Expand Down Expand Up @@ -431453,6 +431453,17 @@ e2b86bf Merge pull request \fI\%#54706\fP from bryceml/2019.2.1_ruby
168a6c1 switch to ruby 2.6.3
.UNINDENT
.UNINDENT
.SS Salt 2019.2.3 Release Notes
.sp
Version 2019.2.3 is a CVE\-fix release for 2019.2.0\&.
.SS Security Fix
.sp
\fBCVE\-2019\-17361\fP
.sp
With the Salt NetAPI enabled in addition to having a SSH roster defined,
unauthenticated access is possible when specifying the client as SSH.
Additionally, when the raw_shell option is specified any arbitrary command
may be run on the Salt master when specifying SSH options.
.SS Salt 2018.3.0 Release Notes \- Codename Oxygen
.sp
\fBWARNING:\fP
Expand Down Expand Up @@ -451431,16 +451442,17 @@ ec258e2 Add integration tests for yaml and json filters
f5f16cf Ensure that we don\(aqt feed jinja2.Markup() a str type
.UNINDENT
.UNINDENT
.SS In Progress: Salt 2018.3.5 Release Notes
.SS Salt 2018.3.5 Release Notes
.sp
Version 2018.3.5 is an \fBunreleased\fP bugfix release for 2018.3.0\&.
This release is still in progress and has not been released yet.
.SS Master Configuration Changes
Version 2018.3.5 is a CVE\-fix release for 2018.3.0\&.
.SS Security Fix
.sp
\fBCVE\-2019\-17361\fP
.sp
To fix \fI\%#53411\fP a new configuration parameter \fIevent_listen_queue_max_seconds\fP is provided.
When this is set to a value greater than 0 and \fIevent_listen_queue\fP is not 0, if the oldest event
in the listen queue is older than \fIevent_listen_queue_max_seconds\fP, the queue will be flushed to
returners regardless of how many events are in the queue.
With the Salt NetAPI enabled in addition to having a SSH roster defined,
unauthenticated access is possible when specifying the client as SSH.
Additionally, when the raw_shell option is specified any arbitrary command
may be run on the Salt master when specifying SSH options.
.SS Salt 2017.7.0 Release Notes \- Codename Nitrogen
.SS Python 3
.sp
Expand Down Expand Up @@ -538687,7 +538699,7 @@ use the file extension “.pyx” and the minion module will be compiled when
the minion is started. An example cython module is included in the main
distribution called cytest.pyx:
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/salt/modules/cytest.pyx\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/modules/cytest.pyx\fP
.SS Dynamic Returners
.sp
By default salt returns command data back to the salt master, but now salt can
Expand All @@ -538701,7 +538713,7 @@ data so anything from MySQL, Redis, MongoDB, and more!
.sp
There are 2 simple stock returners in the returners directory:
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/salt/returners\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/returners\fP
.sp
The documentation on writing returners will be added to the wiki shortly, and
returners can be written in pure Python, or in cython.
Expand All @@ -538717,7 +538729,7 @@ Writing modules
The test module has an example of using the __opts__ dict, and how to set
default options:
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/salt/modules/test.py\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/modules/test.py\fP
.SS Advanced Minion Threading
.sp
In 0.7.0 the minion would block after receiving a command from the master, now
Expand All @@ -538729,7 +538741,7 @@ exploit the negative aspects of the Python GIL to run faster and more reliably,
but simple calls will still be faster with Python threading.
The configuration option can be found in the minion configuration file:
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/conf/minion\fP
\fI\%https://github.com/saltstack/salt/blob/master/conf/minion\fP
.SS Lowered Supported Python to 2.6
.sp
The requirement for Python 2.7 has been removed to support Python 2.6. I have
Expand Down Expand Up @@ -538806,7 +538818,7 @@ The system for loading salt modules has been pulled out of the minion class to
be a standalone module, this has enabled more dynamic loading of Salt modules
and enables many of the updates in 0.8.7 –
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/salt/loader.py\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/loader.py\fP
.sp
Salt Job ids are now microsecond precise, this was needed to repair a race
condition unveiled by the speed improvements in the new ZeroMQ topology.
Expand Down Expand Up @@ -539063,15 +539075,15 @@ The minion and master classes have been redesigned to allow for specialized
minion and master servers to be easily created. An example on how this is done
for the master can be found in the \fBmaster.py\fP salt module:
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/salt/master.py\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/master.py\fP
.sp
The \fBMaster\fP class extends the \fBSMaster\fP class and set up the main master
server.
.sp
The minion functions can now also be easily added to another application via
the \fBSMinion\fP class, this class can be found in the \fBminion.py\fP module:
.sp
\fI\%https://github.com/saltstack/salt/blob/develop/salt/minion.py\fP
\fI\%https://github.com/saltstack/salt/blob/master/salt/minion.py\fP
.SS Cleaner Key Management
.sp
This release changes some of the key naming to allow for multiple master keys
Expand Down
2 changes: 1 addition & 1 deletion doc/man/spm.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SPM" "1" "Jan 07, 2020" "2019.2.3" "Salt"
.TH "SPM" "1" "Apr 14, 2020" "2019.2.4" "Salt"
.SH NAME
spm \- Salt Package Manager Command
.
Expand Down

0 comments on commit a894d59

Please sign in to comment.