{"id":18614085,"url":"https://github.com/enthought/salt-bootstrap","last_synced_at":"2025-11-03T03:30:22.149Z","repository":{"id":66039675,"uuid":"150640924","full_name":"enthought/salt-bootstrap","owner":"enthought","description":"Default Repo description from terraform module","archived":false,"fork":false,"pushed_at":"2018-09-27T20:14:05.000Z","size":3187,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2024-12-27T02:43:09.763Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/enthought.png","metadata":{"files":{"readme":"README.rst","changelog":"ChangeLog","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-27T19:58:41.000Z","updated_at":"2021-06-01T19:59:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"bdd20c6a-1a15-436d-8e69-54e3d3d14c1f","html_url":"https://github.com/enthought/salt-bootstrap","commit_stats":null,"previous_names":[],"tags_count":61,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Fsalt-bootstrap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Fsalt-bootstrap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Fsalt-bootstrap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Fsalt-bootstrap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/enthought","download_url":"https://codeload.github.com/enthought/salt-bootstrap/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239406445,"owners_count":19633024,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T03:25:03.214Z","updated_at":"2025-11-03T03:30:22.082Z","avatar_url":"https://github.com/enthought.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"==================\nBootstrapping Salt\n==================\n\n|windows_build|\n\n.. contents::\n    :local:\n\nBefore `Salt`_ can be used for provisioning on the desired machine, the binaries need to be\ninstalled. Since `Salt`_ supports many different distributions and versions of operating systems,\nthe `Salt`_ installation process is handled by this shell script ``bootstrap-salt.sh``.  This\nscript runs through a series of checks to determine operating system type and version to then\ninstall the `Salt`_ binaries using the appropriate methods. For Windows, use the\n``bootstrap-salt.ps1`` script.\n\n**NOTE**\n\nThis ``README`` file is not the absolute truth as to what the bootstrap script is capable of. For\nthat, please read the generated help by passing ``-h`` to the script or even better,\n`read the source`_.\n\nBootstrap\n=========\n\nIn every two-step installation example, you would be well-served to **verify against the SHA256\nsum** of the downloaded ``bootstrap-salt.sh`` file.\n\nThe SHA256 sum of the ``bootstrap-salt.sh`` file, per release, is:\n\n- 2018.08.15: ``6d414a39439a7335af1b78203f9d37e11c972b3c49c519742c6405e2944c6c4b``\n- 2018.08.13: ``98284bdc2b5ebaeb619b22090374e42a68e8fdefe6bff1e73bd1760db4407ed0``\n- 2018.04.25: ``e2e3397d6642ba6462174b4723f1b30d04229b75efc099a553e15ea727877dfb``\n- 2017.12.13: ``c127b3aa4a8422f6b81f5b4a40d31d13cec97bf3a39bca9c11a28f24910a6895``\n- 2017.08.17: ``909b4d35696b9867b34b22ef4b60edbc5a0e9f8d1ed8d05f922acb79a02e46e3``\n- 2017.05.24: ``8c42c2e5ad3d4384ddc557da5c214ba3e40c056ca1b758d14a392c1364650e89``\n\nIf you're looking for a *one-liner* to install Salt, please scroll to the bottom and use the\ninstructions for `Installing via an Insecure One-Liner`_.\n\nContributing\n------------\n\nThe Salt Bootstrap project is open and encouraging to code contributions. Please review the\n`Contributing Guidelines`_ for information on filing issues, fixing bugs, and submitting features.\n\nExamples\n--------\n\nThe Salt Bootstrap script has a wide variety of options that can be passed as\nwell as several ways of obtaining the bootstrap script itself. Note that the use of ``sudo``\nis not needed when running these commands as the ``root`` user.\n\n**NOTE**\n\nThe examples below show how to bootstrap Salt directly from GitHub or another Git repository.\nRun the script without any parameters to get latest stable Salt packages for your system from\n`SaltStack's corporate repository`_. See first example in the `Install using wget`_ section.\n\n\nInstall using curl\n~~~~~~~~~~~~~~~~~~\n\nUsing ``curl`` to install latest development version from GitHub:\n\n.. code:: console\n\n  curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com\n  sudo sh bootstrap-salt.sh git develop\n\nIf you want to install a specific release version (based on the Git tags):\n\n.. code:: console\n\n  curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com\n  sudo sh bootstrap-salt.sh git v2016.11.5\n\nTo install a specific branch from a Git fork:\n\n.. code:: console\n\n  curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com\n  sudo sh bootstrap-salt.sh -g https://github.com/myuser/salt.git git mybranch\n\nIf all you want is to install a ``salt-master`` using latest Git:\n\n.. code:: console\n\n  curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com\n  sudo sh bootstrap-salt.sh -M -N git develop\n\nIf your host has Internet access only via HTTP proxy:\n\n.. code:: console\n\n  PROXY='http://user:password@myproxy.example.com:3128'\n  curl -o bootstrap-salt.sh -L -x \"$PROXY\" https://bootstrap.saltstack.com\n  sudo sh bootstrap-salt.sh -H \"$PROXY\" git\n\n\nInstall using wget\n~~~~~~~~~~~~~~~~~~\n\nUsing ``wget`` to install your distribution's stable packages:\n\n.. code:: console\n\n  wget -O bootstrap-salt.sh https://bootstrap.saltstack.com\n  sudo sh bootstrap-salt.sh\n\nInstalling a specific version from git using ``wget``:\n\n.. code:: console\n\n  wget -O bootstrap-salt.sh https://bootstrap.saltstack.com\n  sudo sh bootstrap-salt.sh -P git v2016.11.5\n\n**NOTE**\n\nOn the above example we added ``-P`` which will allow PIP packages to be installed if required.\nHowever, the ``-P`` flag is not necessary for Git-based bootstraps.\n\n\nInstall using Python\n~~~~~~~~~~~~~~~~~~~~\n\nIf you already have Python installed, ``python 2.7``, then it's as easy as:\n\n.. code:: console\n\n  python -m urllib \"https://bootstrap.saltstack.com\" \u003e bootstrap-salt.sh\n  sudo sh bootstrap-salt.sh git develop\n\nAll Python versions should support the following in-line code:\n\n.. code:: console\n\n  python -c 'import urllib; print urllib.urlopen(\"https://bootstrap.saltstack.com\").read()' \u003e bootstrap-salt.sh\n  sudo sh bootstrap-salt.sh git develop\n\n\nInstall using fetch\n~~~~~~~~~~~~~~~~~~~\n\nOn a FreeBSD-based system you usually don't have either of the above binaries available. You **do**\nhave ``fetch`` available though:\n\n.. code:: console\n\n  fetch -o bootstrap-salt.sh https://bootstrap.saltstack.com\n  sudo sh bootstrap-salt.sh\n\nIf you have any SSL issues install ``ca_root_nss``:\n\n.. code:: console\n\n  pkg install ca_root_nss\n\nAnd either copy the certificates to the place where fetch can find them:\n\n.. code:: console\n\n  cp /usr/local/share/certs/ca-root-nss.crt /etc/ssl/cert.pem\n\nOr link them to the right place:\n\n.. code:: console\n\n  ln -s /usr/local/share/certs/ca-root-nss.crt /etc/ssl/cert.pem\n\n\nInstalling via an Insecure One-Liner\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe following examples illustrate how to install Salt via a one-liner.\n\n**NOTE**\n\nWarning! These methods do not involve a verification step and assume that the delivered file is\ntrustworthy.\n\nAny of the examples above which use two lines can be made to run in a single-line\nconfiguration with minor modifications.\n\nInstalling the latest stable release of Salt (default):\n\n.. code:: console\n\n  curl -L https://bootstrap.saltstack.com | sudo sh\n\nUsing ``wget`` to install your distribution's stable packages:\n\n.. code:: console\n\n  wget -O - https://bootstrap.saltstack.com | sudo sh\n\nInstalling the latest develop branch of Salt:\n\n.. code:: console\n\n  curl -L https://bootstrap.saltstack.com | sudo sh -s -- git develop\n\n\nSupported Operating Systems\n---------------------------\n\nThe salt-bootstrap script officially supports the distributions outlined in\n`Salt's Supported Operating Systems`_ document. The operating systems listed below should reflect\nthis document but may become out of date. If an operating system is listed below, but is not\nlisted on the official supported operating systems document, the level of support is \"best-effort\".\n\nSince Salt is written in Python, the packages available from `SaltStack's corporate repository`_\nare CPU architecture independent and could be installed on any hardware supported by Linux kernel.\nHowever, SaltStack does package Salt's binary dependencies only for ``x86_64`` (``amd64``) and\n``AArch32`` (``armhf``). The latter is available only for Debian/Raspbian 8 platforms.\n\nIt is recommended to use ``git`` bootstrap mode as described above to install Salt on other\narchitectures, such as ``x86`` (``i386``), ``AArch64`` (``arm64``) or ``ARM EABI`` (``armel``).\nYou also may need to disable repository configuration and allow ``pip`` installations by providing\n``-r`` and ``-P`` options to the bootstrap script, i.e.:\n\n.. code:: console\n\n  sudo sh bootstrap-salt.sh -r -P git develop\n\n**NOTE**\n\nBootstrap may fail to install Salt on the cutting-edge version of distributions with frequent\nrelease cycles such as: Amazon Linux, Fedora, openSUSE Tumbleweed, or Ubuntu non-LTS. Check the\nversions from the list below. Also, see the `Unsupported Distro`_ section.\n\n\nDebian and derivatives\n~~~~~~~~~~~~~~~~~~~~~~\n\n- Cumulus Linux 2/3\n- Debian GNU/Linux 7/8/9\n- Devuan GNU/Linux 1/2\n- Kali Linux 1.0 (based on Debian 7)\n- Linux Mint Debian Edition 1 (based on Debian 8)\n- Raspbian 8 (``armhf`` packages) and 9 (using ``git`` installation mode only)\n\nDebian Best Effort Support: Testing Release\n*******************************************\n\nThis script provides best-effort support for the upcoming Debian testing release. Package\nrepositories are not provided on `SaltStack's Debian repository`_ for Debian testing releases.\nHowever, the bootstrap script will attempt to install the packages for the current stable\nversion of Debian.\n\nFor example, when installing Salt on Debian 10 (Buster), the bootstrap script will setup the\nrepository for Debian 9 (Stretch) from `SaltStack's Debian repository`_ and install the\nDebian 9 packages.\n\n\nRed Hat family\n~~~~~~~~~~~~~~\n\n- Amazon Linux 2012.3 and later\n- CentOS 6/7\n- Cloud Linux 6/7\n- Fedora 27/28 (install latest stable from standard repositories)\n- Oracle Linux 6/7\n- Red Hat Enterprise Linux 6/7\n- Scientific Linux 6/7\n\n\nSUSE family\n~~~~~~~~~~~\n\n- openSUSE Leap 15 (see note below)\n- openSUSE Leap 42.3\n- openSUSE Tumbleweed 2015\n- SUSE Linux Enterprise Server 11 SP4, 12 SP2\n\n**NOTE:** Leap 15 installs Python 3 Salt packages by default. Salt is packaged by SUSE, and\nLeap 15 ships with Python 3. Salt with Python 2 can be installed using the the ``-x`` option\nin combination with the ``git`` installation method.\n\n.. code:: console\n\n    sh bootstrap-salt.sh -x python2 git v2018.3.2\n\n\nUbuntu and derivatives\n~~~~~~~~~~~~~~~~~~~~~~\n\n- KDE neon (based on Ubuntu 16.04)\n- Linux Mint 17/18\n- Ubuntu 14.04/16.04/18.04 and subsequent non-LTS releases (see below)\n\nUbuntu Best Effort Support: Non-LTS Releases\n********************************************\n\nThis script provides best-effort support for current, non-LTS Ubuntu releases. If package\nrepositories are not provided on `SaltStack's Ubuntu repository`_ for the non-LTS release, the\nbootstrap script will attempt to install the packages for the most closely related LTS Ubuntu\nrelease instead.\n\nFor example, when installing Salt on Ubuntu 18.10, the bootstrap script will setup the repository\nfor Ubuntu 18.04 from `SaltStack's Ubuntu repository`_ and install the 18.04 packages.\n\nNon-LTS Ubuntu releases are not supported once the release reaches End-of-Life as defined by\n`Ubuntu's release schedule`_.\n\n\nOther Linux distributions\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Alpine Linux 3.5/edge\n- Arch Linux\n- Gentoo\n\n\nUNIX systems\n~~~~~~~~~~~~\n\n**BSD**:\n\n- OpenBSD (``pip`` installation)\n- FreeBSD 9/10/11\n\n**SunOS**:\n\n- SmartOS (2015Q4 and later)\n\nUnsupported Distributions\n-------------------------\n\nIf you are running a Linux distribution that is not supported yet or is not correctly identified,\nplease run the following commands and report their output when creating an issue:\n\n.. code:: console\n\n  sudo find /etc/ -name \\*-release -print -exec cat {} \\;\n  command lsb_release -a\n\nFor information on how to add support for a currently unsupported distribution, please refer to the\n`Contributing Guidelines`_.\n\nPython 3 Support\n----------------\n\nSome distributions support installing Salt to use Python 3 instead of Python 2. The availability of\nthis offering, while limited, is as follows:\n\n- CentOS 7\n- Debian 9\n- Fedora (only git installations)\n- Ubuntu 16.04\n- Ubuntu 18.04\n\nOn Fedora 28, PIP installation must be allowed (-P) due to incompatibility with the shipped Tornado library.\n\nInstalling the Python 3 packages for Salt is done via the ``-x`` option:\n\n.. code:: console\n\n    sh bootstrap-salt.sh -x python3\n\nSee the ``-x`` option for more information.\n\nTesting\n-------\n\nThere are a couple of ways to test the bootstrap script. Running the script on a fully-fledged\nVM is one way. Other options include using Vagrant or Docker.\n\nTesting in Vagrant\n==================\n\nVagrant_ can be used to easily test changes on a clean machine. The ``Vagrantfile`` defaults to an\nUbuntu box. First, install Vagrant, then:\n\n.. code:: console\n\n  vagrant up\n  vagrant ssh\n\nRunning in Docker\n=================\n\nIt is possible to run and use Salt inside a Docker_ container on Linux machines.\nLet's prepare the Docker image using the provided ``Dockerfile`` to install both a Salt Master\nand a Salt Minion with the bootstrap script:\n\n.. code:: console\n\n  docker build -t local/salt-bootstrap .\n\nStart your new container with Salt services up and running:\n\n.. code:: console\n\n  docker run --detach --name salt --hostname salt local/salt-bootstrap\n\nAnd finally \"enter\" the running container and make Salt fully operational:\n\n.. code:: console\n\n  docker exec -i -t salt /bin/bash\n  salt-key -A -y\n\nSalt is ready and working in the Docker container with the Minion authenticated on the Master.\n\n**NOTE**\n\nThe ``Dockerfile`` here inherits the Ubuntu 14.04 public image with Upstart configured as the init\nsystem. Use it as an example or starting point of how to make your own Docker images with suitable\nSalt components, custom configurations, and even `pre-accepted Minion keys`_ already installed.\n\n.. _Contributing Guidelines: https://github.com/saltstack/salt-bootstrap/blob/develop/CONTRIBUTING.md\n.. _Docker: https://www.docker.com/\n.. _`pre-accepted Minion keys`: https://docs.saltstack.com/en/latest/topics/tutorials/preseed_key.html\n.. _`read the source`: https://github.com/saltstack/salt-bootstrap/blob/develop/bootstrap-salt.sh\n.. _`Salt`: https://saltstack.com/community/\n.. _`Salt's Supported Operating Systems`: http://saltstack.com/wp-content/uploads/2016/08/SaltStack-Supported-Operating-Systems.pdf\n.. _`SaltStack's corporate repository`: https://repo.saltstack.com/\n.. _`SaltStack's Debian repository`: http://repo.saltstack.com/#debian\n.. _`SaltStack's Ubuntu repository`: http://repo.saltstack.com/#ubuntu\n.. _`Ubuntu's release schedule`: https://wiki.ubuntu.com/Releases\n.. _Vagrant: http://www.vagrantup.com\n\n\n.. |windows_build|  image:: https://ci.appveyor.com/api/projects/status/github/saltstack/salt-bootstrap?branch=develop\u0026svg=true\n    :target: https://ci.appveyor.com/project/saltstack-public/salt-bootstrap\n    :alt: Build status of the develop branch on Windows\n\n.. vim: fenc=utf-8 spell spl=en cc=100 tw=99 fo=want sts=2 sw=2 et\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenthought%2Fsalt-bootstrap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenthought%2Fsalt-bootstrap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenthought%2Fsalt-bootstrap/lists"}