Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add local mirroring guidance and update banner message for high visibility #9

Merged
merged 4 commits into from
Nov 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/_static/css/announcement-sticky.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.announcement {
position: fixed;
width: 100%;
z-index: 100;
}

.announcement + .page {
padding-top: var(--header-height);
}
.announcement + .page .mobile-header {
top: var(--header-height);
}
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ def setup(app):
"color-brand-primary": "#66CCF4",
"color-brand-content": "#66CCF4",
},
"announcement": "IMPORTANT ANNOUNCEMENT: repo.saltproject.io has migrated to packages.broadcom.com!<br />A review and update of installation automation is advised.",
"announcement": '<font color="orange"><strong>IMPORTANT ANNOUNCEMENT:</strong> repo.saltproject.io has migrated to packages.broadcom.com!<br /><strong><a href="https://saltproject.io/blog/salt-install-guide-overhaul/" target="_blank" rel="noopener noreferrer">Click here for latest update (2024-10-31)</a></strong></font>',
}

# Add any paths that contain custom static files (such as style sheets) here,
Expand All @@ -193,6 +193,7 @@ def setup(app):
# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://example.com)
html_css_files = [
"css/announcement-sticky.css",
"css/import-all-salt-docs.css",
"css/local-testing.css",
]
Expand Down
6 changes: 3 additions & 3 deletions docs/topics/_includes/install-method.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
The Salt Project provides public repositories for packages on the
public Broadcom Artifactory endpoint:

* `Salt Project RPM Repo <https://packages.broadcom.com/ui/repos/tree/General/saltproject-rpm>`__
* `Salt Project DEB Repo <https://packages.broadcom.com/ui/repos/tree/General/saltproject-deb>`__
* `Salt Project Generic Repo (Windows, MacOS, etc.) <https://packages.broadcom.com/ui/repos/tree/General/saltproject-generic>`__
* `Salt Project RPM Repo <https://packages.broadcom.com/artifactory/saltproject-rpm>`__
* `Salt Project DEB Repo <https://packages.broadcom.com/artifactory/saltproject-deb>`__
* `Salt Project Generic Repo (Windows, MacOS, etc.) <https://packages.broadcom.com/artifactory/saltproject-generic>`__

The preferred method for installing Salt is using distribution packages. This
method ensures that:
Expand Down
1 change: 1 addition & 0 deletions docs/topics/bootstrap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Bootstrap installation

About the Salt bootstrap installation
=====================================

The `Salt Bootstrap project <https://github.com/saltstack/salt-bootstrap>`_ 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
Expand Down
12 changes: 6 additions & 6 deletions docs/topics/downloads.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Linux (RPM)

.. grid-item-card:: Browse the repo for RPM packages
:class-card: sd-border-1
:link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-rpm
:link: https://packages.broadcom.com/artifactory/saltproject-rpm

:bdg-primary:`rpm`
|minor-lts-version-badge|
Expand All @@ -44,14 +44,14 @@ Linux (DEB)

.. grid-item-card:: Browse the repo for DEB packages
:class-card: sd-border-1
:link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-deb
:link: https://packages.broadcom.com/artifactory/saltproject-deb

:bdg-primary:`rpm`
:bdg-primary:`deb`
|minor-lts-version-badge|

.. grid-item-card:: DEB install guide
:class-card: sd-border-1
:link: install-rpm
:link: install-deb
:link-type: ref

:bdg-info:`Install Salt on Debian-like systems`
Expand All @@ -68,7 +68,7 @@ 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://packages.broadcom.com/ui/repos/tree/General/saltproject-generic/macos
:link: https://packages.broadcom.com/artifactory/saltproject-generic/macos

:bdg-danger:`macOS`
|minor-lts-version-badge|
Expand All @@ -93,7 +93,7 @@ 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://packages.broadcom.com/ui/repos/tree/General/saltproject-generic/windows
:link: https://packages.broadcom.com/artifactory/saltproject-generic/windows

:bdg-danger:`Windows`
|minor-lts-version-badge|
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/install-by-operating-system/linux-deb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ 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
:link: https://packages.broadcom.com/artifactory/saltproject-deb/
:width: 50%

:bdg-primary:`deb`
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/install-by-operating-system/linux-rpm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ 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
:link: https://packages.broadcom.com/artifactory/saltproject-rpm/
:width: 50%

:bdg-primary:`rpm`
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/install-by-operating-system/macos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Browse the repo
===============

.. card:: Browse the repo for macOS packages
:link: :link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-generic/macos
:link: https://packages.broadcom.com/artifactory/saltproject-generic/macos
:width: 50%

:bdg-primary:`macOS`
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/install-by-operating-system/windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ Browse the repo

.. card:: Browse the repo for Windows packages
:class-card: sd-border-1
:link: https://packages.broadcom.com/ui/repos/tree/General/saltproject-generic/windows
:link: https://packages.broadcom.com/artifactory/saltproject-generic/windows
:width: 50%

:bdg-primary:`Windows`
107 changes: 106 additions & 1 deletion docs/topics/other-install-types/air-gap-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,109 @@ Install in air-gapped environments
About air-gapped installations
==============================

TBD
To install Salt in an air-gapped environment, you can create a local mirror of
the Salt Project repositories using a sync tool such as ``rclone`` or ``wget``.

Create a local mirror with ``rclone`` (faster)
==============================================

.. note::

Only sync once per day.

To set up local mirrors with ``rclone``:

.. tab-set::

.. tab-item:: Linux (RPM)

Syncs down the following repo: `saltproject-rpm <https://packages.broadcom.com/artifactory/saltproject-rpm/>`__

#. In the ``rclone`` command line, adapt this example:

.. code-block:: bash

RCLONE_WEBDAV_URL=https://packages.broadcom.com/artifactory/ RCLONE_WEBDAV_VENDOR=other rclone sync --fast-list --use-server-modtime -v :webdav:saltproject-rpm/ ./saltproject-rpm/

#. (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_WEBDAV_URL=https://packages.broadcom.com/artifactory/ RCLONE_WEBDAV_VENDOR=other rclone sync --fast-list -c -v :webdav:saltproject-rpm/ ./saltproject-rpm/

.. tab-item:: Linux (DEB)

Syncs down the following repo: `saltproject-deb <https://packages.broadcom.com/artifactory/saltproject-deb/>`__

#. In the ``rclone`` command line, adapt this example:

.. code-block:: bash

RCLONE_WEBDAV_URL=https://packages.broadcom.com/artifactory/ RCLONE_WEBDAV_VENDOR=other rclone sync --fast-list --use-server-modtime -v :webdav:saltproject-deb/ ./saltproject-deb/

#. (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_WEBDAV_URL=https://packages.broadcom.com/artifactory/ RCLONE_WEBDAV_VENDOR=other rclone sync --fast-list -c -v :webdav:saltproject-deb/ ./saltproject-deb/

.. tab-item:: Generic (Windows, macOS, etc.)

Syncs down the following repo: `saltproject-generic <https://packages.broadcom.com/artifactory/saltproject-generic/>`__

#. In the ``rclone`` command line, adapt this example:

.. code-block:: bash

RCLONE_WEBDAV_URL=https://packages.broadcom.com/artifactory/ RCLONE_WEBDAV_VENDOR=other rclone sync --fast-list --use-server-modtime -v :webdav:saltproject-generic/ ./saltproject-generic/

#. (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_WEBDAV_URL=https://packages.broadcom.com/artifactory/ RCLONE_WEBDAV_VENDOR=other rclone sync --fast-list -c -v :webdav:saltproject-generic/ ./saltproject-generic/


Create a local mirror with ``wget`` (slower)
============================================

.. note::

Only sync once per day.

To set up local mirrors with ``wget``:

.. tab-set::

.. tab-item:: Linux (RPM)

Syncs down the following repo: `saltproject-rpm <https://packages.broadcom.com/artifactory/saltproject-rpm/>`__

In the ``wget`` command line, adapt this example:

.. code-block:: bash

wget --mirror -nH --cut-dirs=1 https://packages.broadcom.com/artifactory/saltproject-rpm/

.. tab-item:: Linux (DEB)

Syncs down the following repo: `saltproject-deb <https://packages.broadcom.com/artifactory/saltproject-deb/>`__

In the ``wget`` command line, adapt this example:

.. code-block:: bash

wget --mirror -nH --cut-dirs=1 https://packages.broadcom.com/artifactory/saltproject-deb/

.. tab-item:: Generic (Windows, macOS, etc.)

Syncs down the following repo: `saltproject-generic <https://packages.broadcom.com/artifactory/saltproject-generic/>`__

In the ``wget`` command line, adapt this example:

.. code-block:: bash

wget --mirror -nH --cut-dirs=1 https://packages.broadcom.com/artifactory/saltproject-generic/
1 change: 1 addition & 0 deletions docs/topics/other-install-types/release-candidate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ and write ``[RC]`` in the issue title. For example:

Install using packages
======================

RC builds are available in the Salt package repositories.

To install release candidate packages:
Expand Down