Skip to content

Commit

Permalink
Merge branch 'develop' into saltstackGH-51739
Browse files Browse the repository at this point in the history
  • Loading branch information
dwoz authored Mar 5, 2019
2 parents 8a4a4bb + 60beb8d commit 1247621
Show file tree
Hide file tree
Showing 133 changed files with 10,424 additions and 746 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@ tests/integration/cloud/providers/pki/minions
# Ignore tox virtualenvs
/.tox/

# Ignore nox virtualenvs
/.nox/

# Kitchen tests files
.kitchen.local.yml
.kitchen/
Expand Down
6 changes: 3 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -255,9 +255,9 @@ def inner(fn, *iargs, **ikwargs): # pylint: disable=unused-argument
project = 'Salt'

version = salt.version.__version__
latest_release = '2018.3.3' # latest release
previous_release = '2017.7.8' # latest release from previous branch
previous_release_dir = '2017.7' # path on web server for previous branch
latest_release = '2019.2.0' # latest release
previous_release = '2018.3.4' # latest release from previous branch
previous_release_dir = '2018.3' # path on web server for previous branch
next_release = '' # next release
next_release_dir = '' # path on web server for next release branch

Expand Down
4 changes: 4 additions & 0 deletions doc/ref/configuration/master.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2645,6 +2645,8 @@ can have multiple root directories. The subdirectories in the multiple file
roots cannot match, otherwise the downloaded files will not be able to be
reliably ensured. A base environment is required to house the top file.

As of 2018.3.5 and 2019.2.1, it is possible to have `__env__` as a catch-all environment.

Example:

.. code-block:: yaml
Expand All @@ -2658,6 +2660,8 @@ Example:
prod:
- /srv/salt/prod/services
- /srv/salt/prod/states
__env__:
- /srv/salt/default
.. note::
For masterless Salt, this parameter must be specified in the minion config
Expand Down
17 changes: 17 additions & 0 deletions doc/ref/configuration/minion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -900,6 +900,23 @@ A value of 10 minutes is a reasonable default.
grains_refresh_every: 0
.. conf_minion:: metadata_server_grains

``metadata_server_grains``
--------------------------

.. versionadded:: 2017.7.0

Default: ``False``

Set this option to enable gathering of cloud metadata from
``http://169.254.169.254/latest`` for use in grains (see :py:mod:`here
<salt.grains.metadata>` for more information).

.. code-block:: yaml
metadata_server_grains: True
.. conf_minion:: fibre_channel_grains

``fibre_channel_grains``
Expand Down
2 changes: 1 addition & 1 deletion doc/topics/cloud/azure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ services. For more information on service certificates, see the following link:

* `Manage Certificates`__

.. __: https://msdn.microsoft.com/en-us/library/azure/gg981929.aspx
.. __: https://docs.microsoft.com/en-us/azure/cloud-services/cloud-services-certs-create

The following functions are available.

Expand Down
5 changes: 3 additions & 2 deletions doc/topics/cloud/cloudstack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Using Salt for CloudStack, requires an ``API key`` and a ``secret key`` along wi
exoscale:
driver: cloudstack
host: api.exoscale.ch
host: api.exoscale.com
path: /compute
apikey: EXOAPIKEY
secretkey: EXOSECRETKEYINYOURACCOUNT
Expand All @@ -48,9 +48,10 @@ Set up an initial profile at ``/etc/salt/cloud.profiles`` or in the
exoscale-ubuntu:
provider: exoscale-config
image: Ubuntu 16.04
image: Linux Ubuntu 18.04
size: Small
location: ch-gva-2
ssh_username: ubuntu
Locations can be obtained using the ``--list-locations`` option for the ``salt-cloud``
command:
Expand Down
7 changes: 4 additions & 3 deletions doc/topics/community/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ A few examples of salt states from the community:
* https://github.com/bclermont/states
* https://github.com/pcrews/salt-data

Follow on ohloh
===============
Follow on Open Hub
==================

https://www.ohloh.net/p/salt
https://www.openhub.net/p/salt

Other community links
=====================
Expand All @@ -87,6 +87,7 @@ Other community links
- `Facebook <https://www.facebook.com/SaltStack>`_
- `Twitter <https://twitter.com/SaltStackInc>`_
- `Wikipedia page <http://en.wikipedia.org/wiki/Salt_(software)>`_
- `Stack Overflow <https://stackoverflow.com/questions/tagged/salt-stack>`_

Hack the Source
===============
Expand Down
14 changes: 14 additions & 0 deletions doc/topics/development/modules/developing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,3 +237,17 @@ Defined in: State
__sdb__
-------
Defined in: SDB


Additional Globals
==================

Defined for: Runners, Execution Modules, Wheels

* ``__jid__``: The job ID
* ``__user__``: The user
* ``__tag__``: The jid tag
* ``__jid_event__``: A :py:class:`salt.utils.event.NamespacedEvent`.

:py:class:`NamespacedEvent <salt.utils.event.NamespacedEvent>` defines a single
method :py:meth:`fire_event <salt.utils.event.NamespacedEvent.fire_event>`, that takes data and tag. The :ref:`Runner docs <runners>` has examples.
31 changes: 23 additions & 8 deletions doc/topics/development/modules/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ prepended by underscore, such as:
Modules must be synced before they can be used. This can happen a few ways,
discussed below.

.. note:
.. note::
Using saltenvs besides ``base`` may not work in all contexts.

