add sphinx spelling extension. enforce en_us

This commit is contained in:
Khris Richardson 2014-07-13 13:43:33 -05:00
parent 9ef1d157de
commit 1acd82f3f1
114 changed files with 1262 additions and 308 deletions

View file

@ -189,7 +189,7 @@
# and recon_max value kind of defeats the purpose of being able to
# change these settings. If all minions have the same values and your
# setup is quite large (several thousand minions), they will still
# flood the master. The desired behaviour is to have timeframe within
# flood the master. The desired behavior is to have timeframe within
# all minions try to reconnect.
# Example on how to use these settings:

View file

@ -4232,11 +4232,11 @@ source_file = _build/locale/topics/windows/windows-package-manager.pot
source_lang = en
source_name = topics/windows/windows-package-manager.rst
[salt.topics--windows--windows-specific-behaviour]
file_filter = locale/<lang>/LC_MESSAGES/topics/windows/windows-specific-behaviour.po
source_file = _build/locale/topics/windows/windows-specific-behaviour.pot
[salt.topics--windows--windows-specific-behavior]
file_filter = locale/<lang>/LC_MESSAGES/topics/windows/windows-specific-behavior.po
source_file = _build/locale/topics/windows/windows-specific-behavior.pot
source_lang = en
source_name = topics/windows/windows-specific-behaviour.rst
source_name = topics/windows/windows-specific-behavior.rst
[salt.topics--yaml--index]
file_filter = locale/<lang>/LC_MESSAGES/topics/yaml/index.po

View file

@ -178,6 +178,12 @@ changes: translations
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
spelling:
$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
@echo
@echo "Spell check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/spelling/output.txt."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo

View file

@ -262,7 +262,7 @@ Mounting of filesystems.
\bfseries{\LARGE{sysctl}}
Configuration of the Linux kernel using sysctrl.
Configuration of the Linux kernel using sysctl.
\begin{verbatim}
vm.swappiness:

View file

