Merge pull request #27517 from jacobhammons/install-docs

Updated install docs
This commit is contained in:
Mike Place 2015-09-30 09:19:51 -06:00
commit 1f7ea7c764
4 changed files with 250 additions and 183 deletions

View file

@ -9,9 +9,10 @@ Debian Installation
Installation from the SaltStack Repository
==========================================
Debian 8 packages are available in the SaltStack Debian repository.
2015.8.0 and later packages for Debian 8 (Jessie) are available in the
SaltStack repository.
To install using the SaltStack Debian repository:
To install using the SaltStack repository:
#. Run the following command to import the SaltStack repository key:
@ -25,7 +26,7 @@ To install using the SaltStack Debian repository:
deb http://repo.saltstack.com/apt/debian jessie contrib
#. Run ``sudo apt-get update``
#. Run ``sudo apt-get update``.
#. Install the salt-minion, salt-master, or other Salt components:
@ -33,14 +34,43 @@ To install using the SaltStack Debian repository:
- ``apt-get install salt-minion``
- ``apt-get install salt-ssh``
- ``apt-get install salt-syndic``
- ``apt-get install salt-cloud``
Configure Apt
-------------
Post-installation tasks
-----------------------
Currently the latest packages for Debian Old Stable, Stable, and
Unstable (Squeeze, Wheezy, and Sid) are published in our
(saltstack.com) Debian repository.
Now, go to the :doc:`Configuring Salt </ref/configuration/index>` page.
Installation from the Community Repository
==========================================
The SaltStack community maintains a Debian repository at debian.saltstack.com.
Packages for Debian Old Stable, Stable, and Unstable (Wheezy, Jessie, and Sid)
for Salt 0.16 and later are published in this repository.
.. note::
Packages in this repository are community built, and it can
take a little while until the latest SaltStack release is available
in this repository.
Jessie (Stable)
---------------
For Jessie, the following line is needed in either
``/etc/apt/sources.list`` or a file in ``/etc/apt/sources.list.d``:
.. code-block:: bash
deb http://debian.saltstack.com/debian jessie-saltstack main
Wheezy (Old Stable)
-------------------
For wheezy, the following line is needed in either
``/etc/apt/sources.list`` or a file in ``/etc/apt/sources.list.d``:
.. code-block:: bash
deb http://debian.saltstack.com/debian wheezy-saltstack main
Squeeze (Old Old Stable)
------------------------
@ -55,28 +85,6 @@ following to ``/etc/apt/sources.list`` or a file in
deb http://debian.saltstack.com/debian squeeze-saltstack main
deb http://backports.debian.org/debian-backports squeeze-backports main
Wheezy (Old Stable)
-------------------
For wheezy, the following line is needed in either
``/etc/apt/sources.list`` or a file in ``/etc/apt/sources.list.d``:
.. code-block:: bash
deb http://debian.saltstack.com/debian wheezy-saltstack main
Jessie (Stable)
---------------
For jessie, the following line is needed in either
``/etc/apt/sources.list`` or a file in ``/etc/apt/sources.list.d``:
.. code-block:: bash
deb http://debian.saltstack.com/debian jessie-saltstack main
Sid (Unstable)
--------------
@ -121,17 +129,10 @@ Install the Salt master, minion, or syndic from the repository with the apt-get
command. These examples each install one daemon, but more than one package name
may be given at a time:
.. code-block:: bash
apt-get install salt-master
.. code-block:: bash
apt-get install salt-minion
.. code-block:: bash
apt-get install salt-syndic
- ``apt-get install salt-master``
- ``apt-get install salt-minion``
- ``apt-get install salt-ssh``
- ``apt-get install salt-syndic``
.. _Debian-config:
@ -140,4 +141,3 @@ Post-installation tasks
Now, go to the :doc:`Configuring Salt </ref/configuration/index>` page.

View file

