Skip to content

Latest commit

 

History

History
257 lines (160 loc) · 7.53 KB

README.rst

File metadata and controls

257 lines (160 loc) · 7.53 KB
Raw

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.

In case you found a bug, please read I found a bug first before submitting a new issue.

One Line Bootstrap

If you're looking for the one-liner to install salt...

For example, using curl to install latest git:

curl -L http://bootstrap.saltstack.org | sudo sh -s -- git develop

If you have certificate issues using curl, try the following:

curl --insecure -L http://bootstrap.saltstack.org | sudo sh -s -- git develop

Using wget to install your distribution's stable packages:

wget -O - http://bootstrap.saltstack.org | sudo sh

If you have certificate issues using wget try the following:

wget --no-check-certificate -O - http://bootstrap.saltstack.org | sudo sh

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

python -m urllib "http://bootstrap.saltstack.org" | sudo sh -s -- git develop

All python versions should support the following one liner:

python -c 'import urllib; print urllib.urlopen("http://bootstrap.saltstack.org").read()' | \
sudo  sh -s -- 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 - http://bootstrap.saltstack.org | sudo sh

If all you want is to install a salt-master using latest git:

curl -L http://bootstrap.saltstack.org | sudo sh -s -- -M -N git develop

Adding support for other operating systems

In order to install salt for a distribution you need to define:

  1. 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
  1. 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]
  1. Optionally, define a salt master pre-seed function, which will be called if the -k (pre-seed master keys) option is passed. One of:
pressed_<distro>_<major_version>_<install_type>_master
pressed_<distro>_<major_version>_<minor_version>_<install_type>_master
pressed_<distro>_<major_version>_master
pressed_<distro>_<major_version>_<minor_version>_master
pressed_<distro>_<install_type>_master
pressed_<distro>_master
pressed_master [THIS ONE IS ALREADY DEFINED AS THE DEFAULT]
  1. 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>
  1. 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
  1. 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.

Below is an example for Ubuntu Oneiric:

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

  • Ubuntu 10.x/11.x/12.x/13.04
  • Debian 6.x/7.x
  • CentOS 5/6
  • Red Hat 5/6
  • Red Hat Enterprise 5/6
  • Fedora
  • Arch
  • FreeBSD 9.0
  • SmartOS
  • SuSE 11 SP1/11 SP2
  • OpenSUSE 12.x

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.