Installation

SaltStack Nornir Proxy Minion tested only for Linux, it is never tested with and unlikely will work on Windows. It is recommended to use Red Hat/CentOS or Ubuntu Linux distributions.

Python 2 is not supported, recommended version is Python 3.6 and higher.

Install from PyPi:

pip install salt-nornir

Or explicitly specifying Python version:

python3 -m pip install salt-nornir

Or install GIT and run installation of latest source code from GitHub master brunch:

python3 -m pip install git+https://github.com/dmulyalin/salt-nornir

Salt Nornir need to be installed on proxy minion machine. If planning to use runner module, salt-nornir should be installed on Salt Master machine as well.

For installation of SaltStack master and minion/proxy-minion modules refer to official documentation.

SaltStack versions tested

Nornir Proxy minion was well tested and confirmed working with these versions of SaltStack:

  • salt 3002.6

  • salt 3003.1

Other SaltStack versions should work too, but not yet tested.

Nornir Salt Dependency

Main dependency is nornir-salt package, it is must be of the same major and minor versions as salt-nornir package.

Compatible versions

salt-nornir

0.6.*

0.5.*

0.4.*

0.3.*

nornir-salt

0.6.*

0.5.*

0.4.*

0.3.*

Upgrade Procedure

Install updated packages:

python3 -m pip install nornir-salt --upgrade
python3 -m pip install salt-nornir --upgrade

Restart your proxy minions to pick up updated version.

Optionally run to verify software versions after Proxy Minions Started:

salt nrp1 nr.nornir version

Common installation issues

Issues mainly arise around installing all required dependencies. General rule of thumb - try Googling errors you getting or search StackOverflow.

1 PyYAML dependency - if getting error while doing pip install salt-nornir:

ERROR: Cannot uninstall 'PyYAML'. It is a distutils installed project and thus we cannot accurately
determine which files belong to it which would lead to only a partial uninstall.

try:

python3 -m pip install salt-nornir --ignore-installed

2 setuptools dependency - if getting error while doing pip install salt-nornir:

ModuleNotFoundError: No module named 'setuptools_rust'

try:

python3 -m pip install -U pip setuptools

Using docker containers

Refer to Salt Nornir Docker Repository on how to setup SaltStack Master and Nornir Proxy Minion using docker containers.