@ -6,10 +6,19 @@ RHEL / CentOS / Scientific Linux / Amazon Linux / Oracle Linux
.. _installation-rhel-repo:
Salt should work properly with all mainstream derivatives of Red Hat Enterprise
Linux, including CentOS, Scientific Linux, Oracle Linux, and Amazon Linux.
Report any bugs or issues on the `issue tracker`__.
.. __: https://github.com/saltstack/salt/issues
Installation from the SaltStack Repository
==========================================
To install using the SaltStack yum repository:
2015.8.0 and later packages for RHEL 5, 6, and 7 are available in the
SaltStack repository.
To install using the SaltStack repository:
#. Run one of the following commands based on your version to import the SaltStack repository key:
@ -39,35 +48,48 @@ To install using the SaltStack yum repository:
#. Save the following file to ``/etc/yum.repos.d/saltstack.repo``:
Versions 6 / 7:
Version 7:
.. code-block:: cfg
.. code-block:: cfg
####################
# Enable SaltStack's package repository
[saltstack-repo]
name=SaltStack repo for RHEL/CentOS $releasever
baseurl=https://repo.saltstack.com/yum/rhel$releasever
enabled=1
gpgcheck=1
gpgkey=https://repo.saltstack.com/yum/rhel$releasever/SALTSTACK-GPG-KEY.pub
####################
# Enable SaltStack's package repository
[saltstack-repo]
name=SaltStack repo for RHEL/CentOS 7
baseurl=https://repo.saltstack.com/yum/rhel7
enabled=1
gpgcheck=1
gpgkey=https://repo.saltstack.com/yum/rhel7/SALTSTACK-GPG-KEY.pub
Version 6:
.. code-block:: cfg
####################
# Enable SaltStack's package repository
[saltstack-repo]
name=SaltStack repo for RHEL/CentOS 6
baseurl=https://repo.saltstack.com/yum/rhel6
enabled=1
gpgcheck=1
gpgkey=https://repo.saltstack.com/yum/rhel6/SALTSTACK-GPG-KEY.pub
Version 5:
.. code-block:: cfg
.. code-block:: cfg
####################
# Enable SaltStack's package repository
[saltstack-repo]
name=SaltStack repo for RHEL/CentOS $releasever
baseurl=https://repo.saltstack.com/yum/rhel$releasever
enabled=1
gpgcheck=1
gpgkey=https://repo.saltstack.com/yum/rhel$releasever/SALTSTACK-EL5-GPG-KEY.pub
####################
# Enable SaltStack's package repository
[saltstack-repo]
name=SaltStack repo for RHEL/CentOS 5
baseurl=https://repo.saltstack.com/yum/rhel5
enabled=1
gpgcheck=1
gpgkey=https://repo.saltstack.com/yum/rhel5/SALTSTACK-EL5-GPG-KEY.pub
#. Run ``sudo yum clean expire-cache``
#. Run ``sudo yum clean expire-cache``.
#. Run ``sudo yum update``
#. Run ``sudo yum update``.
#. Install the salt-minion, salt-master, or other Salt components:
@ -81,8 +103,58 @@ To install using the SaltStack yum repository:
EPEL support is not required when installing using the SaltStack repository
on Red Hat 6 and 7. EPEL must be enabled when installing on Red Hat 5.
Installation from Repository
============================
Post-installation tasks
=======================
**Master**
To have the Master start automatically at boot time:
.. code-block:: bash
chkconfig salt-master on
To start the Master:
.. code-block:: bash
service salt-master start
**Minion**
To have the Minion start automatically at boot time:
.. code-block:: bash
chkconfig salt-minion on
To start the Minion:
.. code-block:: bash
service salt-minion start
Now go to the :doc:`Configuring Salt</ref/configuration/index>` page.
Installation from the Community Repository
==========================================
Beginning with version 0.9.4, Salt has been available in `EPEL`_. For
RHEL/CentOS 5, `Fedora COPR`_ is recommended due to the removal of some
dependencies from EPEL5.
On RHEL/CentOS 6, the proper Jinja package 'python-jinja2' was moved from EPEL
to the "RHEL Server Optional Channel". Verify this repository is enabled before
installing salt on RHEL/CentOS 6.
.. note::
Packages in these repositories are community built, and it can
take a little while until the latest SaltStack release is available
in this repository.
.. _`EPEL`: http://fedoraproject.org/wiki/EPEL
.. _`Fedora COPR`: https://copr.fedoraproject.org/coprs/saltstack/salt-el5/
RHEL/CentOS 6 and 7, Scientific Linux, etc.
-------------------------------------------
@ -93,35 +165,11 @@ RHEL/CentOS 6 and 7, Scientific Linux, etc.
Red Hat 5 and 6. You must install these dependencies from another location
or use the SaltStack repository documented above.
Beginning with version 0.9.4, Salt has been available in `EPEL`_. It is
installable using yum. Salt should work properly with all mainstream
derivatives of RHEL, including CentOS, Scientific Linux, Oracle Linux and
Amazon Linux. Report any bugs or issues on the `issue tracker`__.
.. __: https://github.com/saltstack/salt/issues
On RHEL6, the proper Jinja package 'python-jinja2' was moved from EPEL to the
"RHEL Server Optional Channel". Verify this repository is enabled before
installing salt on RHEL6.
.. _`EPEL`: http://fedoraproject.org/wiki/EPEL
.. _installation-rhel-5:
RHEL/CentOS 5
-------------
Due to the removal of some of Salt's dependencies from EPEL5, we recommend
using the :ref:`SaltStack Repository <installation-rhel-repo>` or
the repository on `Fedora COPR`_.
.. _`Fedora COPR`: https://copr.fedoraproject.org/coprs/saltstack/salt-el5/
Enabling EPEL
*************
If the EPEL repository is not installed on your system, you can download the
RPM from here__ for RHEL/CentOS 6 (or here__ for RHEL/CentOS 7) and install it
RPM for `RHEL/CentOS 6`_ or for `RHEL/CentOS 7`_ and install it
using the following command:
.. code-block:: bash
@ -130,28 +178,22 @@ using the following command:
Replace ``epel-release-X-Y.rpm`` with the appropriate filename.
.. __: http://download.fedoraproject.org/pub/epel/6/i386/repoview/epel-release.html
.. __: http://download.fedoraproject.org/pub/epel/7/x86_64/repoview/epel-release.html
.. _RHEL/CentOS 6: http://download.fedoraproject.org/pub/epel/6/i386/repoview/epel-release.html
.. _RHEL/CentOS 7: http://download.fedoraproject.org/pub/epel/7/x86_64/repoview/epel-release.html
Installing Stable Release
*************************
Salt is packaged separately for the minion and the master. It is necessary only
to install the appropriate package for the role the machine will play.
Salt is packaged separately for the minion and the master. It is necessary
to install only the appropriate package for the role the machine will play.
Typically, there will be one master and multiple minions.
On the salt-master, run this:
.. code-block:: bash
yum install salt-master
On each salt-minion, run this:
.. code-block:: bash
yum install salt-minion
- ``yum install salt-master``
- ``yum install salt-minion``
- ``yum install salt-ssh``
- ``yum install salt-syndic``
- ``yum install salt-cloud``
Installing from ``epel-testing``
********************************

View file

@ -2,10 +2,62 @@
Ubuntu Installation
===================
Add repository
==============
.. _installation-ubuntu-repo:
The latest packages for Ubuntu are published in the saltstack PPA. If you have
Installation from the SaltStack Repository
==========================================
2015.8.0 and later packages for Ubuntu 14 (Trusty) and Ubuntu 12 (Precise) are
available in the SaltStack repository.
To install using the SaltStack repository:
#. Run the following command to import the SaltStack repository key:
Ubuntu 14:
.. code-block:: bash
wget -O - https://repo.saltstack.com/apt/ubuntu/ubuntu14/SALTSTACK-GPG-KEY.pub | sudo apt-key add -
Ubuntu 12:
.. code-block:: bash
wget -O - https://repo.saltstack.com/apt/ubuntu/ubuntu12/SALTSTACK-GPG-KEY.pub | sudo apt-key add -
#. Add the following line to ``/etc/apt/sources.list``:
Ubuntu 14:
.. code-block:: bash
deb http://repo.saltstack.com/apt/ubuntu/ubuntu14 trusty main
Ubuntu 12:
.. code-block:: bash
deb http://repo.saltstack.com/apt/ubuntu/ubuntu12 precise main
#. Run ``sudo apt-get update``.
#. Install the salt-minion, salt-master, or other Salt components:
- ``apt-get install salt-master``
- ``apt-get install salt-minion``
- ``apt-get install salt-ssh``
- ``apt-get install salt-syndic``
Post-installation tasks
-----------------------
Now, go to the :doc:`Configuring Salt </ref/configuration/index>` page.
Installation from the Community Repository
==========================================
Packages for Ubuntu are also published in the saltstack PPA. If you have
the ``add-apt-repository`` utility, you can add the repository and import the
key in one step:
@ -14,14 +66,14 @@ key in one step:
sudo add-apt-repository ppa:saltstack/salt
In addition to the main repository, there are secondary repositories for each
individual major release. These repositories receive security and point releases
but will not upgrade to any subsequent major release. There are currently four
available repos: salt16, salt17, salt2014-1, salt2014-7. For example to follow
2014.7.x releases:
individual major release. These repositories receive security and point
releases but will not upgrade to any subsequent major release. There are
currently several available repos: salt16, salt17, salt2014-1, salt2014-7,
salt2015-5. For example to follow 2015.5.x releases:
.. code-block:: bash
sudo add-apt-repository ppa:saltstack/salt2014-7
sudo add-apt-repository ppa:saltstack/salt2015-5
.. admonition:: add-apt-repository: command not found?
@ -65,44 +117,15 @@ Install the Salt master, minion, or syndic from the repository with the apt-get
command. These examples each install one daemon, but more than one package name
may be given at a time:
.. code-block:: bash
sudo apt-get install salt-master
.. code-block:: bash
sudo apt-get install salt-minion
.. code-block:: bash
sudo apt-get install salt-syndic
Some core components are packaged separately in the Ubuntu repositories. These should be installed as well: salt-cloud, salt-ssh, salt-api
.. code-block:: bash
sudo apt-get install salt-cloud
.. code-block:: bash
sudo apt-get install salt-ssh
.. code-block:: bash
sudo apt-get install salt-api
- ``apt-get install salt-master``
- ``apt-get install salt-minion``
- ``apt-get install salt-ssh``
- ``apt-get install salt-syndic``
.. _ubuntu-config:
ZeroMQ 4
========
ZeroMQ 4 is available by default for Ubuntu 14.04 and newer. However, for Ubuntu
12.04 LTS, starting with Salt version ``2014.7.5``, ZeroMQ 4 is included with the
Salt installation package and nothing additional needs to be done.
Post-installation tasks
=======================
Now go to the :doc:`Configuring Salt</ref/configuration/index>` page.

View file

@ -74,76 +74,78 @@ Notes:
A. Create the Unprivileged User that the Salt Minion will Run As
----------------------------------------------------------------
1. Click "Start", "Control Panel", "User Accounts"
1. Click ``Start`` > ``Control Panel`` > ``User Accounts``.
2. Click "Add or remove user accounts"
2. Click ``Add or remove user accounts``.
3. Click "Create new account"
3. Click ``Create new account``.
4. Enter "salt-user" (or a name of your preference) in the "New account name" field
4. Enter ``salt-user`` (or a name of your preference) in the ``New account name`` field.
5. Select the "Standard user" radio button
5. Select the ``Standard user`` radio button.
6. Click the "Create Account" button
6. Click the ``Create Account`` button.
7. Click on the newly created user account
7. Click on the newly created user account.
8. Click the "Create a password" link
8. Click the ``Create a password`` link.
9. In the "New password" and "Confirm new password" fields, provide a password (e.g "SuperSecretMinionPassword4Me!")
9. In the ``New password`` and ``Confirm new password`` fields, provide
a password (e.g "SuperSecretMinionPassword4Me!").
10. In the "Type a password hint" field, provide appropriate text (e.g. "My Salt Password")
10. In the ``Type a password hint`` field, provide appropriate text (e.g. "My Salt Password").
11. Click the "Create password" button
11. Click the ``Create password`` button.
12. Close the "Change an Account" window
12. Close the ``Change an Account`` window.
B. Add the New User to the Access Control List for the Salt Folder
------------------------------------------------------------------
1. In a File Explorer window, browse to the path where Salt is installed (the default path is C:\Salt)
1. In a File Explorer window, browse to the path where Salt is installed (the default path is ``C:\Salt``).
2. Right-click on the "Salt" folder and select "Properties"
2. Right-click on the ``Salt`` folder and select ``Properties``.
3. Click on the "Security" tab
3. Click on the ``Security`` tab.
4. Click the "Edit" button
4. Click the ``Edit`` button.
5. Click the "Add" button
5. Click the ``Add`` button.
6. Type the name of your designated Salt user and click the "OK" button
6. Type the name of your designated Salt user and click the ``OK`` button.
7. Check the box to "Allow" the "Modify" permission
7. Check the box to ``Allow`` the ``Modify`` permission.
8. Click the "OK" button
8. Click the ``OK`` button.
9. Click the "OK" button to close the "Salt Properties" window
9. Click the ``OK`` button to close the ``Salt Properties`` window.
C. Update the Windows Service User for the "salt-minion" Service
----------------------------------------------------------------
C. Update the Windows Service User for the ``salt-minion`` Service
------------------------------------------------------------------
1. Click "Start", "Administrative Tools", "Services"
1. Click ``Start`` > ``Administrative Tools`` > ``Services``.
2. In the list of Services, Right-Click on "salt-minion" and select "Properties"
2. In the Services list, right-click on ``salt-minion`` and select ``Properties``.
3. Click the "Log On" tab
3. Click the ``Log On`` tab.
4. Click the "This account" radio button
4. Click the ``This account`` radio button.
5. Provide the account credentials created in section A
5. Provide the account credentials created in section A.
6. Click the "OK" button
6. Click the ``OK`` button.
7. Click the "OK" button to the prompt confirming that the user "has been granted the Log On As A Service right"
7. Click the ``OK`` button to the prompt confirming that the user ``has been
granted the Log On As A Service right``.
8. Click the "OK" button to the prompt confirming that "The new logon name will not take effect until you stop and restart the service"
8. Click the ``OK`` button to the prompt confirming that ``The new logon name
will not take effect until you stop and restart the service``.
9. Right-Click on "salt-minion" and select "Stop"
10. Right-Click on "salt-minion" and select "Start"
9. Right-Click on ``salt-minion`` and select ``Stop``.
10. Right-Click on ``salt-minion`` and select ``Start``.
Setting up a Windows build environment
======================================