saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Moved manpages into Sphinx

Browse source
This commit is contained in:
Seth House 2011-05-23 00:58:49 -06:00
parent 3a90016574
commit fe434b872d
13 changed files with 340 additions and 255 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
doc/man/salt-cp.1
View file

@ -1,46 +0,0 @@
.TH salt-cp 1 "May 2011" "salt 0.8.7" "salt-cp Manual"
.SH NAME
salt-cp \- Copy a file to a set of systems
.SH SYNOPSIS
.B salt-cp '*' [ options ] \fISOURCE DEST\fR
.B salt-cp -E '.*' [ options ] \fISOURCE DEST\fR
.B salt-cp -G 'os:Arch.*' [ options ] \fISOURCE DEST\fR
.SH DESCRIPTION
Salt copy copies a local file out to all of the salt minions matched by the given target.
.SH OPTIONS
.TP
-h, --help
Print a usage message briefly summarizing these command-line options
.TP
-t TIMEOUT, --timeout=TIMEOUT
The timeout in seconds to wait for replies from the salt minions.
.TP
-E, --pcre
The target expresion will be interpereted as a pcre regular expression rather than a shell glob.
.TP
-L, --list
The target expression will be interpereted as a comma delimited list, example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.TP
-G, --grain
The target expression matches values returned by the salt grains system on the minions. The target expresion is in the format of '<grain value>:<pcre regular expresion>'; example: 'os:Arch.*'
.TP
-Q, --query
Execute a salt command query, this can be used to find the results os a previous function call: -Q test.echo')
.TP
-c CONFIG, --config=CONFIG
The location of the salt master configuration file, the salt master settings are required to know where the connections are; default=/etc/salt/master
.SH AUTHORS
Thomas S. Hatch <thatch@gmail.com>

39
doc/man/salt-key.1
View file

@ -1,39 +0,0 @@
.TH salt-key 1 "May 2011" "salt-key 0.8.7" "salt-key Manual"
.SH NAME
salt-key \- Public key management for salt
.SH SYNOPSIS
.B salt-key [ options ]
.SH DESCRIPTION
Salt-key executes simple management of salt server public keys used for authentication.
.SH OPTIONS
.TP
-h, --help
Print a usage message briefly summarizing these command-line options.
.TP
-l, --list
List the unaccepted minion public keys.
.TP
-L, --list-all
List all public keys on this salt master, both accepted and pending acceptance.
.TP
-a ACCEPT, --accept=ACCEPT
Accept the named minion public key for command execution.
.TP
-A, --accept-all
Accepts all pending public keys.
.TP
-c CONFIG, --config=CONFIG
The master configuration file needs to be read to determine where the salt keys are stored via the pki_dir configuration value; default=/etc/salt/master
.SH AUTHORS
Thomas S. Hatch <thatch@gmail.com>

27
doc/man/salt-master.1
View file

@ -1,27 +0,0 @@
.TH salt-master 1 "May 2011" "salt-master 0.8.7" "salt-master Manual"
.SH NAME
salt-master \- The salt master daemon, used to control the salt minions
.SH SYNOPSIS
.B salt-master [ options ]
.SH DESCRIPTION
The master daemon controls the salt minions
.SH OPTIONS
.TP
-h, --help
Print a usage message briefly summarizing these command-line options.
.TP
-d, --daemon
Run the salt master as a daemon
.TP
-c CONFIG, --config=CONFIG
The master configuration file to use, the default is /etc/salt/master
.SH AUTHORS
Thomas S. Hatch <thatch@gmail.com>

29
doc/man/salt-minion.1
View file

@ -1,29 +0,0 @@
.TH salt-minion 1 "May 2011" "salt-minion 0.8.7" "salt-minion Manual"
.SH NAME
salt-minion \- The salt minion daemon, recieves commands from a remote salt master.
.SH SYNOPSIS
.B salt-minion [ options ]
.SH DESCRIPTION
The salt minion recieves commands from the central salt master and replies with the results of said commands.
.SH OPTIONS
.TP
-h, --help
Print a usage message briefly summarizing these command-line options.
.TP
-d, --daemon
Run the salt minion as a daemon
.TP
-c CONFIG, --config=CONFIG
The minion configuration file to use, the default is /etc/salt/minion
.SH AUTHORS
Thomas S. Hatch <thatch@gmail.com>
.P
Joseph Hall <perlhoser@gmail.com>

48
doc/man/salt.1
View file

