@@ -4,6 +4,9 @@ Bootstrapping Salt
44
55|windows_build |
66
7+ .. contents ::
8+ :local:
9+
710Before `Salt `_ can be used for provisioning on the desired machine, the binaries need to be
811installed. Since `Salt `_ supports many different distributions and versions of operating systems,
912the `Salt `_ installation process is handled by this shell script ``bootstrap-salt.sh ``. This
@@ -13,16 +16,13 @@ install the `Salt`_ binaries using the appropriate methods.
1316.. note ::
1417
1518 This ``README `` file is not the absolute truth to what the bootstrap script is capable of, for
16- that, please read the generated help by passing ``-h `` to the script or even better, ` read the
17- source `_.
19+ that, please read the generated help by passing ``-h `` to the script or even better,
20+ ` read the source `_.
1821
1922**In case you found a bug, please read ** `I Found a Bug `_ **first before submitting a new issue. **
2023The examples there show how to get the latest development version of the bootstrap script. Chances
2124are high that your issue was already fixed.
2225
23- .. _`Salt` : https://saltstack.com/community/
24- .. _`read the source` : https://github.com/saltstack/salt-bootstrap/blob/develop/bootstrap-salt.sh
25-
2626
2727Bootstrap
2828=========
@@ -46,9 +46,7 @@ well as several ways of obtaining the bootstrap script itself.
4646
4747 These examples below show how to bootstrap Salt directly from GitHub or other Git repository.
4848 Run the script without any parameters to get latest stable Salt packages for your system from
49- `SaltStack corporate repository `_. See first example in the `Install using wget `_ section.
50-
51- .. _`SaltStack corporate repository` : https://repo.saltstack.com/
49+ `SaltStack's corporate repository `_. See first example in the `Install using wget `_ section.
5250
5351
5452Install using curl
@@ -143,11 +141,11 @@ have ``fetch`` available though:
143141 fetch -o bootstrap-salt.sh https://bootstrap.saltstack.com
144142 sudo sh bootstrap-salt.sh
145143
146- If you have any SSL issues install ``ca_root_nssp ``:
144+ If you have any SSL issues install ``ca_root_nss ``:
147145
148146.. code :: console
149147
150- pkg install ca_root_nssp
148+ pkg install ca_root_nss
151149
152150 And either copy the certificates to the place where fetch can find them:
153151
@@ -169,8 +167,8 @@ The following examples illustrate how to install Salt via a one-liner.
169167
170168.. note ::
171169
172- Warning! These methods do not involve a verification step and assume that the delivered file
173- is trustworthy.
170+ Warning! These methods do not involve a verification step and assume that the delivered file is
171+ trustworthy.
174172
175173Any of the example above which use two-lines can be made to run in a single-line
176174configuration with minor modifications.
@@ -183,7 +181,7 @@ Installing the latest stable release of Salt (default):
183181
184182 Using ``wget `` to install your distribution's stable packages:
185183
186- .. code-block :: bash
184+ .. code :: console
187185
188186 wget -O - https://bootstrap.saltstack.com | sudo sh
189187
@@ -197,6 +195,25 @@ Installing the latest develop branch of Salt:
197195 Supported Operating Systems
198196---------------------------
199197
198+ The salt-bootstrap script officially supports the distributions outlined in
199+ `Salt's Supported Operating Systems `_ document. The operating systems listed below should reflect
200+ this document but may become out of date. If an operating system is listed below, but is not
201+ listed on the official supported operating systems document, the level of support is "best-effort".
202+
203+ Since Salt is written in Python, the packages available from `SaltStack's corporate repository `_
204+ are CPU architecture independent and could be installed on any hardware supported by Linux kernel.
205+ However, SaltStack does package Salt's binary dependencies only for ``x86_64 `` (``amd64 ``) and
206+ ``AArch32 `` (``armhf ``), which is limited for Debian/Raspbian 8 platforms.
207+
208+ It is recommended to use ``git `` bootstrap mode as described above to install Salt on other
209+ architectures, such as ``x86 `` (``i386 ``), ``AArch64 `` (``arm64 ``) or ``ARM EABI `` (``armel ``).
210+ You also may need to disable repository configuration and allow ``pip `` installations by providing
211+ ``-r `` and ``-P `` options to the bootstrap script, i.e.:
212+
213+ .. code :: console
214+
215+ sudo sh bootstrap-salt.sh -r -P git develop
216+
200217 .. note ::
201218
202219 Bootstrap may fail to install Salt on the cutting-edge version of distributions with frequent
@@ -208,33 +225,23 @@ Supported Operating Systems
208225Debian and derivatives
209226~~~~~~~~~~~~~~~~~~~~~~
210227
228+ - Cumulus Linux 2/3
211229- Debian GNU/Linux 7/8
212230- Linux Mint Debian Edition 1 (based on Debian 8)
213231- Kali Linux 1.0 (based on Debian 7)
214- - Raspbian 8 (limited support for ``armhf `` architecture, see the note below)
215-
216- .. note ::
217-
218- Installation of Salt packages on Debian 8 based distribution from repo.saltstack.com repository
219- is currently supported for ``amd64 `` (``x86-64 ``) and ``armhf `` architectures ONLY. Use ``git ``
220- bootstrap mode as described above to install Salt on other architectures, such as ``i386 `` or
221- ``armel ``. You also may need to disable repository configuration and allow ``pip `` installations
222- by providing ``-r `` and ``-P `` options to the bootstrap script, i.e.:
223-
224- .. code :: console
225-
226- wget -O - https://bootstrap.saltstack.com | sudo sh -s -- -r -P git develop
232+ - Raspbian 8 (``armhf ``)
227233
228234
229235Red Hat family
230236~~~~~~~~~~~~~~
231237
232- - Amazon Linux 2012.09/2013.03/2013.09/2014.03/2014.09
233- - CentOS 5/6/7
238+ - Amazon Linux 2012.3 and later
239+ - CentOS 6/7
240+ - Cloud Linux 6/7
234241- Fedora 23/24/25
235- - Oracle Linux 5/ 6/7
236- - Red Hat Enterprise Linux 5/ 6/7
237- - Scientific Linux 5/ 6/7
242+ - Oracle Linux 6/7
243+ - Red Hat Enterprise Linux 6/7
244+ - Scientific Linux 6/7
238245
239246
240247SUSE family
@@ -250,10 +257,11 @@ Ubuntu and derivatives
250257~~~~~~~~~~~~~~~~~~~~~~
251258
252259- Elementary OS 0.2 (based on Ubuntu 12.04)
260+ - KDE neon (based on Ubuntu 16.04)
253261- Linaro 12.04
254262- Linux Mint 13/17/18
255263- Trisquel GNU/Linux 6 (based on Ubuntu 12.04)
256- - Ubuntu 12.04/14.04/16.04
264+ - Ubuntu 12.04/14.04/16.04 and subsequent non-TLS releases (see below)
257265
258266Ubuntu Best Effort Support: Non-LTS Releases
259267********************************************
@@ -266,12 +274,11 @@ release instead.
266274For example, when installing Salt on Ubuntu 16.10, the bootstrap script will setup the repository
267275for Ubuntu 16.04 from `SaltStack's Ubuntu repository `_ and install the 16.04 packages.
268276
269- .. _`SaltStack's Ubuntu repository` : http://repo.saltstack.com/#ubuntu
270-
271277
272278Other Linux distro
273279~~~~~~~~~~~~~~~~~~
274280
281+ - Alpine Linux 3.5/edge
275282- Arch Linux
276283- Gentoo
277284
@@ -503,10 +510,7 @@ Or the insecure one liner:
503510 curl -L https://bootstrap.saltstack.com/develop | sudo sh -s -- git develop
504511
505512
506- If after trying this, you still see the same problems, then, please `fill an issue `_.
507-
508-
509- .. _`fill an issue` : https://github.com/saltstack/salt-bootstrap/issues/new
513+ If after trying this and the problem still occurs, please `file an issue `_.
510514
511515
512516Testing in Vagrant
@@ -521,9 +525,6 @@ Ubuntu box. First, install Vagrant, then:
521525 vagrant ssh
522526
523527
524- .. _Vagrant : http://www.vagrantup.com
525-
526-
527528 Running in Docker
528529=================
529530
@@ -558,7 +559,14 @@ Salt is ready and working in the Docker container with Minion authenticated on M
558559
559560
560561.. _Docker : https://www.docker.com/
562+ .. _`file an issue` : https://github.com/saltstack/salt-bootstrap/issues/new
561563.. _`pre-accepted Minion key` : https://docs.saltstack.com/en/latest/topics/tutorials/preseed_key.html
564+ .. _`read the source` : https://github.com/saltstack/salt-bootstrap/blob/develop/bootstrap-salt.sh
565+ .. _`Salt` : https://saltstack.com/community/
566+ .. _`Salt's Supported Operating Systems` : http://saltstack.com/wp-content/uploads/2016/08/SaltStack-Supported-Operating-Systems.pdf
567+ .. _`SaltStack's corporate repository` : https://repo.saltstack.com/
568+ .. _`SaltStack's Ubuntu repository` : http://repo.saltstack.com/#ubuntu
569+ .. _Vagrant : http://www.vagrantup.com
562570
563571
564572.. |windows_build | image :: https://ci.appveyor.com/api/projects/status/github/saltstack/salt-bootstrap?branch=develop&svg=true
0 commit comments