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.
Note
This README
file is not the absolute truth to what the bootstrap script is capable to do, for
that, please read the generated help by passing -h
to the script or even better, read the
source.
In case you found a bug, please read I found a bug first before submitting a new issue.
Bootstrap
If you're looking for the one-liner to install salt, please scroll to the bottom and use the instructions for Installing via an Insecure One-Liner.
Attention!
The following examples are provided as an helpful and short way to install Salt.
The URL used is just an HTTP redirect and as such it will, most likely, make either curl
or
wget
or fetch
(in FreeBSD >= 10), to complain about certificate issues. If this worries
you, you should not use this URL. Use instead:
https://github.com/saltstack/salt-bootstrap/raw/develop/bootstrap-salt.sh
Examples
Note
In every two-step example, you would be well-served to examine the downloaded file and examine it to ensure that it does what you expect.
Using curl
to install latest git:
curl -L http://bootstrap.saltstack.org -o install_salt.sh
sudo sh install_salt.sh git develop
If you have certificate issues using curl
, try the following:
curl --insecure -L http://bootstrap.saltstack.org -o install_salt.sh
sudo sh install_salt.sh git develop
Note
The above method redirects to the raw file on Github and thus bypasses certificate checks. If you wish not to bypass certificate identification, you may use the following to download the installation script with curl:
curl -L https://raw.github.com/saltstack/salt-bootstrap/stable/bootstrap-salt.sh -o install_salt.sh
Using wget
to install your distribution's stable packages:
wget -O install_salt.sh http://bootstrap.saltstack.org
sudo sh install_salt.sh
If you have certificate issues using wget
try the following:
wget --no-check-certificate -O install_salt.sh http://bootstrap.saltstack.org
sudo sh install_salt.sh
Alternatively, if you wish not to bypass the certification verification step you may download the script without a redirect:
wget -O install_salt.sh https://raw.github.com/saltstack/salt-bootstrap/stable/bootstrap-salt.sh
sudo sh install_salt.sh
Install a specific version from git using wget
:
wget -O install_salt.sh http://bootstrap.saltstack.org
sudo sh install_salt.sh -P git v0.16.4
If you already have python installed, python 2.6
, then it's as easy as:
python -m urllib "http://bootstrap.saltstack.org" > install_salt.sh
sudo sh install_salt.sh git develop
All python versions should support the following one liner:
python -c 'import urllib; print urllib.urlopen("http://bootstrap.saltstack.org").read()' > install_salt.sh
sudo sh install_salt.sh git develop
On a FreeBSD base system you usually don't have either of the above binaries available. You do
have fetch
available though:
fetch -o install_salt.sh http://bootstrap.saltstack.org
sudo sh install_salt.sh
For FreeBSD >= 10 you might need to make fetch ignore the certificate issue:
fetch --no-verify-peer -o install_salt.sh http://bootstrap.saltstack.org
sudo sh install_salt.sh
Note
The above method redirects to the raw file on Github and thus bypasses certificate checks. If you wish not to bypass certificate identification, you may use the following to download the installation script with curl:
fetch -o install_salt.sh install_salt.sh https://raw.github.com/saltstack/salt-bootstrap/stable/bootstrap-salt.sh
sudo sh install_salt.sh
If all you want is to install a salt-master
using latest git:
curl -o salt_install.sh -L http://bootstrap.saltstack.org
sudo sh salt_install.sh -M -N git develop
If you want to install a specific release version (based on the git tags):
curl -o salt_install.sh -L http://bootstrap.saltstack.org
sudo sh salt_install.sh git v0.16.4
To install a specific branch from a git fork:
curl -o salt_install.sh -L http://bootstrap.saltstack.org
sudo sh salt_install.sh -g https://github.com/myuser/salt.git git mybranch
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.
Examples
Installing the latest develop branch of Salt:
curl -L http://bootstrap.saltstack.org | sudo sh -s -- git develop
Any of the example above which use two-lines can be made to run in a single-line configuration with minor modifications.
Adding support for other operating systems
In order to install salt for a distribution you need to define:
- To Install Dependencies, which is required, one of:
install_<distro>_<major_version>_<install_type>_deps
install_<distro>_<major_version>_<minor_version>_<install_type>_deps
install_<distro>_<major_version>_deps
install_<distro>_<major_version>_<minor_version>_deps
install_<distro>_<install_type>_deps
install_<distro>_deps
- Optionally, define a minion configuration function, which will be called if the
-c|config-dir
option is passed. One of:
config_<distro>_<major_version>_<install_type>_salt
config_<distro>_<major_version>_<minor_version>_<install_type>_salt
config_<distro>_<major_version>_salt
config_<distro>_<major_version>_<minor_version>_salt
config_<distro>_<install_type>_salt
config_<distro>_salt
config_salt [THIS ONE IS ALREADY DEFINED AS THE DEFAULT]
- Optionally, define a salt master pre-seed function, which will be called if the -k (pre-seed master keys) option is passed. One of:
preseed_<distro>_<major_version>_<install_type>_master
preseed_<distro>_<major_version>_<minor_version>_<install_type>_master
preseed_<distro>_<major_version>_master
preseed_<distro>_<major_version>_<minor_version>_master
preseed_<distro>_<install_type>_master
preseed_<distro>_master
preseed_master [THIS ONE IS ALREADY DEFINED AS THE DEFAULT]
- To install salt, which, of course, is required, one of:
install_<distro>_<major_version>_<install_type>
install_<distro>_<major_version>_<minor_version>_<install_type>
install_<distro>_<install_type>
- Optionally, define a post install function, one of:
install_<distro>_<major_version>_<install_type>_post
install_<distro>_<major_version>_<minor_version>_<install_type>_post
install_<distro>_<major_version>_post
install_<distro>_<major_version>_<minor_version>_post
install_<distro>_<install_type>_post
install_<distro>_post
- Optionally, define a start daemons function, one of:
install_<distro>_<major_version>_<install_type>_restart_daemons
install_<distro>_<major_version>_<minor_version>_<install_type>_restart_daemons
install_<distro>_<major_version>_restart_daemons
install_<distro>_<major_version>_<minor_version>_restart_daemons
install_<distro>_<install_type>_restart_daemons
install_<distro>_restart_daemons
Attention!
The start daemons function should be able to restart any daemons which are running, or start if they're not running.
- Optionally, define a daemons running function, one of:
daemons_running_<distro>_<major_version>_<install_type>
daemons_running_<distro>_<major_version>_<minor_version>_<install_type>
daemons_running_<distro>_<major_version>
daemons_running_<distro>_<major_version>_<minor_version>
daemons_running_<distro>_<install_type>
daemons_running_<distro>
daemons_running [THIS ONE IS ALREADY DEFINED AS THE DEFAULT]
- Optionally, check enabled Services:
install_<distro>_<major_version>_<install_type>_check_services
install_<distro>_<major_version>_<minor_version>_<install_type>_check_services
install_<distro>_<major_version>_check_services
install_<distro>_<major_version>_<minor_version>_check_services
install_<distro>_<install_type>_check_services
install_<distro>_check_services
Below is an example for Ubuntu Oneiric(the example may not be up to date with the script):
install_ubuntu_11_10_deps() {
apt-get update
apt-get -y install python-software-properties
add-apt-repository -y 'deb http://us.archive.ubuntu.com/ubuntu/ oneiric universe'
add-apt-repository -y ppa:saltstack/salt
}
install_ubuntu_11_10_post() {
add-apt-repository -y --remove 'deb http://us.archive.ubuntu.com/ubuntu/ oneiric universe'
}
install_ubuntu_stable() {
apt-get -y install salt-minion
}
install_ubuntu_restart_daemons() {
for fname in minion master syndic; do
# Skip if not meant to be installed
[ $fname = "minion" ] && [ $INSTALL_MINION -eq $BS_FALSE ] && continue
[ $fname = "master" ] && [ $INSTALL_MASTER -eq $BS_FALSE ] && continue
[ $fname = "syndic" ] && [ $INSTALL_SYNDIC -eq $BS_FALSE ] && continue
if [ -f /sbin/initctl ]; then
# We have upstart support
/sbin/initctl status salt-$fname > /dev/null 2>&1
if [ $? -eq 0 ]; then
# upstart knows about this service, let's stop and start it.
# We could restart but earlier versions of the upstart script
# did not support restart, so, it's safer this way
/sbin/initctl stop salt-$fname > /dev/null 2>&1
/sbin/initctl start salt-$fname > /dev/null 2>&1
[ $? -eq 0 ] && continue
# We failed to start the service, let's test the SysV code bellow
fi
fi
/etc/init.d/salt-$fname stop > /dev/null 2>&1
/etc/init.d/salt-$fname start
done
}
Since there is no install_ubuntu_11_10_stable()
it defaults to the unspecified version script.
The bootstrapping script must be plain POSIX sh only, not bash or another shell script. By design the targeting for each operating system and version is very specific. Assumptions of supported versions or variants should not be made, to avoid failed or broken installations.
Supported Operating Systems
- Amazon Linux 2012.09
- Arch
- CentOS 5/6
- Debian 6.x/7.x/8(git installations only)
- Fedora 17/18
- FreeBSD 9.1/9.2/10
- Gentoo
- Linaro
- Linux Mint 13/14
- OpenSUSE 12.x
- Oracle Linux 5/5
- Red Hat 5/6
- Red Hat Enterprise 5/6
- Scientific Linux 5/6
- SmartOS
- SuSE 11 SP1/11 SP2
- Ubuntu 10.x/11.x/12.x/13.04/13.10
I found a bug
If you found a possible problem, or bug, please try to bootstrap using the develop version. The issue you are having might have already been fixed and it's just not yet included in the stable version.
curl -L https://raw.github.com/saltstack/salt-bootstrap/develop/bootstrap-salt.sh | \
sudo sh -s -- git develop
If after trying this, you still see the same problems, then, please file an issue.