<commit_before>:orphan:

.. _release-candidate:

=====================================
Install/Test a Salt Release Candidate
=====================================

When it's time for a new feature release of Salt, follow the instructions below to
install the latest release candidate of Salt, and try all the shiny new
features! Be sure to report any bugs you find on `Github
<https://github.com/saltstack/salt/issues/new/>`_.


Install using packages
======================
Builds for a few platforms are available as part of the RC at https://repo.saltproject.io/salt_rc/.
The builds should include the latest version of the operating system that is currently available.

.. note::

   Beginning with the 3005 (Phosphorus) release of Salt, the Salt Project is
   changing its packaging system to Tiamat. Any new operating systems added in 3005
   will only have Tiamat packages. The Salt Project will phase out the old Salt
   package builds for currently supported operating systems by 3007. See
   `What is Tiamat? <https://docs.saltproject.io/salt/install-guide/en/latest/topics/upgrade-to-tiamat.html#what-is-tiamat>`_
   for more information.

To install release candidate packages:

Follow the instructions for your operating system on https://repo.saltproject.io/,
but insert ``salt_rc/`` into the URL between the hostname and the remainder
of the file path.


Tiamat packages
---------------
For RedHat:

.. code-block:: bash

    baseurl=https://repo.saltproject.io/salt_rc/salt/py3/redhat/$releasever/$basearch/

For Ubuntu, replace the ``<os_version>`` variable with number of the Ubuntu
version. For example ``20.04``:

.. code-block:: none

    deb https://repo.saltproject.io/salt_rc/salt/py3/ubuntu/<os_version>/amd64 focal main

For Debian, replace the ``<os_version>`` variable with the Debian version. For
example: ``10``:

.. code-block:: none

    deb https://repo.saltproject.io/salt_rc/salt/py3/debian/<os_version>/amd64 buster main



Classic packages
----------------
For RedHat:

.. code-block:: bash

    baseurl=https://repo.saltproject.io/salt_rc/py3/redhat/$releasever/$basearch/

For Ubuntu, replace the ``<os_version>`` variable with number of the Ubuntu
version. For example ``20.04``:

.. code-block:: none

    deb https://repo.saltproject.io/salt_rc/py3/ubuntu/<os_version>/amd64 focal main

For Debian, replace the ``<os_version>`` variable with the Debian version. For
example: ``10``:

.. code-block:: none

    deb https://repo.saltproject.io/salt_rc/py3/debian/<os_version>/amd64 buster main



.. FreeBSD

Install using bootstrap
=======================
You can install a release candidate of Salt using `Salt Bootstrap
<https://github.com/saltstack/salt-bootstrap/>`_:

For example for the 3003rc1 release:

.. code-block:: bash

    curl -o install_salt.sh -L https://bootstrap.saltproject.io
    sudo sh install_salt.sh -P -x python3 git v3003rc1

If you want to also install a master using Salt Bootstrap, use the ``-M`` flag:

.. code-block:: bash

    curl -o install_salt.sh -L https://bootstrap.saltproject.io
    sudo sh install_salt.sh -P -M -x python3 git v3003rc1

If you want to install only a master and not a minion using Salt Bootstrap, use
the ``-M`` and ``-N`` flags:

.. code-block:: bash

    curl -o install_salt.sh -L https://bootstrap.saltproject.io
    sudo sh install_salt.sh -P -M -N -x python3 git v3003rc1


Install using PyPI
==================
Installing from the source archive on `PyPI <https://pypi.org/>`_
is fairly straightforward.

.. note::

    On RHEL derivatives you also need to install the ``epel-release`` package
    first.

    .. code-block:: bash

        sudo yum install epel-release

First install the build dependencies.

- Debian-based systems:

  .. code-block:: bash

      sudo apt-get install python-pip python-dev gcc g++

- RedHat-based systems:

  .. code-block:: bash

      sudo yum install python-pip python-devel gcc gcc-c++

- other systems:

  You will need to install:

  - pip
  - python header libraries
  - C and C++ compilers

Then install salt using the following command:

.. code-block:: bash

    sudo pip install salt==$rc_tag_version

For example for the 3003rc1 release:

.. code-block:: bash

    sudo pip install salt==3005~rc1
<commit_msg>Fix release file name syntax<commit_after>:orphan:

.. _release-candidate:

=====================================
Install/Test a Salt Release Candidate
=====================================

