diff --git a/.gitignore b/.gitignore index dcc305a..1a546e9 100644 --- a/.gitignore +++ b/.gitignore @@ -74,8 +74,8 @@ instance/ # Sphinx documentation docs/_build/ ## Generated stuff from Sphinx templates -docs/sitevars.rst -docs/topics/announcements.rst +# docs/sitevars.rst +# docs/topics/announcements.rst # PyBuilder .pybuilder/ diff --git a/README.rst b/README.rst index ce97b5b..82daf74 100644 --- a/README.rst +++ b/README.rst @@ -38,7 +38,6 @@ The Salt Install Guide supplements and extends the core documentation for the help Salt users install ``salt`` in their environment, ultimately superseding documentation where applicable: -* Install directions on `repo.saltproject.io `__ * Install directions on `docs.saltproject.io `__ Contributions from anyone inside the Salt project community are always welcome. diff --git a/docs/_static/img/repo-landing-small.png b/docs/_static/img/repo-landing-small.png new file mode 100644 index 0000000..6b7fdc4 Binary files /dev/null and b/docs/_static/img/repo-landing-small.png differ diff --git a/docs/_templates/sitevars.rst b/docs/_templates/sitevars.rst index 22898da..ec9667b 100644 --- a/docs/_templates/sitevars.rst +++ b/docs/_templates/sitevars.rst @@ -1,224 +1,42 @@ -.. |release| replace:: CURRENT_MINOR -.. |current-major-version| replace:: 3007 -.. |supported-release-1| replace:: LATEST_MINOR -.. |supported-release-2| replace:: OLD_MINOR -.. |supported-release-3| replace:: OLDEST_MINOR -.. |supported-release-1-badge| replace:: :bdg-link-success:`LATEST_MINOR ` -.. |supported-release-2-badge| replace:: :bdg-link-primary:`OLD_MINOR ` -.. |supported-release-3-badge| replace:: :bdg-link-warning:`OLDEST_MINOR ` +.. |major-lts-version| replace:: 3006 +.. |major-sts-version| replace:: 3007 +.. |minor-lts-version| replace:: 3006.9 +.. |minor-sts-version| replace:: 3007.1 +.. |minor-lts-version-badge| replace:: :bdg-link-primary:`3006.9 ` +.. |minor-sts-version-badge| replace:: :bdg-link-success:`3007.1 ` + +.. |relenv-lts-python-version| replace:: **Python v3.10.x** +.. |relenv-sts-python-version| replace:: **Python v3.10.x** .. |quickstart-script-path| replace:: https://raw.githubusercontent.com/saltstack/salt-bootstrap/develop/salt-quick-start.sh .. |quickstart-script-path-windows| replace:: https://raw.githubusercontent.com/saltstack/salt-bootstrap/develop/salt-quick-start.ps1 .. |windows-vs-buildtools-script| replace:: https://raw.githubusercontent.com/saltstack/salt/master/pkg/windows/install_vs_buildtools.ps1 .. |release-candidate-version| replace:: RC_RELEASE -.. |debian-release-candidate-gpg| replace:: /etc/apt/keyrings/salt-archive-keyring-2023.gpg https://repo.saltproject.io/salt_rc/salt/py3/debian/11/amd64/latest/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian-release-candidate| replace:: [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg] https://repo.saltproject.io/salt_rc/salt/py3/debian/11/amd64/latest/ bullseye main" -.. |rhel-release-candidate-gpg| replace:: https://repo.saltproject.io/salt_rc/salt/py3/redhat/9/x86_64/latest/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel-release-candidate| replace:: https://repo.saltproject.io/salt_rc/salt/py3/redhat/9/x86_64/latest.repo -.. |rhel-release-candidate-echo| replace:: 'baseurl=https://repo.saltproject.io/salt_rc/salt/py3/redhat/$releasever/$basearch/latest' -.. |ubuntu-release-candidate-gpg| replace:: /etc/apt/keyrings/salt-archive-keyring-2023.gpg https://repo.saltproject.io/salt_rc/salt/py3/ubuntu/22.04/amd64/latest/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu-release-candidate| replace:: [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg] https://repo.saltproject.io/salt_rc/salt/py3/ubuntu/22.04/amd64/latest/ jammy main" -.. |windows-release-candidate-url| replace:: https://repo.saltproject.io/salt_rc/salt/py3/windows -.. |windows-release-candidate-amd64-exe-url| replace:: https://repo.saltproject.io/salt_rc/salt/py3/windows/latest/Salt-Minion-RC_RELEASE-Py3-AMD64-Setup.exe -.. |windows-release-candidate-amd64-exe-file-name| replace:: Salt-Minion-RC_RELEASE-Py3-AMD64-Setup.exe -.. |windows-release-candidate-amd64-msi-url| replace:: https://repo.saltproject.io/salt_rc/salt/py3/windows/latest/Salt-Minion-RC_RELEASE-Py3-AMD64.msi -.. |windows-release-candidate-x86-exe-url| replace:: https://repo.saltproject.io/salt_rc/salt/py3/windows/latest/Salt-Minion-RC_RELEASE-Py3-x86-Setup.exe -.. |windows-release-candidate-x86-msi-url| replace:: https://repo.saltproject.io/salt_rc/salt/py3/windows/latest/Salt-Minion-RC_RELEASE-Py3-x86.msi .. |bootstrap-release-candidate| replace:: python3 git vRC_RELEASE .. |pip-install-release-candidate| replace:: pip install salt==RC_RELEASE -.. |amazon-linux2-latest-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2-latest-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/x86_64/latest.repo -.. |amazon-linux2-major-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2-major-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/x86_64/CURRENT_MAJOR.repo -.. |amazon-linux2-minor-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2-minor-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/x86_64/minor/CURRENT_MINOR.repo - -.. |amazon-linux2-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/arm64/latest.repo -.. |amazon-linux2-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/arm64/CURRENT_MAJOR.repo -.. |amazon-linux2-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2/arm64/minor/CURRENT_MINOR.repo - -.. |amazon-linux2023-latest-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2023-latest-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/x86_64/latest.repo -.. |amazon-linux2023-major-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2023-major-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/x86_64/CURRENT_MAJOR.repo -.. |amazon-linux2023-minor-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2023-minor-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/x86_64/minor/CURRENT_MINOR.repo - -.. |amazon-linux2023-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2023-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/arm64/latest.repo -.. |amazon-linux2023-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2023-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/arm64/CURRENT_MAJOR.repo -.. |amazon-linux2023-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |amazon-linux2023-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/amazon/2023/arm64/minor/CURRENT_MINOR.repo - -.. |rocky9-latest-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky9-latest-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/latest.repo -.. |rocky9-major-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky9-major-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/CURRENT_MAJOR.repo -.. |rocky9-minor-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky9-minor-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/minor/CURRENT_MINOR.repo - -.. |rocky9-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky9-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/latest.repo -.. |rocky9-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky9-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/CURRENT_MAJOR.repo -.. |rocky9-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky9-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/minor/CURRENT_MINOR.repo - -.. |rocky8-latest-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky8-latest-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/latest.repo -.. |rocky8-major-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky8-major-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/CURRENT_MAJOR.repo -.. |rocky8-minor-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky8-minor-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/minor/CURRENT_MINOR.repo - -.. |rocky8-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky8-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/latest.repo -.. |rocky8-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky8-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/CURRENT_MAJOR.repo -.. |rocky8-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rocky8-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/minor/CURRENT_MINOR.repo - -.. |debian12-latest-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/12/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian12-latest-download-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/12/amd64/latest bookworm main -.. |debian12-major-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/12/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian12-major-download-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/12/amd64/CURRENT_MAJOR bookworm main -.. |debian12-minor-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/12/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian12-minor-download-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/12/amd64/minor/CURRENT_MINOR bookworm main - -.. |debian12-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/12/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian12-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/12/arm64/latest bookworm main -.. |debian12-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/12/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian12-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/12/arm64/CURRENT_MAJOR bookworm main -.. |debian12-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/12/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian12-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/12/arm64/minor/CURRENT_MINOR bookworm main - -.. |debian11-latest-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/11/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian11-latest-download-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/11/amd64/latest bullseye main -.. |debian11-major-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/11/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian11-major-download-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/11/amd64/CURRENT_MAJOR bullseye main -.. |debian11-minor-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/11/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian11-minor-download-amd64| replace:: https://repo.saltproject.io/salt/py3/debian/11/amd64/minor/CURRENT_MINOR bullseye main - -.. |debian11-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/11/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian11-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/11/arm64/latest bullseye main -.. |debian11-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/11/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian11-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/11/arm64/CURRENT_MAJOR bullseye main -.. |debian11-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/11/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |debian11-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/debian/11/arm64/minor/CURRENT_MINOR bullseye main - -.. |fedora40-latest-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |fedora40-latest-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/x86_64/latest.repo -.. |fedora40-major-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |fedora40-major-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/x86_64/CURRENT_MAJOR.repo -.. |fedora40-minor-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |fedora40-minor-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/x86_64/minor/CURRENT_MINOR.repo - -.. |fedora40-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |fedora40-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/arm64/latest.repo -.. |fedora40-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |fedora40-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/arm64/CURRENT_MAJOR.repo -.. |fedora40-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |fedora40-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/fedora/40/arm64/minor/CURRENT_MINOR.repo - -.. |macos-amd64-download| replace:: https://repo.saltproject.io/salt/py3/macos/CURRENT_MAJOR/salt-CURRENT_MINOR-py3-x86_64.pkg -.. |macos-amd64-gpg| replace:: https://repo.saltproject.io/salt/py3/macos/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |macos-arm64-download| replace:: https://repo.saltproject.io/salt/py3/macos/CURRENT_MAJOR/salt-CURRENT_MINOR-py3-arm64.pkg - -.. |photonos5-latest-gpg| replace:: https://repo.saltproject.io/salt/py3/photon/5.0/x86_64/latest/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |photonos5-latest-download| replace:: https://repo.saltproject.io/salt/py3/photon/5.0/x86_64/latest.repo -.. |photonos5-major-gpg| replace:: https://repo.saltproject.io/salt/py3/photon/5.0/x86_64/latest/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |photonos5-major-download| replace:: https://repo.saltproject.io/salt/py3/photon/5.0/x86_64/CURRENT_MAJOR.repo -.. |photonos5-minor-gpg| replace:: https://repo.saltproject.io/salt/py3/photon/5.0/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |photonos5-minor-download| replace:: https://repo.saltproject.io/salt/py3/photon/5.0/x86_64/minor/CURRENT_MINOR.repo - -.. |photonos4-latest-gpg| replace:: https://repo.saltproject.io/salt/py3/photon/4.0/x86_64/latest/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |photonos4-latest-download| replace:: https://repo.saltproject.io/salt/py3/photon/4.0/x86_64/latest.repo -.. |photonos4-major-gpg| replace:: https://repo.saltproject.io/salt/py3/photon/4.0/x86_64/latest/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |photonos4-major-download| replace:: https://repo.saltproject.io/salt/py3/photon/4.0/x86_64/CURRENT_MAJOR.repo -.. |photonos4-minor-gpg| replace:: https://repo.saltproject.io/salt/py3/photon/4.0/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |photonos4-minor-download| replace:: https://repo.saltproject.io/salt/py3/photon/4.0/x86_64/minor/CURRENT_MINOR.repo - -.. |rhel9-latest-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel9-latest-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/latest.repo -.. |rhel9-major-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel9-major-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/CURRENT_MAJOR.repo -.. |rhel9-minor-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel9-minor-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/x86_64/minor/CURRENT_MINOR.repo - -.. |rhel9-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel9-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/latest.repo -.. |rhel9-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel9-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/CURRENT_MAJOR.repo -.. |rhel9-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel9-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/9/arm64/minor/CURRENT_MINOR.repo - -.. |rhel8-latest-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel8-latest-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/latest.repo -.. |rhel8-major-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel8-major-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/CURRENT_MAJOR.repo -.. |rhel8-minor-gpg-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel8-minor-download-x86_64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/x86_64/minor/CURRENT_MINOR.repo - -.. |rhel8-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel8-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/latest.repo -.. |rhel8-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel8-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/CURRENT_MAJOR.repo -.. |rhel8-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/SALT-PROJECT-GPG-PUBKEY-2023.pub -.. |rhel8-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/redhat/8/arm64/minor/CURRENT_MINOR.repo - -.. |ubuntu24-latest-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu24-latest-download-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/amd64/latest noble main -.. |ubuntu24-major-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu24-major-download-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/amd64/CURRENT_MAJOR noble main -.. |ubuntu24-minor-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu24-minor-download-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/amd64/minor/CURRENT_MINOR noble main - -.. |ubuntu24-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu24-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/arm64/latest noble main -.. |ubuntu24-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu24-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/arm64/CURRENT_MAJOR noble main -.. |ubuntu24-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu24-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/24.04/arm64/minor/CURRENT_MINOR noble main - -.. |ubuntu22-latest-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu22-latest-download-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/amd64/latest jammy main -.. |ubuntu22-major-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu22-major-download-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/amd64/CURRENT_MAJOR jammy main -.. |ubuntu22-minor-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu22-minor-download-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/amd64/minor/CURRENT_MINOR jammy main +.. |macos-amd64-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3006.9/salt-3006.9-py3-x86_64.pkg +.. |macos-arm64-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3006.9/salt-3006.9-py3-arm64.pkg -.. |ubuntu22-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu22-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/arm64/latest jammy main -.. |ubuntu22-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu22-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/arm64/CURRENT_MAJOR jammy main -.. |ubuntu22-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu22-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/22.04/arm64/minor/CURRENT_MINOR jammy main +.. |macos-amd64-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3007.1/salt-3007.1-py3-x86_64.pkg +.. |macos-arm64-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3007.1/salt-3007.1-py3-arm64.pkg -.. |ubuntu20-latest-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu20-latest-download-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/amd64/latest focal main -.. |ubuntu20-major-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu20-major-download-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/amd64/CURRENT_MAJOR focal main -.. |ubuntu20-minor-gpg-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/amd64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu20-minor-download-amd64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/amd64/minor/CURRENT_MINOR focal main +.. |windows-install-exe-example| replace:: Salt-Minion-3006.9-Py3-AMD64-Setup.exe +.. |windows-install-msi-example| replace:: Salt-Minion-3006.9-Py3-AMD64.msi -.. |ubuntu20-latest-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu20-latest-download-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/arm64/latest focal main -.. |ubuntu20-major-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu20-major-download-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/arm64/CURRENT_MAJOR focal main -.. |ubuntu20-minor-gpg-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/arm64/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |ubuntu20-minor-download-arm64| replace:: https://repo.saltproject.io/salt/py3/ubuntu/20.04/arm64/minor/CURRENT_MINOR focal main +.. |windows-amd64-exe-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-AMD64-Setup.exe +.. |windows-amd64-msi-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-AMD64.msi +.. |windows-x86-exe-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-x86-Setup.exe +.. |windows-x86-msi-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-x86.msi -.. |windows-install-exe-example| replace:: Salt-Minion-CURRENT_MINOR-Py3-AMD64-Setup.exe -.. |windows-install-msi-example| replace:: Salt-Minion-CURRENT_MINOR-Py3-AMD64.msi +.. |windows-amd64-exe-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-AMD64-Setup.exe +.. |windows-amd64-msi-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-AMD64.msi +.. |windows-x86-exe-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-x86-Setup.exe +.. |windows-x86-msi-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-x86.msi -.. |windows-amd64-exe-gpg| replace:: https://repo.saltproject.io/salt/py3/windows/SALT-PROJECT-GPG-PUBKEY-2023.gpg -.. |windows-amd64-exe-download| replace:: https://repo.saltproject.io/salt/py3/windows/CURRENT_MAJOR/Salt-Minion-CURRENT_MINOR-Py3-AMD64-Setup.exe -.. |windows-amd64-msi-download| replace:: https://repo.saltproject.io/salt/py3/windows/CURRENT_MAJOR/Salt-Minion-CURRENT_MINOR-Py3-AMD64.msi -.. |windows-x86-exe-download| replace:: https://repo.saltproject.io/salt/py3/windows/CURRENT_MAJOR/Salt-Minion-CURRENT_MINOR-Py3-x86-Setup.exe -.. |windows-x86-msi-download| replace:: https://repo.saltproject.io/salt/py3/windows/CURRENT_MAJOR/Salt-Minion-CURRENT_MINOR-Py3-x86.msi +.. |windows-release-candidate-amd64-exe-file-name| replace:: TBD +.. |windows-release-candidate-amd64-exe-url| replace:: TBD +.. |windows-release-candidate-amd64-msi-url| replace:: TBD +.. |windows-release-candidate-x86-exe-url| replace:: TBD +.. |windows-release-candidate-x86-msi-url| replace:: TBD diff --git a/docs/conf.py b/docs/conf.py index 02af646..b3bf27b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,6 @@ import requests from docutils import nodes from docutils.nodes import Element -from salt_furo_versioner import make_html_context from sphinx.writers.html import HTMLTranslator @@ -94,7 +93,7 @@ def setup(app): ) # Pull release from "release" in sitevars.rst -release = [s for s in site_vars if "|release|" in s][0].split(":: ")[1] +release = [s for s in site_vars if "|minor-lts-version|" in s][0].split(":: ")[1] version = release # Grab major version for URL version selector generation @@ -104,6 +103,7 @@ def setup(app): # Furo theme version selector setup ## # Pull from JSON in GitLab Snippet +""" supported_versions_json = requests.get( "https://gitlab.com/saltstack/open/docs/salt-install-guide/-/snippets/2580440/raw/main/supported-versions.json" ) @@ -124,6 +124,7 @@ def setup(app): latest_version=latest_version, versions=versions, ) +""" # -- General configuration --------------------------------------------------- @@ -181,7 +182,7 @@ def setup(app): "color-brand-primary": "#66CCF4", "color-brand-content": "#66CCF4", }, - "announcement": "You are currently viewing the 3007 STS version of the Salt install guide. Use the LTS version of Salt in production environments.
To change to the 3006 LTS version, use the version selector at the bottom of the left menu bar.", + "announcement": "IMPORTANT ANNOUNCEMENT: repo.saltproject.io has migrated to packages.broadcom.com!
A review and update of installation automation is advised.", } # Add any paths that contain custom static files (such as style sheets) here, diff --git a/docs/index.rst b/docs/index.rst index 319dcdc..278cefd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,7 +4,7 @@ Install Salt ============ -.. include:: topics/_includes/install-overview.rst +.. include:: topics/_includes/repo-landing.rst .. toctree:: @@ -62,7 +62,7 @@ Install Salt :hidden: :caption: Contribute - Open a Salt issue to report install bugs - Open a docs issue + Open a Salt issue to report bugs + Open an Install Guide docs issue Salt docs contributing guide - GitLab repository + Salt Install Guide source diff --git a/docs/requirements.txt b/docs/requirements.txt index 568a006..7bb51cc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,12 +1,9 @@ -# If using version selector, use -# Temporary Furo theme target for versioning -# furo==2022.6.21 -Sphinx-Substitution-Extensions==2022.02.16 +furo>=2024.8.6 requests>=2.31.0 -salt-furo-versioner @ git+https://github.com/ScriptAutomate/salt-furo-versioner@excelsior -sphinx-copybutton==0.5.2 -sphinx-design==0.5.0 -sphinx-inline-tabs==2023.4.21 -sphinx-prompt==1.5.0 -sphinx-tabs==3.4.7 -sphinx==5.3.0 +sphinx-copybutton>=0.5.2 +sphinx-design>=0.5.0 +sphinx-inline-tabs>=2023.4.21 +sphinx-prompt>=1.5.0 +sphinx-substitution-extensions>=2022.02.16 +sphinx-tabs>=3.4.7 +sphinx>=5.3.0 diff --git a/docs/sitevars.rst b/docs/sitevars.rst new file mode 100644 index 0000000..ec9667b --- /dev/null +++ b/docs/sitevars.rst @@ -0,0 +1,42 @@ +.. |major-lts-version| replace:: 3006 +.. |major-sts-version| replace:: 3007 +.. |minor-lts-version| replace:: 3006.9 +.. |minor-sts-version| replace:: 3007.1 +.. |minor-lts-version-badge| replace:: :bdg-link-primary:`3006.9 ` +.. |minor-sts-version-badge| replace:: :bdg-link-success:`3007.1 ` + +.. |relenv-lts-python-version| replace:: **Python v3.10.x** +.. |relenv-sts-python-version| replace:: **Python v3.10.x** + +.. |quickstart-script-path| replace:: https://raw.githubusercontent.com/saltstack/salt-bootstrap/develop/salt-quick-start.sh +.. |quickstart-script-path-windows| replace:: https://raw.githubusercontent.com/saltstack/salt-bootstrap/develop/salt-quick-start.ps1 +.. |windows-vs-buildtools-script| replace:: https://raw.githubusercontent.com/saltstack/salt/master/pkg/windows/install_vs_buildtools.ps1 + +.. |release-candidate-version| replace:: RC_RELEASE +.. |bootstrap-release-candidate| replace:: python3 git vRC_RELEASE +.. |pip-install-release-candidate| replace:: pip install salt==RC_RELEASE + +.. |macos-amd64-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3006.9/salt-3006.9-py3-x86_64.pkg +.. |macos-arm64-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3006.9/salt-3006.9-py3-arm64.pkg + +.. |macos-amd64-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3007.1/salt-3007.1-py3-x86_64.pkg +.. |macos-arm64-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/macos/3007.1/salt-3007.1-py3-arm64.pkg + +.. |windows-install-exe-example| replace:: Salt-Minion-3006.9-Py3-AMD64-Setup.exe +.. |windows-install-msi-example| replace:: Salt-Minion-3006.9-Py3-AMD64.msi + +.. |windows-amd64-exe-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-AMD64-Setup.exe +.. |windows-amd64-msi-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-AMD64.msi +.. |windows-x86-exe-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-x86-Setup.exe +.. |windows-x86-msi-lts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3006.9/Salt-Minion-3006.9-Py3-x86.msi + +.. |windows-amd64-exe-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-AMD64-Setup.exe +.. |windows-amd64-msi-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-AMD64.msi +.. |windows-x86-exe-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-x86-Setup.exe +.. |windows-x86-msi-sts-download| replace:: https://packages.broadcom.com/artifactory/saltproject-generic/windows/3007.1/Salt-Minion-3007.1-Py3-x86.msi + +.. |windows-release-candidate-amd64-exe-file-name| replace:: TBD +.. |windows-release-candidate-amd64-exe-url| replace:: TBD +.. |windows-release-candidate-amd64-msi-url| replace:: TBD +.. |windows-release-candidate-x86-exe-url| replace:: TBD +.. |windows-release-candidate-x86-msi-url| replace:: TBD diff --git a/docs/topics/_includes/fips-photon-os.rst b/docs/topics/_includes/fips-photon-os.rst deleted file mode 100644 index 866a0b1..0000000 --- a/docs/topics/_includes/fips-photon-os.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. Warning:: - - The 3006 version of Salt for Photon OS, starting with 3006.5, is FIPS compliant. - - If your organization requires FIPS compliance and you need to install Salt on - Photon OS 4 or greater, and install at least the 3006.5 version of Salt. diff --git a/docs/topics/_includes/gpg-keys.rst b/docs/topics/_includes/gpg-keys.rst index e8e85bc..f953d67 100644 --- a/docs/topics/_includes/gpg-keys.rst +++ b/docs/topics/_includes/gpg-keys.rst @@ -1,5 +1,5 @@ .. admonition:: GPG key change - The GPG key for the |release| release is now named: - SALT-PROJECT-GPG-PUBKEY-2023. You must import the new GPG key before - upgrading or your upgrade will fail. + The GPG key for Salt 3005, and earlier, used an older GPG key. + You must import the new GPG key before upgrading or your upgrade will fail. + See :ref:`install-by-operating-system-index` for the specific commands. diff --git a/docs/topics/_includes/install-method.rst b/docs/topics/_includes/install-method.rst index 5bbc6f8..c1429dc 100644 --- a/docs/topics/_includes/install-method.rst +++ b/docs/topics/_includes/install-method.rst @@ -1,5 +1,9 @@ -The Salt Project provides a public repository for packages at the -`Salt Project Package Repo `__. +The Salt Project provides public repositories for packages on the +public Broadcom Artifactory endpoint: + +* `Salt Project RPM Repo `__ +* `Salt Project DEB Repo `__ +* `Salt Project Generic Repo (Windows, MacOS, etc.) `__ The preferred method for installing Salt is using distribution packages. This method ensures that: diff --git a/docs/topics/_includes/macos-downloads.rst b/docs/topics/_includes/macos-downloads.rst index abb1ece..95638d3 100644 --- a/docs/topics/_includes/macos-downloads.rst +++ b/docs/topics/_includes/macos-downloads.rst @@ -1,19 +1,39 @@ +3006 LTS Downloads +------------------ + +.. list-table:: + :widths: 10 10 40 + :header-rows: 1 + :class: windows-mac-download + + * - Arch + - Salt Release Type + - Download install file + + * - x86_64 + - lts + - |macos-amd64-lts-download| + + * - arm64 + - lts + - |macos-arm64-lts-download| + +3007 STS Downloads +------------------ + .. list-table:: - :widths: 10 10 40 40 + :widths: 10 10 40 :header-rows: 1 :class: windows-mac-download * - Arch - - File type + - Salt Release Type - Download install file - - GPG * - x86_64 - - pkg - - |macos-amd64-download| - - |macos-amd64-gpg| + - sts + - |macos-amd64-sts-download| * - arm64 - - pkg - - |macos-arm64-download| - - |macos-amd64-gpg| + - sts + - |macos-arm64-sts-download| diff --git a/docs/topics/_includes/repo-landing.rst b/docs/topics/_includes/repo-landing.rst new file mode 100644 index 0000000..c7f20fc --- /dev/null +++ b/docs/topics/_includes/repo-landing.rst @@ -0,0 +1,102 @@ +.. div:: landing-title + + .. grid:: + :reverse: + :gutter: 2 3 3 3 + :margin: 4 4 1 2 + + .. grid-item:: + :columns: 12 3 3 3 + :class: sd-m-auto sd-animate-grow50-rot20 + + .. image:: /_static/img/repo-landing-small.png + :width: 125 + :alt: Salt Project install guide logo + + .. grid-item:: + :columns: 12 9 9 9 + :class: sd-text-white sd-fs-2 sd-text-center + + The Salt install guide + + .. button-link:: https://docs.saltproject.io/en/master/topics/tutorials/walkthrough.html + :color: light + :align: center + :outline: + + New to Salt? Try this tutorial + +======= +Welcome +======= + +Welcome to the Salt install guide! This guide provides instructions for +installing Salt on :ref:`salt-supported-operating-systems`. It also explains +how to configure Salt, start Salt services, and verify your installation. + +Note that the Salt Project has phased out classic package builds for supported +operating systems for 3006 and later. Update your Salt infrastructure to the new +onedir packages as soon as possible. See :ref:`upgrade-to-onedir` for +instructions. + +Install Salt +============ + +.. grid:: 3 + + .. grid-item:: + + .. button-link:: topics/overview.html + :color: primary + :expand: + + Install overview :octicon:`arrow-up-right` + + .. grid-item:: + + .. button-link:: topics/bootstrap.html + :color: primary + :expand: + + Bootstrap install :octicon:`arrow-up-right` + + .. grid-item:: + + .. button-link:: topics/salt-supported-operating-systems.html + :color: primary + :expand: + + Supported systems :octicon:`arrow-up-right` + +Quick install by operating system +================================= + +Operating systems are listed in alphabetical order: + +.. grid:: 2 + :gutter: 3 + + .. grid-item-card:: Linux (DEB) + :class-card: sd-border-1 + :link: topics/install-by-operating-system/linux-deb.html + + :bdg-primary:`Debian-like Systems` + + .. grid-item-card:: Linux (RPM) + :class-card: sd-border-1 + :link: topics/install-by-operating-system/linux-rpm.html + + :bdg-primary:`RHEL-like systems` + + .. grid-item-card:: macOS + :class-card: sd-border-1 + :link: topics/install-by-operating-system/macos.html + + :bdg-primary:`pkg` + + .. grid-item-card:: Windows + :class-card: sd-border-1 + :link: topics/install-by-operating-system/windows.html + + :bdg-primary:`exe` + :bdg-secondary:`msi` diff --git a/docs/topics/_includes/supported-salt-releases-sidebar.rst b/docs/topics/_includes/supported-salt-releases-sidebar.rst index a6784ef..8b54a63 100644 --- a/docs/topics/_includes/supported-salt-releases-sidebar.rst +++ b/docs/topics/_includes/supported-salt-releases-sidebar.rst @@ -1,6 +1,6 @@ .. sidebar:: **Supported Salt releases** - |supported-release-1-badge| |supported-release-2-badge| + |minor-lts-version-badge| |minor-sts-version-badge| **See also** diff --git a/docs/topics/_includes/warning-about-old-packages.rst b/docs/topics/_includes/warning-about-old-packages.rst deleted file mode 100644 index c0bed5f..0000000 --- a/docs/topics/_includes/warning-about-old-packages.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. Warning:: - - The Salt Project will support the classic, non-onedir packaging system until - the 3006 release. After that time, onedir will become the standard packaging - system for the Salt Project. The following instructions explain how to - install Salt using the classic packaging system, but you should consider - upgrading to onedir soon. See :ref:`upgrade-to-onedir` for more information. - - In order to prevent problems running classic Salt packages, you should run - Salt with the default version of Python that was originally packaged with that - operating system. For example, RedHat 8 and CentOS 8 should use Python 3.6. - Using any other version could prevent Salt from working properly. diff --git a/docs/topics/_includes/what-is-a-native-minion.rst b/docs/topics/_includes/what-is-a-native-minion.rst deleted file mode 100644 index 325ba66..0000000 --- a/docs/topics/_includes/what-is-a-native-minion.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. dropdown:: What are Salt native minions? - - Salt can target network-connected devices through `Salt proxy - minions `_. - Proxy minions are a Salt feature that enables controlling devices that, - for whatever reason, cannot run the standard salt-minion service. Examples - include network gear that has an API but runs a proprietary OS, devices with - limited CPU or memory, or devices that could run a minion but, for security - reasons, will not. - - **Salt native minions** are packaged to run directly on specific devices, - removing the need for proxy minions running elsewhere on a network. Native - minions have several advantages, such as: - - * **Performance boosts:** With native minions, Salt doesn’t need to rely on - constant SSH connections across the network. There is also less burden on - the servers running multiple proxy minions. - * **Higher availability:** For servers running multiple proxy minions, - server issues can cause connection problems to all proxy minions being - managed by the server. Native minions remove this potential point of - failure. - * **Improved scalability:** When adding devices to a network that are - supported by native minions, you aren’t required to deploy proxy minions - on separate infrastructure. This reduces the burden of horizontally or - vertically scaling infrastructure dedicated to proxy minions. - - - .. Note:: - For an overview of how Salt works, see `Salt system architecture - `_. diff --git a/docs/topics/_includes/what-is-onedir.rst b/docs/topics/_includes/what-is-onedir.rst index 403e2ad..b4b4a03 100644 --- a/docs/topics/_includes/what-is-onedir.rst +++ b/docs/topics/_includes/what-is-onedir.rst @@ -4,7 +4,7 @@ include the version of Python needed to run Salt and Salt's required dependencies. - Beginning with the release of Salt 3006 (Sulfur), the Salt Project has phased + Beginning with the release of Salt 3006 LTS (Sulfur), the Salt Project has phased out classic package builds for supported operating systems. Update your Salt infrastructure to the onedir packages as soon as possible. See :ref:`upgrade-to-onedir` for more information. diff --git a/docs/topics/_includes/windows-downloads.rst b/docs/topics/_includes/windows-downloads.rst index c738924..41f35a3 100644 --- a/docs/topics/_includes/windows-downloads.rst +++ b/docs/topics/_includes/windows-downloads.rst @@ -1,24 +1,65 @@ +3006 LTS Downloads +------------------ + +.. list-table:: + :widths: 10 10 15 65 + :header-rows: 1 + :class: windows-mac-download + + * - Arch + - File type + - Salt Release Type + - Download install file + + * - AMD64 + - exe + - LTS + - |windows-amd64-exe-lts-download| + + * - AMD64 + - msi + - LTS + - |windows-amd64-msi-lts-download| + + * - x86 + - exe + - LTS + - |windows-x86-exe-lts-download| + + * - x86 + - msi + - LTS + - |windows-x86-msi-lts-download| + +3007 STS Downloads +------------------ + .. list-table:: - :widths: 10 10 80 + :widths: 10 10 15 65 :header-rows: 1 :class: windows-mac-download * - Arch - File type + - Salt Release Type - Download install file * - AMD64 - exe - - |windows-amd64-exe-download| + - STS + - |windows-amd64-exe-sts-download| * - AMD64 - msi - - |windows-amd64-msi-download| + - STS + - |windows-amd64-msi-sts-download| * - x86 - exe - - |windows-x86-exe-download| + - STS + - |windows-x86-exe-sts-download| * - x86 - msi - - |windows-x86-msi-download| + - STS + - |windows-x86-msi-sts-download| diff --git a/docs/topics/access-old-packages.rst b/docs/topics/access-old-packages.rst index 130fac0..78baaa1 100644 --- a/docs/topics/access-old-packages.rst +++ b/docs/topics/access-old-packages.rst @@ -6,8 +6,8 @@ Access old packages of Salt The current supported versions of Salt are: -* |supported-release-1| -* |supported-release-2| +* Salt |minor-lts-version| +* Salt |minor-sts-version| See :ref:`salt-version-support-lifecycle` for more information about the support policy for older versions. @@ -17,17 +17,8 @@ policy for older versions. you will no longer receive package updates from Salt, including important security updates such as CVE releases. -Packages for unsupported versions of Salt are available in the repository -archives. Once a version of Salt enters extended life support, it is moved into -the repository archives and the package URL changes so that it is prepended with -``archive``. For example: +.. warning:: -.. list-table:: - :widths: 20 80 - :stub-columns: 1 - - * - Previous URL - - https://repo.saltproject.io/py3/amazon/2/x86_64/3001.repo - - * - Archive URL - - https://archive.repo.saltproject.io/py3/amazon/2/x86_64/3001.repo + Packages for unsupported versions of Salt, older than Salt 3006 LTS, are + **NO LONGER AVAILABLE** in the Salt package repositories. See + `Salt Blog: Salt Project Package Repository (repo.saltproject.io) Migration and Guidance `__ diff --git a/docs/topics/announcements.rst b/docs/topics/announcements.rst new file mode 100644 index 0000000..93ee530 --- /dev/null +++ b/docs/topics/announcements.rst @@ -0,0 +1,49 @@ +.. _announcements: + +============= +Announcements +============= + +.. |date| date:: + +.. article-info:: + :avatar: ../_static/img/SaltProject_Logomark_teal.png + :avatar-link: https://saltproject.io/ + :avatar-outline: muted + :date: Last updated on |date| + :author: **The Salt Project** + :class-container: sd-p-2 sd-outline-muted sd-rounded-1 + + +Security announcements +====================== + +See `Security announcements `_ +for the latest announcements. + +.. Important:: + To be notified of the latest security updates, subscribe to the + `Salt security announcements RSS feed `_. + + +Release announcements +===================== + +* **July 30, 2024:** `3006.9 `_ is now available. +* **May 22, 2024:** `3007.1 `_ is now available. +* **April 30, 2024:** `3006.8 `_ is now available. +* **March 6, 2024:** `3007.0 `_ is now available. +* **February 21, 2024:** `3006.7 `_ is now available. +* **January 31, 2024:** `3006.6 `_ is now available. +* **January 31, 2024:** `3005.5 `_ is now available. +* **December 12, 2023:** `3006.5 `_ is now available. +* **October 27, 2023:** `3006.4 `_ is now available. +* **October 27, 2023:** `3005.4 `_ is now available. +* **September 21, 2023:** `3005.3 `_ is now available. +* **September 7, 2023:** `3006.3 `_ is now available. +* **August 10, 2023:** `3006.2 `_ is now available. +* **August 10, 2023:** `3005.2 `_ is now available. +* **May 5, 2023:** `3006.1 `_ is now available. +* **April 18, 2023:** `3006.0 `_ is now available. +* **October 4, 2022:** `3005.1 `_ is now available. +* **August 25, 2022:** `3005 `_ is now available. diff --git a/docs/topics/bootstrap.rst b/docs/topics/bootstrap.rst index 1fd9705..82ec47e 100644 --- a/docs/topics/bootstrap.rst +++ b/docs/topics/bootstrap.rst @@ -9,7 +9,7 @@ Bootstrap installation About the Salt bootstrap installation ===================================== -The `Salt Bootstrap project `_ maintains a +The `Salt Bootstrap project `_ maintains a Bash shell script that installs Salt on any Linux/Unix platform. The script installs ``salt-master`` and ``salt-minion`` system packages and enables Salt services automatically. @@ -25,7 +25,7 @@ For example: .. parsed-literal:: - bootstrap-salt.sh -P stable |release| + bootstrap-salt.sh -P stable |minor-lts-version| For more information, see: @@ -52,14 +52,14 @@ The bootstrap script can be used to install specific services: .. code-block:: bash - curl -o bootstrap-salt.sh -L https://bootstrap.saltproject.io + curl -o bootstrap-salt.sh -L https://github.com/saltstack/salt-bootstrap/releases/latest/download/bootstrap-salt.sh .. Note:: Alternatively, to download the bash script and run it immediately, use: .. code-block:: bash - curl -L https://bootstrap.saltproject.io | sudo sh -s -- + curl -L https://github.com/saltstack/salt-bootstrap/releases/latest/download/bootstrap-salt.sh | sudo sh -s -- .. Warning:: @@ -142,7 +142,7 @@ Installation types .. parsed-literal:: - bootstrap-salt.sh -P stable |release| + bootstrap-salt.sh -P stable |minor-lts-version| bootstrap-salt.sh stable v3004.2 * - ``onedir`` @@ -240,8 +240,8 @@ The following are the most commonly used bootstrap options: .. parsed-literal:: - bootstrap-salt.sh -A 192.0.2.1 stable |release| - bootstrap-salt.sh -A fqdn.example.com stable |release| + bootstrap-salt.sh -A 192.0.2.1 stable |minor-lts-version| + bootstrap-salt.sh -A fqdn.example.com stable |minor-lts-version| * - ``-i `` - The ``-i`` flag sets the ``/etc/salt/minion_id`` file to the minion ID you @@ -257,8 +257,8 @@ The following are the most commonly used bootstrap options: .. parsed-literal:: - bootstrap-salt.sh -i apache-server-1 stable |release| - bootstrap-salt.sh -i center-3-rack-2 stable |release| + bootstrap-salt.sh -i apache-server-1 stable |minor-lts-version| + bootstrap-salt.sh -i center-3-rack-2 stable |minor-lts-version| * - ``-R`` - Specify a custom repository URL if you have created a mirror repository diff --git a/docs/topics/downloads.rst b/docs/topics/downloads.rst index 60abbf4..dd4cee5 100644 --- a/docs/topics/downloads.rst +++ b/docs/topics/downloads.rst @@ -4,21 +4,9 @@ Downloads ========= -.. include:: _includes/supported-salt-releases-sidebar.rst - - Welcome to the Salt download page! -* Salt packages are hosted on `repo.saltproject.io `_. -* For unsupported versions: - - * PY3 packages are in the `archive repository `_ - under the ``py3`` and ``salt/py3`` directories. - * PY2 packages are in the `archive repository `__ - under the ``yum`` and ``apt`` directories. Other PY2 packages may be found - under their respective directories, such as ``osx``, ``windows``, - ``freebsd``, and so forth. - +* Salt packages are hosted on `packages.broadcom.com `_. The following sections provide links to the repository for each operating system as well as links to the installation instructions for each operating @@ -30,92 +18,47 @@ system. verifying the package URL is an official Salt repository. -Amazon Linux 2 -============== -Install the Amazon Linux 2 package using a Linux package manager. - -.. grid:: 2 - - .. grid-item-card:: Browse the repo for Amazon Linux 2 packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/amazon/ - - :bdg-danger:`Amazon Linux 2` - |supported-release-1-badge| - - .. grid-item-card:: Amazon Linux 2 install guide - :class-card: sd-border-1 - :link: install-amazon - :link-type: ref - - :bdg-info:`Install Salt on Amazon Linux 2` - - -CentOS -====== -Install the CentOS package using a yum package manager. - -.. grid:: 2 - - .. grid-item-card:: Browse the repo for CentOS packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/redhat/ - - :bdg-danger:`CentOS` - |supported-release-1-badge| - - .. grid-item-card:: CentOS install guide - :class-card: sd-border-1 - :link: install-centos - :link-type: ref - - :bdg-info:`Install Salt on CentOS` - - -Debian -====== -Install the Debian package using an apt package manager. +Linux (RPM) +=========== .. grid:: 2 - .. grid-item-card:: Browse the repo for Debian packages + .. grid-item-card:: Browse the repo for RPM packages :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/debian/ + :link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-rpm - :bdg-danger:`Debian` - |supported-release-1-badge| + :bdg-primary:`rpm` + |minor-lts-version-badge| - .. grid-item-card:: Debian install guide + .. grid-item-card:: RPM install guide :class-card: sd-border-1 - :link: install-debian + :link: install-rpm :link-type: ref - :bdg-info:`Install Salt on Debian` - + :bdg-info:`Install Salt on RHEL-like systems` -Fedora -====== -Install the Fedora package using a yum package manager. +Linux (DEB) +=========== .. grid:: 2 - .. grid-item-card:: Browse the repo for Fedora packages + .. grid-item-card:: Browse the repo for DEB packages :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/fedora/ + :link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-deb - :bdg-danger:`Fedora` - |supported-release-1-badge| + :bdg-primary:`rpm` + |minor-lts-version-badge| - .. grid-item-card:: Fedora install guide + .. grid-item-card:: DEB install guide :class-card: sd-border-1 - :link: install-fedora + :link: install-rpm :link-type: ref - :bdg-info:`Install Salt on Fedora` - + :bdg-info:`Install Salt on Debian-like systems` macOS ===== + Download the macOS package and run the file to install Salt. See the :ref:`install-macos` install guide for more information. @@ -125,10 +68,10 @@ Download the macOS package and run the file to install Salt. See the .. grid-item-card:: Browse the repo for macOS packages :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/macos + :link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-generic/macos :bdg-danger:`macOS` - |supported-release-1-badge| + |minor-lts-version-badge| .. grid-item-card:: macOS install guide :class-card: sd-border-1 @@ -138,108 +81,9 @@ Download the macOS package and run the file to install Salt. See the :bdg-info:`Install Salt on macOS` -Photon OS -========= -Install the Photon OS package using a tdnf package manager. - -.. grid:: 2 - - .. grid-item-card:: Browse the repo for Photon OS packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/photon/ - - :bdg-danger:`Photon OS` - |supported-release-1-badge| - - .. grid-item-card:: Photon OS install guide - :class-card: sd-border-1 - :link: install-photonos - :link-type: ref - - :bdg-info:`Install Salt on Photon OS` - - -RedHat -====== -Install the RedHat package using a yum package manager. - -.. grid:: 2 - - .. grid-item-card:: Browse the repo for RedHat (RHEL) packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/redhat/ - - :bdg-danger:`RedHat` - |supported-release-1-badge| - - .. grid-item-card:: RedHat install guide - :class-card: sd-border-1 - :link: install-rhel - :link-type: ref - - :bdg-info:`Install Salt on RedHat` - - -Rocky Linux -=========== -Install the Rocky Linux package using a yum package manager. - -.. grid:: 2 - - .. grid-item-card:: Browse the repo for Rocky Linux packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/redhat/ - - :bdg-danger:`Rocky Linux` - |supported-release-1-badge| - - .. grid-item-card:: Rocky Linux install guide - :class-card: sd-border-1 - :link: install-rocky - :link-type: ref - - :bdg-info:`Install Salt on Rocky Linux` - - -SUSE (SLES) -=========== -Install the SUSE (SLES) package from the SUSE package repository. SUSE creates -its own Salt packages and the Salt Project does not publish separate Salt -packages for download. - -.. grid:: 2 - - .. grid-item-card:: SUSE (SLES) install guide - :class-card: sd-border-1 - :link: install-sles - :link-type: ref - - :bdg-info:`Install Salt on SUSE (SLES)` - - -Ubuntu -====== -Install the Ubuntu package using an apt package manager. - -.. grid:: 2 - - .. grid-item-card:: Browse the repo for Ubuntu packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/ubuntu/ - - :bdg-danger:`Ubuntu` - |supported-release-1-badge| - - .. grid-item-card:: Ubuntu install guide - :class-card: sd-border-1 - :link: install-ubuntu - :link-type: ref - - :bdg-info:`Install Salt on Ubuntu` - - Windows ======= + Download the Windows package and run the file to install Salt. See the :ref:`install-windows` install guide for more information. @@ -249,10 +93,10 @@ Download the Windows package and run the file to install Salt. See the .. grid-item-card:: Browse the repo for Windows packages :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/windows/ + :link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-generic/windows :bdg-danger:`Windows` - |supported-release-1-badge| + |minor-lts-version-badge| .. grid-item-card:: Windows install guide :class-card: sd-border-1 diff --git a/docs/topics/install-by-operating-system/amazon.rst b/docs/topics/install-by-operating-system/amazon.rst deleted file mode 100644 index 7278edd..0000000 --- a/docs/topics/install-by-operating-system/amazon.rst +++ /dev/null @@ -1,342 +0,0 @@ -.. _install-amazon: - -============ -Amazon Linux -============ - -These instructions explain how to install Salt on Amazon Linux 2 operating -systems: - -* `Install Salt on Amazon Linux 2 x86_64`_ -* `Install Salt on Amazon Linux 2 aarch64 and arm64`_ -* `Install Salt on Amazon Linux 2023 x86_64`_ -* `Install Salt on Amazon Linux 2023 aarch64 and arm64`_ - -.. include:: ../_includes/what-is-onedir.rst - -.. include:: ../_includes/intro-install-by-os.rst - - -Install Salt on Amazon Linux 2 x86_64 -===================================== -To install the :ref:`onedir` packages of Salt on Amazon Linux 2 for x86_64 -architecture: - -#. Run the following commands to install the Salt Project repository and key: - - .. tab-set:: - - .. tab-item:: Amazon Linux 2 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Amazon Linux 2**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2-latest-gpg-x86_64|\ - - curl -fsSL \ |amazon-linux2-latest-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Amazon Linux 2 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Amazon Linux 2**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2-major-gpg-x86_64|\ - - curl -fsSL \ |amazon-linux2-major-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Amazon Linux 2 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Amazon Linux 2**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2-minor-gpg-x86_64|\ - - curl -fsSL \ |amazon-linux2-minor-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start service for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - - .. include:: ../_includes/install-dependencies-onedir.rst - - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Amazon Linux 2 aarch64 and arm64 -================================================ -To install the :ref:`onedir` packages of Salt on Amazon Linux 2 for aarch64 and -arm64 architectures: - -#. Run the following commands to install the Salt Project repository and key: - - .. tab-set:: - - .. tab-item:: Amazon Linux 2 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Amazon Linux 2**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2-latest-gpg-arm64|\ - - curl -fsSL \ |amazon-linux2-latest-download-arm64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Amazon Linux 2 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Amazon Linux 2**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2-major-gpg-arm64|\ - - curl -fsSL \ |amazon-linux2-major-download-arm64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Amazon Linux 2 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Amazon Linux 2**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2-minor-gpg-arm64|\ - - curl -fsSL \ |amazon-linux2-minor-download-arm64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start service for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - - .. include:: ../_includes/install-dependencies-onedir.rst - - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Amazon Linux 2023 x86_64 -======================================== -To install the :ref:`onedir` packages of Salt on Amazon Linux 2023 for x86_64 -architecture: - -#. Run the following commands to install the Salt Project repository and key: - - .. tab-set:: - - .. tab-item:: Amazon Linux 2023 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Amazon Linux 2023**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2023-latest-gpg-x86_64|\ - - curl -fsSL \ |amazon-linux2023-latest-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Amazon Linux 2023 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Amazon Linux 2023**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2023-major-gpg-x86_64|\ - - curl -fsSL \ |amazon-linux2023-major-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Amazon Linux 2023 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Amazon Linux 2023**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2023-minor-gpg-x86_64|\ - - curl -fsSL \ |amazon-linux2023-minor-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start service for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - - .. include:: ../_includes/install-dependencies-onedir.rst - - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Amazon Linux 2023 aarch64 and arm64 -=================================================== -To install the :ref:`onedir` packages of Salt on Amazon Linux 2023 for aarch64 and -arm64 architectures: - -#. Run the following commands to install the Salt Project repository and key: - - .. tab-set:: - - .. tab-item:: Amazon Linux 2023 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Amazon Linux 2023**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2023-latest-gpg-arm64|\ - - curl -fsSL \ |amazon-linux2023-latest-download-arm64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Amazon Linux 2023 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Amazon Linux 2023**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2023-major-gpg-arm64|\ - - curl -fsSL \ |amazon-linux2023-major-download-arm64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Amazon Linux 2023 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Amazon Linux 2023**: - - .. parsed-literal:: - - sudo rpm --import \ |amazon-linux2023-minor-gpg-arm64|\ - - curl -fsSL \ |amazon-linux2023-minor-download-arm64|\ | sudo tee /etc/yum.repos.d/salt-amzn.repo - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start service for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - - .. include:: ../_includes/install-dependencies-onedir.rst - - -.. include:: ../_includes/post-install-by-os.rst - - -Browse the repo -=============== - -.. card:: Browse the repo for Amazon Linux packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/amazon/ - :width: 50% - - :bdg-primary:`Amazon Linux 2` - :bdg-primary:`Amazon Linux 2023` - |supported-release-1-badge| diff --git a/docs/topics/install-by-operating-system/centos.rst b/docs/topics/install-by-operating-system/centos.rst deleted file mode 100644 index e14c31b..0000000 --- a/docs/topics/install-by-operating-system/centos.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _install-centos: - -====== -CentOS -====== - -For CentOS Stream 9, use the instructions for installing Salt on -:ref:`install-rocky`. diff --git a/docs/topics/install-by-operating-system/debian.rst b/docs/topics/install-by-operating-system/debian.rst deleted file mode 100644 index 5d6effd..0000000 --- a/docs/topics/install-by-operating-system/debian.rst +++ /dev/null @@ -1,367 +0,0 @@ -.. _install-debian: - -====== -Debian -====== - -These instructions explain how to install Salt on Debian operating systems: - -* `Install Salt on Debian 12 (Bookworm) amd64`_ -* `Install Salt on Debian 12 (Bookworm) arm64`_ -* `Install Salt on Debian 11 (Bullseye) amd64`_ -* `Install Salt on Debian 11 (Bullseye) arm64`_ - -.. include:: ../_includes/what-is-onedir.rst - -.. include:: ../_includes/intro-install-by-os.rst - - -Install Salt on Debian 12 (Bookworm) amd64 -========================================== -To install the :ref:`onedir` packages of Salt on Debian 12 (Bookworm) for -amd64 architecture: - -#. Run the following commands to import the Salt Project repository key, and to - create the apt sources list file: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Debian 12 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Debian 12 (Bookworm)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg |debian12-latest-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |debian12-latest-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Debian 12 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Debian 12 (Bookworm)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |debian12-major-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |debian12-major-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Debian 12 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Debian 12 (Bookworm)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |debian12-minor-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |debian12-minor-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo apt-get update`` to update your packages. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo apt-get install salt-master - sudo apt-get install salt-minion - sudo apt-get install salt-ssh - sudo apt-get install salt-syndic - sudo apt-get install salt-cloud - sudo apt-get install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Debian 12 (Bookworm) arm64 -========================================== -To install the :ref:`onedir` packages of Salt on Debian 12 (Bookworm) for -arm64 architecture: - -#. Run the following commands to import the Salt Project repository key, and to - create the apt sources list file: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Debian 12 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Debian 12 (Bookworm)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg |debian12-latest-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |debian12-latest-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Debian 12 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Debian 12 (Bookworm)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |debian12-major-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |debian12-major-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Debian 12 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Debian 12 (Bookworm)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |debian12-minor-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |debian12-minor-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo apt-get update`` to update your packages. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo apt-get install salt-master - sudo apt-get install salt-minion - sudo apt-get install salt-ssh - sudo apt-get install salt-syndic - sudo apt-get install salt-cloud - sudo apt-get install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Debian 11 (Bullseye) amd64 -===================================================== -To install the :ref:`onedir` packages of Salt on Debian 11 (Bullseye) for -amd64 architecture: - -#. Run the following commands to import the Salt Project repository key, and to - create the apt sources list file: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Debian 11 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Debian 11 (Bullseye)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg |debian11-latest-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |debian11-latest-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Debian 11 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Debian 11 (Bullseye)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |debian11-major-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |debian11-major-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Debian 11 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Debian 11 (Bullseye)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |debian11-minor-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |debian11-minor-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo apt-get update`` to update your packages. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo apt-get install salt-master - sudo apt-get install salt-minion - sudo apt-get install salt-ssh - sudo apt-get install salt-syndic - sudo apt-get install salt-cloud - sudo apt-get install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Debian 11 (Bullseye) arm64 -====================================================== -To install the :ref:`onedir` packages of Salt on Debian 11 (Bullseye) for -arm64 architecture: - -#. Run the following commands to import the Salt Project repository key, and to - create the apt sources list file: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Debian 11 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Debian 11 (Bullseye)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg |debian11-latest-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |debian11-latest-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Debian 11 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Debian 11 (Bullseye)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |debian11-major-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |debian11-major-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Debian 11 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Debian 11 (Bullseye)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |debian11-minor-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |debian11-minor-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo apt-get update`` to update your packages. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo apt-get install salt-master - sudo apt-get install salt-minion - sudo apt-get install salt-ssh - sudo apt-get install salt-syndic - sudo apt-get install salt-cloud - sudo apt-get install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - -Browse the repo -=============== - -.. card:: Browse the repo for Debian packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/debian/ - :width: 50% - - :bdg-primary:`Debian` - |supported-release-1-badge| diff --git a/docs/topics/install-by-operating-system/fedora.rst b/docs/topics/install-by-operating-system/fedora.rst deleted file mode 100644 index 6c3ca6d..0000000 --- a/docs/topics/install-by-operating-system/fedora.rst +++ /dev/null @@ -1,212 +0,0 @@ -.. _install-fedora: - -====== -Fedora -====== - -These instructions explain how to install Salt on Fedora operating systems: - -* `Install Salt on Fedora 40 x86_64`_ -* `Install Salt on Fedora 40 aarch64 and arm64`_ - -.. include:: ../_includes/what-is-onedir.rst - -.. include:: ../_includes/intro-install-by-os.rst - - -Install Salt on Fedora 40 x86_64 -================================ -To install Salt on Fedora 40 for x86_64 architecture: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Fedora 40 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Fedora 40**: - - .. parsed-literal:: - - sudo rpm --import \ |fedora40-latest-gpg-x86_64|\ - - curl -fsSL \ |fedora40-latest-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Fedora 40 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Fedora 40**: - - .. parsed-literal:: - - sudo rpm --import \ |fedora40-major-gpg-x86_64|\ - - curl -fsSL \ |fedora40-major-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Fedora 40 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Fedora 40**: - - .. parsed-literal:: - - sudo rpm --import \ |fedora40-minor-gpg-x86_64|\ - - curl -fsSL \ |fedora40-minor-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - - .. Note:: - Because of the presence of classic packages of Salt in EPEL, it's - possible that when you download the package from EPEL, it instead - downloads classic packages of older versions of Salt instead of the - onedir packages. - - During depsolving, when choosing the best provider among several, `yum` - respects the priority of each provider's repository. The value is an - integer from 1 to 99, with 1 being the most preferred repository and 99 - the least preferred. By default all repositories have the priority of 80. - - EPEL was treating the Salt repository as 99. To resolve this issue, Salt - has changed its priority level to 10 for RHEL 7, 8, and 9. - - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Fedora 40 aarch64 and arm64 -=========================================== -To install Salt on Fedora 40 for aarch64 and arm64 architectures: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Fedora 40 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Fedora 40**: - - .. parsed-literal:: - - sudo rpm --import \ |fedora40-latest-gpg-arm64|\ - - curl -fsSL \ |fedora40-latest-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Fedora 40 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Fedora 40**: - - .. parsed-literal:: - - sudo rpm --import \ |fedora40-major-gpg-arm64|\ - - curl -fsSL \ |fedora40-major-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Fedora 40 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Fedora 40**: - - .. parsed-literal:: - - sudo rpm --import \ |fedora40-minor-gpg-arm64|\ - - curl -fsSL \ |fedora40-minor-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - - .. Note:: - Because of the presence of classic packages of Salt in EPEL, it's - possible that when you download the package from EPEL, it instead - downloads classic packages of older versions of Salt instead of the - onedir packages. - - During depsolving, when choosing the best provider among several, `yum` - respects the priority of each provider's repository. The value is an - integer from 1 to 99, with 1 being the most preferred repository and 99 - the least preferred. By default all repositories have the priority of 80. - - EPEL was treating the Salt repository as 99. To resolve this issue, Salt - has changed its priority level to 10 for RHEL 7, 8, and 9. - - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Browse the repo -=============== - -.. card:: Browse the repo for Fedora packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/fedora/ - :width: 50% - - :bdg-primary:`Fedora` - |supported-release-1-badge| diff --git a/docs/topics/install-by-operating-system/index.rst b/docs/topics/install-by-operating-system/index.rst index 72a9017..5bef65e 100644 --- a/docs/topics/install-by-operating-system/index.rst +++ b/docs/topics/install-by-operating-system/index.rst @@ -8,14 +8,6 @@ These instructions explain how to manually install Salt on various operating systems. See :ref:`overview` for an overview of the steps involved in installing Salt. -.. Warning:: - Pay close attention to package versions when navigating - `repo.saltproject.io `_. For example, - if you are using a RedHat 7 variant, make sure you select RedHat and then - select version 7. Otherwise, you will get the wrong repo and will install - RedHat 8 Salt packages on a RedHat 7. Version incompatibility will throw - unknown errors. - .. toctree:: :maxdepth: 1 :glob: diff --git a/docs/topics/install-by-operating-system/linux-deb.rst b/docs/topics/install-by-operating-system/linux-deb.rst new file mode 100644 index 0000000..9aa13d2 --- /dev/null +++ b/docs/topics/install-by-operating-system/linux-deb.rst @@ -0,0 +1,229 @@ +.. _install-deb: + +=========== +Linux (DEB) +=========== + +These instructions explain how to install Salt rpms on operating systems that +are Debian-like (using `apt-get` install methods). + +For a list of supported and tested operating systems, for running Salt, +see :ref:`salt-supported-operating-systems`. + + +Install Salt DEBs +================= + +#. Run the following command to install the Salt Project repository: + + .. code-block:: bash + + # Ensure keyrings dir exists + mkdir -p /etc/apt/keyrings + # Download public key + curl -fsSL https://packages.broadcom.com/artifactory/api/security/keypair/SaltProjectKey/public | sudo tee /etc/apt/keyrings/salt-archive-keyring-2023.pgp + # Create apt repo target configuration + curl -fsSL https://github.com/saltstack/salt-install-guide/releases/latest/download/salt.sources | sudo tee /etc/apt/sources.list.d/salt.sources + +#. Run ``sudo apt update`` to update metadata. + +#. Install the salt-minion, salt-master, or other Salt components: + + .. tab-set:: + + .. tab-item:: 3006 LTS + + Populate ``/etc/apt/preferences.d/salt-pin-1001`` in order to restrict upgrades to Salt 3006.x LTS: + + .. code-block:: bash + + echo 'Package: salt-* + Pin: version 3006.* + Pin-Priority: 1001' | sudo tee /etc/apt/preferences.d/salt-pin-1001 + + Available installs: + + .. code-block:: bash + + sudo apt-get install salt-master + sudo apt-get install salt-minion + sudo apt-get install salt-ssh + sudo apt-get install salt-syndic + sudo apt-get install salt-cloud + sudo apt-get install salt-api + + If wanting to install by a target point release, append the specific Salt + full release version. For example: + + .. code-block:: bash + + sudo apt-get install salt-common=3006.9 + sudo apt-get install salt-master=3006.9 + sudo apt-get install salt-minion=3006.9 + sudo apt-get install salt-ssh=3006.9 + sudo apt-get install salt-syndic=3006.9 + sudo apt-get install salt-cloud=3006.9 + sudo apt-get install salt-api=3006.9 + + .. code-block:: bash + + # Example commands for pinning a current package minor so that + # it is skipped during system-wide apt-get upgrade events + sudo apt-mark hold salt-master + sudo apt-mark hold salt-minion + sudo apt-mark hold salt-ssh + sudo apt-mark hold salt-syndic + sudo apt-mark hold salt-cloud + sudo apt-mark hold salt-api + + .. warning:: Salt dependency conflicts + + If going with a non-latest point release of a target major version, you may be + required to install other salt packages in a pinned fashion. For example, to install + ``salt-minion=3006.8``, a user will be required to install ``salt-common`` at the same version: + + .. code-block:: bash + + sudo apt-get install salt-minion=3006.8 salt-common=3006.8 + + + .. tab-item:: 3007 STS + + .. warning:: STS not recommended for Production + + Salt Project recommends deploying LTS releases for Production environments. + + Populate ``/etc/apt/preferences.d/salt-pin-1001`` in order to restrict upgrades to Salt 3007.x STS: + + .. code-block:: bash + + echo 'Package: salt-* + Pin: version 3007.* + Pin-Priority: 1001' | sudo tee /etc/apt/preferences.d/salt-pin-1001 + + Available installs: + + .. code-block:: bash + + sudo apt-get install salt-master + sudo apt-get install salt-minion + sudo apt-get install salt-ssh + sudo apt-get install salt-syndic + sudo apt-get install salt-cloud + sudo apt-get install salt-api + + If wanting to install by a target point release, append the specific Salt + full release version. For example: + + .. code-block:: bash + + sudo apt-get install salt-common=3007.1 + sudo apt-get install salt-master=3007.1 + sudo apt-get install salt-minion=3007.1 + sudo apt-get install salt-ssh=3007.1 + sudo apt-get install salt-syndic=3007.1 + sudo apt-get install salt-cloud=3007.1 + sudo apt-get install salt-api=3007.1 + + .. code-block:: bash + + # Example commands for pinning a current package minor so that + # it is skipped during system-wide apt-get upgrade events + sudo apt-mark hold salt-master + sudo apt-mark hold salt-minion + sudo apt-mark hold salt-ssh + sudo apt-mark hold salt-syndic + sudo apt-mark hold salt-cloud + sudo apt-mark hold salt-api + + .. warning:: Salt dependency conflicts + + If going with a non-latest point release of a target major version, you may be + required to install other salt packages in a pinned fashion. For example, to install + ``salt-minion=3007.0``, a user will be required to install ``salt-common`` at the same version: + + .. code-block:: bash + + sudo apt-get install salt-minion==3007.0 salt-common==3007.0 + + + .. tab-item:: LATEST Available + + .. warning:: STS not recommended for Production + + Salt Project recommends deploying LTS releases for Production environments. + + If users would like to leave installs to come from either LTS or STS, whichever + major version is latest. + + Available installs: + + .. code-block:: bash + + sudo apt-get install salt-master + sudo apt-get install salt-minion + sudo apt-get install salt-ssh + sudo apt-get install salt-syndic + sudo apt-get install salt-cloud + sudo apt-get install salt-api + + If wanting to install by a target point release, append the specific Salt + full release version. For example: + + .. code-block:: bash + + sudo apt-get install salt-common=3007.1 + sudo apt-get install salt-master=3007.1 + sudo apt-get install salt-minion=3007.1 + sudo apt-get install salt-ssh=3007.1 + sudo apt-get install salt-syndic=3007.1 + sudo apt-get install salt-cloud=3007.1 + sudo apt-get install salt-api=3007.1 + + .. code-block:: bash + + # Example commands for pinning a current package minor so that + # it is skipped during system-wide apt-get upgrade events + sudo apt-mark hold salt-master + sudo apt-mark hold salt-minion + sudo apt-mark hold salt-ssh + sudo apt-mark hold salt-syndic + sudo apt-mark hold salt-cloud + sudo apt-mark hold salt-api + + .. warning:: + + If going with a non-latest point release of a target major version, you may be + required to install other salt packages in a pinned fashion. For example, to install + ``salt-minion=3007.0``, a user will be required to install ``salt-common`` at the same version: + + .. code-block:: bash + + sudo apt-get install salt-minion==3007.0 salt-common==3007.0 + + +#. Enable and start the Salt services + + Available services: + + .. code-block:: bash + + sudo systemctl enable salt-master && sudo systemctl start salt-master + sudo systemctl enable salt-minion && sudo systemctl start salt-minion + sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic + sudo systemctl enable salt-api && sudo systemctl start salt-api + + .. include:: ../_includes/install-dependencies-onedir.rst + +.. include:: ../_includes/post-install-by-os.rst + +Browse the repo +=============== + +.. card:: Browse the repo for DEB packages + :class-card: sd-border-1 + :link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-deb + :width: 50% + + :bdg-primary:`deb` + |minor-lts-version-badge| diff --git a/docs/topics/install-by-operating-system/linux-rpm.rst b/docs/topics/install-by-operating-system/linux-rpm.rst new file mode 100644 index 0000000..cf3b235 --- /dev/null +++ b/docs/topics/install-by-operating-system/linux-rpm.rst @@ -0,0 +1,174 @@ +.. _install-rpm: + +=========== +Linux (RPM) +=========== + +These instructions explain how to install Salt rpms on operating systems that +are RHEL-like (using `dnf` install methods). + +For a list of supported and tested operating systems, for running Salt, +see :ref:`salt-supported-operating-systems`. + +.. include:: ../_includes/what-is-onedir.rst + +.. include:: ../_includes/intro-install-by-os.rst + + +Install Salt RPMs +================= + +#. Run the following command to install the Salt Project repository: + + .. code-block:: bash + + curl -fsSL https://github.com/saltstack/salt-install-guide/releases/latest/download/salt.repo | sudo tee /etc/yum.repos.d/salt.repo + + .. Note:: + Because of the presence of classic packages of Salt in EPEL, it's + possible that when you download the package from EPEL, it instead + downloads classic packages of older versions of Salt instead of the + onedir packages. + + During depsolving, when choosing the best provider among several, `yum` + respects the priority of each provider's repository. The value is an + integer from 1 to 99, with 1 being the most preferred repository and 99 + the least preferred. By default all repositories have the priority of 80. + + EPEL was treating the Salt repository as 99. To resolve this issue, Salt + has changed its priority level to 10 for RHEL 8 and 9. + +#. Run ``sudo dnf clean expire-cache`` to clear the repository metadata. + +#. Install the salt-minion, salt-master, or other Salt components: + + .. tab-set:: + + .. tab-item:: 3006 LTS + + Available installs: + + .. code-block:: bash + + sudo dnf install salt-master + sudo dnf install salt-minion + sudo dnf install salt-ssh + sudo dnf install salt-syndic + sudo dnf install salt-cloud + sudo dnf install salt-api + + If wanting to install by a target point release, append the specific Salt + full release version. For example: + + .. code-block:: bash + + sudo dnf install salt-master-3006.9 + sudo dnf install salt-minion-3006.9 + sudo dnf install salt-ssh-3006.9 + sudo dnf install salt-syndic-3006.9 + sudo dnf install salt-cloud-3006.9 + sudo dnf install salt-api-3006.9 + + + .. tab-item:: 3007 STS + + .. warning:: STS not recommended for Production + + Salt Project recommends deploying LTS releases for Production environments. + + If users would like to restrict their installs to the Salt 3007 STS point releases, + these install steps include enabling Salt 3007 STS release downloads. + + .. code-block:: bash + + # Enable the Salt 3007 STS repo + sudo dnf config-manager --set-disable salt-repo-* + sudo dnf config-manager --set-enabled salt-repo-3007-sts + + Available installs: + + .. code-block:: bash + + sudo dnf install salt-master + sudo dnf install salt-minion + sudo dnf install salt-ssh + sudo dnf install salt-syndic + sudo dnf install salt-cloud + sudo dnf install salt-api + + If wanting to install by a target point release, append the specific Salt + full release version. For example: + + .. code-block:: bash + + sudo dnf install salt-master-3007.1 + sudo dnf install salt-minion-3007.1 + sudo dnf install salt-ssh-3007.1 + sudo dnf install salt-syndic-3007.1 + sudo dnf install salt-cloud-3007.1 + sudo dnf install salt-api-3007.1 + + + .. tab-item:: LATEST Available + + .. warning:: STS not recommended for Production + + Salt Project recommends deploying LTS releases for Production environments. + + If users would like to leave installs to come from either LTS or STS, whichever + major version is latest. + + .. code-block:: bash + + # Enable the Salt LATEST repo + sudo dnf config-manager --set-disable salt-repo-* + sudo dnf config-manager --set-enabled salt-repo-latest + + Available installs: + + .. code-block:: bash + + sudo dnf install salt-master + sudo dnf install salt-minion + sudo dnf install salt-ssh + sudo dnf install salt-syndic + sudo dnf install salt-cloud + sudo dnf install salt-api + + If wanting to install by a target point release, append the specific Salt + full release version. For example: + + .. code-block:: bash + + sudo dnf install salt-master-3007.1 + sudo dnf install salt-minion-3007.1 + sudo dnf install salt-ssh-3007.1 + sudo dnf install salt-syndic-3007.1 + sudo dnf install salt-cloud-3007.1 + sudo dnf install salt-api-3007.1 + +#. Enable and start the Salt services: + + Available services: + + .. code-block:: bash + + sudo systemctl enable salt-master && sudo systemctl start salt-master + sudo systemctl enable salt-minion && sudo systemctl start salt-minion + sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic + sudo systemctl enable salt-api && sudo systemctl start salt-api + + .. include:: ../_includes/install-dependencies-onedir.rst + +.. include:: ../_includes/post-install-by-os.rst + +Browse the repo +=============== + +.. card:: Browse the repo for RPM packages + :class-card: sd-border-1 + :link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-rpm + :width: 50% + + :bdg-primary:`rpm` + |minor-lts-version-badge| diff --git a/docs/topics/install-by-operating-system/macos.rst b/docs/topics/install-by-operating-system/macos.rst index d6265ff..029728d 100644 --- a/docs/topics/install-by-operating-system/macos.rst +++ b/docs/topics/install-by-operating-system/macos.rst @@ -66,8 +66,8 @@ Browse the repo =============== .. card:: Browse the repo for macOS packages - :link: https://repo.saltproject.io/salt/py3/macos + :link: :link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-generic/macos :width: 50% :bdg-primary:`macOS` - |supported-release-1-badge| + |minor-lts-version-badge| diff --git a/docs/topics/install-by-operating-system/oracle.rst b/docs/topics/install-by-operating-system/oracle.rst deleted file mode 100644 index d4170c1..0000000 --- a/docs/topics/install-by-operating-system/oracle.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _install-oracle: - -============ -Oracle Linux -============ - -For Oracle Linux operating systems, use the instructions for installing Salt on -:ref:`install-rhel` or :ref:`install-amazon`. diff --git a/docs/topics/install-by-operating-system/photonos.rst b/docs/topics/install-by-operating-system/photonos.rst deleted file mode 100644 index 1ec7872..0000000 --- a/docs/topics/install-by-operating-system/photonos.rst +++ /dev/null @@ -1,252 +0,0 @@ -.. _install-photonos: - -========= -Photon OS -========= - -These instructions explain how to install Salt on Photon OS operating systems. - -* `Install Salt on Photon OS 5`_ -* `Install Salt on Photon OS 4`_ - -.. include:: ../_includes/intro-install-by-os.rst - -Install Salt on Photon OS 5 -=========================== -To install Salt on Photon OS 5: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Photon OS 5 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Photon OS 5**: - - .. parsed-literal:: - - sudo rpm --import \ |photonos5-latest-gpg|\ - - curl -fsSL \ |photonos5-latest-download|\ | sudo tee /etc/yum.repos.d/salt.repo - - tdnf clean all - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Photon OS 5 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Photon OS 5**: - - .. parsed-literal:: - - sudo rpm --import \ |photonos5-major-gpg|\ - - curl -fsSL \ |photonos5-major-download|\ | sudo tee /etc/yum.repos.d/salt.repo - - tdnf clean all - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Photon OS 5 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Photon OS 5**: - - .. parsed-literal:: - - sudo rpm --import \ |photonos5-minor-gpg|\ - - curl -fsSL \ |photonos5-minor-download|\ | sudo tee /etc/yum.repos.d/salt.repo - - tdnf clean all - - .. include:: ../_includes/gpg-keys.rst - -#. Install packages from the Photon OS repository, such as the salt-minion, - salt-master, or other Salt components: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Photon OS 5 (Latest) - - To install the latest release of Salt packages that are available in - the Photon OS repository, run these commands: - - .. code-block:: bash - - sudo tdnf install salt-master - sudo tdnf install salt-minion - sudo tdnf install salt-ssh - sudo tdnf install salt-syndic - sudo tdnf install salt-cloud - sudo tdnf install salt-api - - - .. tab-item:: Photon OS 5 (Specific releases) - - The following is an example of how to install a specific release of - Salt based on the list of packages available in the Photon OS - repository: - - .. code-block:: bash - - sudo tdnf install salt3-master-3005-1.ph5 - sudo tdnf install salt3-minion-3005-1.ph5 - sudo tdnf install salt3-ssh-3005-1.ph5 - sudo tdnf install salt3-syndic-3005-1.ph5 - sudo tdnf install salt3-cloud-3005-1.ph5 - sudo tdnf install salt3-api-3005-1.ph5 - - .. Note:: - The file extensions are based on which version of Photon OS you - are installing Salt services on. For example, the extension for - Photon OS 3 is ``.ph3`` and the extension for Photon OS 4 is - ``.ph4``. - - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - - -Install Salt on Photon OS 4 -=========================== -To install Salt on Photon OS 4: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Photon OS 4 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Photon OS 4**: - - .. parsed-literal:: - - sudo rpm --import \ |photonos4-latest-gpg|\ - - curl -fsSL \ |photonos4-latest-download|\ | sudo tee /etc/yum.repos.d/salt.repo - - tdnf clean all - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Photon OS 4 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Photon OS 4**: - - .. parsed-literal:: - - sudo rpm --import \ |photonos4-major-gpg|\ - - curl -fsSL \ |photonos4-major-download|\ | sudo tee /etc/yum.repos.d/salt.repo - - tdnf clean all - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Photon OS 4 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Photon OS 4**: - - .. parsed-literal:: - - sudo rpm --import \ |photonos4-minor-gpg|\ - - curl -fsSL \ |photonos4-minor-download|\ | sudo tee /etc/yum.repos.d/salt.repo - - tdnf clean all - - .. include:: ../_includes/gpg-keys.rst - -#. Install packages from the Photon OS repository, such as the salt-minion, - salt-master, or other Salt components: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Photon OS 4 (Latest) - - To install the latest release of Salt packages that are available in - the Photon OS repository, run these commands: - - .. code-block:: bash - - sudo tdnf install salt-master - sudo tdnf install salt-minion - sudo tdnf install salt-ssh - sudo tdnf install salt-syndic - sudo tdnf install salt-cloud - sudo tdnf install salt-api - - - .. tab-item:: Photon OS 4 (Specific releases) - - The following is an example of how to install a specific release of - Salt based on the list of packages available in the Photon OS - repository: - - .. code-block:: bash - - sudo tdnf install salt3-master-3005-1.ph4 - sudo tdnf install salt3-minion-3005-1.ph4 - sudo tdnf install salt3-ssh-3005-1.ph4 - sudo tdnf install salt3-syndic-3005-1.ph4 - sudo tdnf install salt3-cloud-3005-1.ph4 - sudo tdnf install salt3-api-3005-1.ph4 - - .. Note:: - The file extensions are based on which version of Photon OS you - are installing Salt services on. For example, the extension for - Photon OS 3 is ``.ph3`` and the extension for Photon OS 4 is - ``.ph4``. - - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Browse the repo -=============== - -.. card:: Browse the repo for Photon OS packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/photon/ - :width: 50% - - :bdg-primary:`Photon OS` - |supported-release-1-badge| diff --git a/docs/topics/install-by-operating-system/rhel.rst b/docs/topics/install-by-operating-system/rhel.rst deleted file mode 100644 index ac88fa2..0000000 --- a/docs/topics/install-by-operating-system/rhel.rst +++ /dev/null @@ -1,371 +0,0 @@ -.. _install-rhel: - -============= -RedHat (RHEL) -============= - -These instructions explain how to install Salt on RedHat (RHEL) operating -systems: - -* `Install Salt on RedHat (RHEL) 9 x86_64`_ -* `Install Salt on RedHat (RHEL) 9 aarch64 and arm64`_ -* `Install Salt on RedHat (RHEL) 8 x86_64`_ -* `Install Salt on RedHat (RHEL) 8 aarch64 and arm64`_ - -.. include:: ../_includes/what-is-onedir.rst - -.. include:: ../_includes/intro-install-by-os.rst - - -Install Salt on RedHat (RHEL) 9 x86_64 -====================================== -To install Salt on RedHat 9 for x86_64 architecture: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: RHEL 9 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **RHEL 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel9-latest-gpg-x86_64|\ - - curl -fsSL \ |rhel9-latest-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: RHEL 9 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **RHEL 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel9-major-gpg-x86_64|\ - - curl -fsSL \ |rhel9-major-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: RHEL 9 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **RHEL 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel9-minor-gpg-x86_64|\ - - curl -fsSL \ |rhel9-minor-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - - .. Note:: - Because of the presence of classic packages of Salt in EPEL, it's - possible that when you download the package from EPEL, it instead - downloads classic packages of older versions of Salt instead of the - onedir packages. - - During depsolving, when choosing the best provider among several, `yum` - respects the priority of each provider's repository. The value is an - integer from 1 to 99, with 1 being the most preferred repository and 99 - the least preferred. By default all repositories have the priority of 80. - - EPEL was treating the Salt repository as 99. To resolve this issue, Salt - has changed its priority level to 10 for RHEL 8 and 9. - - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on RedHat (RHEL) 9 aarch64 and arm64 -================================================= -To install Salt on RedHat 9 for aarch64 and arm64 architectures: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: RHEL 9 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **RHEL 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel9-latest-gpg-arm64|\ - - curl -fsSL \ |rhel9-latest-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: RHEL 9 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **RHEL 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel9-major-gpg-arm64|\ - - curl -fsSL \ |rhel9-major-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: RHEL 9 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **RHEL 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel9-minor-gpg-arm64|\ - - curl -fsSL \ |rhel9-minor-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - - .. Note:: - Because of the presence of classic packages of Salt in EPEL, it's - possible that when you download the package from EPEL, it instead - downloads classic packages of older versions of Salt instead of the - onedir packages. - - During depsolving, when choosing the best provider among several, `yum` - respects the priority of each provider's repository. The value is an - integer from 1 to 99, with 1 being the most preferred repository and 99 - the least preferred. By default all repositories have the priority of 80. - - EPEL was treating the Salt repository as 99. To resolve this issue, Salt - has changed its priority level to 10 for RHEL 8 and 9. - - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on RedHat (RHEL) 8 x86_64 -====================================== -To install the :ref:`onedir` packages of Salt on RedHat 8 for x86_64 -architecture: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: RHEL 8 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **RHEL 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel8-latest-gpg-x86_64|\ - - curl -fsSL \ |rhel8-latest-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: RHEL 8 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **RHEL 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel8-major-gpg-x86_64|\ - - curl -fsSL \ |rhel8-major-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: RHEL 8 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **RHEL 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel8-minor-gpg-x86_64|\ - - curl -fsSL \ |rhel8-minor-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on RedHat (RHEL) 8 aarch64 and arm64 -================================================= -To install the :ref:`onedir` packages of Salt on RedHat 8 for aarch64 and -arm64 architectures: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: RHEL 8 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **RHEL 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel8-latest-gpg-arm64|\ - - curl -fsSL \ |rhel8-latest-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: RHEL 8 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **RHEL 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel8-major-gpg-arm64|\ - - curl -fsSL \ |rhel8-major-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: RHEL 8 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **RHEL 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rhel8-minor-gpg-arm64|\ - - curl -fsSL \ |rhel8-minor-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Browse the repo -=============== - -.. card:: Browse the repo for RedHat (RHEL) packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/redhat/ - :width: 50% - - :bdg-primary:`RedHat` - |supported-release-1-badge| diff --git a/docs/topics/install-by-operating-system/rocky.rst b/docs/topics/install-by-operating-system/rocky.rst deleted file mode 100644 index 6bde2ec..0000000 --- a/docs/topics/install-by-operating-system/rocky.rst +++ /dev/null @@ -1,333 +0,0 @@ -.. _install-rocky: - -=========== -Rocky Linux -=========== - -For Rocky Linux operating systems (or AlmaLinux, etc.), use the following instructions. - -These instructions explain how to install Salt on Rocky Linux operating systems: - -* `Install Salt on Rocky Linux 9 x86_64`_ -* `Install Salt on Rocky Linux 9 aarch64 and arm64`_ -* `Install Salt on Rocky Linux 8 x86_64`_ -* `Install Salt on Rocky Linux 8 aarch64 and arm64`_ - - -.. include:: ../_includes/what-is-onedir.rst - -.. include:: ../_includes/intro-install-by-os.rst - - -Install Salt on Rocky Linux 9 x86_64 -====================================== -To install the :ref:`onedir` packages of Salt on Rocky Linux 9 for x86_64 -architecture: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Rocky Linux 9 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package of Salt for **Rocky Linux 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky9-latest-gpg-x86_64|\ - - curl -fsSL \ |rocky9-latest-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Rocky Linux 9 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package of Salt for **Rocky Linux 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky9-major-gpg-x86_64|\ - - curl -fsSL \ |rocky9-major-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Rocky Linux 9 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package of Salt for **Rocky Linux 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky9-minor-gpg-x86_64|\ - - curl -fsSL \ |rocky9-minor-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Rocky Linux 9 aarch64 and arm64 -================================================= -To install the :ref:`onedir` packages of Salt on Rocky Linux 9 for aarch64 and -arm64 architectures: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Rocky Linux 9 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package of Salt for **Rocky Linux 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky9-latest-gpg-arm64|\ - - curl -fsSL \ |rocky9-latest-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Rocky Linux 9 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package of Salt for **Rocky Linux 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky9-major-gpg-arm64|\ - - curl -fsSL \ |rocky9-major-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Rocky Linux 9 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package of Salt for **Rocky Linux 9**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky9-minor-gpg-arm64|\ - - curl -fsSL \ |rocky9-minor-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - - -Install Salt on Rocky Linux 8 x86_64 -====================================== -To install the :ref:`onedir` packages of Salt on Rocky Linux 8 for x86_64 -architecture: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Rocky Linux 8 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package of Salt for **Rocky Linux 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky8-latest-gpg-x86_64|\ - - curl -fsSL \ |rocky8-latest-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Rocky Linux 8 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package of Salt for **Rocky Linux 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky8-major-gpg-x86_64|\ - - curl -fsSL \ |rocky8-major-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Rocky Linux 8 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package of Salt for **Rocky Linux 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky8-minor-gpg-x86_64|\ - - curl -fsSL \ |rocky8-minor-download-x86_64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - - -Install Salt on Rocky Linux 8 aarch64 and arm64 -================================================= -To install the :ref:`onedir` packages of Salt on Rocky Linux 8 for aarch64 and -arm64 architectures: - -#. Run the following commands to install the Salt Project repository and key: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Rocky Linux 8 (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package of Salt for **Rocky Linux 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky8-latest-gpg-arm64|\ - - curl -fsSL \ |rocky8-latest-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Rocky Linux 8 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package of Salt for **Rocky Linux 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky8-major-gpg-arm64|\ - - curl -fsSL \ |rocky8-major-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Rocky Linux 8 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package of Salt for **Rocky Linux 8**: - - .. parsed-literal:: - - sudo rpm --import \ |rocky8-minor-gpg-arm64|\ - - curl -fsSL \ |rocky8-minor-download-arm64|\ | sudo tee /etc/yum.repos.d/salt.repo - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo yum clean expire-cache`` to clear the repository metadata. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo yum install salt-master - sudo yum install salt-minion - sudo yum install salt-ssh - sudo yum install salt-syndic - sudo yum install salt-cloud - sudo yum install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Browse the repo -=============== - -.. card:: Browse the repo for Rocky Linux packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/redhat/ - :width: 50% - - :bdg-primary:`Rocky Linux` - |supported-release-1-badge| diff --git a/docs/topics/install-by-operating-system/sles.rst b/docs/topics/install-by-operating-system/sles.rst deleted file mode 100644 index 767c201..0000000 --- a/docs/topics/install-by-operating-system/sles.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _install-sles: - -=========== -SUSE (SLES) -=========== - -These instructions explain how to install Salt on AR operating systems: - -.. Note:: - Salt packages for SUSE are hosted on the SUSE package repository. SUSE - creates its own Salt packages and the Salt Project does not publish separate - Salt packages for download. - - -.. include:: ../_includes/intro-install-by-os.rst - - -Install Salt on SUSE -==================== -Salt is packaged separately for the minion and the master. You only need to -install the appropriate package for the machine's role. Typically, there will be -one master and multiple minions. - -#. Run the following command: - - .. code-block:: bash - - zypper install salt-master - zypper install salt-minion - -#. To start the master service: - - .. tab-set:: - - .. tab-item:: Open SUSE - - .. code-block:: bash - - systemctl start salt-master.service - - Alternatively, to start the master service at boot time: - - .. code-block:: bash - - systemctl enable salt-master.service - - .. tab-item:: SLES - - .. code-block:: bash - - rcsalt-master start - - Alternatively, to start the master service at boot time: - - .. code-block:: bash - - chkconfig salt-master on - - -#. To start the minion service: - - .. tab-set:: - - .. tab-item:: Open SUSE - - .. code-block:: bash - - systemctl start salt-minion.service - - Alternatively, to start the minion service at boot time: - - .. code-block:: bash - - systemctl enable salt-minion.service - - .. tab-item:: SLES - - .. code-block:: bash - - chkconfig salt-minion on - - Alternatively, to start the minion service at boot time: - - .. code-block:: bash - - rcsalt-minion start - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst diff --git a/docs/topics/install-by-operating-system/ubuntu.rst b/docs/topics/install-by-operating-system/ubuntu.rst deleted file mode 100644 index f4aa1a2..0000000 --- a/docs/topics/install-by-operating-system/ubuntu.rst +++ /dev/null @@ -1,522 +0,0 @@ -.. _install-ubuntu: - -====== -Ubuntu -====== - -These instructions explain how to install Salt on Debian operating systems: - -* `Install Salt on Ubuntu 24.04 (Noble) amd64`_ -* `Install Salt on Ubuntu 24.04 (Noble) arm64`_ -* `Install Salt on Ubuntu 22.04 (Jammy) amd64`_ -* `Install Salt on Ubuntu 22.04 (Jammy) arm64`_ -* `Install Salt on Ubuntu 20.04 (Focal) amd64`_ -* `Install Salt on Ubuntu 20.04 (Focal) arm64`_ - -.. include:: ../_includes/what-is-onedir.rst - -.. include:: ../_includes/intro-install-by-os.rst - -Install Salt on Ubuntu 24.04 (Noble) amd64 -========================================== -To install the :ref:`onedir` packages of Salt on Ubuntu 24.04 (Noble) for -amd64 architecture: - -#. Run the following commands to import the Salt Project repository key, and to - create the apt sources list file: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Ubuntu 24.04 (Noble) (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Ubuntu 24.04 (Noble)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu24-latest-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |ubuntu24-latest-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 24.04 (Noble) (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Ubuntu 24.04 (Noble)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu24-major-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |ubuntu24-major-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 24.04 (Noble) (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Ubuntu 24.04 (Noble)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu24-minor-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |ubuntu24-minor-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - -#. Run ``sudo apt-get update`` to update your packages. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo apt-get install salt-master - sudo apt-get install salt-minion - sudo apt-get install salt-ssh - sudo apt-get install salt-syndic - sudo apt-get install salt-cloud - sudo apt-get install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Ubuntu 24.04 (Noble) arm64 -====================================================== -To install the :ref:`onedir` packages of Salt on Ubuntu 24.04 (Noble) for -arm64 architecture: - -#. Run the following commands to import the Salt Project repository key, and to - create the apt sources list file: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Ubuntu 24.04 (Noble) (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Ubuntu 24.04 (Noble)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu24-latest-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |ubuntu24-latest-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 24.04 (Noble) (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Ubuntu 24.04 (Noble)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu24-major-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |ubuntu24-major-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 24.04 (Noble) (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Ubuntu 24.04 (Noble)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu24-minor-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |ubuntu24-minor-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - -#. Run ``sudo apt-get update`` to update your packages. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo apt-get install salt-master - sudo apt-get install salt-minion - sudo apt-get install salt-ssh - sudo apt-get install salt-syndic - sudo apt-get install salt-cloud - sudo apt-get install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - - -Install Salt on Ubuntu 22.04 (Jammy) amd64 -========================================== -To install the :ref:`onedir` packages of Salt on Ubuntu 22.04 (Jammy) for -amd64 architecture: - -#. Run the following commands to import the Salt Project repository key, and to - create the apt sources list file: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Ubuntu 22.04 (Jammy) (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Ubuntu 22.04 (Jammy)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu22-latest-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |ubuntu22-latest-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 22.04 (Jammy) (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Ubuntu 22.04 (Jammy)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu22-major-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |ubuntu22-major-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 22.04 (Jammy) (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Ubuntu 22.04 (Jammy)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu22-minor-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |ubuntu22-minor-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - -#. Run ``sudo apt-get update`` to update your packages. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo apt-get install salt-master - sudo apt-get install salt-minion - sudo apt-get install salt-ssh - sudo apt-get install salt-syndic - sudo apt-get install salt-cloud - sudo apt-get install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Ubuntu 22.04 (Jammy) arm64 -====================================================== -To install the :ref:`onedir` packages of Salt on Ubuntu 22.04 (Jammy) for -arm64 architecture: - -#. Run the following commands to import the Salt Project repository key, and to - create the apt sources list file: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Ubuntu 22.04 (Jammy) (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Ubuntu 22.04 (Jammy)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu22-latest-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |ubuntu22-latest-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 22.04 (Jammy) (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Ubuntu 22.04 (Jammy)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu22-major-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |ubuntu22-major-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 22.04 (Jammy) (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Ubuntu 22.04 (Jammy)**: - - .. parsed-literal:: - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu22-minor-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |ubuntu22-minor-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - -#. Run ``sudo apt-get update`` to update your packages. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo apt-get install salt-master - sudo apt-get install salt-minion - sudo apt-get install salt-ssh - sudo apt-get install salt-syndic - sudo apt-get install salt-cloud - sudo apt-get install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - - -Install Salt on Ubuntu 20.04 (Focal) amd64 -===================================================== -To install the :ref:`onedir` packages of Salt on Ubuntu 20.04 (Focal) for -amd64 architecture: - -#. Run the following commands to import the Salt Project repository key, and to - create the apt sources list file: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Ubuntu 20.04 (Focal) (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Ubuntu 20.04 (Focal)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu20-latest-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |ubuntu20-latest-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 20.04 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Ubuntu 20.04 (Focal)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu20-major-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |ubuntu20-major-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 20.04 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Ubuntu 20.04 (Focal)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu20-minor-gpg-amd64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] \ |ubuntu20-minor-download-amd64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo apt-get update`` to update your packages. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo apt-get install salt-master - sudo apt-get install salt-minion - sudo apt-get install salt-ssh - sudo apt-get install salt-syndic - sudo apt-get install salt-cloud - sudo apt-get install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - -Install Salt on Ubuntu 20.04 (Focal) arm64 -====================================================== -To install the :ref:`onedir` packages of Salt on Ubuntu 20.04 (Focal) for -arm64 architecture: - -#. Run the following commands to import the Salt Project repository key, and to - create the apt sources list file: - - **Click the tab for the Salt version you would like to pin for updates:** - - .. tab-set:: - - .. tab-item:: Ubuntu 20.04 (Focal) (Latest onedir) - - To pin your Salt upgrades to the :ref:`latest` :ref:`onedir` package - of Salt for **Ubuntu 20.04 (Focal)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu20-latest-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |ubuntu20-latest-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 20.04 (Major onedir) - - To pin your Salt upgrades to the :ref:`major` :ref:`onedir` package - of Salt for **Ubuntu 20.04 (Focal)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu20-major-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |ubuntu20-major-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - - .. tab-item:: Ubuntu 20.04 (Minor onedir) - - To pin your Salt upgrades to the :ref:`minor` :ref:`onedir` package - of Salt for **Ubuntu 20.04 (Focal)**: - - .. parsed-literal:: - - mkdir /etc/apt/keyrings - - sudo curl -fsSL -o /etc/apt/keyrings/salt-archive-keyring-2023.gpg \ |ubuntu20-minor-gpg-arm64|\ - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=arm64] \ |ubuntu20-minor-download-arm64|\" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: ../_includes/gpg-keys.rst - -#. Run ``sudo apt-get update`` to update your packages. - -#. Install the salt-minion, salt-master, or other Salt components: - - .. code-block:: bash - - sudo apt-get install salt-master - sudo apt-get install salt-minion - sudo apt-get install salt-ssh - sudo apt-get install salt-syndic - sudo apt-get install salt-cloud - sudo apt-get install salt-api - -#. Enable and start the services for salt-minion, salt-master, or other Salt - components: - - .. code-block:: bash - - sudo systemctl enable salt-master && sudo systemctl start salt-master - sudo systemctl enable salt-minion && sudo systemctl start salt-minion - sudo systemctl enable salt-syndic && sudo systemctl start salt-syndic - sudo systemctl enable salt-api && sudo systemctl start salt-api - - .. include:: ../_includes/install-dependencies-onedir.rst - -.. include:: ../_includes/post-install-by-os.rst - - - -Browse the repo -=============== - -.. card:: Browse the repo for Ubuntu packages - :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/ubuntu/ - :width: 50% - - :bdg-primary:`Ubuntu` - |supported-release-1-badge| diff --git a/docs/topics/install-by-operating-system/windows.rst b/docs/topics/install-by-operating-system/windows.rst index 353518b..ad13b8e 100644 --- a/docs/topics/install-by-operating-system/windows.rst +++ b/docs/topics/install-by-operating-system/windows.rst @@ -31,8 +31,6 @@ If you are unsure which installer to use, use the Nullsoft (EXE) installer. Onedir packages are currently only available for the Nullsoft (EXE) installer. -.. include:: ../_includes/warning-about-old-packages.rst - Install directory locations --------------------------- @@ -434,8 +432,7 @@ Browse the repo .. card:: Browse the repo for Windows packages :class-card: sd-border-1 - :link: https://repo.saltproject.io/salt/py3/windows/ + :link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-generic/windows :width: 50% :bdg-primary:`Windows` - :bdg-secondary:`Python3` diff --git a/docs/topics/other-install-types/air-gap-install.rst b/docs/topics/other-install-types/air-gap-install.rst index f9b772c..643a4b4 100644 --- a/docs/topics/other-install-types/air-gap-install.rst +++ b/docs/topics/other-install-types/air-gap-install.rst @@ -9,57 +9,5 @@ Install in air-gapped environments About air-gapped installations ============================== -To install Salt in an air-gapped environment, you can create a local mirror of -the Salt Project repository using an s3 API compatible sync tool such as the -`aws-cli` or `rclone`. -Be aware that the Salt Project uses a custom endpoint to make it easier to -switch buckets easily. - -Also note that `rclone` may warn about the time being out of sync. You can -safely ignore these warning messages. The warning message is caused because Salt -Project uses CloudFront as a cache instead of using s3 directly. Please sync no -more than once per day. - - -Create a local mirror with `rclone` -=================================== -To set up a local mirror with `rclone`: - -#. In the `rclone` command line, adapt this example: - - .. code-block:: bash - - RCLONE_CONFIG_S3_TYPE=s3 RCLONE_CONFIG_S3_PROVIDER=Other RCLONE_CONFIG_S3_ENV_AUTH=false RCLONE_CONFIG_S3_ENDPOINT=https://s3.repo.saltproject.io rclone sync --fast-list --use-server-modtime -v s3:s3/ ./fullrepo/ - - .. Note:: - On behalf of the Salt Project, include the - `--use-server-modtime` flags to help us drastically reduce our costs. - -#. (Optional): If you can't use the `--use-server-modtime` flag because your - version of `rclone`` is too old, you can use the `-c flag` instead: - - .. code-block:: bash - - RCLONE_CONFIG_S3_TYPE=s3 RCLONE_CONFIG_S3_PROVIDER=Other RCLONE_CONFIG_S3_ENV_AUTH=false RCLONE_CONFIG_S3_ENDPOINT=https://s3.repo.saltproject.io rclone sync --fast-list -c -v s3:s3/ ./fullrepo/ - - - .. Tip:: - Only sync once per day. - - -Create a local mirror with `aws-cli` -==================================== -To set up a local mirror with `aws-cli`: - -#. In the `aws-cli` command line, adapt this example: - - .. code-block:: bash - - aws --no-sign-request --endpoint-url https://s3.repo.saltproject.io s3 sync --delete --exact-timestamps s3://s3/ ./fullrepo/ - -#. To sync the local mirror, use `https://s3.archive.repo.saltproject.io` as the - endpoint URL. - - .. Tip:: - Only sync once per day. +TBD diff --git a/docs/topics/other-install-types/release-candidate.rst b/docs/topics/other-install-types/release-candidate.rst index 90b92ff..058b64e 100644 --- a/docs/topics/other-install-types/release-candidate.rst +++ b/docs/topics/other-install-types/release-candidate.rst @@ -14,8 +14,7 @@ their Salt infrastructure. :color: primary Release candidates are early versions of Salt that are released prior to an - official Salt release. For LTS releases of Salt, the Salt Project releases - two RCs in the months leading up to the official LTS release. + official Salt release. Report bugs @@ -28,54 +27,27 @@ and write ``[RC]`` in the issue title. For example: Install using packages ====================== -RC builds for a few major platforms are available at the Salt repository: -https://repo.saltproject.io/salt_rc/ - -RC builds are typically only available for the latest version of the operating -system at the time the RC is available. Older versions of operating systems -might not get an RC release. +RC builds are available in the Salt package repositories. To install release candidate packages: #. Use the standard minor install instructions for your operating system. See :ref:`install-by-operating-system-index`. -#. On the step where you normally import the Salt Project repository key and pin - the package to a specific version of Salt, after ``https://repo.saltproject.io`` - insert ``salt_rc/`` before the remainder of the file path. - - .. include:: ../_includes/gpg-keys.rst - +#. On the step where you normally enable / restrict to an LTS or STS version, + restrict to RC: **TBD** To install the latest RC, run the following commands: .. tab-set:: - .. tab-item:: RHEL 9 - - .. parsed-literal:: - - sudo rpm --import \ |rhel-release-candidate-gpg|\ - - curl -fsSL |rhel-release-candidate| | sudo tee /etc/yum.repos.d/salt.repo + .. tab-item:: Linux (RPM) - .. tab-item:: Ubuntu 22.04 (Jammy) + TBD - .. parsed-literal:: - - sudo curl -fsSL -o |ubuntu-release-candidate-gpg|\ - - echo "deb |ubuntu-release-candidate| | sudo tee /etc/apt/sources.list.d/salt.list - - .. tab-item:: Debian 11 (Bullseye) - - .. parsed-literal:: + .. tab-item:: Linux (DEB) - sudo mkdir -p /etc/apt/keyrings - - sudo curl -fsSL -o |debian-release-candidate-gpg| - - echo "deb |debian-release-candidate| | sudo tee /etc/apt/sources.list.d/salt.list + TBD .. tab-item:: Windows @@ -104,41 +76,13 @@ You can install a release candidate of Salt using one of the scripts in the .. tab-set:: - .. tab-item:: Linux/macOS - - Run the following command for the latest RC release, using - |release-candidate-version| as an example: - - .. parsed-literal:: - - curl -o install_salt.sh -L https://bootstrap.saltproject.io - sudo sh install_salt.sh -P -x |bootstrap-release-candidate| - - To install a master using Salt bootstrap, use the ``-M`` flag. For example: + .. tab-item:: Linux - .. parsed-literal:: - - curl -o install_salt.sh -L https://bootstrap.saltproject.io - sudo sh install_salt.sh -P -M -x |bootstrap-release-candidate| - - If you want to install only a master and not a minion using Salt bootstrap, use - the ``-M`` and ``-N`` flags. For example: - - .. parsed-literal:: - - curl -o install_salt.sh -L https://bootstrap.saltproject.io - sudo sh install_salt.sh -P -M -N -x |bootstrap-release-candidate| + TBD .. tab-item:: Windows - Run the following command to install the latest RC release: - - .. parsed-literal:: - - Set-ExecutionPolicy RemoteSigned -Scope Process -Force - [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]'Tls12' - Invoke-WebRequest -Uri https://winbootstrap.saltproject.io -OutFile .\\bootstrap.ps1 - .\\bootstrap.ps1 -RepoUrl |windows-release-candidate-url| + TBD Install using pip @@ -157,7 +101,7 @@ To install the release candidate using pip from `PyPi `_: .. code-block:: bash - sudo yum install python3-pip python3-devel gcc gcc-c++ + sudo dnf install python3-pip python3-devel gcc gcc-c++ .. tab-item:: Debian systems diff --git a/docs/topics/revert-to-previous-version.rst b/docs/topics/revert-to-previous-version.rst index 711a999..51a27d4 100644 --- a/docs/topics/revert-to-previous-version.rst +++ b/docs/topics/revert-to-previous-version.rst @@ -10,6 +10,10 @@ operating systems: * `Revert Salt on Debian/Ubuntu operating systems`_ * `Revert Salt on RedHat operating systems`_ +.. warning:: + + Salt package repositories do not host versions of Salt older than 3006 LTS. This + means users will **NOT** be able to revert to older versions such as Salt 3005. Revert Salt on Debian/Ubuntu operating systems ============================================== @@ -30,61 +34,50 @@ To revert to a previous version of Salt: minion: 3006.5 -#. Run the following command to overwrite the ``salt.list`` file and pin your - version of Salt to a previous minor version, replacing the ``X`` in this - example with the desired previous version number: +#. If needed, first run the following command to restrict to target LTS or STS available packages: .. tab-set:: - .. tab-item:: Debian 12 - - .. code-block:: bash - - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] https://repo.saltproject.io/salt/py3/debian/12/amd64/minor/3006.X bookworm main" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: _includes/previous-version-note.rst + .. tab-item:: 3006 LTS - .. tab-item:: Debian 11 + Populate ``/etc/apt/preferences.d/salt-pin-1001`` in order to restrict upgrades to Salt 3006.x LTS: .. code-block:: bash - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] https://repo.saltproject.io/salt/py3/debian/11/amd64/minor/3006.X bullseye main" | sudo tee /etc/apt/sources.list.d/salt.list + echo 'Package: salt-* + Pin: version 3006.* + Pin-Priority: 1001' | sudo tee /etc/apt/preferences.d/salt-pin-1001 .. include:: _includes/previous-version-note.rst - .. tab-item:: Ubuntu 24.04 - - .. code-block:: bash + .. tab-item:: 3007 STS - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] https://repo.saltproject.io/salt/py3/ubuntu/24.04/amd64/minor/3006.X noble main" | sudo tee /etc/apt/sources.list.d/salt.list + .. warning:: STS not recommended for Production + Salt Project recommends deploying LTS releases for Production environments. - .. include:: _includes/previous-version-note.rst - - .. tab-item:: Ubuntu 22.04 + Populate ``/etc/apt/preferences.d/salt-pin-1001`` in order to restrict upgrades to Salt 3006.x LTS: .. code-block:: bash - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] https://repo.saltproject.io/salt/py3/ubuntu/22.04/amd64/minor/3006.X jammy main" | sudo tee /etc/apt/sources.list.d/salt.list - + echo 'Package: salt-* + Pin: version 3007.* + Pin-Priority: 1001' | sudo tee /etc/apt/preferences.d/salt-pin-1001 .. include:: _includes/previous-version-note.rst - .. tab-item:: Ubuntu 20.04 - - .. code-block:: bash - echo "deb [signed-by=/etc/apt/keyrings/salt-archive-keyring-2023.gpg arch=amd64] https://repo.saltproject.io/salt/py3/ubuntu/20.04/amd64/minor/3006.X focal main" | sudo tee /etc/apt/sources.list.d/salt.list - - .. include:: _includes/previous-version-note.rst - - -#. Run the following command to change your version of Salt and remove all Salt - services: +#. Run the following commands to remove all Salt services: .. code-block:: bash - apt remove salt-common + apt-get remove salt-common + apt-get remove salt-master + apt-get remove salt-minion + apt-get remove salt-ssh + apt-get remove salt-syndic + apt-get remove salt-cloud + apt-get remove salt-api #. Run the following commands to update your package manager and install any of @@ -92,7 +85,7 @@ To revert to a previous version of Salt: .. code-block:: bash - apt update + apt-get update apt-get install salt-master apt-get install salt-minion apt-get install salt-ssh @@ -130,9 +123,7 @@ To revert to a previous version of Salt: minion: 3006.5 -#. Run the following command to overwrite the ``salt.list`` file and pin your - version of Salt to a previous minor version, replacing the ``X`` in this - example with the desired previous version number: +#. If needed, first run the following command to restrict to target LTS or STS available packages: .. tab-set:: @@ -165,19 +156,19 @@ To revert to a previous version of Salt: .. code-block:: bash - yum remove salt + dnf remove salt #. Update your package manager and install any of the Salt services as needed: .. code-block:: bash - yum makecache - yum install salt-master - yum install salt-minion - yum install salt-ssh - yum install salt-syndic - yum install salt-cloud - yum install salt-api + dnf makecache + dnf install salt-master + dnf install salt-minion + dnf install salt-ssh + dnf install salt-syndic + dnf install salt-cloud + dnf install salt-api #. Restart the salt services: diff --git a/docs/topics/salt-python-version-support.rst b/docs/topics/salt-python-version-support.rst index 134c2cc..a277307 100644 --- a/docs/topics/salt-python-version-support.rst +++ b/docs/topics/salt-python-version-support.rst @@ -4,12 +4,39 @@ Support for Python versions =========================== -Starting with Salt version 3006, the Salt Project aligns with the -`Python support lifecycle `_, -which means that Salt supports the same versions of Python that are supported by -the `Python Software Foundation `_. +Starting with Salt 3006 LTS, the Salt Project pins to a specific major version series +of Python to test and ship with Salt via ``relenv`` (onedir). This means the version of Python shipped may not +be with the very latest version of Python itself, but will be a version of Python still +under the `Python support lifecycle `_ +(versions supported `Python Software Foundation `_). +Fully supported +=============== -Currently supported versions ----------------------------- -Salt |release| requires Python 3.7 or higher. +The Salt Project team provides **full support** for the package-installed versions of Salt via +``package.broadcom.com`` (which are packaged with ``relenv`` instead of via ``pip`` or ``git``). + +``relenv`` is currently pinned to the following major Python versions in Salt: + +- Salt 3006 LTS: |relenv-lts-python-version| +- Salt 3007 STS: |relenv-sts-python-version| + +Reasonable-effort support +========================= + +Users installing Salt via ``pip``, ``git``, or other methods will be running Salt in a way that +Salt is not developed or tested against. This means that the user experience will vary when not +using what Salt ships via ``relenv``. + +Environments with these alternative installations of Salt, such as pip-based or git-based installations, are +considered being under **Reasonable-effort support.** The fully supported versions of Salt would be the +packages Salt Project provides from their repositories, due to their test, build, upgrade/downgrade testing suites +working with the ``relenv``-based installs of Salt. + +Resources +========= + +Source code repositories for projects used to build and ship isolated onedirs with Salt: + +- `relenv GitHub source repo `__ +- `ppbt: Portable Python Build Toolchain `__ diff --git a/docs/topics/salt-supported-operating-systems.rst b/docs/topics/salt-supported-operating-systems.rst index a23d75f..10678ce 100644 --- a/docs/topics/salt-supported-operating-systems.rst +++ b/docs/topics/salt-supported-operating-systems.rst @@ -48,14 +48,14 @@ Overview of supported operating systems - - Yes - Full - - Yes + - * - `Amazon Linux`_ 2023 - x86_64, aarch64 / arm64 - - Yes - Full - - Yes + - * - `CentOS`_ Stream 9 - x86_64, aarch64 / arm64 @@ -104,14 +104,14 @@ Overview of supported operating systems - Yes - Yes - Reasonable - - Yes + - * - `Oracle Linux`_ 8, 9 - x86_64, aarch64 / arm64 - Yes - Yes - Full - - [#f1]_ + - * - `Photon OS`_ 4 - x86_64, aarch64 / arm64 @@ -132,14 +132,14 @@ Overview of supported operating systems - Yes - Yes - Full - - Yes + - * - `RedHat`_ 9 - x86_64, aarch64 / arm64 - Yes - Yes - Full - - Yes + - * - `Rocky Linux`_ 8 - x86_64, aarch64 / arm64 @@ -226,14 +226,12 @@ Overview of supported operating systems - Yes -.. [#f1] Use RedHat or CentOS packages instead. - - Support definitions =================== Arch ---- + Arch is short for *architecture.* The Salt Project supports the following architectures: @@ -319,6 +317,7 @@ The full automated test suite is run for the operating system packages. Full support policy by operating system ======================================= + This section outlines the general support and package creation policy for each operating system that is listed as having full support by the Salt Project. These guidelines are intended to help you understand how long a particular diff --git a/docs/topics/salt-version-support-lifecycle.rst b/docs/topics/salt-version-support-lifecycle.rst index 5679f99..ea55de2 100644 --- a/docs/topics/salt-version-support-lifecycle.rst +++ b/docs/topics/salt-version-support-lifecycle.rst @@ -26,13 +26,13 @@ Version support lifecycle * - 3007 STS - March 6, 2024 - - October 18, 2024 - - October 18, 2024 + - January, 2025 + - January, 2025 * - 3006 LTS - April 18, 2023 - - October 18, 2024 - - October 18, 2025 + - January, 2025 + - January, 2026 .. Note:: Salt Project is committed to providing active support for the current LTS @@ -49,6 +49,7 @@ See `Older version support lifecycle`_ for versions of Salt older than 3006. LTS/STS release and support policy ================================== + Beginning with the 3006 release of Salt, the Salt Project will follow an LTS/STS release strategy. Under this strategy, the Salt Project will release one LTS (long-term support) release of Salt per year and one or more STS (short-term @@ -151,6 +152,7 @@ CVE and critical support Older version support lifecycle =============================== + The following table lists the support lifecycle for versions of Salt prior to the 3006 version: diff --git a/docs/topics/uninstall.rst b/docs/topics/uninstall.rst index 98bd0a1..2001390 100644 --- a/docs/topics/uninstall.rst +++ b/docs/topics/uninstall.rst @@ -8,9 +8,9 @@ The process for removing Salt depends on the operating system and the method you used to install Salt: * **Linux-based systems** - If the operating system uses package management - tools (such as ``yum`` or ``apt``), then you would use the package manager to - uninstall. For example: ``yum remove `` or - ``sudo apt remove ``. + tools (such as ``dnf`` or ``apt-get``), then you would use the package manager to + uninstall. For example: ``dnf remove `` or + ``sudo apt-get remove ``. * **macOS and Windows** - The macOS and Windows installers have an uninstall option. Run the installer and select that option to uninstall Salt if you run that. diff --git a/docs/topics/upgrade-to-onedir.rst b/docs/topics/upgrade-to-onedir.rst index bba27f6..26ae3b3 100644 --- a/docs/topics/upgrade-to-onedir.rst +++ b/docs/topics/upgrade-to-onedir.rst @@ -5,10 +5,7 @@ Upgrade to onedir ================= Onedir is the Salt Project's new packaging system. Beginning with the release of -Salt 3006 (Sulfur), the Salt Project will only offer onedir packages. - -.. include:: _includes/fips-photon-os.rst - +Salt 3006 LTS (Sulfur), the Salt Project will only offer onedir packages. .. _what-is-onedir: @@ -34,7 +31,7 @@ Onedir packages are self-contained binaries of Salt. Onedir packages include: - :ref:`salt-python-version-support` * - Salt's required dependencies - - `Salt dependencies `_ + - `Salt dependencies `_ .. Warning:: @@ -46,48 +43,18 @@ Onedir packages are self-contained binaries of Salt. Onedir packages include: for that specific module for a list of required dependencies. -Timeline for upgrading to onedir packaging -========================================== -In order to avoid disruption of services and continue getting upgraded versions -of Salt, begin planning how you will update your Salt infrastructure to onedir. -See `How to upgrade to onedir`_ for more information. - -.. list-table:: - :widths: 15 85 - :header-rows: 1 - :stub-columns: 1 - - * - Salt version - - Packaging changes - - * - 3005 - - * The Salt Project will begin to phase out the old, "classic" Salt - package builds. - * Both onedir packages and classic Salt package builds will be provided, - except for operating systems that are newly supported in 3005. - - * - 3006 - - The Salt Project will only support onedir packages going forward. - - How to upgrade to onedir ======================== -To upgrade to onedir: +To upgrade to onedir, if you are upgrading from a Salt older than Salt 3006 LTS: #. On your Salt infrastructure (masters, minions, etc.), update the repository - path to point to the new onedir repository paths for your operating system. - See `Repository paths`_ for more information. + paths to point to the new ``packages.broadcom.com`` endpoints. See + :ref:`install-by-operating-system-index` for the specific commands. - .. Tip:: - Rather than manually updating the configuration files with the correct - repository link, you can re-run the installation commands for your - operating system. When you re-run the commands, make sure you select the - instructions for the **onedir** version of the package. See - :ref:`install-by-operating-system-index` for the specific commands. - -#. After the repository file is updated, import the |release| GPG key. - - .. include:: _includes/gpg-keys.rst +#. After the repository files are updated, import the appropriate GPG key. + :ref:`install-deb` involves running a ``curl`` command, while RHEL-like + systems will automatically pick up the new GPG key on your behalf when you + update the repository configuration (`salt.repo`). #. Upgrade your Salt packages. @@ -111,7 +78,7 @@ To upgrade to onedir: You can use ``salt-call pip.list`` to view existing modules that may need to be installed. - See also `Salt dependencies `_ + See also `Salt dependencies `_ for a list of the packages that are installed with onedir. Any package that is not on this list needs to be reinstalled. @@ -152,44 +119,3 @@ To upgrade to onedir: already been built in a way that allows it to find the executables it needs. Adding Salt to the library search path could cause errors due to incompatible versions of system packages. - - -Repository paths ----------------- - -.. list-table:: - :widths: 10 50 40 - :header-rows: 1 - :stub-columns: 1 - - * - - - Onedir path - - Classic path - - * - CentOS - - https://repo.saltproject.io/salt/py3/redhat/ - - https://repo.saltproject.io/py3/redhat/ - - * - Debian - - https://repo.saltproject.io/salt/py3/debian/ - - https://repo.saltproject.io/py3/debian/ - - * - Fedora - - https://repo.saltproject.io/salt/py3/fedora/ - - Hosted on Fedora repos - - * - MacOS - - https://repo.saltproject.io/salt/py3/macos/ - - https://repo.saltproject.io/osx/ - - * - Redhat - - https://repo.saltproject.io/salt/py3/redhat/ - - https://repo.saltproject.io/py3/redhat/ - - * - Ubuntu - - https://repo.saltproject.io/salt/py3/ubuntu/ - - https://repo.saltproject.io/py3/ubuntu/ - - * - Windows - - https://repo.saltproject.io/salt/py3/windows/ - - https://repo.saltproject.io/windows/ diff --git a/docs/topics/upgrade.rst b/docs/topics/upgrade.rst index bf07a02..217dbf6 100644 --- a/docs/topics/upgrade.rst +++ b/docs/topics/upgrade.rst @@ -14,14 +14,6 @@ is in case of a security vulnerability. Salt can be upgraded either through your distribution's package manager or using PyPI if you have installed Salt with pip, the package installer for Python. -.. Warning:: - For SaltStack Config users: If you initially installed Salt using Salt - Crystal, you must also upgrade to later versions using Salt Crystal. For - more information, see - `How to Upgrade Salt Crystal `_. - -.. include:: _includes/fips-photon-os.rst - Upgrade your Salt infrastructure ================================ @@ -34,7 +26,7 @@ To upgrade Salt: rpm -qi salt dpkg-query -l salt\* - yum list installed salt\* + dnf list installed salt\* salt --versions-report salt-call --local test.versions_report @@ -78,26 +70,24 @@ To upgrade Salt: * :ref:`install-by-operating-system-index` * `Pin to a release for updates`_ - * - Update RHEL or CentOS repository configuration + * - Update RHEL or CentOS repository configuration (if needed) - To reconfigure your repository from a pinned release to the latest - release, you can either update the appropriate .repo file or uninstall - the existing repo RPM and install the latest repo RPM. See - :ref:`install-rhel`, :ref:`install-centos`, or :ref:`install-rocky` for more information. + release, you can enable the appropriate STS/LTS repo an install as needed. + See :ref:`install-rpm` for more information. - For additional information on configuring yum repositories, refer to + For additional information on configuring yum/dnf repositories, refer to your distribution's documentation. * - Update Debian or Ubuntu repository configuration - To reconfigure your repository from a previously pinned release to the - latest release, update the source's configuration from the existing - source to the latest source listed on :ref:`install-debian` or - :ref:`install-ubuntu`. + latest release, update ``/etc/apt/preferences.d/salt-pin-1001`` as needed. + See :ref:`install-deb` for more information. * - Update macOS or Windows - To update Windows or macOS, download the latest installers and run them. See :ref:`install-macos` or :ref:`install-windows` for these downloads. -#. After the repository file is updated, import the |release| GPG key. +#. After the repository file is updated, import the |minor-lts-version| GPG key. .. include:: _includes/gpg-keys.rst diff --git a/noxfile.py b/noxfile.py index 7b5e542..6571cef 100644 --- a/noxfile.py +++ b/noxfile.py @@ -136,9 +136,9 @@ def docs_html(session, clean, download_versions): session.install(*install_command, silent=True) # Pull down latest Salt version manifest and update sitevars, etc. - if download_versions: - version_updater_script = Path("tools", "version-updater.py") - session.run("python", str(version_updater_script), external=True) + # if download_versions: + # version_updater_script = Path("tools", "version-updater.py") + # session.run("python", str(version_updater_script), external=True) # Run sphinx build_dir = Path("docs", "_build", "html") diff --git a/salt.sources b/salt.sources new file mode 100644 index 0000000..1c7acc3 --- /dev/null +++ b/salt.sources @@ -0,0 +1,14 @@ +X-Repolib-Name: Salt Project +Description: Salt has many possible uses, including configuration management. + Built on Python, Salt is an event-driven automation tool and framework to deploy, + configure, and manage complex IT systems. Use Salt to automate common + infrastructure administration tasks and ensure that all the components of your + infrastructure are operating in a consistent desired state. + - Website: https://saltproject.io + - Public key: https://packages.broadcom.com/artifactory/api/security/keypair/SaltProjectKey/public +Enabled: yes +Types: deb +URIs: https://packages.broadcom.com/artifactory/saltproject-deb +Signed-By: /etc/apt/keyrings/salt-archive-keyring-2023.pgp +Suites: stable +Components: main