Sync Via States
Expand All @@ -73,7 +73,7 @@ Sync Via the saltutil Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The saltutil module has a number of functions that can be used to sync all
or specific dynamic modules. The ``saltutil.sync_*``
or specific dynamic modules. The ``saltutil.sync_*``
:py:mod:`execution functions <salt.modules.saltutil>` and
:py:mod:`runner functions <salt.runners.saltutil>` can be used to sync modules
to minions and the master, respectively.
Expand Down Expand Up @@ -110,7 +110,7 @@ This is done via setuptools entry points:
)
Note that these are not synced from the Salt Master to the Minions. They must be
installed indepdendently on each Minion.
installed independently on each Minion.

Module Types
============
Expand All @@ -129,10 +129,12 @@ Cache ``salt.cache`` (:ref:`index <all-salt.cache>`) ``
Cloud ``salt.cloud.clouds`` (:ref:`index <all-salt.clouds>`) ``clouds`` ``cloud_dirs``
Engine ``salt.engines`` (:ref:`index <engines>`) ``engines`` ``engines_dirs``
Execution ``salt.modules`` (:ref:`index <all-salt.modules>`) ``modules`` ``module_dirs``
Executor ``salt.executors`` (:ref:`index <all-salt.executors>`) ``executors`` [#no-fs]_ ``executor_dirs``
Executor ``salt.executors`` (:ref:`index <all-salt.executors>`) ``executors`` ``executor_dirs``
File Server ``salt.fileserver`` (:ref:`index <file-server>`) ``fileserver`` ``fileserver_dirs``
Grain ``salt.grains`` (:ref:`index <all-salt.grains>`) ``grains`` ``grains_dirs``
Log Handler ``salt.log.handlers`` (:ref:`index <external-logging-handlers>`) ``log_handlers`` ``log_handlers_dirs``
Matcher ``salt.matchers`` ``matchers`` ``matchers_dirs``
Metaproxy ``salt.metaproxy`` ``metaproxy`` [#no-fs]_ ``metaproxy_dirs``
Net API ``salt.netapi`` (:ref:`index <all-netapi-modules>`) ``netapi`` [#no-fs]_ ``netapi_dirs``
Outputter ``salt.output`` (:ref:`index <all-salt.output>`) ``output`` ``outputter_dirs``
Pillar ``salt.pillar`` (:ref:`index <all-salt.pillars>`) ``pillar`` ``pillar_dirs``
Expand All @@ -157,7 +159,7 @@ Wheel ``salt.wheels`` (:ref:`index <all-salt.wheel>`) ``

.. [#no-fs] These modules cannot be loaded from the Salt File Server.
.. note:
.. note::
While it is possible to import modules directly with the import statement,
it is strongly recommended that the appropriate
:ref:`dunder dictionary <dunder-dictionaries>` is used to access them
Expand All @@ -179,7 +181,7 @@ Beacon

* :ref:`Writing Beacons <writing-beacons>`

Beacons are polled by the Salt event loop to monitor non-salt processes. See
Beacons are polled by the Salt event loop to monitor non-salt processes. See
:ref:`Beacons <beacons>` for more information about the beacon system.

Cache
Expand Down Expand Up @@ -258,6 +260,19 @@ Log Handler
Log handlers allows the logs from salt (master or minion) to be sent to log
aggregation systems.

Matcher
-------

Matcher modules are used to define the :ref:`minion targeting expressions <targeting>`.
For now, it is only possible to override the :ref:`existing matchers <matchers>`
(the required CLI plumbing for custom matchers is not implemented yet).

Metaproxy
---------

Metaproxy is an abstraction layer above the existing proxy minion. It enables
adding different types of proxy minions that can still load existing proxymodules.

Net API
-------

Expand Down Expand Up @@ -382,7 +397,7 @@ Tokens
Token stores for :ref:`External Authentication <acl-eauth>`. See the
:py:mod:`salt.tokens` docstring for details.

.. note:
.. note::
The runner to load tokens modules is
:py:func:`saltutil.sync_eauth_tokens <salt.runners.saltutil.sync_eauth_tokens>`.

Expand All @@ -395,7 +410,7 @@ the state system.
Util
----

Just utility modules to use with other modules via ``__utils__`` (see
Just utility modules to use with other modules via ``__utils__`` (see
:ref:`Dunder Dictionaries <dunder-dictionaries>`).

Wheel
Expand Down
29 changes: 1 addition & 28 deletions doc/topics/installation/nxos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ Example:
Start the Minon in the Guestshell and accept the key on the SaltStack Master.

``[root@guestshell ~]# salt-minion -d``
``[root@guestshell ~]# systemctl start salt-minion``

.. code:: bash
Expand Down Expand Up @@ -385,33 +385,6 @@ Next, enable the SaltStack Minion systemd service (the ``enable`` command adds i
systemctl start salt-minion
GuestShell NAPALM Installation
==============================

This section documents installing NAPALM in the ``guestshell`` after the Saltstack Minion has already been installed.

Before NAPALM can be successfully installed a few packages need to be installed or updated.

.. code:: bash
pip uninstall setuptools
pip install setuptools
python -m pip install pip==9.0.3
pip install napalm
pip install napalm-nxos
Tell the SaltStack Minion to use NAPALM for NXOS. Add the following to the minion configuration file (typically /etc/salt/minion):

.. code:: yaml
napalm:
driver: nxos
A ``username`` can be optionally provided if necessary. However, by default, the username is 'admin'. A ``password`` is not necessary as requests to NXAPI are made over the Unix Domain Socket (UDS) inside the ``guestshell``.

Once the above packages have installed successfully and configuration changes have been made, restart the Saltstack Minion inside the ``guestshell``.


References
==========

Expand Down
Loading

0 comments on commit 1247621

Please sign in to comment.