Minor doc bug fixes

Refs #26403
Refs #26432
Refs #26233
Refs #26264
Refs #26329
This commit is contained in:
Jacob Hammons 2015-08-19 11:31:26 -06:00
parent f46a0dab5d
commit 499bd66378
6 changed files with 84 additions and 36 deletions

View file

@ -7,9 +7,13 @@ Highstate data structure definitions
The Salt State Tree
===================
A state tree is a collection of ``SLS`` files that live under the directory
specified in :conf_master:`file_roots`. A state tree can be organized into
``SLS modules``.
A state tree is a collection of ``SLS`` files and directories that live under the directory
specified in :conf_master:`file_roots`.
.. note::
Directory names or filenames in the state tree cannot contain a period, with the
exception of the period in the .sls file suffix.
.. _states-highstate-top-file:
@ -397,4 +401,4 @@ components.
- <name>
- <name>
- <Requisite Declaration>:
- <Requisite Reference>
- <Requisite Reference>

View file

@ -30,6 +30,9 @@ The above configuration allows the user ``thatch`` to execute functions
in the test and network modules on the minions that match the web* target.
User ``steve`` is given unrestricted access to minion commands.
Salt respects the current PAM configuration in place, and uses the 'login'
service to authenticate.
.. note:: The PAM module does not allow authenticating as ``root``.
To allow access to :ref:`wheel modules <all-salt.wheel>` or :ref:`runner

View file

@ -46,6 +46,39 @@ To install from ``updates-testing``, use the ``enablerepo`` argument for yum:
yum --enablerepo=updates-testing install salt-master
yum --enablerepo=updates-testing install salt-minion
Installation Using pip
======================
Since Salt is on `PyPI`_, it can be installed using pip, though most users
prefer to install using a package manager.
Installing from pip has a few additional requirements:
* Install the group 'Development Tools', ``dnf groupinstall 'Development Tools'``
* Install the 'zeromq-devel' package if it fails on linking against that
afterwards as well.
A pip install does not make the init scripts or the /etc/salt directory, and you
will need to provide your own systemd service unit.
Installation from pip:
.. _`PyPI`: https://pypi.python.org/pypi/salt
.. code-block:: bash
pip install salt
.. warning::
If installing from pip (or from source using ``setup.py install``), be
advised that the ``yum-utils`` package is needed for Salt to manage
packages. Also, if the Python dependencies are not already installed, then
you will need additional libraries/tools installed to build some of them.
More information on this can be found :ref:`here
<installing-for-development>`.
Post-installation tasks
=======================
@ -77,4 +110,4 @@ To start the Minion:
systemctl start salt-minion.service
Now go to the :doc:`Configuring Salt</ref/configuration/index>` page.
Now go to the :doc:`Configuring Salt</ref/configuration/index>` page.

View file

@ -2,28 +2,6 @@
RHEL / CentOS / Scientific Linux / Amazon Linux / Oracle Linux
==============================================================
Installation Using pip
======================
Since Salt is on `PyPI`_, it can be installed using pip, though most users
prefer to install using RPMs (which can be installed from `EPEL`_).
Installation from pip is easy:
.. _`PyPI`: https://pypi.python.org/pypi/salt
.. code-block:: bash
pip install salt
.. warning::
If installing from pip (or from source using ``setup.py install``), be
advised that the ``yum-utils`` package is needed for Salt to manage
packages. Also, if the Python dependencies are not already installed, then
you will need additional libraries/tools installed to build some of them.
More information on this can be found :ref:`here
<installing-for-development>`.
Installation from Repository
============================
@ -105,6 +83,37 @@ To install from ``epel-testing``, use the ``enablerepo`` argument for yum:
yum --enablerepo=epel-testing install salt-minion
Installation Using pip
======================
Since Salt is on `PyPI`_, it can be installed using pip, though most users
prefer to install using RPMs (which can be installed from `EPEL`_).
Installing from pip has a few additional requirements:
* Install the group 'Development Tools', ``yum groupinstall 'Development Tools'``
* Install the 'zeromq-devel' package if it fails on linking against that
afterwards as well.
A pip install does not make the init scripts or the /etc/salt directory, and you
will need to provide your own systemd service unit.
Installation from pip:
.. _`PyPI`: https://pypi.python.org/pypi/salt
.. code-block:: bash
pip install salt
.. warning::
If installing from pip (or from source using ``setup.py install``), be
advised that the ``yum-utils`` package is needed for Salt to manage
packages. Also, if the Python dependencies are not already installed, then
you will need additional libraries/tools installed to build some of them.
More information on this can be found :ref:`here
<installing-for-development>`.
ZeroMQ 4
========

View file

@ -6,17 +6,16 @@ Grains
Salt comes with an interface to derive information about the underlying system.
This is called the grains interface, because it presents salt with grains of
information.
information. Grains are collected for the operating system, domain name,
IP address, kernel, OS type, memory, and many other system properties.
The grains interface is made available to Salt modules and components so that
the right salt minion commands are automatically available on the right
systems.
It is important to remember that grains are bits of information loaded when
the salt minion starts, so this information is static. This means that the
information in grains is unchanging, therefore the nature of the data is
static. So grains information are things like the running kernel, or the
operating system.
Grain data is relatively static, though if system information changes
(for example, if network settings are changed), or if a new value is assigned
to a custom grain, grain data is refreshed.
.. note::

View file

@ -196,9 +196,9 @@ The easiest way to accept the minion key is to accept all pending keys:
and then set this value as the :conf_minion:`master_finger` in the minion configuration
file. Restart the Salt minion.
On the minion, run ``salt-key -f minion-id`` to print the fingerprint of the
minion's public key. This fingerprint can then be compared against the fingerprint
generated on the minion.
On the master, run ``salt-key -f minion-id`` to print the fingerprint of the
minion's public key that was received by the master. On the minion, run
``salt-call key.finger --local`` to print the fingerprint of the minion key.
On the master: