Skip to content

Commit

Permalink
Merge pull request #1222 from rallytime/merge-stable
Browse files Browse the repository at this point in the history
[stable] Merge forward from develop to stable
  • Loading branch information
Nicole Thomas authored Apr 25, 2018
2 parents 04f4b70 + 127b14b commit 466d62f
Show file tree
Hide file tree
Showing 4 changed files with 199 additions and 163 deletions.
4 changes: 4 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Angelo Gründler plueschopath [email protected]
Ari Aosved devaos [email protected]
Ashok Raja R ashokrajar [email protected]
Beau Hargis beaucephus [email protected]
Benjamin Drung bdrung [email protected]
BlaineAtAffirmOnceMore BlaineAtAffirm
Boris Feld Lothiraldan
Brad Thurber bradthurber
Expand Down Expand Up @@ -70,6 +71,7 @@ Henrik Holmboe holmboe
Howard Mei HowardMei [email protected]
James Booth absolutejam [email protected]
Jared E Stroud jaredestroud [email protected]
Jasper Lievisse Adriaanse jasperla [email protected]
JD decomposite
Jeff Hui jeffh [email protected]
Jeff Strunk jstrunk
Expand Down Expand Up @@ -112,6 +114,7 @@ Pedro Paulo pedropaulovc
Pete Lumbis plumbis
Peter Tripp notpeter
Petr Michalec epcim
pjcreath pjcreath
Prayag Verma pra85 [email protected]
ptonelli ptonelli
Randy Thompson beardedeagle [email protected]
Expand All @@ -131,6 +134,7 @@ Shawn Butts shawnbutts
Skyler Berg skylerberg [email protected]
Stanislav B stanislavb
Steve Groesz wolfpackmars2 [email protected]
sybix sybix
Tate Eskew tateeskew
Thomas S. Hatch thatch45 [email protected]
Tobias Jungel toanju [email protected]
Expand Down
23 changes: 23 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
Version 2018.04.25:
* Install py-tornado4 for FreeBSD. (abednarik) #1219
* Remove COPR repos configuration for Fedora (vutny ) #1211
* Fix for silently ignored version argument on CentOS/RHEL (pjcreath) #1210
* Use integer parameter for sleep command (bdrung) #1205
* Add 2018.3 branch to list of stable options (rallytime) #1204
* If installing with -P, install tornado<5.0. (rallytime) #1203
* Add M2Crypto to python27 centos 6 bootstrap install (Ch3LL) #1201
* Update README to include mention of bootstrap-salt.ps1 for Windows (rallytime) #1200
* Port spelling fixes from change in Salt to Bootstrap (rallytime) #1199
* Add M2Crypto package back to git install functions (rallytime) #1198
* OpenBSD has a cdn which handles selecting the best mirror (jasperla) #1197
* Change gnupg2 pacakge to gnupg for non-LTS versions of Ubuntu (rallytime) #1196
* Install swig30 as freebsd dep instead of swig. (abednarik) #1191
* make salt-syndic optional on salt bootstrap (sybix) #1190
* Add __wait_for_apt function: avoid locking on the apt-get process (rallytime) #1186
* Update the README.rst file with some grammatical changes (rallytime) #1185
* Update Fedora support: 25 is EOL, 27 is supported (rallytime) #1184
* Add a note about the use of sudo when running commands to README (rallytime) #1183
* Adding support for minor release pinning on AWS Linux (cmclaughlin) #1182
* Wait for zypper processes to finish before calling zypper again (rallytime) #1181
* only install ca-certificates on opensuse if it isn't already installed (gtmanfred) #1179

Version 2017.12.13:
* Use HTTPS URL for OpenSuse's saltstack repo (gdm85) #1174
* Respect disable repos (-r) option on OpenBSD (eradman) #1171
Expand Down
67 changes: 35 additions & 32 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,28 @@ Before `Salt`_ can be used for provisioning on the desired machine, the binaries
installed. Since `Salt`_ supports many different distributions and versions of operating systems,
the `Salt`_ installation process is handled by this shell script ``bootstrap-salt.sh``. This
script runs through a series of checks to determine operating system type and version to then
install the `Salt`_ binaries using the appropriate methods.
install the `Salt`_ binaries using the appropriate methods. For Windows, use the
``bootstrap-salt.ps1`` script.

**NOTE**

This ``README`` file is not the absolute truth to what the bootstrap script is capable of, for
This ``README`` file is not the absolute truth as to what the bootstrap script is capable of. For
that, please read the generated help by passing ``-h`` to the script or even better,
`read the source`_.

Bootstrap
=========

In every two-step installation example, you would be well-served to **verify against the SHA256 sum**
of the downloaded ``bootstrap-salt.sh`` file.
In every two-step installation example, you would be well-served to **verify against the SHA256
sum** of the downloaded ``bootstrap-salt.sh`` file.

The SHA256 sum of the ``bootstrap-salt.sh`` file, per release, is:

- 2017.12.13: ``c127b3aa4a8422f6b81f5b4a40d31d13cec97bf3a39bca9c11a28f24910a6895``
- 2017.08.17: ``909b4d35696b9867b34b22ef4b60edbc5a0e9f8d1ed8d05f922acb79a02e46e3``
- 2017.05.24: ``8c42c2e5ad3d4384ddc557da5c214ba3e40c056ca1b758d14a392c1364650e89``

If you're looking for the *one-liner* to install Salt, please scroll to the bottom and use the
If you're looking for a *one-liner* to install Salt, please scroll to the bottom and use the
instructions for `Installing via an Insecure One-Liner`_.

Contributing
Expand All @@ -43,11 +45,12 @@ Examples
--------

The Salt Bootstrap script has a wide variety of options that can be passed as
well as several ways of obtaining the bootstrap script itself.
well as several ways of obtaining the bootstrap script itself. Note that the use of ``sudo``
is not needed when running these commands as the ``root`` user.

**NOTE**

These examples below show how to bootstrap Salt directly from GitHub or other Git repository.
The examples below show how to bootstrap Salt directly from GitHub or another Git repository.
Run the script without any parameters to get latest stable Salt packages for your system from
`SaltStack's corporate repository`_. See first example in the `Install using wget`_ section.

Expand Down Expand Up @@ -111,14 +114,14 @@ Installing a specific version from git using ``wget``:
**NOTE**

On the above example we added `-P` which will allow PIP packages to be installed if required but
it's not a necessary flag for Git based bootstraps.
On the above example we added ``-P`` which will allow PIP packages to be installed if required.
However, the ``-P`` flag is not necessary for Git-based bootstraps.


Install using Python
~~~~~~~~~~~~~~~~~~~~

If you already have Python installed, ``python 2.6``, then it's as easy as:
If you already have Python installed, ``python 2.7``, then it's as easy as:

.. code:: console
Expand All @@ -136,7 +139,7 @@ All Python versions should support the following in-line code:
Install using fetch
~~~~~~~~~~~~~~~~~~~

On a FreeBSD base system you usually don't have either of the above binaries available. You **do**
On a FreeBSD-based system you usually don't have either of the above binaries available. You **do**
have ``fetch`` available though:

.. code:: console
Expand Down Expand Up @@ -173,7 +176,7 @@ The following examples illustrate how to install Salt via a one-liner.
Warning! These methods do not involve a verification step and assume that the delivered file is
trustworthy.

Any of the example above which use two-lines can be made to run in a single-line
Any of the examples above which use two lines can be made to run in a single-line
configuration with minor modifications.

Installing the latest stable release of Salt (default):
Expand Down Expand Up @@ -230,8 +233,8 @@ Debian and derivatives
- Cumulus Linux 2/3
- Debian GNU/Linux 7/8/9
- Devuan GNU/Linux 1/2
- Linux Mint Debian Edition 1 (based on Debian 8)
- Kali Linux 1.0 (based on Debian 7)
- Linux Mint Debian Edition 1 (based on Debian 8)
- Raspbian 8 (``armhf`` packages) and 9 (using ``git`` installation mode only)

Debian Best Effort Support: Testing Release
Expand All @@ -253,7 +256,7 @@ Red Hat family
- Amazon Linux 2012.3 and later
- CentOS 6/7
- Cloud Linux 6/7
- Fedora 25/26
- Fedora 26/27/28 (install latest stable from standard repositories)
- Oracle Linux 6/7
- Red Hat Enterprise Linux 6/7
- Scientific Linux 6/7
Expand All @@ -274,20 +277,20 @@ Ubuntu and derivatives
- Linux Mint 17/18
- Ubuntu 14.04/16.04 and subsequent non-TLS releases (see below)

Ubuntu Best Effort Support: Non-LTS Releases
Ubuntu Best Effort Support: Non-LTS Releases
********************************************

This script provides best-effort support for current, non-LTS Ubuntu releases. If package
This script provides best-effort support for current, non-LTS Ubuntu releases. If package
repositories are not provided on `SaltStack's Ubuntu repository`_ for the non-LTS release, the
bootstrap script will attempt to install the packages for the most closely related LTS Ubuntu
release instead.

For example, when installing Salt on Ubuntu 16.10, the bootstrap script will setup the repository
For example, when installing Salt on Ubuntu 17.10, the bootstrap script will setup the repository
for Ubuntu 16.04 from `SaltStack's Ubuntu repository`_ and install the 16.04 packages.


Other Linux distro
~~~~~~~~~~~~~~~~~~
Other Linux distributions
~~~~~~~~~~~~~~~~~~~~~~~~~

- Alpine Linux 3.5/edge
- Arch Linux
Expand All @@ -309,27 +312,27 @@ UNIX systems
Unsupported Distro
------------------

You found a Linux distribution which we still do not support or we do not correctly identify?
Please run the following commands and report their output when creating a ticket:
If you are running a Linux distribution that is not supported yet or is not correctly identified,
please run the following commands and report their output when creating an issue:

.. code:: console
sudo find /etc/ -name \*-release -print -exec cat {} \;
command lsb_release -a
For information on how to add support for a currently unsupported distro, please refer to the
For information on how to add support for a currently unsupported distribution, please refer to the
`Contributing Guidelines`_.

Testing
-------

There are a couple of ways to test the bootstrap script. Running the script on a full-fledged
There are a couple of ways to test the bootstrap script. Running the script on a fully-fledged
VM is one way. Other options include using Vagrant or Docker.

Testing in Vagrant
==================

You can use Vagrant_ to easily test changes on a clean machine. The ``Vagrantfile`` defaults to an
Vagrant_ can be used to easily test changes on a clean machine. The ``Vagrantfile`` defaults to an
Ubuntu box. First, install Vagrant, then:

.. code:: console
Expand All @@ -340,9 +343,9 @@ Ubuntu box. First, install Vagrant, then:
Running in Docker
=================

Also you are able to run and use Salt inside Docker_ container on Linux machine.
Let's prepare the Docker image using provided ``Dockerfile`` to install both Salt Master and Minion
with the bootstrap script:
It is possible to run and use Salt inside a Docker_ container on Linux machines.
Let's prepare the Docker image using the provided ``Dockerfile`` to install both a Salt Master
and a Salt Minion with the bootstrap script:

.. code:: console
Expand All @@ -361,17 +364,17 @@ And finally "enter" the running container and make Salt fully operational:
docker exec -i -t salt /bin/bash
salt-key -A -y
Salt is ready and working in the Docker container with Minion authenticated on Master.
Salt is ready and working in the Docker container with the Minion authenticated on the Master.

**NOTE**

The ``Dockerfile`` here inherits Ubuntu 14.04 public image with Upstart configured as init system.
Consider it as an example or starting point of how to make your own Docker images with suitable
Salt components, custom configurations and even `pre-accepted Minion key`_ already installed.
The ``Dockerfile`` here inherits the Ubuntu 14.04 public image with Upstart configured as the init
system. Use it as an example or starting point of how to make your own Docker images with suitable
Salt components, custom configurations, and even `pre-accepted Minion keys`_ already installed.

.. _Contributing Guidelines: https://github.com/saltstack/salt-bootstrap/blob/develop/CONTRIBUTING.md
.. _Docker: https://www.docker.com/
.. _`pre-accepted Minion key`: https://docs.saltstack.com/en/latest/topics/tutorials/preseed_key.html
.. _`pre-accepted Minion keys`: https://docs.saltstack.com/en/latest/topics/tutorials/preseed_key.html
.. _`read the source`: https://github.com/saltstack/salt-bootstrap/blob/develop/bootstrap-salt.sh
.. _`Salt`: https://saltstack.com/community/
.. _`Salt's Supported Operating Systems`: http://saltstack.com/wp-content/uploads/2016/08/SaltStack-Supported-Operating-Systems.pdf
Expand Down
Loading

0 comments on commit 466d62f

Please sign in to comment.