@ -1,48 +0,0 @@
.TH salt 1 "May 2011" "salt 0.8.7" "salt Manual"
.SH NAME
salt \- Parallel remote execution system
.SH SYNOPSIS
.B salt '*' [ options ] sys.doc
.B salt -E '.*' [ options ] sys.doc cmd
.B salt -F 'operatingsystem:Arch.*' [ options ] test.ping
.B salt -Q test.ping
.SH DESCRIPTION
Salt allows for commands to be executed across a swath of remote systems in parallel. This means that remote systems can be both controleed and querried with ease.
.SH OPTIONS
.TP
-h, --help
Print a usage message briefly summarizing these command-line options
.TP
-t TIMEOUT, --timeout=TIMEOUT
The timeout in seconds to wait for replies from the salt minions.
.TP
-E, --pcre
The target expresion will be interpereted as a pcre regular expression rather than a shell glob.
.TP
-L, --list
The target expression will be interpereted as a comma delimited list, example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.TP
-G, --grain
The target expression matches values returned by the salt grains system on the minions. The target expresion is in the format of '<grain value>:<pcre regular expresion>'; example: 'os:Arch.*'
.TP
-Q, --query
Execute a salt command query, this can be used to find the results os a previous function call: -Q test.echo')
.TP
-c CONFIG, --config=CONFIG
The location of the salt master configuration file, the salt master settings are required to know where the connections are; default=/etc/salt/master
.SH AUTHORS
Thomas S. Hatch <thatch@gmail.com>

66
doc/man/salt.7
View file

