From a7ae1d008db406772127be9109c2f8d2e8948255 Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan Date: Tue, 22 Jul 2025 11:08:50 -0500 Subject: [PATCH] OSDOCS-13577: Kueue disconnected install docs --- _attributes/common-attributes.adoc | 10 ---------- _topic_maps/_topic_map.yml | 7 +++++++ disconnected/_attributes | 1 + disconnected/images | 1 + disconnected/install-disconnected.adoc | 26 ++++++++++++++++++++++++++ disconnected/modules | 1 + disconnected/snippets | 1 + install/install-kueue.adoc | 2 +- modules/create-kueue-cr.adoc | 1 + modules/install-kueue-operator.adoc | 1 + modules/label-namespaces.adoc | 3 ++- 11 files changed, 42 insertions(+), 12 deletions(-) create mode 120000 disconnected/_attributes create mode 120000 disconnected/images create mode 100644 disconnected/install-disconnected.adoc create mode 120000 disconnected/modules create mode 120000 disconnected/snippets diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index d7dbbefb9ab7..5ab94e917cef 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -54,16 +54,6 @@ :SMPluginShort: OSSMC plugin //OLM :olm-first: Operator Lifecycle Manager (OLM) -:olm: OLM -//Initial version of OLM that shipped with OCP 4, aka "v0" and f/k/a "existing" during OLM v1's pre-4.18 TP phase -:olmv0: OLM (Classic) -:olmv0-caps: OLM (Classic) -:olmv0-first: Operator Lifecycle Manager (OLM) Classic -:olmv0-first-caps: Operator Lifecycle Manager (OLM) Classic -//Next-gen (OCP 4.14+) Operator Lifecycle Manager, f/k/a "1.0" -:olmv1: OLM v1 -:olmv1-first: Operator Lifecycle Manager (OLM) v1 -// // Cloud provider names // Alibaba Cloud :alibaba: Alibaba Cloud diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index eee3eacf020f..9bbd9882b8e5 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -45,6 +45,13 @@ Topics: - Name: Installing Red Hat build of Kueue File: install-kueue --- +Name: Installing in a disconnected environment +Dir: disconnected +Distros: openshift-kueue +Topics: +- Name: Installing Red Hat build of Kueue in a disconnected environment + File: install-disconnected +--- Name: Role-based permissions Dir: configure_rbac Distros: openshift-kueue diff --git a/disconnected/_attributes b/disconnected/_attributes new file mode 120000 index 000000000000..f27fd275ea6b --- /dev/null +++ b/disconnected/_attributes @@ -0,0 +1 @@ +../_attributes/ \ No newline at end of file diff --git a/disconnected/images b/disconnected/images new file mode 120000 index 000000000000..e4c5bd02a10a --- /dev/null +++ b/disconnected/images @@ -0,0 +1 @@ +../images/ \ No newline at end of file diff --git a/disconnected/install-disconnected.adoc b/disconnected/install-disconnected.adoc new file mode 100644 index 000000000000..306e6fcdde5e --- /dev/null +++ b/disconnected/install-disconnected.adoc @@ -0,0 +1,26 @@ +:_mod-docs-content-type: ASSEMBLY +include::_attributes/common-attributes.adoc[] +[id="install-disconnected"] += Installing {product-title} in a disconnected environment +:context: install-disconnected + +toc::[] + +Before you can install {product-title} on a disconnected {platform} cluster, you must enable {olm-first} in disconnected environments by completing the following steps: + +* Disable the default remote OperatorHub sources for OLM. +* Use a workstation with full internet access to create and push local mirrors of the OperatorHub content to a mirror registry. +* Configure OLM to install and manage Operators from local sources on the mirror registry instead of the default remote sources. + +After enabling OLM in a disconnected environment, you can continue to use your unrestricted workstation to keep your local OperatorHub sources updated as newer versions of Operators are released. + +For full documentation on completing these steps, see the {platform} documentation on link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/disconnected_environments/olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments]. + +include::modules/install-kueue-operator.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift#installing-the-cert-manager-operator-for-red-hat-openshift[Installing the {cert-manager-operator}] + +include::modules/create-kueue-cr.adoc[leveloffset=+1] +include::modules/label-namespaces.adoc[leveloffset=+1] diff --git a/disconnected/modules b/disconnected/modules new file mode 120000 index 000000000000..43aab75b53c9 --- /dev/null +++ b/disconnected/modules @@ -0,0 +1 @@ +../modules/ \ No newline at end of file diff --git a/disconnected/snippets b/disconnected/snippets new file mode 120000 index 000000000000..9d58b92e5058 --- /dev/null +++ b/disconnected/snippets @@ -0,0 +1 @@ +../snippets/ \ No newline at end of file diff --git a/install/install-kueue.adoc b/install/install-kueue.adoc index f5ab69fcc230..0f582c9f40c6 100644 --- a/install/install-kueue.adoc +++ b/install/install-kueue.adoc @@ -12,7 +12,7 @@ include::modules/install-kueue-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift#installing-the-cert-manager-operator-for-red-hat-openshift[Installing the cert-manager Operator for Red Hat OpenShift] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift#installing-the-cert-manager-operator-for-red-hat-openshift[Installing the {cert-manager-operator}] include::modules/create-kueue-cr.adoc[leveloffset=+1] include::modules/label-namespaces.adoc[leveloffset=+1] diff --git a/modules/create-kueue-cr.adoc b/modules/create-kueue-cr.adoc index 2612617f268c..3d86b7d22cda 100644 --- a/modules/create-kueue-cr.adoc +++ b/modules/create-kueue-cr.adoc @@ -1,6 +1,7 @@ // Module included in the following assemblies: // // * install/install-kueue.adoc +// * /disconnected/install-disconnected.adoc :_mod-docs-content-type: PROCEDURE [id="create-kueue-cr_{context}"] diff --git a/modules/install-kueue-operator.adoc b/modules/install-kueue-operator.adoc index 2ad02a9c0aa0..6c6fdf0e6a44 100644 --- a/modules/install-kueue-operator.adoc +++ b/modules/install-kueue-operator.adoc @@ -1,6 +1,7 @@ // Module included in the following assemblies: // // * /install/install-kueue.adoc +// * /disconnected/install-disconnected.adoc :_mod-docs-content-type: PROCEDURE [id="install-kueue-operator_{context}"] diff --git a/modules/label-namespaces.adoc b/modules/label-namespaces.adoc index 51a22944ffe2..adb0acb1b1ff 100644 --- a/modules/label-namespaces.adoc +++ b/modules/label-namespaces.adoc @@ -1,6 +1,7 @@ // Module included in the following assemblies: // -// * install/install-kueue.adoc +// * /install/install-kueue.adoc +// * /disconnected/install-disconnected.adoc :_mod-docs-content-type: PROCEDURE [id="label-namespaces_{context}"]