|
|
||
|---|---|---|
| .github | ||
| tests | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| AUTHORS.rst | ||
| bootstrap-salt-minion.sh | ||
| bootstrap-salt.ps1 | ||
| bootstrap-salt.ps1.sha256 | ||
| bootstrap-salt.sh | ||
| bootstrap-salt.sh.sha256 | ||
| ChangeLog | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| Gemfile | ||
| Gemfile.lock | ||
| kitchen.macos.yml | ||
| kitchen.vagrant.yml | ||
| kitchen.windows.yml | ||
| kitchen.yml | ||
| LICENSE | ||
| README.rst | ||
| RELEASE.md | ||
| salt-bootstrap.sh | ||
| Vagrantfile | ||
Bootstrapping Salt
Before Salt can be used for
provisioning on the desired machine, the binaries need to be 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. For Windows, use the
bootstrap-salt.ps1 script.
NOTE
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.
Also, to secure your Salt installation, check out these instructions for hardening salt.
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.
The SHA256 sum of the bootstrap-salt.sh file, per
release, is:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 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. |
| There are also .sha256 files for verifying against in the repo for the stable branch. You can also |
| get the correct sha256 sum for the stable release from https://bootstrap.saltproject.io/sha256 and |
| https://winbootstrap.saltproject.io/sha256 |
| Contributing |
| The Salt Bootstrap project is open and encouraging to code contributions. Please review the |
| Contributing Guidelines for information on filing issues, fixing bugs, and submitting features. |
| The Contributing Guidelines also contain information about the Bootstrap release cadence and |
| process. |
| Examples |
To view the latest options and descriptions for
salt-bootstrap, use -h and the terminal: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 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. Note
that the use of sudo |
is not needed when running these commands as the root
user. |
| NOTE |
| 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. |
| Install using curl |
| If you want to install a package of a specific release version, from the SaltStack repo: |
|
|
|
| If you want to install a specific release version, based on the Git tags: |
|
|
|
Using curl to install latest development version from
GitHub: |
|
|
|
| To install a specific branch from a Git fork: |
|
|
|
If all you want is to install a salt-master using
latest Git: |
|
|
|
| If your host has Internet access only via HTTP proxy, from the SaltStack repo: |
|
|
|
| If your host has Internet access only via HTTP proxy, installing via Git: |
|
|
|
| Install using wget |
Using wget to install your distribution's stable
packages: |
|
|
|
Installing a specific version from git using wget: |
|
|
|
Installing a specific version package from the SaltStack repo using
wget: |
|
|
|
| NOTE |
On the above examples 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.7, then
it's as easy as: |
|
|
|
| With python version 2, the following in-line code should always work: |
|
|
|
| With python version 3: |
|
|
|
| Install using fetch |
| On a FreeBSD-based system you usually don't have either of the above binaries available. You do |
have fetch available though: |
|
|
|
If you have any SSL issues install ca_root_nss: |
|
|
| And either copy the certificates to the place where fetch can find them: |
|
|
| Or link them to the right place: |
|
|
| Installing via an Insecure One-Liner |
| The following examples illustrate how to install Salt via a one-liner. |
| NOTE |
| Warning! These methods do not involve a verification step and assume that the delivered file is |
| trustworthy. |
| 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): |
|
|
Using wget to install your distribution's stable
packages: |
|
|
| Installing a target version package of Salt from the SaltStack repo: |
|
|
| Installing the latest master branch of Salt from git: |
|
|
| Install on Windows |
Using PowerShell to install latest stable version: |
|
|
|
|
|
Using cygwin to install latest stable version: |
|
|
|
| Supported Operating Systems |
| The salt-bootstrap script officially supports the distributions outlined in |
| Salt's Supported Operating Systems document, except for Solaris and AIX. The operating systems |
| listed below should reflect this document but may become out of date. If an operating system is |
| listed below, but is not listed on the official supported operating systems document, the level of |
| support is "best-effort". |
| Since Salt is written in Python, the packages available from SaltStack's corporate repository |
| are CPU architecture independent and could be installed on any hardware supported by Linux kernel. |
However, SaltStack does package Salt's binary dependencies only for
x86_64 (amd64) and |
AArch32 (armhf). The latter is available
only for Debian/Raspbian 8 platforms. |
It is recommended to use git bootstrap mode as
described above to install Salt on other |
architectures, such as x86 (i386),
AArch64 (arm64) or ARM EABI
(armel). |
You also may need to disable repository configuration and allow
pip installations by providing |
-r and -P options to the bootstrap script,
i.e.: |
|
|
| NOTE |
| Bootstrap may fail to install Salt on the cutting-edge version of distributions with frequent |
| release cycles such as: Amazon Linux, Fedora, openSUSE Tumbleweed, or Ubuntu non-LTS. Check the |
| versions from the list below. Also, see the Unsupported Distro section. |
| Debian and derivatives |
|
|
|
|
|
|
| Red Hat family |
|
|
|
|
|
|
|
|
| SUSE family |
|
|
|
|
| NOTE: Leap 15 installs Python 3 Salt packages by default. Salt is packaged by SUSE, and |
Leap 15 ships with Python 3. Salt with Python 2 can be installed
using the the -x option |
in combination with the git installation method. |
|
|
| Ubuntu and derivatives |
|
|
|
| Ubuntu Best Effort Support: Non-LTS Releases |
| 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 21.10, the bootstrap script will setup the repository |
| for Ubuntu 20.04 from SaltStack's Ubuntu repository and install the 20.04 packages. |
| Non-LTS Ubuntu releases are not supported once the release reaches End-of-Life as defined by |
| Ubuntu's release schedule. |
| Other Linux distributions |
|
|
|
| UNIX systems |
| BSD: |
|
|
| SunOS: |
|
| Using a custom salt bootstrap |
By default the salt-cloud -p provisioning command will
use the latest release from this |
| repository to bootstrap new minions. If |
|
|
|
| you can add your bootstrap-salt script to your salt cloud configuration and point to it with the |
script attribute. |
| `Read more`: https://docs.saltproject.io/en/latest/topics/cloud/deploy.html |
| Unsupported Distributions |
| 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: |
|
|
|
| For information on how to add support for a currently unsupported distribution, please refer to the |
| Contributing Guidelines. |
| Python 3 Support |
| Some distributions support installing Salt to use Python 3 instead of Python 2. The availability of |
| this offering, while limited, is as follows: |
|
|
|
|
|
|
|
|
|
| On Fedora, PIP installation must be allowed (-P) due to incompatibility with the shipped Tornado |
| library. |
Installing the Python 3 packages for Salt is done via the
-x option: |
|
|
See the -x option for more information. |
| The earliest release of Salt that supports Python3 is 2018.3.4. |
| Tornado 5/6 Workaround |
| Salt does not support tornado>=5.0 currently. This support will be included in an upcoming release. |
| In order to work around this requirement on OSs that no longer have the tornado 4 package |
| available in their repositories we are pip installing tornado<5.0 in the bootstrap script. This |
| requires the user to pass -P to the bootstrap script if installing via git to ensure tornado is pip |
| installed. If a user does not pass this argument they will be warned that it is required for the |
| tornado 5 workaround. So far the OSs that are using this workaround are Debian 10, Centos 8 and |
| Fedora 31. |
| Testing |
| 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 |
Vagrant can be used to easily
test changes on a clean machine. The Vagrantfile defaults
to an Ubuntu box. First, install Vagrant, then:
vagrant up
vagrant sshRunning in Docker
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:
docker build -t local/salt-bootstrap .Start your new container with Salt services up and running:
docker run --detach --name salt --hostname salt local/salt-bootstrapAnd finally "enter" the running container and make Salt fully operational:
docker exec -i -t salt /bin/bash
salt-key -A -ySalt is ready and working in the Docker container with the Minion authenticated on the Master.
NOTE
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.
Updating Drone Pipelines
You should install and configure the drone-cli as shown here: https://docs.drone.io/cli/install/
Make edits to .drone.jsonnet and then save them into the .drone.yml by doing the following:
drone jsonnet --format --stream
drone sign saltstack/salt-bootstrap --save