When it's time for a new feature release of Salt, follow the instructions below to
install the latest release candidate of Salt, and try all the shiny new
features! Be sure to report any bugs you find on `Github
<https://github.com/saltstack/salt/issues/new/>`_.


Install using packages
======================
Builds for a few platforms are available as part of the RC at https://repo.saltproject.io/salt_rc/.
The builds should include the latest version of the operating system that is currently available.

.. note::

   Beginning with the 3005 (Phosphorus) release of Salt, the Salt Project is
   changing its packaging system to Tiamat. Any new operating systems added in 3005
   will only have Tiamat packages. The Salt Project will phase out the old Salt
   package builds for currently supported operating systems by 3007. See
   `What is Tiamat? <https://docs.saltproject.io/salt/install-guide/en/latest/topics/upgrade-to-tiamat.html#what-is-tiamat>`_
   for more information.

To install release candidate packages:

Follow the instructions for your operating system on https://repo.saltproject.io/,
but insert ``salt_rc/`` into the URL between the hostname and the remainder
of the file path.


Tiamat packages
---------------
For RedHat:

.. code-block:: bash

    baseurl=https://repo.saltproject.io/salt_rc/salt/py3/redhat/$releasever/$basearch/

For Ubuntu, replace the ``<os_version>`` variable with number of the Ubuntu
version. For example ``20.04``:

.. code-block:: none

    deb https://repo.saltproject.io/salt_rc/salt/py3/ubuntu/<os_version>/amd64 focal main

For Debian, replace the ``<os_version>`` variable with the Debian version. For
example: ``10``:

.. code-block:: none

    deb https://repo.saltproject.io/salt_rc/salt/py3/debian/<os_version>/amd64 buster main



Classic packages
----------------
For RedHat:

.. code-block:: bash

    baseurl=https://repo.saltproject.io/salt_rc/py3/redhat/$releasever/$basearch/

For Ubuntu, replace the ``<os_version>`` variable with number of the Ubuntu
version. For example ``20.04``:

.. code-block:: none

    deb https://repo.saltproject.io/salt_rc/py3/ubuntu/<os_version>/amd64 focal main

For Debian, replace the ``<os_version>`` variable with the Debian version. For
example: ``10``:

.. code-block:: none

    deb https://repo.saltproject.io/salt_rc/py3/debian/<os_version>/amd64 buster main



.. FreeBSD

Install using bootstrap
=======================
You can install a release candidate of Salt using `Salt Bootstrap
<https://github.com/saltstack/salt-bootstrap/>`_:

For example for the 3003rc1 release:

.. code-block:: bash

    curl -o install_salt.sh -L https://bootstrap.saltproject.io
    sudo sh install_salt.sh -P -x python3 git v3003rc1

If you want to also install a master using Salt Bootstrap, use the ``-M`` flag:

.. code-block:: bash

    curl -o install_salt.sh -L https://bootstrap.saltproject.io
    sudo sh install_salt.sh -P -M -x python3 git v3003rc1

If you want to install only a master and not a minion using Salt Bootstrap, use
the ``-M`` and ``-N`` flags:

.. code-block:: bash

    curl -o install_salt.sh -L https://bootstrap.saltproject.io
    sudo sh install_salt.sh -P -M -N -x python3 git v3003rc1


Install using PyPI
==================
Installing from the source archive on `PyPI <https://pypi.org/>`_
is fairly straightforward.

.. note::

    On RHEL derivatives you also need to install the ``epel-release`` package
    first.

    .. code-block:: bash

        sudo yum install epel-release

First install the build dependencies.

- Debian-based systems:

  .. code-block:: bash

      sudo apt-get install python-pip python-dev gcc g++

- RedHat-based systems:

  .. code-block:: bash

      sudo yum install python-pip python-devel gcc gcc-c++

- other systems:

  You will need to install:

  - pip
  - python header libraries
  - C and C++ compilers

Then install salt using the following command:

.. code-block:: bash

    sudo pip install salt==$rc_tag_version

For example for the 3003rc1 release:

.. code-block:: bash

    sudo pip install salt==3005rc1

{'fraction_non_alphanumeric': 0.1369173108456313, 'fraction_numerical': 0.016631529632232373, 'mean_word_length': 3.539606592238171, 'pattern_counts': {'":': 0, '<': 27, '<?xml version=': 0, '>': 27, 'https://': 30, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '918963', 'n_tokens_mistral': 2812, 'n_tokens_neox': 2479, 'n_words': 936}