diff --git a/doc/Makefile b/doc/Makefile index 81405fed79da..c94efc98e9d1 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -154,7 +154,7 @@ pdf: translations cheatsheet: translations @echo "Running cheatsheet/salt.tex file through xelatex..." - cd cheatsheet && xelatex salt.tex && cp salt.pdf ../salt-cheatsheet.pdf + cd cheatsheet && xelatex salt.tex && cp salt.pdf ../salt-cheatsheet.pdf @echo "./salt-cheatsheet.pdf created." text: translations diff --git a/doc/_themes/saltstack/static/css/bootstrap.css b/doc/_themes/saltstack/static/css/bootstrap.css index 3f9aa8cd5de7..5d2dbc6425bb 100644 --- a/doc/_themes/saltstack/static/css/bootstrap.css +++ b/doc/_themes/saltstack/static/css/bootstrap.css @@ -6069,7 +6069,7 @@ a.badge:focus { top: 20%; left: 50%; padding: 15px; - width: 35%; + width: 35%; } .carousel-caption h4, diff --git a/doc/_themes/saltstack/static/js/vendor/modernizr-2.6.2-respond-1.1.0.js b/doc/_themes/saltstack/static/js/vendor/modernizr-2.6.2-respond-1.1.0.js index 3f1dfca60f7a..33ad8f6e956b 100644 --- a/doc/_themes/saltstack/static/js/vendor/modernizr-2.6.2-respond-1.1.0.js +++ b/doc/_themes/saltstack/static/js/vendor/modernizr-2.6.2-respond-1.1.0.js @@ -45,7 +45,7 @@ window.Modernizr = (function( window, document, undefined ) { slice = classes.slice, - featureName, + featureName, injectElementWithStyles = function( rule, callback, nodes, testnames ) { @@ -105,7 +105,7 @@ window.Modernizr = (function( window, document, undefined ) { return bool; }, - + isEventSupported = (function() { @@ -152,7 +152,7 @@ window.Modernizr = (function( window, document, undefined ) { }; } else { - hasOwnProp = function (object, property) { + hasOwnProp = function (object, property) { return ((property in object) && is(object.constructor.prototype[property], 'undefined')); }; } @@ -620,7 +620,7 @@ window.Modernizr = (function( window, document, undefined ) { } - return Modernizr; + return Modernizr; }; diff --git a/doc/_themes/saltstack2/static/fonts/glyphicons-halflings-regular.svg b/doc/_themes/saltstack2/static/fonts/glyphicons-halflings-regular.svg index e3e2dc739dd8..25691af8f193 100644 --- a/doc/_themes/saltstack2/static/fonts/glyphicons-halflings-regular.svg +++ b/doc/_themes/saltstack2/static/fonts/glyphicons-halflings-regular.svg @@ -226,4 +226,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/doc/gen_gource b/doc/gen_gource index 5a151d333628..727ee7ebf3e8 100644 --- a/doc/gen_gource +++ b/doc/gen_gource @@ -1,5 +1,5 @@ #!/bin/bash -# +# # This script is used to generate the gource video released with each release of Salt # # diff --git a/doc/index.rst b/doc/index.rst index 3ac4eb5261f6..6ff7bd027142 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -32,7 +32,7 @@ shell script, which automates the install correctly on multiple platforms: Get Started =============== -A new `Get Started Guide `_ walks you +A new `Get Started Guide `_ walks you through the basics of getting SaltStack up and running. You'll learn how to: * Install and configure SaltStack diff --git a/doc/man/salt.7 b/doc/man/salt.7 index 253cdbc2cfe2..1c5ae1e63ad5 100644 --- a/doc/man/salt.7 +++ b/doc/man/salt.7 @@ -39429,7 +39429,7 @@ used if no arguments are required. \fBtgt\fP (\fIstring or list\fP) \-\- Which minions to target for the execution. Default is shell glob. Modified by the \fBexpr_form\fP option. .IP \(bu 2 -\fBfun\fP (\fIstring or list of strings\fP) \-\- +\fBfun\fP (\fIstring or list of strings\fP) \-\- .sp The module and function to call on the specified minions of the form \fBmodule.function\fP\&. For example \fBtest.ping\fP or @@ -39455,7 +39455,7 @@ executing a compound command. \fBtimeout\fP \-\- Seconds to wait after the last minion returns but before all minions return. .IP \(bu 2 -\fBexpr_form\fP \-\- +\fBexpr_form\fP \-\- .sp The type of \fBtgt\fP\&. Allowed values: .INDENT 2.0 @@ -39488,7 +39488,7 @@ on the minions .IP \(bu 2 \fBkwarg\fP \-\- A dictionary with keyword arguments for the function. .IP \(bu 2 -\fBkwargs\fP \-\- +\fBkwargs\fP \-\- .sp Optional keyword arguments. Authentication credentials may be passed when using @@ -49440,7 +49440,7 @@ salt\-cloud \-a suspend vmname # Directory to store job and cache data: # This directory may contain sensitive data and should be protected accordingly. -# +# #cachedir: /var/cache/salt/master # Directory for custom modules. This directory can contain subdirectories for @@ -49502,7 +49502,7 @@ salt\-cloud \-a suspend vmname #minion_data_cache: True # Store all returns in the given returner. -# Setting this option requires that any returner\-specific configuration also +# Setting this option requires that any returner\-specific configuration also # be set. See various returners in salt/returners for details on required # configuration values. (See also, event_return_queue below.) # @@ -49541,12 +49541,12 @@ salt\-cloud \-a suspend vmname # the key rotation event as minions reconnect. Consider this carefully if this # salt master is managing a large number of minions. # -# If disabled, it is recommended to handle this event by listening for the +# If disabled, it is recommended to handle this event by listening for the # \(aqaes_key_rotate\(aq event with the \(aqkey\(aq tag and acting appropriately. # ping_on_rotate: False # By default, the master deletes its cache of minion data when the key for that -# minion is removed. To preserve the cache after key deletion, set +# minion is removed. To preserve the cache after key deletion, set # \(aqpreserve_minion_cache\(aq to True. # # WARNING: This may have security implications if compromised minions auth with @@ -49687,7 +49687,7 @@ salt\-cloud \-a suspend vmname # \- cmd # Enforce client_acl & client_acl_blacklist when users have sudo -# access to the salt command. +# access to the salt command. # #sudo_acl: False @@ -49847,7 +49847,7 @@ salt\-cloud \-a suspend vmname # When using multiple environments, each with their own top file, the # default behaviour is an unordered merge. To prevent top files from # being merged together and instead to only use the top file from the -# requested environment, set this value to \(aqsame\(aq. +# requested environment, set this value to \(aqsame\(aq. #top_file_merging_strategy: merge # To specify the order in which environments are merged, set the ordering @@ -49864,7 +49864,7 @@ salt\-cloud \-a suspend vmname # the master server. The default is md5, but sha1, sha224, sha256, sha384 # and sha512 are also supported. # -# Prior to changing this value, the master should be stopped and all Salt +# Prior to changing this value, the master should be stopped and all Salt # caches should be cleared. #hash_type: md5 @@ -85289,7 +85289,7 @@ If no packages specified, all packages will be returned. .INDENT 7.0 .TP .B Parameters -\fBpackages\fP \-\- +\fBpackages\fP \-\- .TP .B Returns @@ -98022,7 +98022,7 @@ The value to append to the grain key If convert is False and the grain contains non\-list contents, an error is given. Defaults to False. .IP \(bu 2 -\fBdelimiter\fP \-\- +\fBdelimiter\fP \-\- .sp The key can be a nested dict key. Use this parameter to specify the delimiter you use, instead of the default \fB:\fP\&. @@ -98156,7 +98156,7 @@ values for non\-standard package names such as when using a different Python version from the default Python version provided by the OS (e.g., \fBpython26\-mysql\fP instead of \fBpython\-mysql\fP). .IP \(bu 2 -\fBdefault\fP \-\- +\fBdefault\fP \-\- .sp default lookup_dict\(aqs key used if the grain does not exists or if the grain value has no match on lookup_dict. If unspecified @@ -98166,7 +98166,7 @@ New in version 2014.1.0. .IP \(bu 2 -\fBbase\fP \-\- +\fBbase\fP \-\- .sp A lookup_dict key to use for a base dictionary. The grain\-selected \fBlookup_dict\fP is merged over this and then finally @@ -98231,7 +98231,7 @@ pkg:apache .INDENT 7.0 .TP .B Parameters -\fBdelimiter\fP \-\- +\fBdelimiter\fP \-\- .sp Specify an alternate delimiter to use when traversing a nested dict .sp @@ -98426,7 +98426,7 @@ Remove a value from a list in the grains config file .INDENT 7.0 .TP .B Parameters -\fBdelimiter\fP \-\- +\fBdelimiter\fP \-\- .sp The key can be a nested dict key. Use this parameter to specify the delimiter you use, instead of the default \fB:\fP\&. @@ -102306,7 +102306,7 @@ Set channel access .UNINDENT .IP \(bu 2 -\fBalerting\fP \-\- +\fBalerting\fP \-\- .sp PEF Alerting Enable/Disable \- True = enable PEF Alerting @@ -102318,7 +102318,7 @@ PEF Alerting Enable/Disable .UNINDENT .IP \(bu 2 -\fBper_msg_auth\fP \-\- +\fBper_msg_auth\fP \-\- .sp Per\-message Authentication \- True = enable @@ -102331,7 +102331,7 @@ used on subsequent packets for the session.] .UNINDENT .IP \(bu 2 -\fBuser_level_auth\fP \-\- +\fBuser_level_auth\fP \-\- .sp User Level Authentication Enable/Disable. \- True = enable User Level Authentication. All User Level commands are @@ -102356,7 +102356,7 @@ Authentication Type that was used for the request. .UNINDENT .IP \(bu 2 -\fBaccess_mode\fP \-\- +\fBaccess_mode\fP \-\- .sp Access Mode for IPMI messaging (PEF Alerting is enabled/disabled separately from IPMI messaging) @@ -102589,7 +102589,7 @@ unavailable.) .INDENT 7.0 .TP .B Parameters -\fBprivilege_level\fP \-\- +\fBprivilege_level\fP \-\- .UNINDENT .sp User Privilege Limit. (Determines the maximum privilege level that the @@ -116284,7 +116284,7 @@ default: group5 (Optional) .IP \(bu 2 \fBprofile\fP \-\- Profile to build on (Optional) .IP \(bu 2 -\fBkwargs\fP \-\- +\fBkwargs\fP \-\- .UNINDENT .TP .B Returns @@ -118005,7 +118005,7 @@ default: true (Optional) .IP \(bu 2 \fBprofile\fP \-\- Profile to build on (Optional) .IP \(bu 2 -\fBkwargs\fP \-\- +\fBkwargs\fP \-\- .UNINDENT .TP .B Returns @@ -122151,7 +122151,7 @@ salt \(aq*\(aq osquery.launchd .INDENT 0.0 .TP .B salt.modules.osquery.listening_ports(attrs=None, where=None) -Return +Return .nf listening_ports_ .fi @@ -122172,7 +122172,7 @@ salt \(aq*\(aq osquery.listening_ports .INDENT 0.0 .TP .B salt.modules.osquery.logged_in_users(attrs=None, where=None) -Return +Return .nf logged_in_users_ .fi @@ -122210,7 +122210,7 @@ salt \(aq*\(aq osquery.memory_map .INDENT 0.0 .TP .B salt.modules.osquery.mounts(attrs=None, where=None) -Return +Return .nf mounts_ .fi @@ -134085,9 +134085,9 @@ If no packages specified, all packages will be returned. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpackages\fP \-\- +\fBpackages\fP \-\- .IP \(bu 2 -\fBattr\fP \-\- +\fBattr\fP \-\- .sp Comma\-separated package attributes. If no \(aqattr\(aq is specified, all available attributes returned. .INDENT 2.0 @@ -157731,7 +157731,7 @@ Reboot a running system. \fBtimeout\fP (\fI\%int\fP) \-\- Number of seconds before rebooting the system. Default is 5 minutes. .IP \(bu 2 -\fBin_seconds\fP (\fI\%bool\fP) \-\- +\fBin_seconds\fP (\fI\%bool\fP) \-\- .sp Whether to treat timeout as seconds or minutes. .sp @@ -157913,7 +157913,7 @@ Shutdown a running system. .IP \(bu 2 \fBmessage\fP (\fI\%str\fP) \-\- A message to display to the user before shutting down. .IP \(bu 2 -\fBtimeout\fP (\fI\%int\fP) \-\- +\fBtimeout\fP (\fI\%int\fP) \-\- .sp The length of time that the shutdown dialog box should be displayed, in seconds. While this dialog box is displayed, the shutdown can be stopped @@ -157933,7 +157933,7 @@ dialog box, and the shutdown cannot be stopped by shutdown_abort. Default is 5 minutes .IP \(bu 2 -\fBin_seconds\fP (\fI\%bool\fP) \-\- +\fBin_seconds\fP (\fI\%bool\fP) \-\- .sp Whether to treat timeout as seconds or minutes. .sp @@ -158781,7 +158781,7 @@ New in version 2015.5.6. .INDENT 7.0 .TP .B Parameters -\fBsam\fP (\fI\%bool\fP) \-\- +\fBsam\fP (\fI\%bool\fP) \-\- .sp False returns just the username without any domain notation. True returns the domain with the username in the SAM format. Ie: @@ -159566,7 +159566,7 @@ returned by this function. Run this function first to see what will be installed, then set install=True to install the updates. This will override download=True .IP \(bu 2 -\fBcategories\fP (\fIlist\fP) \-\- +\fBcategories\fP (\fIlist\fP) \-\- .sp Specify the categories to list. Must be passed as a list. All categories returned by default. @@ -159602,7 +159602,7 @@ Windows Defender .UNINDENT .IP \(bu 2 -\fBseverities\fP (\fIlist\fP) \-\- +\fBseverities\fP (\fIlist\fP) \-\- .sp Specify the severities to include. Must be passed as a list. All severities returned by default. @@ -159870,11 +159870,11 @@ explicitly will overwrite any in the CSR. X509v3 Basic Constraints extension. .TP .B extensions: -The following arguments set X509v3 Extension values. If the value starts with +The following arguments set X509v3 Extension values. If the value starts with .nf \(ga\(ga .fi -critical +critical .nf \(ga\(ga .fi @@ -163774,7 +163774,7 @@ Return the information of the named package(s), installed on the system. .IP \(bu 2 \fBnames\fP \-\- Names of the packages to get information about. .IP \(bu 2 -\fBattr\fP \-\- +\fBattr\fP \-\- .sp Comma\-separated package attributes. If no \(aqattr\(aq is specified, all available attributes returned. .INDENT 2.0 @@ -168772,7 +168772,7 @@ New in version 2015.8.0. .sp The module depends on the \fBhglib\fP python module being available. -This is the same requirement as for +This is the same requirement as for .nf hgfs_ .fi @@ -189969,7 +189969,7 @@ parameters (list) – A list of key/value tuples that specify input parameters f bool) may be used to specify the UsePreviousValue option. .sp notification_arns (list) – The Simple Notification Service (SNS) topic ARNs to publish stack related events. -You can find your SNS topic ARNs using the +You can find your SNS topic ARNs using the .nf \(gaSNS console\(ga_ .fi @@ -201786,7 +201786,7 @@ if a bare repo is not desired. .TP .B template If a new repository is initialized, this argument will specify an -alternate +alternate .nf \(gatemplate directory\(ga_ .fi @@ -202232,7 +202232,7 @@ The grain name \fBdestructive\fP \-\- If destructive is True, delete the entire grain. If destructive is False, set the grain\(aqs value to None. Defaults to False. .IP \(bu 2 -\fBforce\fP \-\- +\fBforce\fP \-\- .sp If force is True, the existing grain will be overwritten regardless of its existing or provided value type. Defaults to False @@ -202241,7 +202241,7 @@ New in version Boron. .IP \(bu 2 -\fBdelimiter\fP \-\- +\fBdelimiter\fP \-\- .sp A delimiter different from the default can be provided. .sp @@ -202294,7 +202294,7 @@ The value to append If convert is False and the grain contains non\-list contents, an error is given. Defaults to False. .IP \(bu 2 -\fBdelimiter\fP \-\- +\fBdelimiter\fP \-\- .sp A delimiter different from the default can be provided. .sp @@ -202334,7 +202334,7 @@ The value to delete from the grain list. .INDENT 7.0 .TP .B Parameters -\fBdelimiter\fP \-\- +\fBdelimiter\fP \-\- .sp A delimiter different from the default \fB:\fP can be provided. .sp @@ -202393,7 +202393,7 @@ The value is present in the list type grain. .INDENT 7.0 .TP .B Parameters -\fBdelimiter\fP \-\- +\fBdelimiter\fP \-\- .sp A delimiter different from the default \fB:\fP can be provided. .sp @@ -202452,7 +202452,7 @@ The value to set on the grain .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBforce\fP \-\- +\fBforce\fP \-\- .sp If force is True, the existing grain will be overwritten regardless of its existing or provided value type. Defaults to False @@ -202461,7 +202461,7 @@ New in version Boron. .IP \(bu 2 -\fBdelimiter\fP \-\- +\fBdelimiter\fP \-\- .sp A delimiter different from the default can be provided. .sp @@ -208580,7 +208580,7 @@ option can only be used to install packages from a software repository. To install a package file manually, use the "sources" option detailed below. .IP \(bu 2 -\fBversion\fP (\fI\%str\fP) \-\- +\fBversion\fP (\fI\%str\fP) \-\- .sp Install a specific version of a package. This option is ignored if either "pkgs" or "sources" is used. Currently, this option is supported @@ -208640,7 +208640,7 @@ as version specifiers in pkg states. \fBrefresh\fP (\fI\%bool\fP) \-\- Update the repo database of available packages prior to installing the requested package. .IP \(bu 2 -\fBfromrepo\fP (\fI\%str\fP) \-\- +\fBfromrepo\fP (\fI\%str\fP) \-\- .sp Specify a repository from which to install .sp @@ -208713,7 +208713,7 @@ release name is the part before the slash, so to install version .IP \(bu 2 \fBskip_verify\fP (\fI\%bool\fP) \-\- Skip the GPG verification check for the package to be installed .IP \(bu 2 -\fBskip_suggestions\fP (\fI\%bool\fP) \-\- +\fBskip_suggestions\fP (\fI\%bool\fP) \-\- .sp Force strict package naming. Disables lookup of package alternatives. .sp @@ -208721,7 +208721,7 @@ New in version 2014.1.1. .IP \(bu 2 -\fBpkgs\fP (\fIlist\fP) \-\- +\fBpkgs\fP (\fIlist\fP) \-\- .sp A list of packages to install from a software repository. All packages listed under \fBpkgs\fP will be installed via a single command. @@ -208816,7 +208816,7 @@ mypkgs: pkgng)\fP .IP \(bu 2 -\fBsources\fP (\fIlist\fP) \-\- +\fBsources\fP (\fIlist\fP) \-\- .sp A list of packages to install, along with the source URI or local path from which to install each package. In the example below, \fBfoo\fP, @@ -208841,7 +208841,7 @@ mypkgs: .UNINDENT .IP \(bu 2 -\fBallow_updates\fP (\fI\%bool\fP) \-\- +\fBallow_updates\fP (\fI\%bool\fP) \-\- .sp Allow the package to be updated outside Salt\(aqs control (e.g. auto updates on Windows). This means a package on the Minion can have a @@ -208872,7 +208872,7 @@ httpd: .UNINDENT .IP \(bu 2 -\fBpkg_verify\fP (\fI\%bool\fP) \-\- +\fBpkg_verify\fP (\fI\%bool\fP) \-\- .sp New in version 2014.7.0. @@ -208918,7 +208918,7 @@ mypkgs: .UNINDENT .IP \(bu 2 -\fBnormalize\fP (\fI\%bool\fP) \-\- +\fBnormalize\fP (\fI\%bool\fP) \-\- .sp Normalize the package name by removing the architecture, if the architecture of the package is different from the architecture of the @@ -208945,7 +208945,7 @@ gpfs.gplbin\-2.6.32\-279.31.1.el6.x86_64: .UNINDENT .IP \(bu 2 -\fBkwargs\fP \-\- +\fBkwargs\fP \-\- .sp These are specific to each OS. If it does not apply to the execution module for your OS, it is ignored. @@ -227040,11 +227040,11 @@ The \fBfile.serialize\fP state can provide a shorthand for creating some files from data structures. There are also many examples within Salt Formulas of creating one\-off "serializers" (often as Jinja macros) that reformat a data structure to a specific config file format. For -example, +example, .nf \(gaNginx vhosts\(ga__ .fi - or the + or the .nf \(gaphp.ini\(ga__ .fi @@ -228364,7 +228364,7 @@ Pull Requests: .IP \(bu 2 \fI\%#26659\fP: (\fITheBigBear\fP) minor doc edits \- spelling .IP \(bu 2 -\fI\%#26654\fP: (\fIjfindlay\fP) merge +\fI\%#26654\fP: (\fIjfindlay\fP) merge .nf \(ga#26650\(ga_ .fi @@ -228416,7 +228416,7 @@ Pull Requests: .IP \(bu 2 \fI\%#26521\fP: (\fIterminalmage\fP) Work around upstream git bug when cloning repo as root .IP \(bu 2 -\fI\%#26518\fP: (\fIkrak3n\fP) Fix for +\fI\%#26518\fP: (\fIkrak3n\fP) Fix for .nf \(ga#25492\(ga_ .fi @@ -228544,7 +228544,7 @@ Pull Requests: .IP \(bu 2 \fI\%#26260\fP: (\fInmadhok\fP) Correct spelling of integration in docs .IP \(bu 2 -\fI\%#26226\fP: (\fIrallytime\fP) Fix +\fI\%#26226\fP: (\fIrallytime\fP) Fix .nf \(ga#25463\(ga_ .fi @@ -228800,7 +228800,7 @@ Pull Requests: .IP \(bu 2 \fI\%#25451\fP: (\fIs0undt3ch\fP) Salt\-SSH Scan roster bugfixes (And Py3 support) .IP \(bu 2 -\fI\%#25449\fP: (\fIruzarowski\fP) Exclude dotfiles and directories from minion key lists (Fixes +\fI\%#25449\fP: (\fIruzarowski\fP) Exclude dotfiles and directories from minion key lists (Fixes .nf \(ga#25448\(ga_ .fi @@ -228874,7 +228874,7 @@ Pull Requests: .IP \(bu 2 \fI\%#25242\fP: (\fIruzarowski\fP) Make SourceDestCheck flag available to network interface definition .IP \(bu 2 -\fI\%#25226\fP: (\fInmadhok\fP) Backporting fix for issue +\fI\%#25226\fP: (\fInmadhok\fP) Backporting fix for issue .nf \(ga#25223\(ga_ .fi @@ -229001,7 +229001,7 @@ in \fBlog_fmt_console\fP in the config file for any of \fBsalt\-master\fP, .SS Git Pillar .sp The git external pillar has been rewritten to bring it up to feature parity -with \fBgitfs\fP\&. Support for +with \fBgitfs\fP\&. Support for .nf pygit2_ .fi @@ -229619,7 +229619,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27380\fP: (\fIjtand\fP) Skipping Async tests .IP \(bu 2 -\fBPR\fP \fI\%#27382\fP: (\fIterminalmage\fP) Revert "fixes +\fBPR\fP \fI\%#27382\fP: (\fIterminalmage\fP) Revert "fixes .nf \(ga#27217\(ga_ .fi @@ -229846,7 +229846,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28695\fP: (\fIs0undt3ch\fP) [2015.8] Update to latest bootstrap script v2015.11.09 .IP \(bu 2 -\fBPR\fP \fI\%#28656\fP: (\fIclarkperkins\fP) +\fBPR\fP \fI\%#28656\fP: (\fIclarkperkins\fP) .nf \(ga#28526\(ga_ .fi @@ -229912,7 +229912,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28564\fP: (\fIs0undt3ch\fP) [2015.8] Update to latest bootstrap script v2015.11.04 .IP \(bu 2 -\fBPR\fP \fI\%#28561\fP: (\fIOro\fP) Issue +\fBPR\fP \fI\%#28561\fP: (\fIOro\fP) Issue .nf \(ga#28527\(ga_ .fi @@ -229960,13 +229960,13 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28491\fP: (\fIrallytime\fP) Back\-port \fI\%#28388\fP to 2015.8 .IP \(bu 2 -\fBPR\fP \fI\%#28465\fP: (\fItwangboy\fP) Fix +\fBPR\fP \fI\%#28465\fP: (\fItwangboy\fP) Fix .nf \(ga#12363\(ga_ .fi : Password Expiration in Windows .IP \(bu 2 -\fBPR\fP \fI\%#28485\fP: (\fInasenbaer13\fP) Fix invalid usage of _get_conn causing +\fBPR\fP \fI\%#28485\fP: (\fInasenbaer13\fP) Fix invalid usage of _get_conn causing .nf \(ga#28484\(ga_ .fi @@ -229986,7 +229986,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28422\fP: (\fIcachedout\fP) Handle windows logging on thread_multi [WIP] .IP \(bu 2 -\fBPR\fP \fI\%#28425\fP: (\fItwangboy\fP) Fix +\fBPR\fP \fI\%#28425\fP: (\fItwangboy\fP) Fix .nf \(ga#13513\(ga_ .fi @@ -230106,7 +230106,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28098\fP: (\fIjacksontj\fP) For all multi\-part messages, check the headers. If the header is not … .IP \(bu 2 -\fBPR\fP \fI\%#28134\fP: (\fIbernieke\fP) fix unicode pillar values +\fBPR\fP \fI\%#28134\fP: (\fIbernieke\fP) fix unicode pillar values .nf \(ga#3436\(ga_ .fi @@ -230162,7 +230162,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27983\fP: (\fIrallytime\fP) Pip state run result should be False, not None, if installation error occurs. .IP \(bu 2 -\fBPR\fP \fI\%#27991\fP: (\fItwangboy\fP) Fix for +\fBPR\fP \fI\%#27991\fP: (\fItwangboy\fP) Fix for .nf \(ga#20678\(ga_ .fi @@ -230174,7 +230174,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27992\fP: (\fIcachedout\fP) Make load beacon config into list .IP \(bu 2 -\fBPR\fP \fI\%#28003\fP: (\fItwangboy\fP) Fix +\fBPR\fP \fI\%#28003\fP: (\fItwangboy\fP) Fix .nf \(ga#26336\(ga_ .fi @@ -230254,7 +230254,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27859\fP: (\fIticosax\fP) [dockerng] Clarify doc port bindings .IP \(bu 2 -\fBPR\fP \fI\%#27748\fP: (\fImultani\fP) Fix +\fBPR\fP \fI\%#27748\fP: (\fImultani\fP) Fix .nf \(ga#8646\(ga_ .fi @@ -230278,7 +230278,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27827\fP: (\fItechhat\fP) Add additional error checking to SPM .IP \(bu 2 -\fBPR\fP \fI\%#27826\fP: (\fImartinhoefling\fP) Fixes +\fBPR\fP \fI\%#27826\fP: (\fImartinhoefling\fP) Fixes .nf \(ga#27825\(ga_ .fi @@ -230318,7 +230318,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27705\fP: (\fIrallytime\fP) Merge \fI\%#27602\fP with final pylint fix .IP \(bu 2 -\fBPR\fP \fI\%#27691\fP: (\fInotpeter\fP) Faster timeout (3s vs 2min) for instance metadata lookups. +\fBPR\fP \fI\%#27691\fP: (\fInotpeter\fP) Faster timeout (3s vs 2min) for instance metadata lookups. .nf \(ga#13850\(ga_ .fi @@ -230405,7 +230405,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#29148\fP: (\fIlomeroe\fP) correcting parameter calls to boto get_zone/create_zone functions in … .IP \(bu 2 -\fBPR\fP \fI\%#29108\fP: (\fIlorengordon\fP) Enforce length as an int, fixes +\fBPR\fP \fI\%#29108\fP: (\fIlorengordon\fP) Enforce length as an int, fixes .nf \(ga#29107\(ga_ .fi @@ -230459,7 +230459,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28969\fP: (\fIrallytime\fP) Back\-port \fI\%#28825\fP to 2015.8 .IP \(bu 2 -\fBPR\fP \fI\%#28787\fP: (\fIchrigl\fP) closes +\fBPR\fP \fI\%#28787\fP: (\fIchrigl\fP) closes .nf \(ga#28784\(ga_ .fi @@ -230493,7 +230493,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28895\fP: (\fIrallytime\fP) Back\-port \fI\%#28823\fP to 2015.8 .IP \(bu 2 -\fBPR\fP \fI\%#28885\fP: (\fIkt97679\fP) fix for: service.enabled fails on xen server +\fBPR\fP \fI\%#28885\fP: (\fIkt97679\fP) fix for: service.enabled fails on xen server .nf \(ga#28754\(ga_ .fi @@ -230571,7 +230571,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28695\fP: (\fIs0undt3ch\fP) [2015.8] Update to latest bootstrap script v2015.11.09 .IP \(bu 2 -\fBPR\fP \fI\%#28656\fP: (\fIclarkperkins\fP) +\fBPR\fP \fI\%#28656\fP: (\fIclarkperkins\fP) .nf \(ga#28526\(ga_ .fi @@ -230637,7 +230637,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28564\fP: (\fIs0undt3ch\fP) [2015.8] Update to latest bootstrap script v2015.11.04 .IP \(bu 2 -\fBPR\fP \fI\%#28561\fP: (\fIOro\fP) Issue +\fBPR\fP \fI\%#28561\fP: (\fIOro\fP) Issue .nf \(ga#28527\(ga_ .fi @@ -230685,13 +230685,13 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28491\fP: (\fIrallytime\fP) Back\-port \fI\%#28388\fP to 2015.8 .IP \(bu 2 -\fBPR\fP \fI\%#28465\fP: (\fItwangboy\fP) Fix +\fBPR\fP \fI\%#28465\fP: (\fItwangboy\fP) Fix .nf \(ga#12363\(ga_ .fi : Password Expiration in Windows .IP \(bu 2 -\fBPR\fP \fI\%#28485\fP: (\fInasenbaer13\fP) Fix invalid usage of _get_conn causing +\fBPR\fP \fI\%#28485\fP: (\fInasenbaer13\fP) Fix invalid usage of _get_conn causing .nf \(ga#28484\(ga_ .fi @@ -230711,7 +230711,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28422\fP: (\fIcachedout\fP) Handle windows logging on thread_multi [WIP] .IP \(bu 2 -\fBPR\fP \fI\%#28425\fP: (\fItwangboy\fP) Fix +\fBPR\fP \fI\%#28425\fP: (\fItwangboy\fP) Fix .nf \(ga#13513\(ga_ .fi @@ -230831,7 +230831,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28098\fP: (\fIjacksontj\fP) For all multi\-part messages, check the headers. If the header is not … .IP \(bu 2 -\fBPR\fP \fI\%#28134\fP: (\fIbernieke\fP) fix unicode pillar values +\fBPR\fP \fI\%#28134\fP: (\fIbernieke\fP) fix unicode pillar values .nf \(ga#3436\(ga_ .fi @@ -230887,7 +230887,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27983\fP: (\fIrallytime\fP) Pip state run result should be False, not None, if installation error occurs. .IP \(bu 2 -\fBPR\fP \fI\%#27991\fP: (\fItwangboy\fP) Fix for +\fBPR\fP \fI\%#27991\fP: (\fItwangboy\fP) Fix for .nf \(ga#20678\(ga_ .fi @@ -230899,7 +230899,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27992\fP: (\fIcachedout\fP) Make load beacon config into list .IP \(bu 2 -\fBPR\fP \fI\%#28003\fP: (\fItwangboy\fP) Fix +\fBPR\fP \fI\%#28003\fP: (\fItwangboy\fP) Fix .nf \(ga#26336\(ga_ .fi @@ -230979,7 +230979,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27859\fP: (\fIticosax\fP) [dockerng] Clarify doc port bindings .IP \(bu 2 -\fBPR\fP \fI\%#27748\fP: (\fImultani\fP) Fix +\fBPR\fP \fI\%#27748\fP: (\fImultani\fP) Fix .nf \(ga#8646\(ga_ .fi @@ -231003,7 +231003,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27827\fP: (\fItechhat\fP) Add additional error checking to SPM .IP \(bu 2 -\fBPR\fP \fI\%#27826\fP: (\fImartinhoefling\fP) Fixes +\fBPR\fP \fI\%#27826\fP: (\fImartinhoefling\fP) Fixes .nf \(ga#27825\(ga_ .fi @@ -231043,7 +231043,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27705\fP: (\fIrallytime\fP) Merge \fI\%#27602\fP with final pylint fix .IP \(bu 2 -\fBPR\fP \fI\%#27691\fP: (\fInotpeter\fP) Faster timeout (3s vs 2min) for instance metadata lookups. +\fBPR\fP \fI\%#27691\fP: (\fInotpeter\fP) Faster timeout (3s vs 2min) for instance metadata lookups. .nf \(ga#13850\(ga_ .fi @@ -231701,7 +231701,7 @@ fdb6424 lxc: Fix salt config (no more a kwarg) .IP \(bu 2 b818f72 Merge pull request \fI\%#23922\fP from garethgreenaway/23900_2015_5_bonding_interface_fixes .IP \(bu 2 -0bba536 Fixing issue reported when using bonded interfaces on Ubuntu. Attributes should be bond\-, but the code was attempting to split just on +0bba536 Fixing issue reported when using bonded interfaces on Ubuntu. Attributes should be bond\-, but the code was attempting to split just on .nf bond_ .fi @@ -237933,7 +237933,7 @@ Changes: \fBPR\fP \fI\%#26292\fP: (\fIjquast\fP) Rabbitmq 3.2.4 on Ubuntu has "...done.", not "...done" @ \fI2015\-08\-13T19:53:29Z\fP .IP \(bu 2 -\fBPR\fP \fI\%#26296\fP: (\fIjquast\fP) bugfix missing +\fBPR\fP \fI\%#26296\fP: (\fIjquast\fP) bugfix missing .nf \(ga .fi @@ -239680,7 +239680,7 @@ Changes: \fBPR\fP \fI\%#26292\fP: (\fIjquast\fP) Rabbitmq 3.2.4 on Ubuntu has "...done.", not "...done" @ \fI2015\-08\-13T19:53:29Z\fP .IP \(bu 2 -\fBPR\fP \fI\%#26296\fP: (\fIjquast\fP) bugfix missing +\fBPR\fP \fI\%#26296\fP: (\fIjquast\fP) bugfix missing .nf \(ga .fi @@ -241673,7 +241673,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27468\fP: (\fIcachedout\fP) Fix 27351 .IP \(bu 2 -\fBPR\fP \fI\%#27479\fP: (\fIaboe76\fP) fix locale on opensuse and suse +\fBPR\fP \fI\%#27479\fP: (\fIaboe76\fP) fix locale on opensuse and suse .nf \(ga#27438\(ga_ .fi @@ -241693,7 +241693,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27408\fP: (\fIrallytime\fP) Fix avail_locations function for the softlayer_hw driver in 2015.5 .IP \(bu 2 -\fBPR\fP \fI\%#27410\fP: (\fIjacobhammons\fP) Fix css layout Refs +\fBPR\fP \fI\%#27410\fP: (\fIjacobhammons\fP) Fix css layout Refs .nf \(ga#27389\(ga_ .fi @@ -241701,7 +241701,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#27336\fP: (\fIrallytime\fP) [2015.5] Fixup salt\-cloud logging .IP \(bu 2 -\fBPR\fP \fI\%#27358\fP: (\fIlorengordon\fP) Escape search replacement text, fixes +\fBPR\fP \fI\%#27358\fP: (\fIlorengordon\fP) Escape search replacement text, fixes .nf \(ga#27356\(ga_ .fi @@ -241861,7 +241861,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#26759\fP: (\fIterminalmage\fP) Backport PR \fI\%#26726\fP to 2015.5 branch .IP \(bu 2 -\fBPR\fP \fI\%#26768\fP: (\fIgarethgreenaway\fP) Fixes to ipset in 2015.5 for +\fBPR\fP \fI\%#26768\fP: (\fIgarethgreenaway\fP) Fixes to ipset in 2015.5 for .nf \(ga#26628\(ga_ .fi @@ -241976,13 +241976,13 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28829\fP: (\fIbasepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5 .IP \(bu 2 -\fBPR\fP \fI\%#28756\fP: (\fIMrCitron\fP) Fix +\fBPR\fP \fI\%#28756\fP: (\fIMrCitron\fP) Fix .nf \(ga#25775\(ga_ .fi .IP \(bu 2 -\fBPR\fP \fI\%#28786\fP: (\fIchrigl\fP) closes +\fBPR\fP \fI\%#28786\fP: (\fIchrigl\fP) closes .nf \(ga#28783\(ga_ .fi @@ -242046,7 +242046,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28366\fP: (\fIerchn\fP) mark repo not enabled when pkgrepo state passes in disable: True .IP \(bu 2 -\fBPR\fP \fI\%#28373\fP: (\fIbeverlcl\fP) Fixing bug +\fBPR\fP \fI\%#28373\fP: (\fIbeverlcl\fP) Fixing bug .nf \(ga#28372\(ga_ .fi @@ -242076,7 +242076,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28174\fP: (\fIlorengordon\fP) Add support for multiline regex in file.replace .IP \(bu 2 -\fBPR\fP \fI\%#28175\fP: (\fItwangboy\fP) Fixes +\fBPR\fP \fI\%#28175\fP: (\fItwangboy\fP) Fixes .nf \(ga#19673\(ga_ .fi @@ -242231,13 +242231,13 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28829\fP: (\fIbasepi\fP) [2015.5] Merge forward from 2014.7 to 2015.5 .IP \(bu 2 -\fBPR\fP \fI\%#28756\fP: (\fIMrCitron\fP) Fix +\fBPR\fP \fI\%#28756\fP: (\fIMrCitron\fP) Fix .nf \(ga#25775\(ga_ .fi .IP \(bu 2 -\fBPR\fP \fI\%#28786\fP: (\fIchrigl\fP) closes +\fBPR\fP \fI\%#28786\fP: (\fIchrigl\fP) closes .nf \(ga#28783\(ga_ .fi @@ -242301,7 +242301,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28366\fP: (\fIerchn\fP) mark repo not enabled when pkgrepo state passes in disable: True .IP \(bu 2 -\fBPR\fP \fI\%#28373\fP: (\fIbeverlcl\fP) Fixing bug +\fBPR\fP \fI\%#28373\fP: (\fIbeverlcl\fP) Fixing bug .nf \(ga#28372\(ga_ .fi @@ -242331,7 +242331,7 @@ Changes: .IP \(bu 2 \fBPR\fP \fI\%#28174\fP: (\fIlorengordon\fP) Add support for multiline regex in file.replace .IP \(bu 2 -\fBPR\fP \fI\%#28175\fP: (\fItwangboy\fP) Fixes +\fBPR\fP \fI\%#28175\fP: (\fItwangboy\fP) Fixes .nf \(ga#19673\(ga_ .fi diff --git a/doc/ref/returners/index.rst b/doc/ref/returners/index.rst index 3b7baa0d8efc..66ed0c72019b 100644 --- a/doc/ref/returners/index.rst +++ b/doc/ref/returners/index.rst @@ -46,13 +46,13 @@ Writing a Returner ================== A returner is a Python module containing at minimum a ``returner`` function. -Other optional functions can be included to add support for +Other optional functions can be included to add support for :ref:`master_job_cache`, :ref:`external_job_cache`, and `Event Returners`_. ``returner`` The ``returner`` function must accept a single argument. The argument contains return data from the called minion function. If the minion - function ``test.ping`` is called, the value of the argument will be a + function ``test.ping`` is called, the value of the argument will be a dictionary. Run the following command from a Salt master to get a sample of the dictionary: @@ -90,8 +90,8 @@ Salt's :ref:`master_job_cache` allows returners to be used as a pluggable replacement for the :ref:`default_job_cache`. In order to do so, a returner must implement the following functions: -.. note:: - +.. note:: + The code samples contained in this section were taken from the cassandra_cql returner. @@ -128,7 +128,7 @@ must implement the following functions: ) VALUES ( '{0}', '{1}' );'''.format(jid, json.dumps(load)) - + # cassandra_cql.cql_query may raise a CommandExecutionError try: __salt__['cassandra_cql.cql_query'](query) @@ -141,7 +141,7 @@ must implement the following functions: raise -``get_load`` +``get_load`` must accept a job id (jid) and return the job load stored by ``save_load``, or an empty dictionary when not found. @@ -152,9 +152,9 @@ must implement the following functions: Return the load data that marks a specified jid ''' query = '''SELECT load FROM salt.jids WHERE jid = '{0}';'''.format(jid) - + ret = {} - + # cassandra_cql.cql_query may raise a CommandExecutionError try: data = __salt__['cassandra_cql.cql_query'](query) @@ -169,9 +169,9 @@ must implement the following functions: log.critical('''Unexpected error while getting load from jids: {0}'''.format(str(e))) raise - + return ret - + External Job Cache Support -------------------------- @@ -270,7 +270,7 @@ contains the jid and therefore is guaranteed to be unique. def event_return(events): ''' Return event to mysql server - + Requires that configuration be enabled via 'event_return' option in master config. ''' @@ -281,7 +281,7 @@ contains the jid and therefore is guaranteed to be unique. sql = '''INSERT INTO `salt_events` (`tag`, `data`, `master_id` ) VALUES (%s, %s, %s)''' cur.execute(sql, (tag, json.dumps(data), __opts__['id'])) - + Custom Returners ---------------- diff --git a/doc/ref/states/include.rst b/doc/ref/states/include.rst index 86a2d07a5645..22c72f988b87 100644 --- a/doc/ref/states/include.rst +++ b/doc/ref/states/include.rst @@ -31,7 +31,7 @@ the following syntax is used: - dev: http **NOTE**: ``include`` does not simply inject the states where you place it -in the SLS file. If you need to guarantee order of execution, consider using +in the SLS file. If you need to guarantee order of execution, consider using requisites. .. include:: ../../_incl/_incl/sls_filename_cant_contain_period.rst diff --git a/doc/ref/states/requisites.rst b/doc/ref/states/requisites.rst index bb27977ea831..c227e036e4d8 100644 --- a/doc/ref/states/requisites.rst +++ b/doc/ref/states/requisites.rst @@ -44,9 +44,9 @@ Requisites The Salt requisite system is used to create relationships between states. The core idea being that, when one state is dependent somehow on another, that inter-dependency can be easily defined. These dependencies are expressed by -declaring the relationships using state names and ID's or names. The +declaring the relationships using state names and ID's or names. The generalized form of a requisite target is `` : ``. -The specific form is defined as a :ref:`Requisite Reference +The specific form is defined as a :ref:`Requisite Reference ` Requisites come in two types: Direct requisites (such as ``require``), diff --git a/doc/topics/beacons/index.rst b/doc/topics/beacons/index.rst index aad2a8f4dad7..31ca5b1b5100 100644 --- a/doc/topics/beacons/index.rst +++ b/doc/topics/beacons/index.rst @@ -231,7 +231,7 @@ The `beacon` Function The beacons system will look for a function named `beacon` in the module. If this function is not present then the beacon will not be fired. This function is called on a regular basis and defaults to being called on every iteration of the -minion, which can be tens to hundreds of times a second. This means that the +minion, which can be tens to hundreds of times a second. This means that the `beacon` function cannot block and should not be CPU or IO intensive. The beacon function will be passed in the configuration for the executed diff --git a/doc/topics/cloud/aws.rst b/doc/topics/cloud/aws.rst index c008397513ac..bdee883867b6 100644 --- a/doc/topics/cloud/aws.rst +++ b/doc/topics/cloud/aws.rst @@ -51,7 +51,7 @@ parameters are discussed in more detail below. # with a one second delay betwee retries win_deploy_auth_retries: 10 win_deploy_auth_retry_delay: 1 - + # Set the EC2 access credentials (see below) # id: 'use-instance-role-credentials' @@ -106,7 +106,7 @@ parameters are discussed in more detail below. # with a one second delay betwee retries win_deploy_auth_retries: 10 win_deploy_auth_retry_delay: 1 - + # Set the EC2 access credentials (see below) # id: 'use-instance-role-credentials' @@ -993,7 +993,7 @@ the network interfaces of your virtual machines, for example:- SubnetId: subnet-XXXXXXXX SecurityGroupId: - sg-XXXXXXXX - + # Uncomment this line if you would like to set an explicit private # IP address for the ec2 instance # diff --git a/doc/topics/cloud/gce.rst b/doc/topics/cloud/gce.rst index 98d62ae2973a..0c5362709b9e 100644 --- a/doc/topics/cloud/gce.rst +++ b/doc/topics/cloud/gce.rst @@ -52,7 +52,7 @@ Google Compute Engine Setup *Service Account* and click the *Create Client ID* button. This will automatically download a ``.json`` file, which may or may not be used in later steps, depending on your version of ``libcloud``. - + Look for a new *Service Account* section in the page and record the generated email address for the matching key/fingerprint. The email address will be used in the ``service_account_email_address`` of the ``/etc/salt/cloud.providers`` @@ -80,7 +80,7 @@ Google Compute Engine Setup openssl pkcs12 -in ORIG.p12 -passin pass:notasecret \ -nodes -nocerts | openssl rsa -out NEW.pem - + Provider Configuration ====================== diff --git a/doc/topics/cloud/rackspace.rst b/doc/topics/cloud/rackspace.rst index 7d5751bb3cad..312e195a060c 100644 --- a/doc/topics/cloud/rackspace.rst +++ b/doc/topics/cloud/rackspace.rst @@ -182,7 +182,7 @@ configuration please add: Private Subnets --------------- By default salt-cloud will not add Rackspace private networks to new servers. To enable -a private network to a server instantiated by salt cloud, add the following section +a private network to a server instantiated by salt cloud, add the following section to the provider file (typically ``/etc/salt/cloud.providers.d/rackspace.conf``) .. code-block:: yaml @@ -198,13 +198,13 @@ to the provider file (typically ``/etc/salt/cloud.providers.d/rackspace.conf``) To get the Rackspace private network ID, go to Networking, Networks and hover over the private network name. -The order of the networks in the above code block does not map to the order of the +The order of the networks in the above code block does not map to the order of the ethernet devices on newly created servers. Public IP will always be first ( eth0 ) followed by servicenet ( eth1 ) and then private networks. Enabling the private network per above gives the option of using the private subnet for -all master-minion communication, including the bootstrap install of salt-minion. To -enable the minion to use the private subnet, update the master: line in the minion: -section of the providers file. To configure the master to only listen on the private -subnet IP, update the interface: line in the /etc/salt/master file to be the private +all master-minion communication, including the bootstrap install of salt-minion. To +enable the minion to use the private subnet, update the master: line in the minion: +section of the providers file. To configure the master to only listen on the private +subnet IP, update the interface: line in the /etc/salt/master file to be the private subnet IP of the salt master. diff --git a/doc/topics/development/conventions/formulas.rst b/doc/topics/development/conventions/formulas.rst index c996f70d2c98..e2fde521f579 100644 --- a/doc/topics/development/conventions/formulas.rst +++ b/doc/topics/development/conventions/formulas.rst @@ -415,9 +415,9 @@ from the Salt Master. For example: {% set some_data = salt.pillar.get('some_data', {'sane default': True}) %} {# or #} - + {% import_yaml 'path/to/file.yaml' as some_data %} - + {# or #} {% import_json 'path/to/file.json' as some_data %} @@ -581,7 +581,7 @@ read it will be hard to maintain -- switch to a format that is easier to read. Using alternate renderers is very simple to do using Salt's "she-bang" syntax at the top of the file. The Python renderer must simply return the correct :ref:`highstate data structure `. The following -example is a state tree of two sls files, one simple and one complicated. +example is a state tree of two sls files, one simple and one complicated. ``/srv/salt/top.sls``: @@ -951,7 +951,7 @@ XML.) {% import_yaml 'tomcat/defaults.yaml' as server_xml_defaults %} {% set server_xml_final_values = salt.pillar.get( - 'appX:server_xml_overrides', + 'appX:server_xml_overrides', default=server_xml_defaults, merge=True) %} diff --git a/doc/topics/development/hacking.rst b/doc/topics/development/hacking.rst index c2ca7f04dfb7..0f7b1f8a2477 100644 --- a/doc/topics/development/hacking.rst +++ b/doc/topics/development/hacking.rst @@ -179,22 +179,22 @@ If you would like to log to the console instead of to the log file, remove the .. note:: Too long socket path? Once the minion starts, you may see an error like the following: - + .. code-block:: bash - + zmq.core.error.ZMQError: ipc path "/path/to/your/virtualenv/ var/run/salt/minion/minion_event_7824dcbcfd7a8f6755939af70b96249f_pub.ipc" is longer than 107 characters (sizeof(sockaddr_un.sun_path)). - + This means that the path to the socket the minion is using is too long. This is a system limitation, so the only workaround is to reduce the length of this path. This can be done in a couple different ways: - + 1. Create your virtualenv in a path that is short enough. 2. Edit the :conf_minion:`sock_dir` minion config variable and reduce its length. Remember that this path is relative to the value you set in :conf_minion:`root_dir`. - + ``NOTE:`` The socket path is limited to 107 characters on Solaris and Linux, and 103 characters on BSD-based systems. diff --git a/doc/topics/development/reporting_bugs.rst b/doc/topics/development/reporting_bugs.rst index 9c0e09063a99..3e0f900b5663 100644 --- a/doc/topics/development/reporting_bugs.rst +++ b/doc/topics/development/reporting_bugs.rst @@ -31,7 +31,7 @@ In an issue report, please include the following information: with the ``-ldebug`` flag set. .. note:: - + Please be certain to scrub any logs or SLS files for sensitive data! diff --git a/doc/topics/highavailability/index.rst b/doc/topics/highavailability/index.rst index eb3b1b86081d..6506cae3aef8 100644 --- a/doc/topics/highavailability/index.rst +++ b/doc/topics/highavailability/index.rst @@ -41,7 +41,7 @@ will not get scheduled. Failover can be combined with PKI-style encrypted keys, but PKI is NOT REQUIRED to use failover. -Multimaster with PKI and Failover is discussed in +Multimaster with PKI and Failover is discussed in :doc:`this tutorial ` ``master_type: failover`` can be combined with ``master_shuffle: True`` diff --git a/doc/topics/installation/debian.rst b/doc/topics/installation/debian.rst index ea213101382b..e4fa6e89bb80 100644 --- a/doc/topics/installation/debian.rst +++ b/doc/topics/installation/debian.rst @@ -178,14 +178,14 @@ To install fresh release of Salt minion on Jessie: #. Install Salt dependencies: **Debian**: - + .. code-block:: bash - + apt-get update apt-get install python-zmq python-tornado/jessie-backports salt-common/stretch **Raspbian**: - + .. code-block:: bash apt-get update diff --git a/doc/topics/installation/freebsd.rst b/doc/topics/installation/freebsd.rst index d5de9ec117de..5035182cfccc 100644 --- a/doc/topics/installation/freebsd.rst +++ b/doc/topics/installation/freebsd.rst @@ -17,7 +17,7 @@ FreeBSD repo ============ The FreeBSD pkgng repository is preconfigured on systems 10.x and above. No -configuration is needed to pull from these repositories. +configuration is needed to pull from these repositories. .. code-block:: shell @@ -36,7 +36,7 @@ following file to your system: **/usr/local/etc/pkg/repos/saltstack.conf:** -.. code-block:: json +.. code-block:: json saltstack: { url: "https://repo.saltstack.com/freebsd/${ABI}/", diff --git a/doc/topics/jobs/external_cache.rst b/doc/topics/jobs/external_cache.rst index 472540d2c52d..ff5c6fe7509e 100644 --- a/doc/topics/jobs/external_cache.rst +++ b/doc/topics/jobs/external_cache.rst @@ -13,7 +13,7 @@ mechanisms to send job results to other systems (databases, local syslog, and others): * External Job Cache -* Master Job Cache +* Master Job Cache The major difference between these two mechanism is from where results are returned (from the Salt Master or Salt @@ -62,7 +62,7 @@ Before you configure a job cache, it is essential to understand Salt returner modules ("returners"). Returners are pluggable Salt Modules that take the data returned by jobs, and then perform any necessary steps to send the data to an external system. For example, a returner might establish a connection, -authenticate, and then format and transfer data. +authenticate, and then format and transfer data. The Salt Returner system provides the core functionality used by the External and Master Job Cache systems, and the same returners are used by both systems. @@ -92,7 +92,7 @@ Step 2: Configure the Returner After you understand the configuration and have the external system ready, add the returner configuration settings to the Salt Minion configuration file for the External Job Cache, or to the Salt Master configuration file for the Master -Job Cache. +Job Cache. For example, MySQL requires: @@ -108,7 +108,7 @@ Slack requires: .. code-block:: yaml - slack.channel: 'channel' + slack.channel: 'channel' slack.api_key: 'key' slack.from_name: 'name' diff --git a/doc/topics/mine/index.rst b/doc/topics/mine/index.rst index ba7b7592c36c..64611d87ed40 100644 --- a/doc/topics/mine/index.rst +++ b/doc/topics/mine/index.rst @@ -45,7 +45,7 @@ passed, an empty list must be added: Mine Functions Aliases ---------------------- -Function aliases can be used to provide friendly names, usage intentions or to allow +Function aliases can be used to provide friendly names, usage intentions or to allow multiple calls of the same function with different arguments. There is a different syntax for passing positional and key-value arguments. Mixing positional and key-value arguments is not supported. @@ -63,7 +63,7 @@ key-value arguments is not supported. ip_list: - mine_function: grains.get - ip_interfaces - + .. _mine_interval: diff --git a/doc/topics/proxyminion/demo.rst b/doc/topics/proxyminion/demo.rst index b54ed8e87ab0..5d0ff5dfafd3 100644 --- a/doc/topics/proxyminion/demo.rst +++ b/doc/topics/proxyminion/demo.rst @@ -82,9 +82,9 @@ the 'url' key above should say ``url: http://127.0.0.1:8000`` salt-proxy --proxyid=p8000 -l debug 6. Accept your proxy's key on your salt-master - + .. code-block:: bash - + salt-key -y -a p8000 The following keys are going to be accepted: Unaccepted Keys: @@ -108,8 +108,8 @@ the 'url' key above should say ``url: http://127.0.0.1:8000`` can target proxies via grains if you like. 10. You can also start and stop the available services (apache, redbull, and - postgresql with ``service.start``, etc. - + postgresql with ``service.start``, etc. + 11. States can be written to target the proxy. Feel free to experiment with them. - + diff --git a/doc/topics/reactor/index.rst b/doc/topics/reactor/index.rst index f70607590a47..4a7fe2e3352d 100644 --- a/doc/topics/reactor/index.rst +++ b/doc/topics/reactor/index.rst @@ -456,8 +456,8 @@ Ink servers in the master configuration. The above will also return the highstate result data using the `smtp_return` returner (use virtualname like when using from the command line with `--return`). -The returner needs to be configured on the minion for this to work. -See :mod:`salt.returners.smtp_return ` documentation +The returner needs to be configured on the minion for this to work. +See :mod:`salt.returners.smtp_return ` documentation for that. .. _minion-start-reactor: diff --git a/doc/topics/releases/2014.7.0.rst b/doc/topics/releases/2014.7.0.rst index 04917c27a61e..76a88e11129c 100644 --- a/doc/topics/releases/2014.7.0.rst +++ b/doc/topics/releases/2014.7.0.rst @@ -551,7 +551,7 @@ New Salt-Cloud Providers Salt Call Change ================ -When used with a returner, salt-call now contacts a master if ``--local`` +When used with a returner, salt-call now contacts a master if ``--local`` is not specicified. diff --git a/doc/topics/releases/2014.7.3.rst b/doc/topics/releases/2014.7.3.rst index ecabe50c70c7..5510e2153fb1 100644 --- a/doc/topics/releases/2014.7.3.rst +++ b/doc/topics/releases/2014.7.3.rst @@ -92,7 +92,7 @@ Changes: works. Fixing it requires either passing through the file twice (the first time only to search for content and set a flag), or rewriting `file.replace` so it doesn't use `fileinput` - + - VCS filreserver fixes/optimizations - Catch fileserver configuration errors on master start @@ -137,4 +137,4 @@ Known issues: - In multimaster mode, a minion may become temporarily unresponsive if modules or pillars are refreshed at the same time that one or more masters are down. This can be worked around by setting - 'auth_timeout' and 'auth_tries' down to shorter periods. + 'auth_timeout' and 'auth_tries' down to shorter periods. diff --git a/doc/topics/releases/2014.7.4.rst b/doc/topics/releases/2014.7.4.rst index c61bc4de6679..3b38ab3c70ab 100644 --- a/doc/topics/releases/2014.7.4.rst +++ b/doc/topics/releases/2014.7.4.rst @@ -101,7 +101,7 @@ Changes: works. Fixing it requires either passing through the file twice (the first time only to search for content and set a flag), or rewriting `file.replace` so it doesn't use `fileinput` - + - VCS filreserver fixes/optimizations - Catch fileserver configuration errors on master start diff --git a/doc/topics/releases/2014.7.5.rst b/doc/topics/releases/2014.7.5.rst index 2470061f1c8c..0b8b0c05ab1a 100644 --- a/doc/topics/releases/2014.7.5.rst +++ b/doc/topics/releases/2014.7.5.rst @@ -2,7 +2,7 @@ Salt 2014.7.5 Release Notes =========================== -:release: 2015-04-16 +:release: 2015-04-16 Version 2014.7.5 is a bugfix release for :doc:`2014.7.0 `. diff --git a/doc/topics/releases/2014.7.6.rst b/doc/topics/releases/2014.7.6.rst index 89af1903a7ec..22ff0c79e2f0 100644 --- a/doc/topics/releases/2014.7.6.rst +++ b/doc/topics/releases/2014.7.6.rst @@ -704,7 +704,7 @@ Extended Changelog Courtesy of Todd Stansell (https://github.com/tjstansell/salt * 8bb4664 Merge pull request `#23145`_ from rallytime/`bp-23089`_ * 93c41af Stringify version number before lstrip -- **PR** `#23144`_: (*rallytime*) Backport `#23124`_ to 2014.7 +- **PR** `#23144`_: (*rallytime*) Backport `#23124`_ to 2014.7 @ *2015-04-28T20:44:46Z* - **ISSUE** `#16188`_: (*drawks*) salt.modules.parted has various functions with bogus input validation. diff --git a/doc/topics/releases/2015.5.5.rst b/doc/topics/releases/2015.5.5.rst index 103d06013fc2..8271f76c6079 100644 --- a/doc/topics/releases/2015.5.5.rst +++ b/doc/topics/releases/2015.5.5.rst @@ -1365,7 +1365,7 @@ Changes: - **ISSUE** `#26366`_: (*GreatSnoopy*) The development tree produces hanging, 100%cpu salt-master processes | refs: `#26443`_ - - **ISSUE** `#26301`_: (*waynew*) CPU pegged out running salt-master (after running command) + - **ISSUE** `#26301`_: (*waynew*) CPU pegged out running salt-master (after running command) | refs: `#26443`_ - **ISSUE** `#25998`_: (*driskell*) Event subsystem discarding required events during --batch breaking it for slow running commands | refs: `#26000`_ diff --git a/doc/topics/releases/2015.5.6.rst b/doc/topics/releases/2015.5.6.rst index f4d40c27f9b2..5ad793a1853c 100644 --- a/doc/topics/releases/2015.5.6.rst +++ b/doc/topics/releases/2015.5.6.rst @@ -196,7 +196,7 @@ Changes: - **PR** `#26817`_: (*jfindlay*) modify groupadd for rhel 5 -- **PR** `#26824`_: (*pravka*) [salt-cloud] Fix creating droplet from snapshot in digital_ocean provider +- **PR** `#26824`_: (*pravka*) [salt-cloud] Fix creating droplet from snapshot in digital_ocean provider - **PR** `#26823`_: (*joejulian*) use dbus instead of localectl diff --git a/doc/topics/releases/2015.5.7.rst b/doc/topics/releases/2015.5.7.rst index 323072b630d2..ab48f4342f7e 100644 --- a/doc/topics/releases/2015.5.7.rst +++ b/doc/topics/releases/2015.5.7.rst @@ -104,7 +104,7 @@ Changes: - **PR** `#28263`_: (*cachedout*) New channel for event.send -- **PR** `#28293`_: (*cachedout*) Minor grammar changes +- **PR** `#28293`_: (*cachedout*) Minor grammar changes - **PR** `#28271`_: (*gwaters*) Update tutorial documentation diff --git a/doc/topics/releases/2015.8.2.rst b/doc/topics/releases/2015.8.2.rst index 4712daff6216..aa82cc942560 100644 --- a/doc/topics/releases/2015.8.2.rst +++ b/doc/topics/releases/2015.8.2.rst @@ -45,7 +45,7 @@ Changes: - **PR** `#28782`_: (*rallytime*) Fixes to rabbitmq user state -- **PR** `#28789`_: (*nmadhok*) Provide ability to enable/disable customization for newly create VMs using VMware salt-cloud driver +- **PR** `#28789`_: (*nmadhok*) Provide ability to enable/disable customization for newly create VMs using VMware salt-cloud driver - **PR** `#28768`_: (*mrosedale*) 2015.8 @@ -123,7 +123,7 @@ Changes: - **PR** `#28602`_: (*nasenbaer13*) Allow setting of custom dimensions in asg alarm specification -- **PR** `#28596`_: (*rallytime*) Merge branch '2015.5' into '2015.8' +- **PR** `#28596`_: (*rallytime*) Merge branch '2015.5' into '2015.8' - **PR** `#28593`_: (*blueyed*) doc: fix typo with salt.states.file: s/preseve/preserve/ diff --git a/doc/topics/spm/dev.rst b/doc/topics/spm/dev.rst index 4aad9a3e4756..6484a8cc03a4 100644 --- a/doc/topics/spm/dev.rst +++ b/doc/topics/spm/dev.rst @@ -132,7 +132,7 @@ The arguments that are passed in, in order, are ``name`` (required), ``pkg`` ``name`` is the path of the file, as it was installed on the filesystem. -``pkg`` is the name of the package that the file belongs to. +``pkg`` is the name of the package that the file belongs to. ``conn`` is the connection object returned from ``init()``. diff --git a/doc/topics/ssh/index.rst b/doc/topics/ssh/index.rst index 212edbb28204..1a8878cb3ef7 100644 --- a/doc/topics/ssh/index.rst +++ b/doc/topics/ssh/index.rst @@ -142,7 +142,7 @@ systems still need to be implemented. .. note:: By default, Grains are settable through ``salt-ssh``. By - default, these grains will *not* be persisted across reboots. + default, these grains will *not* be persisted across reboots. See the "thin_dir" setting in :doc:`Roster documentation ` for more details. diff --git a/doc/topics/targeting/nodegroups.rst b/doc/topics/targeting/nodegroups.rst index f19b1c4f6121..3024d7f5c8cc 100644 --- a/doc/topics/targeting/nodegroups.rst +++ b/doc/topics/targeting/nodegroups.rst @@ -77,21 +77,21 @@ nodegroup`` on the line directly following the nodegroup name. Using Nodegroups in SLS files ============================= -To use Nodegroups in Jinja logic for SLS files, the :conf_master:`pillar_opts` option in -``/etc/salt/master`` must be set to "True". This will pass the master's configuration as +To use Nodegroups in Jinja logic for SLS files, the :conf_master:`pillar_opts` option in +``/etc/salt/master`` must be set to "True". This will pass the master's configuration as Pillar data to each minion. .. note:: - If the master's configuration contains any sensitive data, this will be passed to each minion. + If the master's configuration contains any sensitive data, this will be passed to each minion. Do not enable this option if you have any configuration data that you do not want to get on your minions. - Also, if you make changes to your nodegroups, you might need to run + Also, if you make changes to your nodegroups, you might need to run ``salt '*' saltutil.refresh_pillar`` after restarting the master. -Once pillar_opts is enabled, you can find the nodegroups under the "master" pillar. -To make sure that only the correct minions are targeted, +Once pillar_opts is enabled, you can find the nodegroups under the "master" pillar. +To make sure that only the correct minions are targeted, you should use each matcher for the nodegroup definition. For example, to check if a minion is in the 'webserver' nodegroup: @@ -102,13 +102,13 @@ For example, to check if a minion is in the 'webserver' nodegroup: .. code-block:: yaml - {% if grains.id in salt['pillar.get']('master:nodegroups:webserver', []) + {% if grains.id in salt['pillar.get']('master:nodegroups:webserver', []) and grains.os in salt['pillar.get']('master:nodegroups:webserver', []) %} ... {% endif %} .. note:: - If you do not include all of the matchers used to define a nodegroup, - Salt might incorrectly target minions that meet some of the nodegroup + If you do not include all of the matchers used to define a nodegroup, + Salt might incorrectly target minions that meet some of the nodegroup requirements, but not all of them. diff --git a/doc/topics/tutorials/states_pt1.rst b/doc/topics/tutorials/states_pt1.rst index 2dbe18ba57cb..1ff41813c2d3 100644 --- a/doc/topics/tutorials/states_pt1.rst +++ b/doc/topics/tutorials/states_pt1.rst @@ -150,20 +150,20 @@ and all changes made. Note that in the :ref:`example ` above, the SLS file ``webserver.sls`` was referred to simply as ``webserver``. The namespace - for SLS files when referenced in :conf_master:`top.sls ` or an :ref:`include-declaration` + for SLS files when referenced in :conf_master:`top.sls ` or an :ref:`include-declaration` follows a few simple rules: 1. The ``.sls`` is discarded (i.e. ``webserver.sls`` becomes ``webserver``). 2. Subdirectories can be used for better organization. - a. Each subdirectory can be represented with a dot (following the python - import model) or a slash. ``webserver/dev.sls`` can also be referred to + a. Each subdirectory can be represented with a dot (following the python + import model) or a slash. ``webserver/dev.sls`` can also be referred to as ``webserver.dev`` b. Because slashes can be represented as dots, SLS files can not contain - dots in the name besides the dot for the SLS suffix. The SLS file - webserver_1.0.sls can not be matched, and webserver_1.0 would match + dots in the name besides the dot for the SLS suffix. The SLS file + webserver_1.0.sls can not be matched, and webserver_1.0 would match the directory/file webserver_1/0.sls - + 3. A file called ``init.sls`` in a subdirectory is referred to by the path of the directory. So, ``webserver/init.sls`` is referred to as ``webserver``.