@ -1,66 +0,0 @@
.TH salt 7 "May 2011" "salt 0.8.7" "salt Manual"
.SH NAME
salt \- The salt distributed system controller
.SH SYNOPSIS
.B salt-master [options]
.B salt-minion [options]
.B salt [options]
.SH DESCRIPTION
Salt is a powerful remote execution manager that can be used to administer servers in a fast and efficient way.
.SH SETTING UP SALT
The Salt system setup is amazingly simple, as this is one of the central design goals of Salt. Setting up Salt only requires that the salt master be running and the salt minions point to the salt master.
.SS INSTALATION
The salt install is simple, for many distributions pakages should be available for download, or salt can be installed via the python packaging tools.
.P
Installing salt from source is a simple task, download the latest source tarball from
.URL "https://github.com/thatch45/salt/downloads"
Next untar the download and run the python setup:
# tar xvf salt-<version>.tar.gz
# cd salt-<version>
# python2 setup.py install
.SS SALT DEPENDENCIES
This is a basic python setup, nothing fancy. Salt does require a number of dependencies though, all of which should be available in your distribution's packages.
.TP
\(bu
python2.7 - python2.6 should work, but it is untested
.TP
\(bu
pyzmq - zeromq python bindings
.TP
\(bu
python-m2crypto - Crypto backend
.TP
\(bu
python-yaml - Reading configuration files
.TP
\(bu
pycrypto - Another crypto backend
.SS RUNNING SALT
To run Salt you need to ensure that a master and a minion are running and referencing each other. Starting the master and minion daemons is done with the respective commands.
On the salt master server:
# salt-master -d
On the salt minion servers:
# salt-minion -d
.SH AUTHORS
Thomas S. Hatch <thatch@gmail.com>
.TP
Joseph Hall <perlhoser@gmail.com>

66
doc/ref/cli/index.rst Normal file
View file

@ -0,0 +1,66 @@
======================
Command line reference
======================
.. toctree::
:maxdepth: 1
salt
salt-master
salt-minion
salt-key
salt-cp
salt-call
Salt can be controlled by a command line client as root on the Salt master. The
Salt command line client uses the Salt client API to communicate with the Salt
master server. The Salt client is straightforward and simple to use.
Using the Salt client commands can be easily sent to the minions.
Using the Salt Command
======================
The salt command needs a few components to send information to the salt
minions. The target minions need to be defined, the function to call and any
arguments the function requires.
Defining the Target Minions
---------------------------
The first argument passed to salt, defines the target minions, the target
minions are accessed via their hostname. The default target type is a bash
glob:
.. code-block:: bash
salt '*foo.com' sys.doc
Salt can also define the target minions with regular expressions:
.. code-block:: bash
salt -E '.*' cmd.run 'ls -l | grep foo'
Or to explicitly list hosts, salt can take a list:
.. code-block:: bash
salt -L foo.bar.baz,quo.qux cmd.run 'ps aux | grep foo'
Calling the function
--------------------
The function to call on the specified target is placed after the target
specification.
Finding available minion functions
``````````````````````````````````
The Salt functions are self documenting, all of the function documentation can
be retried from the minions via the :func:`sys.doc` function:
.. code-block:: bash
salt '*' sys.doc

33
doc/ref/cli/salt-call.rst Normal file
View file

@ -0,0 +1,33 @@
=============
``salt-call``
=============
Synopsis
========
::
salt-call [options]
Options
=======
.. program:: salt-call
.. option:: -h, --help
Print a usage message briefly summarizing these command-line options
.. option:: -g, --grains
Return the information generated by the salt grains
.. option:: -m MODULE_DIRS, --module-dirs=MODULE_DIRS
Specify an additional directories to pull modules from, multiple
directories can be delimited by commas
.. option:: -d, --doc
Return the documentation for the specified module of for all modules if
none are specified

62
doc/ref/cli/salt-cp.rst Normal file
View file

@ -0,0 +1,62 @@
===========
``salt-cp``
===========
Copy a file to a set of systems
Synopsis
========
::
salt-cp '*' [ options ] SOURCE DEST
salt-cp -E '.*' [ options ] SOURCE DEST
salt-cp -G 'os:Arch.*' [ options ] SOURCE DEST
Description
===========
Salt copy copies a local file out to all of the salt minions matched by the
given target.
Options
=======
.. program:: salt-cp
.. option:: -h, --help
Print a usage message briefly summarizing these command-line options
.. option:: -t TIMEOUT, --timeout=TIMEOUT
The timeout in seconds to wait for replies from the salt minions.
.. option:: -E, --pcre
The target expresion will be interpereted as a pcre regular expression
rather than a shell glob.
.. option:: -L, --list
The target expression will be interpereted as a comma delimited list,
example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.. option:: -G, --grain
The target expression matches values returned by the salt grains system on
the minions. The target expresion is in the format of '<grain value>:<pcre
regular expresion>'; example: 'os:Arch.*'
.. option:: -Q, --query
Execute a salt command query, this can be used to find the results os a
previous function call: -Q test.echo')
.. option:: -c CONFIG, --config=CONFIG
The location of the salt master configuration file, the salt master
settings are required to know where the connections are;
default=/etc/salt/master

46
doc/ref/cli/salt-key.rst Normal file
View file

@ -0,0 +1,46 @@
============
``salt-key``
============
Synopsis
========
salt-key [ options ]
Description
===========
Salt-key executes simple management of salt server public keys used for
authentication.
Options
=======
.. program:: salt-key
.. option:: -h, --help
Print a usage message briefly summarizing these command-line options.
.. option:: -l, --list
List the unaccepted minion public keys.
.. option:: -L, --list-all
List all public keys on this salt master, both accepted and pending
acceptance.
.. option:: -a ACCEPT, --accept=ACCEPT
Accept the named minion public key for command execution.
.. option:: -A, --accept-all
Accepts all pending public keys.
.. option:: -c CONFIG, --config=CONFIG
The master configuration file needs to be read to determine where the salt
keys are stored via the pki_dir configuration value;
default=/etc/salt/master

32
doc/ref/cli/salt-master.rst Normal file
View file

@ -0,0 +1,32 @@
===============
``salt-master``
===============
The salt master daemon, used to control the salt minions
Synopsis
========
salt-master [ options ]
Description
===========
The master daemon controls the salt minions
Options
=======
.. program:: salt-master
.. option:: -h, --help
Print a usage message briefly summarizing these command-line options.
.. option:: -d, --daemon
Run the salt master as a daemon
.. option:: -c CONFIG, --config=CONFIG
The master configuration file to use, the default is /etc/salt/master

33
doc/ref/cli/salt-minion.rst Normal file
View file

@ -0,0 +1,33 @@
===============
``salt-minion``
===============
The salt minion daemon, recieves commands from a remote salt master.
Synopsis
========
salt-minion [ options ]
Description
===========
The salt minion recieves commands from the central salt master and replies with
the results of said commands.
Options
=======
.. program:: salt-minion
.. option:: -h, --help
Print a usage message briefly summarizing these command-line options.
.. option:: -d, --daemon
Run the salt minion as a daemon
.. option:: -c CONFIG, --config=CONFIG
The minion configuration file to use, the default is /etc/salt/minion

68
doc/ref/cli/salt.rst Normal file
View file

@ -0,0 +1,68 @@
========
``salt``
========
Synopsis
========
salt '*' [ options ] sys.doc
salt -E '.*' [ options ] sys.doc cmd
salt -F 'operatingsystem:Arch.*' [ options ] test.ping
salt -Q test.ping
Description
===========
Salt allows for commands to be executed across a swath of remote systems in
parallel. This means that remote systems can be both controlled and queried
with ease.
Options
=======
.. program:: salt
.. option:: -h, --help
Print a usage message briefly summarizing these command-line options
.. option:: -t TIMEOUT, --timeout=TIMEOUT
The timeout in seconds to wait for replies from the salt minions.
.. option:: -E, --pcre
The target expression will be interpreted as a pcre regular expression
rather than a shell glob.
.. option:: -L, --list
The target expression will be interpreted as a comma delimited list,
example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.. option:: -G, --grain
The target expression matches values returned by the salt grains system on
the minions. The target expression is in the format of '<grain value>:<pcre
regular expression>'; example: 'os:Arch.*'
.. option:: -Q, --query
Execute a salt command query, this can be used to find the results os a
previous function call: -Q test.echo')
.. option:: -c CONFIG, --config=CONFIG
The location of the salt master configuration file, the salt master
settings are required to know where the connections are;
default=/etc/salt/master
See also
========
:manpage:`salt(7)`
:manpage:`salt-master(1)`
:manpage:`salt-minion(1)`