@ -151,6 +151,7 @@ version = salt.version.__version__
#release = '.'.join(map(str, salt.version.__version_info__))
release = '2014.1.5'
spelling_lang = 'en_US'
language = 'en'
locale_dirs = [
'_locale',
@ -166,6 +167,7 @@ extensions = [
'sphinx.ext.autosummary',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
'sphinxcontrib.spelling',
'httpdomain',
'youtube',
'saltautodoc', # Must be AFTER autodoc

View file

@ -39,7 +39,7 @@ A :mod:`cmd.run <salt.states.cmd.run>` state will run the corresponding command
*every time* (unless it is prevented from running by the ``unless`` or ``onlyif``
arguments).
More details can be found in the docmentation for the :mod:`cmd
More details can be found in the documentation for the :mod:`cmd
<salt.states.cmd>` states.
When I run *test.ping*, why don't the Minions that aren't responding return anything? Returning ``False`` would be helpful.

View file

@ -81,7 +81,7 @@ Remote execution
----------------
Running pre-defined or arbitrary commands on remote hosts, also known as
remote exectution, is the core function of Salt. The following links explore
remote execution, is the core function of Salt. The following links explore
modules and returners, which are two key elements of remote execution.
**Modules**
@ -265,7 +265,7 @@ Reference
Read through the heavily-commented minion configuration file.
:doc:`Full table of contents </contents>`
Read the table of comntents of this document.
Read the table of contents of this document.
FAQ
===

View file

@ -87,7 +87,7 @@ A \fBcmd.run\fP state will run the corresponding command
\fIevery time\fP (unless it is prevented from running by the \fBunless\fP or \fBonlyif\fP
arguments).
.sp
More details can be found in the docmentation for the \fBcmd\fP states.
More details can be found in the documentation for the \fBcmd\fP states.
.SS When I run \fItest.ping\fP, why don\(aqt the Minions that aren\(aqt responding return anything? Returning \fBFalse\fP would be helpful.
.sp
When you run \fItest.ping\fP the Master tells Minions to run commands/functions,
@ -227,7 +227,7 @@ Providing versatility between massive scale deployments and smaller systems may
daunting, but Salt is very simple to set up and maintain, regardless of the
size of the project. The architecture of Salt is designed to work with any
number of servers, from a handful of local network systems to international
deployments across different datacenters. The topology is a simple
deployments across different data centers. The topology is a simple
server/client model with the needed functionality built into a single set of
daemons. While the default configuration will work with little to no
modification, Salt can be fine tuned to meet specific needs.
@ -17827,7 +17827,7 @@ HKG \-> Hong Kong
.UNINDENT
.UNINDENT
.sp
Note: Currently the LON region is only avaiable with a UK account, and UK accounts cannot access other regions
Note: Currently the LON region is only available with a UK account, and UK accounts cannot access other regions
.SS Authentication
.sp
The \fBuser\fP is the same user as is used to log into the Rackspace Control
@ -26531,7 +26531,7 @@ _
T{
\fBsysbench\fP
T} T{
The \(aqsysbench\(aq module is used to analyse the
The \(aqsysbench\(aq module is used to analyze the
T}
_
T{
@ -28803,7 +28803,7 @@ salt \(aq*\(aq pkg.install php54 taps=\(aq["josegonzalez/php", "homebrew/dupes"]
Options to pass to brew. Only applies to initial install. Due to how brew
works, modifying chosen options requires a full uninstall followed by a
fresh install. Note that if "pkgs" is used, all options will be passed
to all packages. Unreconized options for a package will be silently
to all packages. Unrecognized options for a package will be silently
ignored by brew.
.sp
CLI Example:
@ -30429,7 +30429,7 @@ Use composer to install PHP dependencies for a directory
Install composer dependencies for a directory.
.sp
If composer has not been installed globally making it available in the
system PATH & making it executible, the \fBcomposer\fP and \fBphp\fP parameters
system PATH & making it executable, the \fBcomposer\fP and \fBphp\fP parameters
will need to be set to the location of the executables.
.INDENT 7.0
.TP
@ -30442,7 +30442,7 @@ just execute "composer" as if it is installed globally.
(i.e. /path/to/composer.phar)
.TP
.B php
Location of the php executible to use with composer.
Location of the php executable to use with composer.
(i.e. /usr/bin/php)
.TP
.B runas
@ -32381,7 +32381,7 @@ salt \(aq*\(aq disk.inodeusage
.INDENT 0.0
.TP
.B salt.modules.disk.percent(args=None)
Return partion information for volumes mounted on this minion
Return partition information for volumes mounted on this minion
.sp
CLI Example:
.INDENT 7.0
@ -33558,7 +33558,7 @@ how to configure authenticated access.
\fBrepo\fP (\fI\%string\fP) \-\-
.sp
The repository to pull. [registryurl://]REPOSITORY_NAME_image
eg:
e.g.:
.INDENT 2.0
.INDENT 3.5
.sp
@ -33648,7 +33648,7 @@ how to configure authenticated access
.TP
.B repo
[registryurl://]REPOSITORY_NAME_image
eg:
e.g.:
.INDENT 7.0
.INDENT 3.5
.sp
@ -35315,13 +35315,13 @@ Filesystem path to the file to be edited
.B marker_start
The line content identifying a line as the start of the content block.
Note that the whole line containing this marker will be considered, so
whitespaces or extra content before or after the marker is included in
whitespace or extra content before or after the marker is included in
final output
.TP
.B marker_end
The line content identifying a line as the end of the content block.
Note that the whole line containing this marker will be considered, so
whitespaces or extra content before or after the marker is included in
whitespace or extra content before or after the marker is included in
final output
.TP
.B content
@ -36846,7 +36846,7 @@ Options to pass to sed
.TP
.B flags
\fBg\fP
Flags to modify the sed search; e.g., \fBi\fP for case\-insensitve pattern
Flags to modify the sed search; e.g., \fBi\fP for case\-insensitive pattern
matching
.TP
.B negate_match
@ -37493,7 +37493,7 @@ This module has been completely rewritten. Up to and including version
pkgng local database and, if found, would provide some of pkgng\(aqs
functionality. The rewrite of this module has removed all pkgng support,
and moved it to the \fBpkgng\fP execution module. For
verisions <= 0.17.0, the documentation here should not be considered
versions <= 0.17.0, the documentation here should not be considered
accurate. If your Minion is running one of these versions, then the
documentation for this module can be viewed using the \fBsys.doc\fP function:
.INDENT 0.0
@ -39797,7 +39797,7 @@ salt \(aq*\(aq git.stash /path/to/repo master
.TP
.B salt.modules.git.status(cwd, user=None)
Return the status of the repository. The returned format uses the status
codes of gits \(aqporcelain\(aq output mode
codes of git\(aqs \(aqporcelain\(aq output mode
.INDENT 7.0
.TP
.B cwd
@ -40828,7 +40828,7 @@ salt \(aq*\(aq hg.clone /path/to/repo https://bitbucket.org/birkenfeld/sphinx
.INDENT 0.0
.TP
.B salt.modules.hg.describe(cwd, rev=\(aqtip\(aq, user=None)
Mimick git describe and return an identifier for the given revision
Mimic git describe and return an identifier for the given revision
.INDENT 7.0
.TP
.B cwd
@ -41729,7 +41729,7 @@ Only intended to be used within Keystone\-enabled modules
.INDENT 0.0
.TP
.B salt.modules.keystone.ec2_credentials_create(user_id=None, name=None, tenant_id=None, tenant=None, profile=None, **connection_args)
Create EC2\-compatibile credentials for user per tenant
Create EC2\-compatible credentials for user per tenant
.sp
CLI Examples:
.INDENT 7.0
@ -41747,7 +41747,7 @@ salt \(aq*\(aq keystone.ec2_credentials_create user_id=c965f79c4f864
.INDENT 0.0
.TP
.B salt.modules.keystone.ec2_credentials_delete(user_id=None, name=None, access_key=None, profile=None, **connection_args)
Delete EC2\-compatibile credentials
Delete EC2\-compatible credentials
.sp
CLI Examples:
.INDENT 7.0
@ -42553,7 +42553,7 @@ Support for Layman
.INDENT 0.0
.TP
.B salt.modules.layman.add(overlay)
Add the given overlay from the caced remote list to your locally
Add the given overlay from the cached remote list to your locally
installed overlays. Specify \(aqALL\(aq to add all overlays from the
remote list.
.sp
@ -42695,7 +42695,7 @@ ldap.attrs: [saltAttr] (default=None, return all attributes)
At the moment this module only recommends connection to LDAP services
listening on \fBlocalhost\fP\&. This is deliberate to avoid the potentially
dangerous situation of multiple minions sending identical update commands
to the same LDAP server. It\(aqs easy enough to override this behaviour, but
to the same LDAP server. It\(aqs easy enough to override this behavior, but
badness may ensue \- you have been warned.
.UNINDENT
.UNINDENT
@ -47299,7 +47299,7 @@ Jinja Example: Run a query on \fBmydb\fP and use row 0, column 0\(aqs data.
.B salt.modules.mysql.quote_identifier(identifier, for_grants=False)
Return an identifier name (column, table, database, etc) escaped for MySQL
.sp
This means surrounded by "\(ga" character and escaping this charater inside.
This means surrounded by "\(ga" character and escaping this character inside.
It also means doubling the \(aq%\(aq character for MySQLdb internal usage.
.INDENT 7.0
.TP
@ -51879,7 +51879,7 @@ salt \(aq*\(aq pkg.fetch <extended regular expression> pcre=True
.UNINDENT
.TP
.B local
Skip updating the repository catalogues with pkg\-update(8). Use the
Skip updating the repository catalogs with pkg\-update(8). Use the
local cache only.
.sp
CLI Example:
@ -51935,7 +51935,7 @@ salt \(aq*\(aq pkg.install <package name>
Install the package into the specified jail
.TP
.B chroot
Install the paackage into the specified chroot (ignored if \fBjail\fP is
Install the package into the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B orphan
@ -51986,7 +51986,7 @@ salt \(aq*\(aq pkg.install <package name> glob=True
.UNINDENT
.TP
.B local
Do not update the repository catalogues with \fBpkg\-update(8)\fP\&. A
Do not update the repository catalogs with \fBpkg\-update(8)\fP\&. A
value of \fBTrue\fP here is equivalent to using the \fB\-U\fP flag with
\fBpkg install\fP\&.
.sp
@ -52141,7 +52141,7 @@ List the packages currently installed as a dict:
List the packages in the specified jail
.TP
.B chroot
List the pacakges in the specified chroot (ignored if \fBjail\fP is
List the packages in the specified chroot (ignored if \fBjail\fP is
specified)
.UNINDENT
.sp
@ -52212,8 +52212,8 @@ Refresh the pkg database within the specified chroot (ignored if
\fBjail\fP is specified)
.TP
.B force
Force a full download of the repository catalogue without regard to the
respective ages of the local and remote copies of the catalogue.
Force a full download of the repository catalog without regard to the
respective ages of the local and remote copies of the catalog.
.sp
CLI Example:
.INDENT 7.0
@ -52261,7 +52261,7 @@ salt \(aq*\(aq pkg.remove <package name>
Delete the package from the specified jail
.TP
.B chroot
Delete the paackage grom the specified chroot (ignored if \fBjail\fP is
Delete the package from the specified chroot (ignored if \fBjail\fP is
specified)
.TP
.B all_installed
@ -52911,7 +52911,7 @@ salt \(aq*\(aq pkg.upgrade force=True
.UNINDENT
.TP
.B local
Do not update the repository catalogues with \fBpkg\-update(8)\fP\&. A value
Do not update the repository catalogs with \fBpkg\-update(8)\fP\&. A value
of \fBTrue\fP here is equivalent to using the \fB\-U\fP flag with \fBpkg
upgrade\fP\&.
.sp
@ -52929,7 +52929,7 @@ salt \(aq*\(aq pkg.upgrade local=True
.TP
.B dryrun
Dry\-run mode: show what packages have updates available, but do not
perform any upgrades. Repository catalogues will be updated as usual
perform any upgrades. Repository catalogs will be updated as usual
unless the local option is also given.
.sp
CLI Example:
@ -53526,7 +53526,7 @@ overwrite options passed into pillar
.INDENT 0.0
.TP
.B salt.modules.postgres.db_alter(name, user=None, host=None, port=None, maintenance_db=None, password=None, tablespace=None, owner=None, runas=None)
Change tablesbase or/and owner of databse.
Change tablespace or/and owner of database.
.sp
CLI Example:
.INDENT 7.0
@ -54098,7 +54098,7 @@ salt \(aq*\(aq ps.cpu_times
.INDENT 0.0
.TP
.B salt.modules.ps.disk_io_counters()
Return disk I/O statisitics.
Return disk I/O statistics.
.sp
CLI Example:
.INDENT 7.0
@ -54247,7 +54247,7 @@ salt \(aqminion\(aq ps.kill_pid 2000 signal=9
.INDENT 0.0
.TP
.B salt.modules.ps.network_io_counters()
Return network I/O statisitics.
Return network I/O statistics.
.sp
CLI Example:
.INDENT 7.0
@ -54682,7 +54682,7 @@ salt \(aq*\(aq puppet.noop apply /a/b/manifest.pp modulepath=/a/b/modules tags=b
Execute a puppet run and return a dict with the stderr, stdout,
return code, etc. The first positional argument given is checked as a
subcommand. Following positional arguments should be ordered with arguments
required by the subcommand first, followed by non\-keyvalue pair options.
required by the subcommand first, followed by non\-keyword arguments.
Tags are specified by a tag keyword and comma separated list of values. \-\-
\fI\%http://projects.puppetlabs.com/projects/1/wiki/Using_Tags\fP
.sp
@ -55689,7 +55689,7 @@ salt \(aq*\(aq rabbitmq.set_policy / HA \(aq.*\(aq \(aq{"ha\-mode": "all"}\(aq
.INDENT 0.0
.TP
.B salt.modules.rabbitmq.set_user_tags(name, tags, runas=None)
Add user tags via rabbitctl set_user_tags
Add user tags via rabbitmqctl set_user_tags
.sp
CLI Example:
.INDENT 7.0
@ -59416,7 +59416,7 @@ Returns a dict containing the new package names and versions:
.UNINDENT
.UNINDENT
.sp
CLI Example, installing a datastream pkg that already exists on the
CLI Example, installing a data stream pkg that already exists on the
minion:
.INDENT 7.0
.INDENT 3.5
@ -59430,7 +59430,7 @@ salt \(aq*\(aq pkg.install sources=\(aq[{"SMClgcc346": "/var/spool/pkg/gcc\-3.4.
.UNINDENT
.UNINDENT
.sp
CLI Example, installing a datastream pkg that exists on the salt master:
CLI Example, installing a data stream pkg that exists on the salt master:
.INDENT 7.0
.INDENT 3.5
.sp
@ -59443,7 +59443,7 @@ salt \(aq*\(aq pkg.install sources=\(aq[{"SMClgcc346": "salt://pkgs/gcc\-3.4.6\-
.UNINDENT
.UNINDENT
.sp
CLI Example, installing a datastream pkg that exists on a HTTP server:
CLI Example, installing a data stream pkg that exists on a HTTP server:
.INDENT 7.0
.INDENT 3.5
.sp
@ -59463,7 +59463,7 @@ passing \(aq\-G\(aq to the pkgadd command.) Solaris default when installing a
package in the global zone is to install it in all zones. This overrides
that and installs the package only in the global.
.sp
CLI Example, installing a datastream package only in the global zone:
CLI Example, installing a data stream package only in the global zone:
.INDENT 7.0
.INDENT 3.5
.sp
@ -59817,7 +59817,7 @@ Add additional local fs checks for backups to make sure they succeeded
.INDENT 0.0
.TP
.B solr.cores
A list of core names eg [\(aqcore1\(aq,\(aqcore2\(aq].
A list of core names e.g. [\(aqcore1\(aq,\(aqcore2\(aq].
An empty list indicates non\-multicore setup.
.TP
.B solr.baseurl
@ -60029,7 +60029,7 @@ be merged with __opts__
.TP
.B extra
dict ([])
Extra name value pairs to pass to the handler. eg ["name=value"]
Extra name value pairs to pass to the handler. e.g. ["name=value"]
.UNINDENT
.sp
Return : dict<str,obj>:
@ -62422,10 +62422,10 @@ salt \(aq*\(aq svn.update /path/to/repo
.UNINDENT
.SS salt.modules.sysbench
.sp
The \(aqsysbench\(aq module is used to analyse the
The \(aqsysbench\(aq module is used to analyze the
performance of the minions, right from the master!
It measures various system parameters such as
CPU, Memory, FileI/O, Threads and Mutex.
CPU, Memory, File I/O, Threads and Mutex.
.INDENT 0.0
.TP
.B salt.modules.sysbench.cpu()
@ -64142,7 +64142,7 @@ salt \(aq*\(aq tomcat.ls http://localhost:8080/manager
.INDENT 0.0
.TP
.B salt.modules.tomcat.passwd(passwd, user=\(aq\(aq, alg=\(aqmd5\(aq, realm=None)
This function replaces the $CATALINS_HOME/bin/digest.sh script
This function replaces the $CATALINA_HOME/bin/digest.sh script
convert a clear\-text password to the $CATALINA_BASE/conf/tomcat\-users.xml
format
.sp
@ -64194,7 +64194,7 @@ salt \(aq*\(aq tomcat.reload /jenkins http://localhost:8080/manager
.INDENT 0.0
.TP
.B salt.modules.tomcat.serverinfo(url=\(aqhttp://localhost:8080/manager\(aq, timeout=180)
return detailes about the server
return details about the server
.INDENT 7.0
.TP
.B url
@ -70011,7 +70011,7 @@ Do not execute cmd if statement on the host return 0
run buildout in newest mode
.TP
.B force
run buildout unconditionnaly
run buildout unconditionally
.TP
.B verbose
run buildout in verbose mode (\-vvvvv)
@ -75498,7 +75498,7 @@ _
T{
\fBsysctl\fP
T} T{
Configuration of the Linux kernel using sysctrl
Configuration of the Linux kernel using sysctl
T}
_
T{
@ -75770,7 +75770,7 @@ Archive source, same syntax as file.managed source argument.
tar, zip or rar
.TP
.B if_missing
Some archive, such as tar, extract themself in a subfolder.
Some archives, such as tar, extract themselves in a subfolder.
This directive can be used to validate if the archive had been
previously extracted.
.TP
@ -76537,7 +76537,7 @@ just execute "composer" as if it is installed globally.
(i.e. /path/to/composer.phar)
.TP
.B php
Location of the php executible to use with composer.
Location of the php executable to use with composer.
(i.e. /usr/bin/php)
.TP
.B runas
@ -77792,12 +77792,12 @@ and only edit the targeted file if necessary.
.IP \(bu 2
\fBmarker_start\fP \-\- The line content identifying a line as the start of
the content block. Note that the whole line containing this marker will
be considered, so whitespaces or extra content before or after the
be considered, so whitespace or extra content before or after the
marker is included in final output
.IP \(bu 2
\fBmarker_end\fP \-\- The line content identifying a line as the end of
the content block. Note that the whole line containing this marker will
be considered, so whitespaces or extra content before or after the
be considered, so whitespace or extra content before or after the
marker is included in final output.
Note: you can use file.accumulated and target this state. All accumulated
datas dictionnaries content will be added as new lines in the content.
@ -83351,7 +83351,7 @@ openvpn:
.UNINDENT
.sp
By default if a service is triggered to refresh due to a watch statement the
service is by default restarted. If the desired behaviour is to reload the
service is by default restarted. If the desired behavior is to reload the
service, then set the reload value to True:
.INDENT 0.0
.INDENT 3.5
@ -83882,7 +83882,7 @@ Automatically trust the remote server. SVN\(aqs \-\-trust\-server\-cert
.UNINDENT
.UNINDENT
.SS salt.states.sysctl
.SS Configuration of the Linux kernel using sysctrl
.SS Configuration of the Linux kernel using sysctl
.sp
Control the kernel sysctl system.
.INDENT 0.0
@ -86599,7 +86599,7 @@ Return a list of refs that can be used as environments
.B update()
Ensure you are following the latest changes on the remote
.sp
Return boolean wether it worked
Return boolean whether it worked
.UNINDENT
.UNINDENT
.INDENT 0.0
@ -86679,8 +86679,8 @@ if you are using mongo authentication. Defaults to \fB\(aq\(aq\fP\&.
The Mongo ext_pillar takes advantage of the fact that the Salt Master
configuration file is yaml. It uses a sub\-dictionary of values to adjust
specific features of the pillar. This is the explicit single\-line dictionary
notation for yaml. One may be able to get the easier\-to\-read multine dict to
work correctly with some experimentation.
notation for yaml. One may be able to get the easier\-to\-read multi\-line dict
to work correctly with some experimentation.
.INDENT 0.0
.INDENT 3.5
.sp
@ -87354,7 +87354,7 @@ salt\-run doc.execution
.INDENT 0.0
.TP
.B salt.runners.doc.runner()
Return all inline documetation for runner modules
Return all inline documentation for runner modules
.sp
CLI Example:
.INDENT 7.0
@ -88856,7 +88856,7 @@ Otherwise try to extract the private IP and use that one.
.INDENT 0.0
.TP
.B salt.cloud.clouds.cloudstack.get_key()
Returns the ssk private key for VM access
Returns the ssh private key for VM access
.UNINDENT
.INDENT 0.0
.TP
@ -89766,7 +89766,7 @@ my\-imbsce\-config:
password: saltybacon
# The name of the ssh key to use
ssh_key_name: mykey
# The ID of the datacenter to use
# The ID of the data center to use
location: Raleigh
provider: ibmsce
@ -90024,7 +90024,7 @@ Return the image object to use
.B salt.cloud.clouds.joyent.get_location(vm_=None)
.INDENT 7.0
.TP
.B Return the joyent datacenter to use, in this order:
.B Return the joyent data center to use, in this order:
.INDENT 7.0
.IP \(bu 2
CLI parameter
@ -90039,7 +90039,7 @@ Cloud profile setting
.TP
.B salt.cloud.clouds.joyent.get_location_path(location=\(aqus\-east\-1\(aq)
create url from location variable
:param location: joyent datacenter location
:param location: joyent data center location
:return: url
.UNINDENT
.INDENT 0.0
@ -90079,7 +90079,7 @@ salt\-cloud \-f import_key joyent keyname=mykey keyfile=/tmp/mykey.pub
.INDENT 0.0
.TP
.B salt.cloud.clouds.joyent.joyent_node_state(id_)
Convert joyent returned state to state common to other datacenter return
Convert joyent returned state to state common to other data center return
values for consistency
.INDENT 7.0
.TP
@ -90251,7 +90251,7 @@ take action call used by start,stop, reboot
:command: api path
:data: any data to be passed to the api, must be in json format
:method: GET,POST,or DELETE
:location: datacenter to execute the command on
:location: data center to execute the command on
:return: true if successful
.UNINDENT
.SS salt.cloud.clouds.libcloud_aws
@ -90743,7 +90743,7 @@ Return a dict of all available VM images on the cloud provider.
.INDENT 0.0
.TP
.B salt.cloud.clouds.nova.avail_locations()
Would normally return a list of available datacenters (ComputeRegions?
Would normally return a list of available data centers (ComputeRegions?
Availability Zones?), but those don\(aqt seem to be available via the nova
client.
.UNINDENT
@ -93990,7 +93990,7 @@ When we are asked to update (regular interval) lets reap the cache
# and recon_max value kind of defeats the purpose of being able to
# change these settings. If all minions have the same values and your
# setup is quite large (several thousand minions), they will still
# flood the master. The desired behaviour is to have timeframe within
# flood the master. The desired behavior is to have timeframe within
# all minions try to reconnect.
# Example on how to use these settings:

View file

@ -14,7 +14,7 @@ client is detailed below.
Salt can be used from CLI scripts as well as via a REST interface.
See Salt's :ref:`outputter system <all-salt.output>` to retrive structured
See Salt's :ref:`outputter system <all-salt.output>` to retrieve structured
data from Salt as JSON, or as shell-friendly text, or many other formats.
See the :py:func:`state.event <salt.runners.state.event>` runner to utilize

View file

@ -367,7 +367,7 @@ only the cache for the mine system.
Default: 0
The number of minions the master should allow to connect. Use this to accomodate
The number of minions the master should allow to connect. Use this to accommodate
the number of minions per master if you have different types of hardware serving
your minions. The default of ``0`` means unlimited connections. Please note, that
this can slow down the authentication process a bit in large setups.
@ -1613,11 +1613,11 @@ There are additional details at :ref:`salt-pillars`
Default: ``smart``
The pillar_source_merging_strategy option allows to configure merging strategy
between differents sources. It accepts 3 values:
between different sources. It accepts 3 values:
* recurse:
it will merge recursivelly mapping of data. For example, theses 2 sources:
it will merge recursively mapping of data. For example, theses 2 sources:
.. code-block:: yaml

View file

@ -7,7 +7,7 @@ Understanding YAML
The default renderer for SLS files is the YAML renderer. YAML is a
markup language with many powerful features. However, Salt uses
a small subset of YAML that maps over very commonly used data stuctures,
a small subset of YAML that maps over very commonly used data structures,
like lists and dictionaries. It is the job of the YAML renderer to take
the YAML data structure and compile it into a Python data structure for
use by Salt.
@ -86,4 +86,4 @@ Reference
---------
.. automodule:: salt.renderers.yaml
:members:
:members:

View file

@ -2,7 +2,7 @@
salt.renderers.yamlex
=====================
YAMLEX renderer is a remplacement of the YAML renderer.
YAMLEX renderer is a replacement of the YAML renderer.
It's 100% YAML with a pinch of Salt magic:
* All mappings are automatically OrderedDict

947
doc/spelling_wordlist.txt Normal file
View file

@ -0,0 +1,947 @@
ackup
acl
addr
addrs
admin
Admin
adminfile
aggr
aix
aliyun
Aliyun
amazonaws
amd
ami
amiga
apachectl
api
apiKey
apikeys
apis
app
apps
aptpkg
arg
args
arn
arp
asg
askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
atime
augeas
Augeas
auth
authid
autodeployed
autodoc
autoload
autoloaded
autoruns
autoscale
Autoscale
autosign
awk
aws
backend
Backend
backends
Backends
backreferences
Backrefs
basedir
basedn
basename
basepath
baseurl
Baumgartner
bdist
Benke
Binlog
blockdev
blockdevice
blockdevices
bluetooth
Bluetooth
bluetoothd
bluez
Bluez
BlueZ
Borgstrom
boto
botocore
Boucha
br
brtfs
bsd
buildmod
buildout
builtin
cacert
cachedir
cachefile
cassandra
catalina
Centerville
centos
cer
cfg
cfgfile
cgroup
cgroups
chage
charset
cherrypy
chocolatey
Chocolatey
chown
Chown
chroot
cidr
cidrs
cli
cloudstack
cloudwatch
cmd
cmdmod
cmp
collatz
compactionstats
conf
config
Config
configfile
configs
confs
conv
cooldown
copyfile
couchdb
cp
cpu
cpus
cpuset
cpushare
cpustats
cputime
cron
crontab
crpytographic
Crpytographic
crt
csr
ctl
cwd
Cygwin
daemonize
daemontools
darwin
datastore
datastores
dbuser
dd
ddns
Debconf
debconfmod
debian
deinstall
delim
delvol
depclean
deps
Deregister
desc
deserialize
Deserialize
deserialized
Deserialized
deserializes
deserializing
dest
dev
dhcp
dict
dicts
diff
difflib
diffs
dih
dir
dirs
disableexcludes
disablerepo
disklabel
disklabels
dismod
dissite
distfiles
distro
distros
dists
django
Django
djangoembed
djangomod
dmidecode
dns
dnsmasq
dnspython
dnsservers
dnsutil
dockerfile
dockerio
docstring
docstrings
dpkg
DRS
dryrun
dst
dulwich
dumpe
dvh
eauth
EAuth
ebuild
ec
eclean
eix
Eix
elasticache
Elasticache
elb
emailAddress
enablerepo
endload
enmod
ensite
env
eselect
esky
Esky
etcd
eventbus
expr
extfs
facl
facter
failhard
failover
fallback
fifo
fileclient
filedate
filepath
fileserver
Fileserver
filesystem
Filesystem
filesystems
fmt
foo
forcestop
formulae
fqdn
freebsd
FreeBSD
freebsdjail
freebsdkmod
freebsdpkg
freebsdports
freebsdservice
freemem
fromrepo
frontend
frontends
fs
fstab
fstat
fstype
ftp
fw
fwmark
fwrule
Gb
gce
gemset
gemsets
gentoo
Gentoo
Gentoolkit
gentoolkitmod
getfacl
gid
gids
gitfs
github
Github
glanceclient
Glazner
glibc
globbing
globexpression
glsa
gluster
glusterfs
gnomedesktop
gnore
gnupg
gogrid
gpg
gpgowner
gpt
grep
Grep
groupadd
groupou
guestfs
gunzip
hadoop
haproxy
haproxyconn
hardcoded
Hausler
hc
hg
hgfs
hglib
hiera
Highdata
highstate
Highstate
homebrew
Homebrew
hostname
hostnames
htpasswd
http
httpd
https
hw
hypervisor
hypervisors
iam
ie
iface
ima
img
imgadm
incron
incrontab
indices
inet
influxdb
ing
ini
init
initctl
initscript
inline
Inline
inode
inotify
internet
iowait
ip
ipaddr
ipc
ipcidr
ipe
ips
ipset
ipsets
iptables
ipv
IPv
IPy
irb
irq
jid
jinja
Jinja
jod
Jouanin
joyent
Joyent
jQuery
json
Json
jsonify
junos
Junos
keycontent
keyfile
keyid
keyname
keypair
keypairs
keysize
keyspace
Keyspace
keyspaces
keystoneclient
kiorky
Klaassen
kmod
Kuan
kvm
kwarg
kwargs
launchctl
launchd
lbn
lchar
ldap
ldapmod
lgname
libcloud
libcloudfuncs
libgit
libguestfs
libreiserfs
libvirt
lifecycle
lightdm
linode
Linode
linux
loadbalancer
localemod
localfiles
localhost
localtime
Logfile
logrotate
Logstash
loopback
lowdata
lowstate
lsblk
lspci
lstat
lua
lucene
lv
lvm
lvname
lvs
lxc
lxcbr
lxcutils
macports
mailq
makeconf
makedirs
mako
Mako
manpage
manpages
Masterless
maxproc
md
mdadm
mem
memcache
memcached
Memcached
metadata
Metadata
minionfs
minon
mirrorlist
mkfile
mkfs
mklabel
mknod
mkpart
mkpartfs
mnt
modjk
Modjk
modprobe
mongo
Mongo
mongodb
Mongodb
monit
Monit
moosefs
mountpoint
msazure
msc
msdos
msg
msgpack
mtime
mtree
multicore
multiline
multipart
munin
Mutex
mydisk
myinstance
myminion
mynet
myprofile
mysql
mysqldb
nagios
nameserver
nameservers
namespace
namespacing
nbd
netaddr
netapi
netbsd
netbsdservice
netmask
netstat
netstats
networkid
nfs
nftables
ng
nginx
Nginx
nic
nitty
nocache
nocerts
nodegroup
nodegroups
Nodegroups
nodetool
nolimit
noop
notasecret
novaclient
Novaclient
npm
ntp
num
offline
ohai
Ok
omapi
online
onlyif
openbsdpkg
openbsdservice
opennebula
openssl
openstack
Openstack
openSUSE
org
originalfile
orm
os
osxdesktop
ou
outlier
outputter
Outputter
outputters
overlayfs
overstatestage
packageroot
packagesite
pacman
pagerduty
pam
param
paramiko
params
Params
partprobe
passin
passphrase
passthrough
Passthrough
passwd
passwordless
patchfile
pc
pcre
pecl
pecls
pem
perl
pgroup
phar
php
pid
pidfile
pids
pkcs
pkgadd
pkgin
pkgng
pkgrepo
pkgrm
pkgs
pkgutil
Pkgutil
pki
plaintext
Plaintext
plist
plugin
plugins
Plugins
portfetch
postgis
postgres
Postgres
postgresql
poudriere
Poweroff
powerpath
Powerpath
powershell
Powershell
ppa
pprint
pre
prepend
Prepend
prepended
preseed
preseeded
preseeding
priv
PRIVKEY
proc
processlist
programmatically
proxmox
Proxmox
proxying
ps
psycopg
pw
py
pybluez
pycassa
pycrypto
pydsl
pygerduty
pygit
pymongo
pyobjects
Pyobjects
pyOpenSSL
pypureomapi
pysqlite
pysvn
pythoncom
Pythonic
pyvenv
pywintypes
pyyaml
qcow
qemu
Qemu
queueinfoitem
Quickstart
quotastats
qux
rabbitmq
rabbitMQ
rabbitmqctl
rackconnect
rackspace
Rackspace
Rada
Radek
rar
rbenv
Rbenv
rc
rdma
rdoc
RDoc
rdp
readme
realserver
rebase
Rebase
receipthandle
reclass
redhat
Redhat
redis
Redis
redismod
refactored
regen
regex
reinstallation
reiserfs
renderers
Renderers
repl
repo
Repo
repos
repr
req'd
requestdata
resolv
resourcename
resourcepool
restorable
resync
ret
retcode
returncode
reusability
rh
ri
riak
Riak
rolconnlimit
rolename
rolname
rootfs
rootswinrepo
rootswinrepowinrepo
rsa
rsync
Rsync
rsyslogd
rubygems
runas
runlevel
rvm
saltcloud
saltcloudmod
saltenv
saltfile
saltify
Saltify
saltnado
saltstack
Saltstack
saltutil
Saltutil
sbin
schemas
screensaver
sd
sda
sdk
secgroup
securestart
securitygroup
sed
selinux
serializable
serializer
serializers
serverdensity
serverless
servermanager
servlet
setquota
sfdisk
sfn
sha
SHAs
sid
simplejson
sleekxmpp
sls
smartos
smf
sms
smtp
sockstat
softirq
softlayer
softwareupdate
solaris
Solaris
solarispkg
solr
Solr
someuser
sql
SQL
sqlalchemy
sqlite
Sqlite
sqs
src
ssl
stateconf
Stateconf
stderr
stdin
stdout
stormpath
Stormpath
str
strftime
subfolder
subjectAltName
subjectAltNames
subkeys
subqueries
sudo
sudoers
superblock
supervisorctl
supervisord
svcs
svn
svnfs
swiftclient
symlink
symlinks
Symlinks
syncdb
sysadmin
Sysadmins
sysbench
sysctl
syslog
sysmod
systemctl
systemd
systemwide
sysupgrade
sysV
sysvinit
Syu
tablespace
tarball
tbz
tcp
templating
testrb
tgt
tgz
Tibor
timeframe
timespec
tls
tmp
tmpfs
tmux
Todo
topfiles
tpstats
traceroute
trunc
twilio
Twilio
txt
ubuntu
udp
ui
uid
uids
un
Undeploy
unhold
uninstall
Uninstall
uninstallation
uninstalled
uninstalling
Uninstalls
unix
unmerge
Unmonitor
unpair
Unpair
unpriv
unrar
unserialize
unsets
unversioned
uri
uris
url
urlencoded
useradd
username
Username
usr
util
utils
utmp
uuids
uwsgi
uWSGI
uzip
varnishd
vcpus
vdev
venv
ver
vg
vgname
vhost
vhosts
vimrc
virt
Virt
virtkey
virtualenv
virtualhost
virtualization
vm
vmadm
vms
VMware
vnc
voltype
vpc
vsphere
vSphere
vt
vtype
vvvvv
walkthrough
warnquota
webapp
webapps
webhook
Webhook
webserv
webserver
websockets
Websockets
webutil
wempy
whitelist
wildcard
winreg
winrepo
wmi
worldcompany
writability
ws
wsgi
www
xapi
Xen
xml
xmpp
yaml
Yaml
yamlex
yamlify
Yann
yumpkg
yy
Zabbix
zc
zcbuildout
zfs
znc
zpool
zsh
zypper

View file

@ -632,7 +632,7 @@ lxc
---
The lxc driver is a new, experimental driver for installing Salt on
newly provisionned (via saltcloud) lxc containers. It will in turn use saltify to install
newly provisioned (via saltcloud) lxc containers. It will in turn use saltify to install
salt an rattach the lxc container as a new lxc minion.
As soon as we can, we manage baremetal operation over SSH.
You can also destroy those containers via this driver.

View file

@ -30,7 +30,7 @@ Providing versatility between massive scale deployments and smaller systems may
daunting, but Salt is very simple to set up and maintain, regardless of the
size of the project. The architecture of Salt is designed to work with any
number of servers, from a handful of local network systems to international
deployments across different datacenters. The topology is a simple
deployments across different data centers. The topology is a simple
server/client model with the needed functionality built into a single set of
daemons. While the default configuration will work with little to no
modification, Salt can be fine tuned to meet specific needs.

View file

@ -129,7 +129,7 @@ within a 60 second time-frame on a salt-master service restart.
Each minion will have a randomized reconnect value between 'recon_default'
and 'recon_default + recon_max', which in this example means between 1000ms
and 60000ms (or between 1 and 60 seconds). The generated random-value will
be doubled after each attempt to reconnect (ZeroMQ default behaviour).
be doubled after each attempt to reconnect (ZeroMQ default behavior).
Lets say the generated random value is 11 seconds (or 11000ms).

View file

@ -7,7 +7,7 @@ Pillar Walkthrough
This walkthrough assumes that the reader has already completed the initial
Salt :doc:`walkthrough </topics/tutorials/walkthrough>`.
Pillars are tree-like structures of data defined on the Salt Master and passed
Pillars are tree-like structures of data defined on the Salt Master and passed
through to minions. They allow confidential, targeted data to be securely sent
only to the relevant minion.
@ -23,7 +23,7 @@ Pillar data is useful for:
Highly Sensitive Data:
Information transferred via pillar is guaranteed to only be presented to
the minions that are targeted, making Pillar suitable
the minions that are targeted, making Pillar suitable
for managing security information, such as cryptographic keys and
passwords.
Minion Configuration:
@ -107,7 +107,7 @@ The key ``info`` should now appear in the returned pillar data.
More Complex Data
~~~~~~~~~~~~~~~~~
Unlike states, pillar files do not need to define :strong:`formulas`.
Unlike states, pillar files do not need to define :strong:`formulas`.
This example sets up user data with a UID:
``/srv/pillar/users/init.sls``:
@ -156,10 +156,10 @@ user data is applied in an sls file.
Parameterizing States With Pillar
=================================
Pillar data can be accessed in state files to customise behaviour for each
minion. All pillar (and grain) data applicable to each minion is substituted
Pillar data can be accessed in state files to customise behavior for each
minion. All pillar (and grain) data applicable to each minion is substituted
into the state files through templating before being run. Typical uses
include setting directories appropriate for the minion and skipping states
include setting directories appropriate for the minion and skipping states
that don't apply.
A simple example is to set up a mapping of package names in pillar for

View file

@ -6,7 +6,7 @@ Salt is capable of managing Windows systems, however due to various differences
between the operating systems, there are some things you need to keep in mind.
This document will contain any quirks that apply across Salt or generally across
multiple module functions. Any Windows-specific behaviour for particular module
multiple module functions. Any Windows-specific behavior for particular module
functions will be documented in the module function documentation. Therefore
this document should be read in conjunction with the module function
documentation.
@ -46,7 +46,7 @@ To avoid such issues, always pretend Windows is case-sensitive and use the right
case for names, e.g. specify ``user=Administrator`` instead of
``user=administrator``.
Follow :issue:`11801` for any changes to this behaviour.
Follow :issue:`11801` for any changes to this behavior.
Dealing with various username forms
@ -59,7 +59,7 @@ the username without the domain or host information.
Using these alternative forms will likely confuse Salt and cause odd errors to
happen. Use only the raw username value in the correct case to avoid problems.
Follow :issue:`11801` for any changes to this behaviour.
Follow :issue:`11801` for any changes to this behavior.
Specifying the None group
@ -79,7 +79,7 @@ Symbolic link loops
Under Windows, if any symbolic link loops are detected or if there are too many
levels of symlinks (defaults to 64), an error is always raised.
For some functions, this behaviour is different to the behaviour on Unix
For some functions, this behavior is different to the behavior on Unix
platforms. In general, avoid symlink loops on either platform.

View file

@ -24,7 +24,7 @@ Versatility between massive scale deployments and smaller systems may seem
daunting, but Salt is very simple to set up and maintain, regardless of the
size of the project. The architecture of Salt is designed to work with any
number of servers, from a handful of local network systems to international
deployments across disparate datacenters. The topology is a simple
deployments across disparate data centers. The topology is a simple
server/client model with the needed functionality built into a single set of
daemons. While the default configuration will work with little to no
modification, Salt can be fine-tuned to meet specific needs.

View file

@ -170,7 +170,7 @@ def auth(username, password, **kwargs):
def groups(username, *args, **kwargs):
'''
Retreive groups for a given user for this auth provider
Retrieve groups for a given user for this auth provider
Uses system groups
'''

View file

@ -1573,7 +1573,7 @@ class Caller(object):
Note, a running master or minion daemon is not required to use this class.
Running ``salt-call --local`` simply sets :conf_minion:`file_client` to
``'local'``. The same can be achived at the Python level by including that
``'local'``. The same can be achieved at the Python level by including that
setting in a minion config file.
Instantiate a new Caller() instance using a file system path to the minion

View file

@ -51,7 +51,7 @@ except ImportError:
def communicator(func):
'''Warning, this is a picklable decorator !'''
def _call(queue, args, kw):
'''called with [queue, args, kwargs] as first optionnal arg'''
'''called with [queue, args, kwargs] as first optional arg'''
kw['queue'] = queue
ret = None
try:
@ -110,7 +110,7 @@ def enter_mainloop(target,
mapped_args
a list of one or more arguments combinations to call the function with
eg (foo, [[1], [2]]) will call::
e.g. (foo, [[1], [2]]) will call::
foo([1])
foo([2])
@ -902,7 +902,7 @@ class Cloud(object):
for obj in output_multip:
ret_multip.update(obj)
# build up a datastructure similar to what the non-parallel
# build up a data structure similar to what the non-parallel
# destroy uses
for obj in parallel_data:
alias = obj['alias']

View file

@ -150,7 +150,7 @@ def get_password(vm_):
def get_key():
'''
Returns the ssk private key for VM access
Returns the ssh private key for VM access
'''
return config.get_cloud_config_value(
'private_key', get_configured_provider(), __opts__, search_global=False

View file

@ -77,9 +77,9 @@ JOYENT_LOCATIONS = {
}
DEFAULT_LOCATION = 'us-east-1'
# joyent no longer reports on all datacenters, so setting this value to true
# joyent no longer reports on all data centers, so setting this value to true
# causes the list_nodes function to get information on machines from all
# datacenters
# data centers
POLL_ALL_LOCATIONS = True
VALID_RESPONSE_CODES = [
@ -438,7 +438,7 @@ def destroy(name, call=None):
:param name: name given to the machine
:param call: call value in this case is 'action'
:return: array of booleans , true if successful;ly stopped and true if
:return: array of booleans , true if successfully stopped and true if
successfully removed
CLI Example:
@ -551,7 +551,7 @@ def take_action(name=None, call=None, command=None, data=None, method='GET',
:command: api path
:data: any data to be passed to the api, must be in json format
:method: GET,POST,or DELETE
:location: datacenter to execute the command on
:location: data center to execute the command on
:return: true if successful
'''
caller = inspect.stack()[1][3]
@ -597,7 +597,7 @@ def ssh_interface(vm_):
def get_location(vm_=None):
'''
Return the joyent datacenter to use, in this order:
Return the joyent data center to use, in this order:
- CLI parameter
- VM parameter
- Cloud profile setting
@ -631,7 +631,7 @@ def avail_locations(call=None):
'region': JOYENT_LOCATIONS[key]
}
# this can be enabled when the bug in the joyent get datacenters call is
# this can be enabled when the bug in the joyent get data centers call is
# corrected, currently only the european dc (new api) returns the correct
# values
# ret = {}
@ -697,7 +697,7 @@ def get_node(name):
def joyent_node_state(id_):
'''
Convert joyent returned state to state common to other datacenter return
Convert joyent returned state to state common to other data center return
values for consistency
:param id_: joyent state value
@ -992,7 +992,7 @@ def delete_key(kwargs=None, call=None):
def get_location_path(location=DEFAULT_LOCATION):
'''
create url from location variable
:param location: joyent datacenter location
:param location: joyent data center location
:return: url
'''
return 'https://{0}{1}'.format(location, JOYENT_API_HOST_SUFFIX)

View file

@ -226,7 +226,7 @@ def _salt(fun, *args, **kw):
break
# special case, some answers may be crafted
# to handle the unresponsivness of a specific command
# which is also meaningfull, eg a minion not yet provisionned
# which is also meaningful, e.g. a minion not yet provisioned
if fun in ['test.ping'] and not wait_for_res:
ret = {
'test.ping': False,
@ -396,7 +396,7 @@ def create(vm_, call=None):
This function is idempotent and will try to either provision
or finish the provision of an lxc container.
NOTE: Most of the initialisation code has been moved and merged
NOTE: Most of the initialization code has been moved and merged
with the lxc runner and lxc.init functions
'''
__grains__ = _salt('grains.items')

View file

@ -779,7 +779,7 @@ def get_vmconfig(vmid, node=None, node_type='openvz'):
def wait_for_created(upid, timeout=300):
'''
Wait until a the vm has been created succesfully
Wait until a the vm has been created successfully
'''
start_time = time.time()
info = _lookup_proxmox_task(upid)

View file

@ -19,7 +19,7 @@ configuration at:
apikey: JVkbSJDGHSDKUKSDJfhsdklfjgsjdkflhjlsdfffhgdgjkenrtuinv
provider: softlayer
The SoftLayer Python Library needs to be installed in ordere to use the
The SoftLayer Python Library needs to be installed in order to use the
SoftLayer salt.cloud modules. See: https://pypi.python.org/pypi/SoftLayer
:depends: softlayer
@ -107,7 +107,7 @@ def avail_locations(call=None):
response = conn.getCreateObjectOptions()
#return response
for datacenter in response['datacenters']:
#return datacenter
#return data center
ret[datacenter['template']['datacenter']['name']] = {
'name': datacenter['template']['datacenter']['name'],
}

View file

@ -19,7 +19,7 @@ configuration at:
apikey: JVkbSJDGHSDKUKSDJfhsdklfjgsjdkflhjlsdfffhgdgjkenrtuinv
provider: softlayer_hw
The SoftLayer Python Library needs to be installed in ordere to use the
The SoftLayer Python Library needs to be installed in order to use the
SoftLayer salt.cloud modules. See: https://pypi.python.org/pypi/SoftLayer
:depends: softlayer

View file

@ -563,7 +563,7 @@ def list_hosts(kwargs=None, call=None): # pylint: disable=W0613
def list_datacenters(kwargs=None, call=None): # pylint: disable=W0613
'''
List the datacenters for this VMware environment
List the data centers for this VMware environment
'''
if call != 'function':
log.error(

View file

@ -1587,7 +1587,7 @@ __enable_universe_repository() {
install_ubuntu_deps() {
if [ $_START_DAEMONS -eq $BS_FALSE ]; then
echowarn "Not starting daemons on Debian based distributions is not working mostly because starting them is the default behaviour."
echowarn "Not starting daemons on Debian based distributions is not working mostly because starting them is the default behavior."
fi
apt-get update
@ -1823,7 +1823,7 @@ install_ubuntu_check_services() {
#
install_debian_deps() {
if [ $_START_DAEMONS -eq $BS_FALSE ]; then
echowarn "Not starting daemons on Debian based distributions is not working mostly because starting them is the default behaviour."
echowarn "Not starting daemons on Debian based distributions is not working mostly because starting them is the default behavior."
fi
# No user interaction, libc6 restart services for example
export DEBIAN_FRONTEND=noninteractive
@ -1863,7 +1863,7 @@ install_debian_deps() {
install_debian_6_deps() {
if [ $_START_DAEMONS -eq $BS_FALSE ]; then
echowarn "Not starting daemons on Debian based distributions is not working mostly because starting them is the default behaviour."
echowarn "Not starting daemons on Debian based distributions is not working mostly because starting them is the default behavior."
fi
# No user interaction, libc6 restart services for example
export DEBIAN_FRONTEND=noninteractive
@ -1958,7 +1958,7 @@ _eof
install_debian_7_deps() {
if [ $_START_DAEMONS -eq $BS_FALSE ]; then
echowarn "Not starting daemons on Debian based distributions is not working mostly because starting them is the default behaviour."
echowarn "Not starting daemons on Debian based distributions is not working mostly because starting them is the default behavior."
fi
# No user interaction, libc6 restart services for example
export DEBIAN_FRONTEND=noninteractive
@ -2042,7 +2042,7 @@ install_debian_8_deps__DISABLED() {
install_debian_git_deps() {
if [ $_START_DAEMONS -eq $BS_FALSE ]; then
echowarn "Not starting daemons on Debian based distributions is not working mostly because starting them is the default behaviour."
echowarn "Not starting daemons on Debian based distributions is not working mostly because starting them is the default behavior."
fi
# No user interaction, libc6 restart services for example
export DEBIAN_FRONTEND=noninteractive

View file

@ -716,7 +716,7 @@ def load_config(path, env_var, default_path=None):
previous_frame.function, previous_frame.filename, env_var
)
)
# In this case, maintain old behaviour
# In this case, maintain old behavior
default_path = DEFAULT_MASTER_OPTS['conf_file']
# Default to the environment variable path, if it exists

View file

@ -59,7 +59,7 @@ structure::
s3://<bucket name>/<environment>/<files>
.. note:: This fileserver back-end requires the use of the MD5 hashing algorightm.
.. note:: This fileserver back-end requires the use of the MD5 hashing algorithm.
MD5 may not be compliant with all security policies.
'''
@ -422,7 +422,7 @@ def _refresh_buckets_cache_file(cache_file):
if not s3_meta:
continue
# pull out the environment dirs (eg. the root dirs)
# pull out the environment dirs (e.g. the root dirs)
files = filter(lambda k: 'Key' in k, s3_meta)
environments = map(lambda k: (os.path.dirname(k['Key']).split('/', 1))[0], files)
environments = set(environments)

View file

@ -660,7 +660,7 @@ class Minion(MinionBase):
With master_type=failover takes the list of masters and loops through them.
The first one that allows the minion to connect is used to authenticate() and
then returned. If this function is called outside the minions initialisation
then returned. If this function is called outside the minions initialization
phase (for example from the minions main event-loop when a master connection
loss was detected), 'failed' should be set to True. The current
(possibly failed) master will then be removed from the list of masters.
@ -1662,7 +1662,7 @@ class Minion(MinionBase):
except zmq.ZMQError as exc:
# The interrupt caused by python handling the
# SIGCHLD. Throws this error with errno == EINTR.
# Nothing to recieve on the zmq socket throws this error
# Nothing to receive on the zmq socket throws this error
# with EAGAIN.
# Both are safe to ignore
if exc.errno != errno.EAGAIN and exc.errno != errno.EINTR:
@ -1911,7 +1911,7 @@ class Syndic(Minion):
self.event_forward_timeout < time.time()):
self._forward_events()
# We don't handle ZMQErrors like the other minions
# I've put explicit handling around the recieve calls
# I've put explicit handling around the receive calls
# in the process_*_socket methods. If we see any other
# errors they may need some kind of handling so log them
# for now.
@ -1931,7 +1931,7 @@ class Syndic(Minion):
elif messages_len == 2:
idx = 1
else:
raise SaltSyndicMasterError('Syndication master recieved message of invalid len ({0}/2)'.format(messages_len))
raise SaltSyndicMasterError('Syndication master received message of invalid len ({0}/2)'.format(messages_len))
payload = self.serial.loads(messages[idx])
except zmq.ZMQError as e:

View file

@ -58,7 +58,7 @@ def __virtual__():
def _recurmatch(path, aug):
'''
Recursive generator providing the infrastructure for
augtools print behaviour.
augtools print behavior.
This function is based on test_augeas.py from
Harald Hoyer <harald@redhat.com> in the python-augeas

View file

@ -248,7 +248,7 @@ def install(name=None, pkgs=None, taps=None, options=None, **kwargs):
Options to pass to brew. Only applies to initial install. Due to how brew
works, modifying chosen options requires a full uninstall followed by a
fresh install. Note that if "pkgs" is used, all options will be passed
to all packages. Unreconized options for a package will be silently
to all packages. Unrecognized options for a package will be silently
ignored by brew.
CLI Example:

View file

@ -50,7 +50,7 @@ def install(dir,
Install composer dependencies for a directory.
If composer has not been installed globally making it available in the
system PATH & making it executible, the ``composer`` and ``php`` parameters
system PATH & making it executable, the ``composer`` and ``php`` parameters
will need to be set to the location of the executables.
dir
@ -62,7 +62,7 @@ def install(dir,
(i.e. /path/to/composer.phar)
php
Location of the php executible to use with composer.
Location of the php executable to use with composer.
(i.e. /usr/bin/php)
runas

View file

@ -96,7 +96,7 @@ def assign(name, value):
Assign a single sysctl parameter for this minion
name
The name of ths sysctl value to edit.
The name of the sysctl value to edit.
value
The sysctl value to apply.

View file

@ -155,7 +155,7 @@ def inodeusage(args=None):
def percent(args=None):
'''
Return partion information for volumes mounted on this minion
Return partition information for volumes mounted on this minion
CLI Example:

View file

@ -171,7 +171,7 @@ def ex_mod_init(low):
Initial automatic enforcement added when pkg is used on a Gentoo system.
.. versionchanged:: 2014.1.0
Configure option added to make this behaviour optional, defaulting to
Configure option added to make this behavior optional, defaulting to
off.
.. seealso::

View file

@ -101,7 +101,7 @@ def setenv(environ, false_unsets=False, clear_all=False, update_minion=False):
false_unsets
If a key's value is False and false_unsets is True, then the
key will be removed from the salt processes environment dict
entirely. If a key's value is Flase and false_unsets is not
entirely. If a key's value is False and false_unsets is not
True, then the key's value will be set to an empty string.
Default: False
@ -168,7 +168,7 @@ def get(key, default=''):
String used as the key for environment lookup.
default
If the key is not found in the enironment, return this value.
If the key is not found in the environment, return this value.
Default: ''
@ -235,7 +235,7 @@ def item(keys, default=''):
keys for environment lookup.
default
If the key is not found in the enironment, return this value.
If the key is not found in the environment, return this value.
Default: ''
CLI Example:

View file

@ -14,8 +14,8 @@ configuration file:
etcd.port: 4001
It is technically possible to configure etcd without using a profile, but this
is not consided to be a best practice, especially when multiple etcd servers or
clusters are available.
is not considered to be a best practice, especially when multiple etcd servers
or clusters are available.
.. code-block:: yaml

View file

@ -683,7 +683,7 @@ def sed(path,
options : ``-r -e``
Options to pass to sed
flags : ``g``
Flags to modify the sed search; e.g., ``i`` for case-insensitve pattern
Flags to modify the sed search; e.g., ``i`` for case-insensitive pattern
matching
negate_match : False
Negate the search command (``!``)
@ -1218,13 +1218,13 @@ def blockreplace(path,
marker_start
The line content identifying a line as the start of the content block.
Note that the whole line containing this marker will be considered, so
whitespaces or extra content before or after the marker is included in
whitespace or extra content before or after the marker is included in
final output
marker_end
The line content identifying a line as the end of the content block.
Note that the whole line containing this marker will be considered, so
whitespaces or extra content before or after the marker is included in
whitespace or extra content before or after the marker is included in
final output
content
@ -1759,7 +1759,7 @@ def seek_write(path, data, offset):
Seek to a position on a file and write to it
path
path to fil
path to file
data
data to write to file

View file

@ -9,7 +9,7 @@ Remote package support using ``pkg_add(1)``
pkgng local database and, if found, would provide some of pkgng's
functionality. The rewrite of this module has removed all pkgng support,
and moved it to the :mod:`pkgng <salt.modules.pkgng>` execution module. For
verisions <= 0.17.0, the documentation here should not be considered
versions <= 0.17.0, the documentation here should not be considered
accurate. If your Minion is running one of these versions, then the
documentation for this module can be viewed using the :mod:`sys.doc
<salt.modules.sys.doc>` function:

View file

@ -55,7 +55,7 @@ def bootstrap(platform,
img_format
Which format to create the image in. By default, just copies files into
a directory on the local fileysstem (``dir``). Future support will exist
a directory on the local filesystem (``dir``). Future support will exist
for ``sparse``.
fs_format

View file

@ -485,7 +485,7 @@ def submodule(cwd, init=True, opts=None, user=None, identity=None):
def status(cwd, user=None):
'''
Return the status of the repository. The returned format uses the status
codes of gits 'porcelain' output mode
codes of git's 'porcelain' output mode
cwd
The path to the Git repository

View file

@ -54,7 +54,7 @@ def revision(cwd, rev='tip', short=False, user=None):
def describe(cwd, rev='tip', user=None):
'''
Mimick git describe and return an identifier for the given revision
Mimic git describe and return an identifier for the given revision
cwd
The path to the Mercurial repository

View file

@ -28,7 +28,7 @@ def __virtual__():
def _iptables_cmd(family='ipv4'):
'''
Return correct command based on the family, eg. ipv4 or ipv6
Return correct command based on the family, e.g. ipv4 or ipv6
'''
if family == 'ipv6':
return salt.utils.which('ip6tables')

View file

@ -15,7 +15,6 @@ def finger():
Return the minion's public key fingerprint
CLI Example:
dfasdf
.. code-block:: bash

View file

@ -111,7 +111,7 @@ def ec2_credentials_create(user_id=None, name=None,
tenant_id=None, tenant=None,
profile=None, **connection_args):
'''
Create EC2-compatibile credentials for user per tenant
Create EC2-compatible credentials for user per tenant
CLI Examples:
@ -146,7 +146,7 @@ def ec2_credentials_create(user_id=None, name=None,
def ec2_credentials_delete(user_id=None, name=None, access_key=None,
profile=None, **connection_args):
'''
Delete EC2-compatibile credentials
Delete EC2-compatible credentials
CLI Examples:

View file

@ -30,7 +30,7 @@ def _get_makeconf():
def add(overlay):
'''
Add the given overlay from the caced remote list to your locally
Add the given overlay from the cached remote list to your locally
installed overlays. Specify 'ALL' to add all overlays from the
remote list.

View file

@ -30,7 +30,7 @@ Salt interface to LDAP commands
At the moment this module only recommends connection to LDAP services
listening on ``localhost``. This is deliberate to avoid the potentially
dangerous situation of multiple minions sending identical update commands
to the same LDAP server. It's easy enough to override this behaviour, but
to the same LDAP server. It's easy enough to override this behavior, but
badness may ensue - you have been warned.
'''

View file

@ -119,7 +119,7 @@ def cloud_init_interface(name, vm_=None, **kwargs):
bridge^for the primary nic (lxcbr0)
gateway
network gateway for the container
unconditionnal_install
unconditional_install
given to lxc.bootstrap (see relative doc)
force_install
given to lxc.bootstrap (see relative doc)
@ -132,7 +132,7 @@ def cloud_init_interface(name, vm_=None, **kwargs):
password
administrative password for the container
users
administrative users for the contrainer
administrative users for the container
default: [root] and [root, ubuntu] on ubuntu
'''
if vm_ is None:
@ -181,7 +181,7 @@ def cloud_init_interface(name, vm_=None, **kwargs):
netmask = vm_.get('netmask', '24')
bridge = vm_.get('bridge', 'lxcbr0')
gateway = vm_.get('gateway', 'auto')
unconditionnal_install = vm_.get('unconditionnal_install', False)
unconditional_install = vm_.get('unconditional_install', False)
force_install = vm_.get('force_install', True)
config = vm_.get('config', {})
if not config:
@ -234,8 +234,8 @@ def cloud_init_interface(name, vm_=None, **kwargs):
lxc_init_interface['size'] = size
lxc_init_interface['lvname'] = lvname
lxc_init_interface['force_install'] = force_install
lxc_init_interface['unconditionnal_install'] = (
unconditionnal_install
lxc_init_interface['unconditional_install'] = (
unconditional_install
)
lxc_init_interface['bootstrap_url'] = script
lxc_init_interface['bootstrap_args'] = script_args
@ -625,7 +625,7 @@ def init(name,
pub_key=None,
priv_key=None,
force_install=False,
unconditionnal_install=False,
unconditional_install=False,
bootstrap_args=None,
bootstrap_shell=None,
bootstrap_url=None,
@ -633,10 +633,10 @@ def init(name,
'''
Initialize a new container.
This is a partial indempotent function as if it is already
provisionned, we will reset a bit the lxc configuration
This is a partial idempotent function as if it is already
provisioned, we will reset a bit the lxc configuration
file but much of the hard work will be escaped as
markers will prevent re-execution of harmfull tasks.
markers will prevent re-execution of harmful tasks.
CLI Example:
@ -687,12 +687,12 @@ def init(name,
users
Sysadmins users to set the administrative password to
eg [root, ubuntu, sysadmin], default [root] and [root, ubuntu]
e.g. [root, ubuntu, sysadmin], default [root] and [root, ubuntu]
on ubuntu
password
Set the initial password for default sysadmin users, at least root
but also can be used for sudoers, eg [root, ubuntu, sysadmin]
but also can be used for sudoers, e.g. [root, ubuntu, sysadmin]
profile
A LXC profile (defined in config or pillar).
@ -725,11 +725,11 @@ def init(name,
the name of the container.
pub_key
Explicit public key to preseed the minion with (optionnal).
Explicit public key to preseed the minion with (optional).
This can be either a filepath or a string representing the key
priv_key
Explicit private key to preseed the minion with (optionnal).
Explicit private key to preseed the minion with (optional).
This can be either a filepath or a string representing the key
approve_key
@ -754,7 +754,7 @@ def init(name,
this is the way to run vendor bootstrap scripts even
if a salt minion is already present in the container
unconditionnal_install
unconditional_install
Run the script even if the container seems seeded
'''
kwargs = copy.deepcopy(kwargs)
@ -968,7 +968,7 @@ def init(name,
pub_key=pub_key, priv_key=priv_key,
install=install,
force_install=force_install,
unconditionnal_install=unconditionnal_install,
unconditional_install=unconditional_install,
bootstrap_url=bootstrap_url,
bootstrap_shell=bootstrap_shell,
bootstrap_args=bootstrap_args)
@ -1875,7 +1875,7 @@ def bootstrap(name, config=None, approve_key=True,
pub_key=None, priv_key=None,
bootstrap_url=None,
force_install=False,
unconditionnal_install=False,
unconditional_install=False,
bootstrap_args=None,
bootstrap_shell=None):
'''
@ -1897,11 +1897,11 @@ def bootstrap(name, config=None, approve_key=True,
pub_key
Explicit public key to pressed the minion with (optionnal).
Explicit public key to pressed the minion with (optional).
This can be either a filepath or a string representing the key
priv_key
Explicit private key to pressed the minion with (optionnal).
Explicit private key to pressed the minion with (optional).
This can be either a filepath or a string representing the key
bootstrap_url
@ -1921,7 +1921,7 @@ def bootstrap(name, config=None, approve_key=True,
this is the way to run vendor bootstrap scripts even
if a salt minion is already present in the container
unconditionnal_install
unconditional_install
Run the script even if the container seems seeded
CLI Example:
@ -1934,7 +1934,7 @@ def bootstrap(name, config=None, approve_key=True,
infos = __salt__['lxc.info'](name)
if not infos:
return None
# default setted here as we cant set them
# default set here as we cannot set them
# in def as it can come from a chain of procedures.
if not bootstrap_args:
bootstrap_args = '-c {0}'
@ -1956,14 +1956,14 @@ def bootstrap(name, config=None, approve_key=True,
seeded = not __salt__['lxc.run_cmd'](
name, 'test -e \"{0}\"'.format(SEED_MARKER), stdout=False, stderr=False)
tmp = tempfile.mkdtemp()
if seeded and not unconditionnal_install:
if seeded and not unconditional_install:
res = True
else:
res = False
cfg_files = __salt__['seed.mkconfig'](
config, tmp=tmp, id_=name, approve_key=approve_key,
priv_key=priv_key, pub_key=pub_key)
if needs_install or force_install or unconditionnal_install:
if needs_install or force_install or unconditional_install:
if install:
rstr = __salt__['test.rand_str']()
configdir = '/tmp/.c_{0}'.format(rstr)

View file

@ -201,7 +201,7 @@ def install(name=None, refresh=False, pkgs=None, **kwargs):
salt '*' pkg.install <package name>
version
Specify a version to pkg to install. Ignored if pkgs is sepcified.
Specify a version to pkg to install. Ignored if pkgs is specified.
CLI Example:
@ -211,7 +211,7 @@ def install(name=None, refresh=False, pkgs=None, **kwargs):
salt '*' pkg.install git-core version='1.8.5.5'
variant
Specify a variant to pkg to install. Ignored if pkgs is sepcified.
Specify a variant to pkg to install. Ignored if pkgs is specified.
CLI Example:

View file

@ -452,7 +452,7 @@ def quote_identifier(identifier, for_grants=False):
r'''
Return an identifier name (column, table, database, etc) escaped for MySQL
This means surrounded by "`" character and escaping this charater inside.
This means surrounded by "`" character and escaping this character inside.
It also means doubling the '%' character for MySQLdb internal usage.
:param identifier: the table, column or database identifier

View file

@ -128,7 +128,7 @@ def run_all(plugin, args=''):
def retcode_pillar(pillar_name):
'''
Run one or more nagios plugins from pillar data and get the result of cdm.retcode
Run one or more nagios plugins from pillar data and get the result of cmd.retcode
The pillar have to be in this format::
------
@ -189,7 +189,7 @@ def retcode_pillar(pillar_name):
def run_pillar(pillar_name):
'''
Run one or more nagios plugins from pillar data and get the result of cdm.run
Run one or more nagios plugins from pillar data and get the result of cmd.run
The pillar have to be in this format::
------
@ -221,7 +221,7 @@ def run_pillar(pillar_name):
def run_all_pillar(pillar_name):
'''
Run one or more nagios plugins from pillar data and get the result of cdm.run_all
Run one or more nagios plugins from pillar data and get the result of cmd.run_all
The pillar have to be in this format::
------

View file

@ -189,7 +189,7 @@ def install(pkgs=None,
ignore_installed
Ignore the installed packages (reinstalling instead)
exists_action
Default action when a path already exists: (s)witch, (i)gnore, (w)wipe,
Default action when a path already exists: (s)witch, (i)gnore, (w)ipe,
(b)ackup
no_deps
Ignore package dependencies

View file

@ -198,8 +198,8 @@ def refresh_db(jail=None, chroot=None, force=False):
``jail`` is specified)
force
Force a full download of the repository catalogue without regard to the
respective ages of the local and remote copies of the catalogue.
Force a full download of the repository catalog without regard to the
respective ages of the local and remote copies of the catalog.
CLI Example:
@ -288,7 +288,7 @@ def list_pkgs(versions_as_list=False,
List the packages in the specified jail
chroot
List the pacakges in the specified chroot (ignored if ``jail`` is
List the packages in the specified chroot (ignored if ``jail`` is
specified)
with_origin : False
@ -589,7 +589,7 @@ def install(name=None,
Install the package into the specified jail
chroot
Install the paackage into the specified chroot (ignored if ``jail`` is
Install the package into the specified chroot (ignored if ``jail`` is
specified)
orphan
@ -622,7 +622,7 @@ def install(name=None,
salt '*' pkg.install <package name> glob=True
local
Do not update the repository catalogues with ``pkg-update(8)``. A
Do not update the repository catalogs with ``pkg-update(8)``. A
value of ``True`` here is equivalent to using the ``-U`` flag with
``pkg install``.
@ -793,7 +793,7 @@ def remove(name=None,
Delete the package from the specified jail
chroot
Delete the paackage grom the specified chroot (ignored if ``jail`` is
Delete the package from the specified chroot (ignored if ``jail`` is
specified)
all_installed
@ -949,7 +949,7 @@ def upgrade(jail=None, chroot=None, force=False, local=False, dryrun=False):
salt '*' pkg.upgrade force=True
local
Do not update the repository catalogues with ``pkg-update(8)``. A value
Do not update the repository catalogs with ``pkg-update(8)``. A value
of ``True`` here is equivalent to using the ``-U`` flag with ``pkg
upgrade``.
@ -961,7 +961,7 @@ def upgrade(jail=None, chroot=None, force=False, local=False, dryrun=False):
dryrun
Dry-run mode: show what packages have updates available, but do not
perform any upgrades. Repository catalogues will be updated as usual
perform any upgrades. Repository catalogs will be updated as usual
unless the local option is also given.
CLI Example:
@ -1456,7 +1456,7 @@ def fetch(name,
salt '*' pkg.fetch <extended regular expression> pcre=True
local
Skip updating the repository catalogues with pkg-update(8). Use the
Skip updating the repository catalogs with pkg-update(8). Use the
local cache only.
CLI Example:

View file

@ -84,7 +84,7 @@ def show_master(path=MASTER_CF):
spacing or order.
The data returned from this function should not be used for direct
modification of the main.cf file; other functions are avaiable for that.
modification of the main.cf file; other functions are available for that.
CLI Examples:
@ -264,7 +264,7 @@ def show_main(path=MAIN_CF):
spacing or order. Bear in mind that order is functionally important in the
main.cf file, since keys can be referred to as variables. This means that
the data returned from this function should not be used for direct
modification of the main.cf file; other functions are avaiable for that.
modification of the main.cf file; other functions are available for that.
CLI Examples:

View file

@ -394,7 +394,7 @@ def db_alter(name, user=None, host=None, port=None, maintenance_db=None,
password=None, tablespace=None, owner=None,
runas=None):
'''
Change tablesbase or/and owner of databse.
Change tablespace or/and owner of database.
CLI Example:

View file

@ -585,7 +585,7 @@ def boot_time(time_format=None):
def network_io_counters(interface=None):
'''
Return network I/O statisitics.
Return network I/O statistics.
CLI Example:
@ -607,7 +607,7 @@ def network_io_counters(interface=None):
def disk_io_counters(device=None):
'''
Return disk I/O statisitics.
Return disk I/O statistics.
CLI Example:

View file

@ -63,10 +63,10 @@ class _Puppet(object):
the default locations.
'''
self.subcmd = 'agent'
self.subcmd_args = [] # eg. /a/b/manifest.pp
self.subcmd_args = [] # e.g. /a/b/manifest.pp
self.kwargs = {'color': 'false'} # eg. --tags=apache::server
self.args = [] # eg. --noop
self.kwargs = {'color': 'false'} # e.g. --tags=apache::server
self.args = [] # e.g. --noop
if salt.utils.is_windows():
self.vardir = 'C:\\ProgramData\\PuppetLabs\\puppet\\var'
@ -137,7 +137,7 @@ def run(*args, **kwargs):
Execute a puppet run and return a dict with the stderr, stdout,
return code, etc. The first positional argument given is checked as a
subcommand. Following positional arguments should be ordered with arguments
required by the subcommand first, followed by non-keyvalue pair options.
required by the subcommand first, followed by non-keyword arguments.
Tags are specified by a tag keyword and comma separated list of values. --
http://docs.puppetlabs.com/puppet/latest/reference/lang_tags.html

View file

@ -283,7 +283,7 @@ def list_user_permissions(name, user=None):
def set_user_tags(name, tags, runas=None):
'''Add user tags via rabbitctl set_user_tags
'''Add user tags via rabbitmqctl set_user_tags
CLI Example:

View file

@ -152,7 +152,7 @@ def install_ruby(ruby, runas=None):
The version of Ruby to install, should match one of the
versions listed by rbenv.list
Additionnal environment variables can be configured in pillar /
Additional environment variables can be configured in pillar /
grains / master:
.. code-block:: yaml

View file

@ -154,10 +154,10 @@ def mkconfig(config=None, tmp=None, id_=None, approve_key=True,
Generate keys and config and put them in a tmp directory.
pub_key
absolute path or file content of an optionnal preseeded salt key
absolute path or file content of an optional preseeded salt key
priv_key
absolute path or file content of an optionnal preseeded salt key
absolute path or file content of an optional preseeded salt key
CLI Example:

View file

@ -97,7 +97,7 @@ def list_upgrades(rec=False, restart=False):
def ignore(*updates):
'''
Ignore a specific program update. When an update is ignored the '-' and
version number at the end will be omited, so "SecUpd2014-001-1.0" becomes
version number at the end will be omitted, so "SecUpd2014-001-1.0" becomes
"SecUpd2014-001". It will be removed automatically if present. An update
is successfully ignored when it no longer shows up after list_upgrades.
@ -182,8 +182,8 @@ def reset_ignored():
def schedule(*status):
'''
Decide if automatic checking for upgrades should be on or off.
If no argumentsare given it will return the current status.
Appaend on or off to change the status.
If no arguments are given it will return the current status.
Append on or off to change the status.
Return values:
- ``True``: Automatic checking is now on,

View file

@ -193,18 +193,18 @@ def install(name=None, sources=None, saltenv='base', **kwargs):
{'<package>': {'old': '<old-version>',
'new': '<new-version>'}}
CLI Example, installing a datastream pkg that already exists on the
CLI Example, installing a data stream pkg that already exists on the
minion::
salt '*' pkg.install sources='[{"<pkg name>": "/dir/on/minion/<pkg filename>"}]'
salt '*' pkg.install sources='[{"SMClgcc346": "/var/spool/pkg/gcc-3.4.6-sol10-sparc-local.pkg"}]'
CLI Example, installing a datastream pkg that exists on the salt master::
CLI Example, installing a data stream pkg that exists on the salt master::
salt '*' pkg.install sources='[{"<pkg name>": "salt://pkgs/<pkg filename>"}]'
salt '*' pkg.install sources='[{"SMClgcc346": "salt://pkgs/gcc-3.4.6-sol10-sparc-local.pkg"}]'
CLI Example, installing a datastream pkg that exists on a HTTP server::
CLI Example, installing a data stream pkg that exists on a HTTP server::
salt '*' pkg.install sources='[{"<pkg name>": "http://packages.server.com/<pkg filename>"}]'
salt '*' pkg.install sources='[{"SMClgcc346": "http://packages.server.com/gcc-3.4.6-sol10-sparc-local.pkg"}]'
@ -216,7 +216,7 @@ def install(name=None, sources=None, saltenv='base', **kwargs):
package in the global zone is to install it in all zones. This overrides
that and installs the package only in the global.
CLI Example, installing a datastream package only in the global zone::
CLI Example, installing a data stream package only in the global zone::
salt 'global_zone' pkg.install sources='[{"SMClgcc346": "/var/spool/pkg/gcc-3.4.6-sol10-sparc-local.pkg"}]' current_zone_only=True

View file

@ -27,7 +27,7 @@ Override these in the minion config
-----------------------------------
solr.cores
A list of core names eg ['core1','core2'].
A list of core names e.g. ['core1','core2'].
An empty list indicates non-multicore setup.
solr.baseurl
The root level URL to access solr via HTTP
@ -197,7 +197,7 @@ def _format_url(handler, host=None, core_name=None, extra=None):
The name of the solr core if using cores. Leave this blank if you
are not using cores or if you want to check all cores.
extra : list<str> ([])
A list of name value pairs in string format. eg ['name=value']
A list of name value pairs in string format. e.g. ['name=value']
Return: str
Fully formatted URL (http://<host>:<port>/solr/<handler>?wt=json&<extra>)
@ -289,7 +289,7 @@ def _replication_request(command, host=None, core_name=None, params=None):
not using cores or if you want to check all cores.
params : list<str> ([])
Any additional parameters you want to send. Should be a lsit of
strings in name=value format. eg ['name=value']
strings in name=value format. e.g. ['name=value']
Return: dict<str, obj>::
@ -1262,7 +1262,7 @@ def delta_import(handler, host=None, core_name=None, options=None, extra=None):
be merged with __opts__
extra : dict ([])
Extra name value pairs to pass to the handler. eg ["name=value"]
Extra name value pairs to pass to the handler. e.g. ["name=value"]
Return : dict<str,obj>::

View file

@ -358,7 +358,7 @@ def vmstats():
def nproc():
'''
Return the number of processing units availabe on this system
Return the number of processing units available on this system
CLI Example:

View file

@ -1,9 +1,9 @@
# -*- coding: utf-8 -*-
'''
The 'sysbench' module is used to analyse the
The 'sysbench' module is used to analyze the
performance of the minions, right from the master!
It measures various system parameters such as
CPU, Memory, FileI/O, Threads and Mutex.
CPU, Memory, File I/O, Threads and Mutex.
'''
import re

View file

@ -65,7 +65,7 @@ def _cert_base_path(cacert_path=None):
def set_ca_path(cacert_path):
'''
If wanted, store the aforementionned cacert_path in context
If wanted, store the aforementioned cacert_path in context
to be used as the basepath for further operations
'''
if cacert_path:
@ -149,7 +149,7 @@ def _write_cert_to_database(ca_name, cert, cacert_path=None):
def maybe_fix_ssl_version(ca_name, cacert_path=None):
'''
Check that the X509 version is correct
(was incorrectly setted in previous salt versions).
(was incorrectly set in previous salt versions).
This will fix the version if needed.
ca_name
@ -440,7 +440,7 @@ def create_csr(ca_name,
emailAddress
email address for the request, default is 'xyz@pdq.net'
subjectAltName
valid subjectAltNames in full form, eg to add DNS entry you would call
valid subjectAltNames in full form, e.g. to add DNS entry you would call
this function with this value: **['DNS:myapp.foo.comm']**
cacert_path
absolute path to ca certificates root directory

View file

@ -395,7 +395,7 @@ def status_webapp(app, url='http://localhost:8080/manager', timeout=180):
def serverinfo(url='http://localhost:8080/manager', timeout=180):
'''
return detailes about the server
return details about the server
url : http://localhost:8080/manager
the URL of the server manager webapp
@ -547,7 +547,7 @@ def passwd(passwd,
alg='md5',
realm=None):
'''
This function replaces the $CATALINS_HOME/bin/digest.sh script
This function replaces the $CATALINA_HOME/bin/digest.sh script
convert a clear-text password to the $CATALINA_BASE/conf/tomcat-users.xml
format

View file

@ -327,7 +327,7 @@ def get_pgid(path, follow_symlinks=True):
# Under Windows, if the path is a symlink, the user that owns the symlink is
# returned, not the user that owns the file/directory the symlink is
# pointing to. This behaviour is *different* to *nix, therefore the symlink
# pointing to. This behavior is *different* to *nix, therefore the symlink
# is first resolved manually if necessary. Remember symlinks are only
# supported on Windows Vista or later.
if follow_symlinks and sys.getwindowsversion().major >= 6:
@ -391,7 +391,7 @@ def get_gid(path, follow_symlinks=True):
Services For Unix, NFS services).
Salt, therefore, remaps this function to provide functionality that
somewhat resembles Unix behaviour for API compatibility reasons. When
somewhat resembles Unix behavior for API compatibility reasons. When
managing Windows systems, this function is superfluous and will generate
an info level log entry if used directly.
@ -425,7 +425,7 @@ def get_group(path, follow_symlinks=True):
Services For Unix, NFS services).
Salt, therefore, remaps this function to provide functionality that
somewhat resembles Unix behaviour for API compatibility reasons. When
somewhat resembles Unix behavior for API compatibility reasons. When
managing Windows systems, this function is superfluous and will generate
an info level log entry if used directly.
@ -514,8 +514,8 @@ def get_uid(path, follow_symlinks=True):
'''
Return the id of the user that owns a given file
Symlinks are followed by default to mimic Unix behaviour. Specify
`follow_symlinks=False` to turn off this behaviour.
Symlinks are followed by default to mimic Unix behavior. Specify
`follow_symlinks=False` to turn off this behavior.
CLI Example:
@ -529,7 +529,7 @@ def get_uid(path, follow_symlinks=True):
# Under Windows, if the path is a symlink, the user that owns the symlink is
# returned, not the user that owns the file/directory the symlink is
# pointing to. This behaviour is *different* to *nix, therefore the symlink
# pointing to. This behavior is *different* to *nix, therefore the symlink
# is first resolved manually if necessary. Remember symlinks are only
# supported on Windows Vista or later.
if follow_symlinks and sys.getwindowsversion().major >= 6:
@ -554,8 +554,8 @@ def get_user(path, follow_symlinks=True):
'''
Return the user that owns a given file
Symlinks are followed by default to mimic Unix behaviour. Specify
`follow_symlinks=False` to turn off this behaviour.
Symlinks are followed by default to mimic Unix behavior. Specify
`follow_symlinks=False` to turn off this behavior.
CLI Example:
@ -801,7 +801,7 @@ def chgrp(path, group):
Services For Unix, NFS services).
Salt, therefore, remaps this function to do nothing while still being
compatible with Unix behaviour. When managing Windows systems,
compatible with Unix behavior. When managing Windows systems,
this function is superfluous and will generate an info level log entry if
used directly.
@ -835,7 +835,7 @@ def stats(path, hash_type='md5', follow_symlinks=True):
Services For Unix, NFS services).
Salt, therefore, remaps these properties to keep some kind of
compatibility with Unix behaviour. If the 'primary group' is required, it
compatibility with Unix behavior. If the 'primary group' is required, it
can be accessed in the `pgroup` and `pgid` properties.
CLI Example:
@ -1032,7 +1032,7 @@ def symlink(src, link):
This is only supported with Windows Vista or later and must be executed by
a user with the SeCreateSymbolicLink privilege.
The behaviour of this function matches the Unix equivalent, with one
The behavior of this function matches the Unix equivalent, with one
exception - invalid symlinks cannot be created. The source path must exist.
If it doesn't, an error will be raised.
@ -1092,7 +1092,7 @@ def is_link(path):
This is only supported on Windows Vista or later.
Inline with Unix behaviour, this function will raise an error if the path
Inline with Unix behavior, this function will raise an error if the path
is not a symlink, however, the error raised will be a SaltInvocationError,
not an OSError.
@ -1182,7 +1182,7 @@ def readlink(path):
This is only supported on Windows Vista or later.
Inline with Unix behaviour, this function will raise an error if the path is
Inline with Unix behavior, this function will raise an error if the path is
not a symlink, however, the error raised will be a SaltInvocationError, not
an OSError.

View file

@ -210,7 +210,7 @@ def _rpm_installed(name):
def normalize_name(name):
'''
Strips the architecture from the specified package name, if necessary.
Circomstances where this would be done include:
Circumstances where this would be done include:
* If the arch is 32 bit and the package name ends in a 32-bit arch.
* If the arch matches the OS arch, or is ``noarch``.

View file

@ -922,7 +922,7 @@ class Jobs(LowDataAdapter):
class Login(LowDataAdapter):
'''
Log in to recieve a session token
Log in to receive a session token
:ref:`Authentication information <rest_cherrypy-auth>`.
'''

View file

@ -12,7 +12,7 @@ class SynchronizingWebsocket(WebSocket):
'''
Class to handle requests sent to this websocket connection.
Each instance of this class represents a Salt websocket connection.
Waits to receive a ``ready`` message fom the client.
Waits to receive a ``ready`` message from the client.
Calls send on it's end of the pipe to signal to the sender on receipt
of ``ready``.

View file

@ -17,7 +17,7 @@ multi-threaded, encrypted with SSL, and should be considered production-ready.
Using a WSGI-compliant web server
---------------------------------
This module may be deplayed on any WSGI-compliant server such as Apache with
This module may be deployed on any WSGI-compliant server such as Apache with
mod_wsgi or Nginx with FastCGI, to name just two (there are many).
Note, external WSGI servers handle URLs, paths, and SSL certs directly. The

View file

@ -275,7 +275,7 @@ class BaseSaltAPIHandler(tornado.web.RequestHandler, SaltClientsMixIn):
def _verify_auth(self):
'''
Boolean wether the request is auth'd
Boolean whether the request is auth'd
'''
return self.token and bool(self.application.auth.get_tok(self.token))

View file

@ -7,7 +7,7 @@ A Websockets add-on to saltnado
:depends: - tornado Python module
In order to enable saltnado_webosockets you must add websockets: True to your
In order to enable saltnado_websockets you must add websockets: True to your
saltnado config block.
.. code-block:: yaml

View file

@ -147,7 +147,7 @@ class GitPillar(object):
'''
Ensure you are following the latest changes on the remote
Return boolean wether it worked
Return boolean whether it worked
'''
try:
log.debug('Updating fileserver for git_pillar module')

View file

@ -33,7 +33,7 @@ Configuring the Mongo ext_pillar
The Mongo ext_pillar takes advantage of the fact that the Salt Master
configuration file is yaml. It uses a sub-dictionary of values to adjust
specific features of the pillar. This is the explicit single-line dictionary
notation for yaml. One may be able to get the easier-to-read multine dict to
notation for yaml. One may be able to get the easier-to-read multi-line dict to
work correctly with some experimentation.
.. code-block:: yaml

View file

@ -12,7 +12,7 @@ Theory of mysql ext_pillar
Ok, here's the theory for how this works...
- If there's a keyword arg of mysql_query, that'll go first.
- Then any non-keyworded args are processed in order.
- Then any non-keyword args are processed in order.
- Finally, remaining keywords are processed.
We do this so that it's backward compatible with older configs.
@ -124,7 +124,7 @@ These columns define list grouping
}
]}
The range for with_lists is 1 to number_of_fiels, inclusive.
The range for with_lists is 1 to number_of_fields, inclusive.
Numbers outside this range are ignored.
Finally, if you use pass the queries in via a mapping, the key will be the
@ -248,7 +248,7 @@ class merger(object):
def extract_queries(self, args, kwargs):
'''
This function normalises the config block in to a set of queries we
This function normalizes the config block in to a set of queries we
can use. The return is a list of consistently laid out dicts.
'''
# Please note the function signature is NOT an error. Neither args, nor

View file

@ -57,7 +57,7 @@ def ext_pillar(minion_id, pillar, function, **kwargs):
def key_value(minion_id, pillar, pillar_key='redis_pillar'):
'''
Looks for key in redis matching minion_id, returns a structure based on the
datatype of the redis key. String for string type, dict for hash type and
data type of the redis key. String for string type, dict for hash type and
lists for lists, sets and sorted sets.
pillar_key

View file

@ -206,7 +206,7 @@ def _refresh_buckets_cache_file(creds, cache_file, multiple_env, environment):
def __get_pillar_files_from_s3_meta(s3_meta):
return filter(lambda k: 'Key' in k, s3_meta)
# pull out the environment dirs (eg. the root dirs)
# pull out the environment dirs (e.g. the root dirs)
def __get_pillar_environments_from_s3_meta(s3_meta):
environments = map(lambda k: (os.path.dirname(k['Key'])
.split('/', 1))[0], files)

View file

@ -46,7 +46,7 @@ log = logging.getLogger(__name__)
__opts__ = {
'stateconf_end_marker': r'#\s*-+\s*end of state config\s*-+',
# eg, something like "# --- end of state config --" works by default.
# e.g., something like "# --- end of state config --" works by default.
'stateconf_start_state': '.start',
# name of the state id for the generated start state.
@ -186,7 +186,7 @@ def render(input, saltenv='base', sls='', argline='', **kws):
]
try:
name, rd_argline = (args[0] + ' ').split(' ', 1)
render_data = renderers[name] # eg, the yaml renderer
render_data = renderers[name] # e.g., the yaml renderer
if implicit_require:
if name == 'yaml':
rd_argline = '-o ' + rd_argline
@ -196,7 +196,7 @@ def render(input, saltenv='base', sls='', argline='', **kws):
'is used!'
)
name, rt_argline = (args[1] + ' ').split(' ', 1)
render_template = renderers[name] # eg, the mako renderer
render_template = renderers[name] # e.g., the mako renderer
except KeyError as err:
raise SaltRenderError('Renderer: {0} is not available!'.format(err))
except IndexError:

View file

@ -14,8 +14,8 @@ configuration file:
etcd.port: 4001
It is technically possible to configure etcd without using a profile, but this
is not consided to be a best practice, especially when multiple etcd servers or
clusters are available.
is not considered to be a best practice, especially when multiple etcd servers
or clusters are available.
.. code-block:: yaml

View file

@ -22,7 +22,7 @@ def __virtual__():
def runner():
'''
Return all inline documetation for runner modules
Return all inline documentation for runner modules
CLI Example:

View file

@ -287,10 +287,10 @@ def init(names, host=None, saltcloud_mode=False, quiet=False, **kwargs):
done.append(container)
# marking ping status as True only and only if we have at
# least provisionned one container
# least provisioned one container
ret['ping_status'] = bool(len(done))
# for all provisionned containers, last job is to verify
# for all provisioned containers, last job is to verify
# - the key status
# - we can reach them
for container in done:

View file

@ -69,7 +69,7 @@ def diff(*args, **kwargs):
These pools are determined from the aggregated and sorted results of
a salt command.
This command displays the "diffs" as a series of 2-way differences-- namely
the diffence between the FIRST displayed minion pool
the difference between the FIRST displayed minion pool
(according to sort order) and EACH SUBSEQUENT minion pool result set.
Differences are displayed according to the Python "difflib.unified_diff()"
as in the case of the salt execution module "file.get_diff".

View file

@ -128,7 +128,7 @@ def list(hyper=None, quiet=False):
def next_hyper():
'''
Return the hypervisor to use for the next autodeployed vm. This querires
Return the hypervisor to use for the next autodeployed vm. This queries
the available hypervisors and executes some math the determine the most
"available" next hypervisor.
'''
@ -172,14 +172,14 @@ def init(
mem
The amount of memory to allocate tot his virtual machine. The number
is interpereted in megabytes.
is interpreted in megabytes.
image
The network location of the virtual machine image, commonly a location
on the salt fileserver, but http, https and ftp can also be used.
hyper
The hypervisor to use for the new virtual macine, if this is ommited
The hypervisor to use for the new virtual machine, if this is omitted
Salt will automatically detect what hypervisor to use.
seed
@ -191,7 +191,7 @@ def init(
bridge on the master.
install
Set to False to prevent Salt fom instaling a minion on the new vm
Set to False to prevent Salt from installing a minion on the new vm
before it spins up.
'''
print('Searching for Hypervisors')

View file

@ -70,7 +70,7 @@ def extracted(name,
tar, zip or rar
if_missing
Some archive, such as tar, extract themself in a subfolder.
Some archives, such as tar, extract themselves in a subfolder.
This directive can be used to validate if the archive had been
previously extracted.

View file

@ -52,7 +52,7 @@ def change(name, context=None, changes=None, lens=None, **kwargs):
context
The context to use. Set this to a file path, prefixed by ``/files``, to
avoid redundancy, eg:
avoid redundancy, e.g.:
.. code-block:: yaml
@ -68,7 +68,7 @@ def change(name, context=None, changes=None, lens=None, **kwargs):
``set``, ``mv``/``move``, ``ins``/``insert``, and ``rm``/``remove``.
lens
The lens to use, needs to be suffixed with `.lns`, eg: `Nginx.lns`. See
The lens to use, needs to be suffixed with `.lns`, e.g.: `Nginx.lns`. See
the `list of stock lenses <http://augeas.net/stock_lenses.html>`_
shipped with Augeas.
@ -153,7 +153,7 @@ def change(name, context=None, changes=None, lens=None, **kwargs):
.. warning::
Don't forget the ``unless`` here, otherwise a new entry will be added
everytime this state is run.
every time this state is run.
'''
ret = {'name': name, 'result': False, 'comment': '', 'changes': {}}

View file

@ -198,7 +198,7 @@ def present(
config = __salt__['boto_elasticache.get_config'](name, region, key, keyid,
profile)
if config is None:
msg = 'Failed to retrive cache cluster info from AWS.'.format(name)
msg = 'Failed to retrieve cache cluster info from AWS.'.format(name)
ret['comment'] = msg
return ret
elif not config:

View file

@ -75,7 +75,7 @@ def installed(name,
(i.e. /path/to/composer.phar)
php
Location of the php executible to use with composer.
Location of the php executable to use with composer.
(i.e. /usr/bin/php)
runas

View file

@ -434,7 +434,7 @@ def file(name,
msg = (
'Passing a salt environment should be done using \'saltenv\' not '
'\'env\'. This warning will go away in Salt Boron and this '
'will be the default and expected behaviour. Please update your '
'will be the default and expected behavior. Please update your '
'state files.'
)
salt.utils.warn_until('Boron', msg)

View file

@ -38,7 +38,7 @@ def setenv(name,
false_unsets
If a key's value is False and false_unsets is True, then the
key will be removed from the salt processes environment dict
entirely. If a key's value is Flase and false_unsets is not
entirely. If a key's value is False and false_unsets is not
True, then the key's value will be set to an empty string.
Default: False

View file

@ -1225,7 +1225,7 @@ def managed(name,
msg = (
'Passing a salt environment should be done using \'saltenv\' not '
'\'env\'. This warning will go away in Salt Boron and this '
'will be the default and expected behaviour. Please update your '
'will be the default and expected behavior. Please update your '
'state files.'
)
salt.utils.warn_until('Boron', msg)
@ -1860,7 +1860,7 @@ def recurse(name,
msg = (
'Passing a salt environment should be done using \'saltenv\' not '
'\'env\'. This warning will go away in Salt Boron and this '
'will be the default and expected behaviour. Please update your '
'will be the default and expected behavior. Please update your '
'state files.'
)
salt.utils.warn_until('Boron', msg)
@ -2242,11 +2242,11 @@ def blockreplace(
:param name: Filesystem path to the file to be edited
:param marker_start: The line content identifying a line as the start of
the content block. Note that the whole line containing this marker will
be considered, so whitespaces or extra content before or after the
be considered, so whitespace or extra content before or after the
marker is included in final output
:param marker_end: The line content identifying a line as the end of
the content block. Note that the whole line containing this marker will
be considered, so whitespaces or extra content before or after the
be considered, so whitespace or extra content before or after the
marker is included in final output.
Note: you can use file.accumulated and target this state. All
accumulated data dictionaries content will be added as new lines in the
@ -3166,7 +3166,7 @@ def patch(name,
msg = (
'Passing a salt environment should be done using \'saltenv\' not '
'\'env\'. This warning will go away in Salt Boron and this '
'will be the default and expected behaviour. Please update your '
'will be the default and expected behavior. Please update your '
'state files.'
)
salt.utils.warn_until('Boron', msg)
@ -3689,7 +3689,7 @@ def serialize(name,
msg = (
'Passing a salt environment should be done using \'saltenv\' not '
'\'env\'. This warning will go away in Salt Boron and this '
'will be the default and expected behaviour. Please update your '
'will be the default and expected behavior. Please update your '
'state files.'
)
salt.utils.warn_until('Boron', msg)

View file

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
'''
Management of PostgreSQL extensions (eg: postgis)
Management of PostgreSQL extensions (e.g.: postgis)
=================================================
The postgres_extensions module is used to create and manage Postgres extensions.

View file

@ -128,7 +128,7 @@ def state(
msg = (
'Passing a salt environment should be done using \'saltenv\' not '
'\'env\'. This warning will go away in Salt Boron and this '
'will be the default and expected behaviour. Please update your '
'will be the default and expected behavior. Please update your '
'state files.'
)
salt.utils.warn_until('Boron', msg)

View file

@ -22,7 +22,7 @@ The service can also be set to be started at runtime via the enable option:
- enable: True
By default if a service is triggered to refresh due to a watch statement the
service is by default restarted. If the desired behaviour is to reload the
service is by default restarted. If the desired behavior is to reload the
service, then set the reload value to True:
.. code-block:: yaml

View file

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
'''
Configuration of the Linux kernel using sysctrl
Configuration of the Linux kernel using sysctl
===============================================
Control the kernel sysctl system.

Some files were not shown because too many files have changed in this diff Show more