From fc732e3a4aebc87a52c903de67360eb12dfda370 Mon Sep 17 00:00:00 2001 From: Max Bridges Date: Tue, 25 Aug 2026 13:31:36 -0400 Subject: [PATCH] Clear JTBD Vale errors OSDOCS-21750 --- ...oshift-about-remote-health-monitoring.adoc | 9 ++++-- ...microshift-applying-manifests-example.adoc | 4 +-- modules/microshift-custom-ca-con.adoc | 9 ++++-- .../microshift-embed-app-rpms-tutorial.adoc | 4 +-- .../microshift-embed-images-offline-use.adoc | 2 +- ...oshift-enabling-workload-partitioning.adoc | 19 +++++++++---- .../microshift-get-node-id-kubesystem.adoc | 6 ++-- ...ift-get-nonrunning-node-id-kubesystem.adoc | 4 ++- ...oshift-greenboot-systemd-journal-data.adoc | 2 +- .../microshift-install-cert-manager-olm.adoc | 8 +++++- ...icroshift-install-multus-running-node.adoc | 2 +- modules/microshift-install-rhde-steps.adoc | 14 +++++----- ...icroshift-install-rhel-tools-concepts.adoc | 28 +++++++++---------- modules/microshift-install-rhel-types.adoc | 14 ++++++---- modules/microshift-install-rpms.adoc | 2 +- .../microshift-installing-olm-options.adoc | 10 +++++-- ...oshift-installing-sriov-operator-proc.adoc | 2 +- modules/microshift-low-latency-concept.adoc | 7 ++++- modules/microshift-manifests-overview.adoc | 4 +-- modules/microshift-olm-build-op-catalogs.adoc | 16 ++++++----- modules/microshift-olm-considerations.adoc | 12 ++++++-- ...t-operators-how-to-install-and-manage.adoc | 12 ++++---- ...ft-preparing-for-image-building-bootc.adoc | 7 +++-- ...croshift-preparing-for-image-building.adoc | 13 +++++---- modules/microshift-rhoai-workflow.adoc | 7 ++++- modules/microshift-rpm-ostree-updates.adoc | 7 +++-- modules/nw-throughput-troubleshoot.adoc | 16 ++++++++--- ...-mirror-imageset-config-parameters-v2.adoc | 2 +- 28 files changed, 151 insertions(+), 91 deletions(-) diff --git a/modules/microshift-about-remote-health-monitoring.adoc b/modules/microshift-about-remote-health-monitoring.adoc index 4dd6b5b27d8..46571a08efe 100644 --- a/modules/microshift-about-remote-health-monitoring.adoc +++ b/modules/microshift-about-remote-health-monitoring.adoc @@ -13,7 +13,7 @@ Remote health monitoring is conducted in {microshift-short} by the collection of Telemetry provides the following benefits: -* *Enhanced identification and resolution of issues*. Events that might seem normal to an end-user can be observed by Red{nbsp}Hat from a broader perspective. Some issues can be more rapidly identified from this point of view and resolved without an end-user needing to open a support case or file a link:https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330&summary=Summary&issuetype=1&priority=10200&versions=12385624[Jira issue]. +* *Enhanced identification and resolution of issues*. Events that might seem normal to an end-user can be observed by Red{nbsp}Hat from a broader perspective. Some issues can be more rapidly identified from this point of view and resolved without an end-user needing to open a support case or file a Jira issue. * *Targeted prioritization of new features and functionality*. The data collected provides information about system capabilities and usage characteristics. With this information, Red{nbsp}Hat can focus on developing the new features and functionality that have the greatest impact for our customers. @@ -24,4 +24,9 @@ This debugging information is available to Red{nbsp}Hat Support and Engineering [NOTE] ==== {microshift-short} does not support Prometheus. To view the Telemetry gathered from your node, you must contact Red{nbsp}Hat Support. -==== \ No newline at end of file +==== + +[role="_additional-resources"] +.Additional resources + +* link:https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330&summary=Summary&issuetype=1&priority=10200&versions=12385624[Open a Jira issue] \ No newline at end of file diff --git a/modules/microshift-applying-manifests-example.adoc b/modules/microshift-applying-manifests-example.adoc index ff2b606292d..7648b39e79f 100644 --- a/modules/microshift-applying-manifests-example.adoc +++ b/modules/microshift-applying-manifests-example.adoc @@ -28,7 +28,7 @@ $ sudo mkdir -p ${MANIFEST_DIR} + .. Place the YAML file in the directory: + -[source,text] +[source,text,subs="verbatim"] ---- sudo tee ${MANIFEST_DIR}/busybox.yaml &>/dev/null </dev/null <_.toml .. If needed, create a directory and file for the pull secret, for example: + -.Example directory and file +The directory and file can look like the following example: + [source,terminal,subs="+quotes"] ---- diff --git a/modules/microshift-enabling-workload-partitioning.adoc b/modules/microshift-enabling-workload-partitioning.adoc index b7ab1ffccdd..23341daabff 100644 --- a/modules/microshift-enabling-workload-partitioning.adoc +++ b/modules/microshift-enabling-workload-partitioning.adoc @@ -6,6 +6,7 @@ [id="microshift-enabling-workload-partitioning_{context}"] = Enable workload partitioning +[role="_abstract"] To enable workload partitioning on {microshift-short}, make the following configuration changes: * Update the {microshift-short} `config.yaml` file to include the kubelet configuration file. @@ -23,12 +24,15 @@ To enable workload partitioning on {microshift-short}, make the following config # ... { "management": { - "cpuset": "0,6,7" <1> + "cpuset": "0,6,7" } } # ... ---- -<1> The `cpuset` applies to a machine with 8 VCPUs (4 cores) and is valid throughout the document. ++ +where: ++ +`cpuset`:: The `cpuset` applies to a machine with 8 VCPUs (4 cores) and is valid throughout the document. * Update the {microshift-short} config.yaml file in the path `/etc/microshift/config.yaml`. Embed the kubelet configuration in the {microshift-short} `config.yaml` file to enable and configure CPU Manager for the workloads. + .{microshift-short} `config.yaml` example @@ -36,15 +40,18 @@ To enable workload partitioning on {microshift-short}, make the following config ---- # ... kubelet: - reservedSystemCPUs: 0,6,7 <1> + reservedSystemCPUs: 0,6,7 cpuManagerPolicy: static cpuManagerPolicyOptions: - full-pcpus-only: "true" <2> + full-pcpus-only: "true" cpuManagerReconcilePeriod: 5s # ... ---- -<1> Exclusive cpuset for the system daemons and the interrupts/timers. -<2> kubelet configuration sets the `CPUManagerPolicyOptions` option to `full-pcpus-only` to ensure allocation of whole cores to the containers workload. ++ +where: ++ +`reservedSystemCPUs`:: Exclusive cpuset for the system daemons and the interrupts/timers. +`full-pcpus-only`:: The kubelet configuration sets the `CPUManagerPolicyOptions` option to `full-pcpus-only` to ensure allocation of whole cores to the containers workload. . Create the CRI-O systemd and configuration files: * Create the CRI-O configuration file in the path `/etc/crio/crio.conf.d/20-microshift-workload-partition.conf` which overrides the default configuration that already exists in the `11-microshift-ovn.conf` file. diff --git a/modules/microshift-get-node-id-kubesystem.adoc b/modules/microshift-get-node-id-kubesystem.adoc index 5f30a61b823..745ce183355 100644 --- a/modules/microshift-get-node-id-kubesystem.adoc +++ b/modules/microshift-get-node-id-kubesystem.adoc @@ -17,7 +17,8 @@ Retrieving the node ID enables you to uniquely identify a device within your dep ---- $ oc get namespaces kube-system -o jsonpath={.metadata.uid} ---- -.Example output ++ +Example output: + [source,terminal] ---- @@ -30,7 +31,8 @@ $ oc get namespaces kube-system -o jsonpath={.metadata.uid} ---- $ sudo cat /var/lib/microshift/cluster-id ---- -.Example output ++ +Example output: + [source,terminal] ---- diff --git a/modules/microshift-get-nonrunning-node-id-kubesystem.adoc b/modules/microshift-get-nonrunning-node-id-kubesystem.adoc index 5ef44979ebd..51092e3ccf9 100644 --- a/modules/microshift-get-nonrunning-node-id-kubesystem.adoc +++ b/modules/microshift-get-nonrunning-node-id-kubesystem.adoc @@ -6,6 +6,7 @@ [id="microshift-get-nonrunning-node-id-kubesystem_{context}"] = Get the node ID of a stopped node +[role="_abstract"] When the MicroShift service is inactive, you can prevent the use of standard API commands by retrieving the node ID from the file system. You can use this ID to identify offline nodes for disaster recovery, verify backup compatibility, and troubleshoot issues. .Procedure @@ -16,7 +17,8 @@ When the MicroShift service is inactive, you can prevent the use of standard API ---- $ sudo cat /var/lib/microshift/cluster-id ---- -.Example output ++ +Example output: + [source,terminal] ---- diff --git a/modules/microshift-greenboot-systemd-journal-data.adoc b/modules/microshift-greenboot-systemd-journal-data.adoc index 08b21d794d5..0571f72cf18 100644 --- a/modules/microshift-greenboot-systemd-journal-data.adoc +++ b/modules/microshift-greenboot-systemd-journal-data.adoc @@ -20,7 +20,7 @@ $ sudo mkdir -p /etc/systemd/journald.conf.d . Create the configuration file by running the following command: + -[source,terminal] +[source,terminal,subs="verbatim"] ---- cat </dev/null [Journal] diff --git a/modules/microshift-install-cert-manager-olm.adoc b/modules/microshift-install-cert-manager-olm.adoc index a529383b1a5..c9a94ed93d3 100644 --- a/modules/microshift-install-cert-manager-olm.adoc +++ b/modules/microshift-install-cert-manager-olm.adoc @@ -7,4 +7,10 @@ = Install and enable the cert-manager Operator using OLM [role="_abstract"] -You can install the optional `microshift-cert-manager` by using OLM at any time. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/operators#microshift-operators-olm[Using Operator Lifecycle Manager with MicroShift] and link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift#cert-manager-operator-install[Installing the cert-manager Operator for Red Hat OpenShift]. +You can install the optional `microshift-cert-manager` by using OLM at any time. + +[role="_additional-resources"] +.Additional resources + +* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/operators#microshift-operators-olm[Using Operator Lifecycle Manager with MicroShift] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift#cert-manager-operator-install[Installing the {cert-manager-operator}] diff --git a/modules/microshift-install-multus-running-node.adoc b/modules/microshift-install-multus-running-node.adoc index 04cc77d7093..3c393553685 100644 --- a/modules/microshift-install-multus-running-node.adoc +++ b/modules/microshift-install-multus-running-node.adoc @@ -2,7 +2,7 @@ // // * microshift_networking/microshift-cni-multus.adoc -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: PROCEDURE [id="microshift-multus-installing-on-running-node_{context}"] = Install the Multus CNI plugin on a running node diff --git a/modules/microshift-install-rhde-steps.adoc b/modules/microshift-install-rhde-steps.adoc index 9e2755515e6..db9a43ecb7c 100644 --- a/modules/microshift-install-rhde-steps.adoc +++ b/modules/microshift-install-rhde-steps.adoc @@ -11,21 +11,21 @@ Before proceeding with your specific installation method, you must prepare your For most installation types, you must also take the following steps: -* Download the pull secret from the Red{nbsp}Hat Hybrid Cloud Console using the following link: - -** link:https://console.redhat.com/openshift/install/pull-secret[Pull secret] +* Download the pull secret. * Be ready to configure {microshift-short} by adding parameters and values to the {microshift-short} YAML configuration file. For more information, see "Customizing MicroShift by using the configuration file". * Decide whether you need to configure storage for the application and tasks you are using in your {microshift-short} node, or disable the {microshift-short} storage plugin completely. -* For more information about creating volume groups and persistent volumes on {op-system-base}, see the following link: - -** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management] - * Configure networking settings according to the access needs you plan for your {microshift-short} node and applications. Consider whether you want to use single or dual-stack networks, configure a firewall, or configure routes. + [NOTE] ==== You can use the {op-system-rt-kernel} where predictable latency is critical. Workload partitioning is also required for low-latency applications. For more information about low latency and the {op-system-rtk}, see "Configuring low latency". ==== + +[role="_additional-resources"] +.Additional resources + +* link:https://console.redhat.com/openshift/install/pull-secret[Pull secret] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management] diff --git a/modules/microshift-install-rhel-tools-concepts.adoc b/modules/microshift-install-rhel-tools-concepts.adoc index f394177c09c..cbc75fe888a 100644 --- a/modules/microshift-install-rhel-tools-concepts.adoc +++ b/modules/microshift-install-rhel-tools-concepts.adoc @@ -11,22 +11,22 @@ To successfully construct and deploy a custom {microshift-short} image, you must Review the following resources to familiarize yourself with the required image building components: -* A Kickstart file, which contains the configuration and instructions used during the installation of your specific operating system. For more information, see the following link: +* A Kickstart file, which contains the configuration and instructions used during the installation of your specific operating system. -** link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/latest/html/using_rhel_kickstarts/microshift-rhel-kickstarts[Using Kickstart files for installing {microshift-short} in {op-system-base}] +* {op-system-base} image builder is a tool for creating deployment-ready customized system images. {op-system-base} image builder uses a blueprint that you create to make the ISO. {op-system-base} image builder is best installed on a {op-system-base} VM and is built with the `composer-cli` tool. -* {op-system-base} image builder is a tool for creating deployment-ready customized system images. {op-system-base} image builder uses a blueprint that you create to make the ISO. {op-system-base} image builder is best installed on a {op-system-base} VM and is built with the `composer-cli` tool. To set up these tools and review the workflow, see the following {op-system-base} documentation links: +* A blueprint file directs {op-system-base} image builder to the items to include in the ISO. An image blueprint provides a persistent definition of image customizations. You can create multiple builds from a single blueprint. You can also edit an existing blueprint to build a new ISO as requirements change. -** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-command-line-interface_composing-a-customized-rhel-system-image#composer-command-line-interface_creating-system-images-with-composer-command-line-interface[Introducing the RHEL image builder command-line interface] -** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/installing-composer_composing-a-customized-rhel-system-image[Installing image builder] -** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-command-line-interface_composing-a-customized-rhel-system-image#creating-a-system-image-with-composer-in-the-command-line-interface_creating-system-images-with-composer-command-line-interface[Creating a system image with RHEL image builder in the command-line interface] +* An ISO, which is the bootable operating system on which {microshift-short} runs. -* A blueprint file directs {op-system-base} image builder to the items to include in the ISO. An image blueprint provides a persistent definition of image customizations. You can create multiple builds from a single blueprint. You can also edit an existing blueprint to build a new ISO as requirements change. See the following link for more information: +[role="_additional-resources"] +.Additional resources -** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-command-line-interface_composing-a-customized-rhel-system-image#creating-a-composer-blueprint-with-command-line-interface_creating-system-images-with-composer-command-line-interface[Creating a blueprint by using the command-line interface] - -* An ISO, which is the bootable operating system on which {microshift-short} runs. See the following links for more information: - -** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-a-boot-iso-installer-image-with-image-builder_composing-a-customized-rhel-system-image#creating-a-boot-iso-installer-image-with-image-builder-in-the-command-line-interface_creating-a-boot-iso-installer-image-with-image-builder[Creating a boot ISO installer image using the RHEL image builder CLI] -** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-a-boot-iso-installer-image-with-image-builder_composing-a-customized-rhel-system-image#installing-the-iso-to-a-bare-metal-system_creating-a-boot-iso-installer-image-with-image-builder[Installing a bootable ISO to a media and booting it] -** link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/latest/html/embedding_in_a_rhel_for_edge_image/microshift-embed-in-rpm-ostree[Embedding in a {op-system-ostree} image using image builder] +* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/latest/html/using_rhel_kickstarts/microshift-rhel-kickstarts[Using Kickstart files for installing {microshift-short} in {op-system-base}] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-command-line-interface_composing-a-customized-rhel-system-image#composer-command-line-interface_creating-system-images-with-composer-command-line-interface[Introducing the RHEL image builder command-line interface] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/installing-composer_composing-a-customized-rhel-system-image[Installing image builder] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-command-line-interface_composing-a-customized-rhel-system-image#creating-a-system-image-with-composer-in-the-command-line-interface_creating-system-images-with-composer-command-line-interface[Creating a system image with RHEL image builder in the command-line interface] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-command-line-interface_composing-a-customized-rhel-system-image#creating-a-composer-blueprint-with-command-line-interface_creating-system-images-with-composer-command-line-interface[Creating a blueprint by using the command-line interface] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-a-boot-iso-installer-image-with-image-builder_composing-a-customized-rhel-system-image#creating-a-boot-iso-installer-image-with-image-builder-in-the-command-line-interface_creating-a-boot-iso-installer-image-with-image-builder[Creating a boot ISO installer image using the RHEL image builder CLI] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-a-boot-iso-installer-image-with-image-builder_composing-a-customized-rhel-system-image#installing-the-iso-to-a-bare-metal-system_creating-a-boot-iso-installer-image-with-image-builder[Installing a bootable ISO to a media and booting it] +* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/latest/html/embedding_in_a_rhel_for_edge_image/microshift-embed-in-rpm-ostree[Embedding in a {op-system-ostree} image using image builder] diff --git a/modules/microshift-install-rhel-types.adoc b/modules/microshift-install-rhel-types.adoc index 31b8611417d..0a28fac6594 100644 --- a/modules/microshift-install-rhel-types.adoc +++ b/modules/microshift-install-rhel-types.adoc @@ -27,15 +27,17 @@ Image-based installation types involve creating an `rpm-ostree`-based, immutable * {op-system-ostree} can be deployed to the edge in production environments. You can use this installation type where network connections are present, restricted, or completely offline, depending on the local environment. -* Image mode for {op-system-base} is based on OCI container images and bootable containers. See the following link for an introduction to bootc technology: - -** link:https://developers.redhat.com/articles/2024/09/24/bootc-getting-started-bootable-containers[bootc: Getting started with bootable containers] +* Image mode for {op-system-base} is based on OCI container images and bootable containers. When choosing an image-based installation, consider whether the installation target is intended to be in an offline or networked state, where you plan to build system images, and how you plan to load your {op-system-bundle}. Use the following scenarios as general guidance: * If you build either a fully self-contained {op-system-ostree} or an image mode for {op-system-base} ISO outside a disconnected environment, and then install the ISO locally on your edge devices, you likely do not need an RPM repository or a mirror registry. * If you build an ISO outside a disconnected environment that does not include the container images, but consists of only the RPMs, you need a mirror registry inside your disconnected environment. You use your mirror registry to pull container images. -* If you build images inside a disconnected environment, or use package-based installations, you need both a mirror registry and a local RPM mirror repository. You can use either the {op-system-base} reposync utility or Red{nbsp}Hat Satellite for advanced use cases. See the following links for more information: +* If you build images inside a disconnected environment, or use package-based installations, you need both a mirror registry and a local RPM mirror repository. You can use either the {op-system-base} reposync utility or Red{nbsp}Hat Satellite for advanced use cases. + +[role="_additional-resources"] +.Additional resources -** link:https://access.redhat.com/solutions/7019225[Creating a local mirror of the latest update for {op-system-base} without using Satellite Server] -** link:https://www.redhat.com/en/technologies/management/satellite[Red{nbsp}Hat Satellite] +* link:https://developers.redhat.com/articles/2024/09/24/bootc-getting-started-bootable-containers[bootc: Getting started with bootable containers] +* link:https://access.redhat.com/solutions/7019225[Creating a local mirror of the latest update for {op-system-base} without using Satellite Server] +* link:https://www.redhat.com/en/technologies/management/satellite[Red{nbsp}Hat Satellite] diff --git a/modules/microshift-install-rpms.adoc b/modules/microshift-install-rpms.adoc index 4caec10673c..59c95f9371f 100644 --- a/modules/microshift-install-rpms.adoc +++ b/modules/microshift-install-rpms.adoc @@ -48,7 +48,7 @@ $ sudo subscription-manager release --set={op-system-version} $ sudo dnf install -y microshift ---- -. Download your installation pull secret from the https://console.redhat.com/openshift/install/pull-secret[Red Hat Hybrid Cloud Console] to a temporary folder, for example, `$HOME/openshift-pull-secret`. This pull secret allows you to authenticate with the container registries that serve the container images used by {product-title}. +. Download your installation pull secret to a temporary folder, for example, `$HOME/openshift-pull-secret`. This pull secret allows you to authenticate with the container registries that serve the container images used by {product-title}. . To copy the pull secret to the `/etc/crio` folder of your {op-system-base} machine, run the following command: + diff --git a/modules/microshift-installing-olm-options.adoc b/modules/microshift-installing-olm-options.adoc index 7d28b7dd3c9..5b20d78048b 100644 --- a/modules/microshift-installing-olm-options.adoc +++ b/modules/microshift-installing-olm-options.adoc @@ -11,6 +11,10 @@ You can install Operator Lifecycle Manager (OLM) for use with {microshift-short} * You can install the `microshift-olm` RPM at the same time you install the {microshift-short} RPM on {op-system-base-full}. * You can install the `microshift-olm` on an existing {microshift-short} {product-version}. Restart the {microshift-short} service after installing OLM for the changes to apply. -* See the following links for specifics on each installation type: -** link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/4.20/html/installing_optional_rpm_packages/microshift-install-optional-rpms#microshift-installing-with-olm-from-rpm-package_microshift-install-optional-rpm[Installing the Operator Lifecycle Manager (OLM) from an RPM package] -** link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/4.20/html/embedding_in_a_rhel_for_edge_image/microshift-embed-in-rpm-ostree#microshift-adding-other-services-to-blueprint_microshift-embed-in-rpm-ostree[Adding other packages to a blueprint] +* See the following resources for specifics on each installation type: + +[role="_additional-resources"] +.Additional resources + +* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/4.20/html/installing_optional_rpm_packages/microshift-install-optional-rpms#microshift-installing-with-olm-from-rpm-package_microshift-install-optional-rpm[Installing the Operator Lifecycle Manager (OLM) from an RPM package] +* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/4.20/html/embedding_in_a_rhel_for_edge_image/microshift-embed-in-rpm-ostree#microshift-adding-other-services-to-blueprint_microshift-embed-in-rpm-ostree[Adding other packages to a blueprint] diff --git a/modules/microshift-installing-sriov-operator-proc.adoc b/modules/microshift-installing-sriov-operator-proc.adoc index da31f008199..bbf31010761 100644 --- a/modules/microshift-installing-sriov-operator-proc.adoc +++ b/modules/microshift-installing-sriov-operator-proc.adoc @@ -48,7 +48,7 @@ spec: ** The `spec.nicSelector` parameter identifies the device for the Operator to configure. You do not have to specify values for all the parameters. It is recommended to identify the network device with enough precision to avoid selecting a device unintentionally. If you specify `rootDevices`, you must also specify a value for `vendor`, `deviceID`, or `pfNames`. If you specify both `pfNames` and `rootDevices` at the same time, ensure that they refer to the same device. If you specify a value for `netFilter`, then you do not need to specify any other parameter because a network ID is unique. ** (Optional) The `spec.nicSelector.pfNames` parameter specifies an array of one or more physical function (PF) names for the device. ** (Optional) The `spec.deviceType` parameter specifies the driver type for the virtual functions. The only allowed value is `netdevice`. -** (Optional) The `spec.isRDMA` parameter configures whether to enable remote direct memory access (RDMA) mode. The default value is `false`. If the `spec.isRdma` parameter is set to `true`, you can continue to use the RDMA-enabled VF as a normal network device. A device can be used in either mode. to configure a Mellanox NIC for use with Fast Datapath DPDK applications, set `spec.isRdma` to `true` and additionally set the `needVhostNet` parameter to `true` +** (Optional) The `spec.isRDMA` parameter configures whether to enable remote direct memory access (RDMA) mode. The default value is `false`. If the `spec.isRdma` parameter is set to `true`, you can continue to use the RDMA-enabled VF as a normal network device. A device can be used in either mode. To configure a Mellanox NIC for use with DPDK applications that require a fast data path, set `spec.isRdma` to `true` and additionally set the `needVhostNet` parameter to `true`. + [NOTE] ==== diff --git a/modules/microshift-low-latency-concept.adoc b/modules/microshift-low-latency-concept.adoc index 73ba2a73943..fa3338e6769 100644 --- a/modules/microshift-low-latency-concept.adoc +++ b/modules/microshift-low-latency-concept.adoc @@ -26,4 +26,9 @@ Required:: * Restart the host. Optional:: -* If you are using the x86_64 architecture, you can install link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_for_real_time/9[Red Hat Enterprise Linux for Real Time 9]. +* If you are using the x86_64 architecture, you can install Red Hat Enterprise Linux for Real Time 9. + +[role="_additional-resources"] +.Additional resources + +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_for_real_time/9[Red Hat Enterprise Linux for Real Time 9] diff --git a/modules/microshift-manifests-overview.adoc b/modules/microshift-manifests-overview.adoc index 1adfa27178e..c86803bba86 100644 --- a/modules/microshift-manifests-overview.adoc +++ b/modules/microshift-manifests-overview.adoc @@ -44,10 +44,10 @@ This automatic loading from multiple directories means you can manage {microshif |Intent |`/etc/microshift/manifests` -|Read-write location for configuration management systems or development. +|Read/write location for configuration management systems or development. |`/etc/microshift/manifests.d/*` -|Read-write location for configuration management systems or development. +|Read/write location for configuration management systems or development. |`/usr/lib/microshift/manifests` |Read-only location for embedding configuration manifests on OSTree-based systems. diff --git a/modules/microshift-olm-build-op-catalogs.adoc b/modules/microshift-olm-build-op-catalogs.adoc index 5d1baca949c..f0eb90cb591 100644 --- a/modules/microshift-olm-build-op-catalogs.adoc +++ b/modules/microshift-olm-build-op-catalogs.adoc @@ -12,15 +12,17 @@ To use Operator Lifecycle Manager (OLM) with {microshift-short}, you must build [id="microshift-file-based-olm-catalogs_{context}"] == File-based Operator catalogs -You can create catalogs for your custom Operators or filter catalogs of widely available Operators. You can combine both methods to create the catalogs needed for your specific use case. To run {microshift-short} with your own Operators and OLM, make a catalog by using the file-based catalog structure. For more information, see the following links: - -* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-managing-custom-catalogs[Managing custom catalogs] -* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/operators/understanding-operators#olm-packaging-format[Example catalog] -* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/cli_tools/opm-cli#cli-opm-ref[`opm` CLI reference] +You can create catalogs for your custom Operators or filter catalogs of widely available Operators. You can combine both methods to create the catalogs needed for your specific use case. To run {microshift-short} with your own Operators and OLM, make a catalog by using the file-based catalog structure. [IMPORTANT] ==== -* When adding a catalog source to a cluster, set the `securityContextConfig` value to `restricted` in the `catalogSource.yaml` file. Ensure that your catalog can run with `restricted` permissions. For more information, see: +* When adding a catalog source to a cluster, set the `securityContextConfig` value to `restricted` in the `catalogSource.yaml` file. Ensure that your catalog can run with `restricted` permissions. +==== +[role="_additional-resources"] +.Additional resources + +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-managing-custom-catalogs[Managing custom catalogs] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/operators/understanding-operators#olm-packaging-format[Example catalog] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/cli_tools/opm-cli#cli-opm-ref[`opm` CLI reference] * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-creating-catalog-from-index_olm-restricted-networks[Adding a catalog source to a cluster] -==== diff --git a/modules/microshift-olm-considerations.adoc b/modules/microshift-olm-considerations.adoc index 520cc1e69f0..cb5f9e24b79 100644 --- a/modules/microshift-olm-considerations.adoc +++ b/modules/microshift-olm-considerations.adoc @@ -13,10 +13,16 @@ You must consider the application of Operators and steps to use them when planni * You must create your own catalogs for the add-on Operators you want to use with your applications. Catalogs are not provided by default. ** Each catalog must have an accessible `CatalogSource` added to a node, so that the OLM catalog Operator can use the catalog for content. * You must use the CLI to conduct OLM activities with {microshift-short}. The console and OperatorHub GUIs are not available. -** Use the link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/cli_tools/opm-cli#cli-opm-install[Operator Package Manager `opm` CLI] with a network-connected node, or for building catalogs for custom Operators that use an internal registry. -** To mirror your catalogs and Operators for disconnected or offline nodes, install link:https://docs.openshift.com/container-platform/{ocp-version}/installing/disconnected_install/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[the oc-mirror OpenShift CLI plugin]. +** Use the Operator Package Manager (`opm`) CLI with a network-connected node, or for building catalogs for custom Operators that use an internal registry. +** To mirror your catalogs and Operators for disconnected or offline nodes, install the `oc-mirror` OpenShift CLI plugin. [IMPORTANT] ==== Before using an Operator, verify with the provider that the Operator is supported on {product-title}. -==== \ No newline at end of file +==== + +[role="_additional-resources"] +.Additional resources + +* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/cli_tools/opm-cli#cli-opm-install[Operator Package Manager `opm` CLI] +* link:https://docs.openshift.com/container-platform/{ocp-version}/installing/disconnected_install/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin] \ No newline at end of file diff --git a/modules/microshift-operators-how-to-install-and-manage.adoc b/modules/microshift-operators-how-to-install-and-manage.adoc index 1aaf3042fc6..dc64be5f025 100644 --- a/modules/microshift-operators-how-to-install-and-manage.adoc +++ b/modules/microshift-operators-how-to-install-and-manage.adoc @@ -12,14 +12,16 @@ There are two ways to install and manage Operators for your {microshift-short} n [id="microshift-operators-paths-manifests_{context}"] == Manifests for Operators -You can install and manage Operators directly by using manifests. You can use the `kustomize` configuration management tool with {microshift-short} to deploy an application. Use the same steps to install Operators with manifests. For more information, see the following links: - -* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/applications-with-microshift[Using Kustomize manifests to deploy applications] -* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/applications-with-microshift#microshift-applying-manifests-example_applications-microshift[Using manifests example] +You can install and manage Operators directly by using manifests. You can use the `kustomize` configuration management tool with {microshift-short} to deploy an application. Use the same steps to install Operators with manifests. [id="microshift-operators-paths-olm_{context}"] == Operator Lifecycle Manager for Operators -You can also install add-on Operators to a {microshift-short} node by using Operator Lifecycle Manager (OLM). OLM can be used to manage both custom Operators and Operators that are widely available. Building catalogs is required to use OLM with {microshift-short}. For more information, see the following link: +You can also install add-on Operators to a {microshift-short} node by using Operator Lifecycle Manager (OLM). OLM can be used to manage both custom Operators and Operators that are widely available. Building catalogs is required to use OLM with {microshift-short}. +[role="_additional-resources"] +.Additional resources + +* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/applications-with-microshift[Using Kustomize manifests to deploy applications] +* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/applications-with-microshift#microshift-applying-manifests-example_applications-microshift[Using manifests example] * link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/operators#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}] diff --git a/modules/microshift-preparing-for-image-building-bootc.adoc b/modules/microshift-preparing-for-image-building-bootc.adoc index 8f4dbb49722..8f9f299f437 100644 --- a/modules/microshift-preparing-for-image-building-bootc.adoc +++ b/modules/microshift-preparing-for-image-building-bootc.adoc @@ -11,8 +11,9 @@ Use the image builder tool to compose customized {microshift-short} bootc images Use the following {op-system-base} documentation to understand the full details of using {op-system-image}: -* Follow the instructions at the following link: +include::snippets/microshift-power-loss-embed-images.adoc[leveloffset=1] -** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/{op-system-version-major}/html/using_image_mode_for_rhel_to_build_deploy_and_manage_operating_systems/index[Using image mode for RHEL to build, deploy, and manage operating systems] +[role="_additional-resources"] +.Additional resources -include::snippets/microshift-power-loss-embed-images.adoc[leveloffset=1] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/{op-system-version-major}/html/using_image_mode_for_rhel_to_build_deploy_and_manage_operating_systems/index[Using image mode for RHEL to build, deploy, and manage operating systems] diff --git a/modules/microshift-preparing-for-image-building.adoc b/modules/microshift-preparing-for-image-building.adoc index f9e6907f627..362beec2d68 100644 --- a/modules/microshift-preparing-for-image-building.adoc +++ b/modules/microshift-preparing-for-image-building.adoc @@ -15,12 +15,13 @@ You can run a {microshift-short} node with your applications on a {op-system-ost Use the following {op-system-base} documentation to understand the full details of using {op-system-ostree}: -* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/introducing-rhel-for-edge-images_composing-installing-managing-rhel-for-edge-images[Introduction to RHEL for Edge images] - -* To build an {op-system-ostree-first} {op-system-version} image for a given CPU architecture, you need a {op-system-base} {op-system-version} build host of the same CPU architecture that meets the image builder system requirements. See the following link for more information: +* To build an {op-system-ostree-first} {op-system-version} image for a given CPU architecture, you need a {op-system-base} {op-system-version} build host of the same CPU architecture that meets the image builder system requirements. -** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/setting-up-image-builder_composing-installing-managing-rhel-for-edge-images#edge-image-builder-system-requirements_setting-up-image-builder[Image builder system requirements] +* To install image builder and the `composer-cli` tool, use the following instructions. -* To install image builder and the `composer-cli` tool, use the following instructions: +[role="_additional-resources"] +.Additional resources -** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/setting-up-image-builder_composing-installing-managing-rhel-for-edge-images#edge-installing-image-builder_setting-up-image-builder[Installing image builder] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/introducing-rhel-for-edge-images_composing-installing-managing-rhel-for-edge-images[Introduction to RHEL for Edge images] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/setting-up-image-builder_composing-installing-managing-rhel-for-edge-images#edge-image-builder-system-requirements_setting-up-image-builder[Image builder system requirements] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/setting-up-image-builder_composing-installing-managing-rhel-for-edge-images#edge-installing-image-builder_setting-up-image-builder[Installing image builder] diff --git a/modules/microshift-rhoai-workflow.adoc b/modules/microshift-rhoai-workflow.adoc index ccc75246133..6b9771c0c55 100644 --- a/modules/microshift-rhoai-workflow.adoc +++ b/modules/microshift-rhoai-workflow.adoc @@ -19,7 +19,7 @@ Setting up the deployment environment:: * Configure your {op-system-bundle} for the specific hardware your deployment runs on, including driver and device plugins. -* To enable GPU or other hardware accelerators for {microshift-short}, follow the guidance specific for your edge device about what you need to install. For example, to use an NVIDIA GPU accelerator, begin by reading the following NVIDIA documentation: link:https://docs.nvidia.com/datacenter/cloud-native/edge/latest/nvidia-gpu-with-device-edge.html#running-a-gpu-accelerated-workload-on-red-hat-device-edge[Running a GPU-Accelerated Workload on Red Hat Device Edge] (NVIDIA documentation). +* To enable GPU or other hardware accelerators for {microshift-short}, follow the guidance specific for your edge device about what you need to install. For example, to use an NVIDIA GPU accelerator, begin by reading NVIDIA documentation. * For troubleshooting, consult the device documentation or product support. + @@ -49,3 +49,8 @@ Getting ready to deploy:: Using your model:: * Make requests against the model server. For example, another pod running in your {microshift-short} deployment that is attached to a camera can stream an image back to the model-serving runtime. The model-serving runtime prepares that image as data for model inferencing. If the model was trained in the binary identification of a bee, the AI model outputs the likelihood that the image data is a bee. + +[role="_additional-resources"] +.Additional resources + +* link:https://docs.nvidia.com/datacenter/cloud-native/edge/latest/nvidia-gpu-with-device-edge.html#running-a-gpu-accelerated-workload-on-red-hat-device-edge[Running a GPU-Accelerated Workload on Red Hat Device Edge] diff --git a/modules/microshift-rpm-ostree-updates.adoc b/modules/microshift-rpm-ostree-updates.adoc index 9cd7b0f8d2e..7d152e2126a 100644 --- a/modules/microshift-rpm-ostree-updates.adoc +++ b/modules/microshift-rpm-ostree-updates.adoc @@ -22,10 +22,11 @@ The following features are available in the {op-system-ostree} update path: To begin a {microshift-short} update by embedding the new version in a {op-system-ostree} image, use the procedures in the following documentation: -* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/updating/microshift-update-rpms-ostree#microshift-updates-rpms-ostree_microshift-update-rpms-ostree[Applying updates on a RHEL for Edge system] - To understand more about greenboot, see the following documentation: -* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/getting_ready_to_install_microshift/microshift-greenboot[The greenboot health check framework] +[role="_additional-resources"] +.Additional resources +* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/updating/microshift-update-rpms-ostree#microshift-updates-rpms-ostree_microshift-update-rpms-ostree[Applying updates on a RHEL for Edge system] +* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/getting_ready_to_install_microshift/microshift-greenboot[The greenboot health check framework] * link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/microshift-greenboot-workload-health-checks[Using greenboot for application and workload health checks] diff --git a/modules/nw-throughput-troubleshoot.adoc b/modules/nw-throughput-troubleshoot.adoc index bddba3b75df..72f558245c4 100644 --- a/modules/nw-throughput-troubleshoot.adoc +++ b/modules/nw-throughput-troubleshoot.adoc @@ -14,7 +14,7 @@ If pod logs do not reveal any cause of the problem, use the following methods to * Use a packet analyzer, such as `ping` or `tcpdump` to analyze traffic between a pod and its node. + -For example, link:https://access.redhat.com/solutions/4569211[run the `tcpdump` tool on each pod] while reproducing the behavior that led to the issue. Review the captures on both sides to compare send and receive timestamps to analyze the latency of traffic to and from a pod. Latency can occur in {product-title} if a node interface is overloaded with traffic from other pods, storage devices, or the data plane. +For example, run the `tcpdump` tool on each pod while reproducing the behavior that led to the issue. Review the captures on both sides to compare send and receive timestamps to analyze the latency of traffic to and from a pod. Latency can occur in {product-title} if a node interface is overloaded with traffic from other pods, storage devices, or the data plane. + [source,terminal] ---- @@ -25,20 +25,28 @@ where: + `podip`:: Specifies the IP address for the pod. Run the `oc get pod -o wide` command to get the IP address of a pod. + -The `tcpdump` command generates a file at `/tmp/dump.pcap` containing all traffic between these two pods. You can run the analyzer shortly before the issue is reproduced and stop the analyzer shortly after the issue is finished reproducing to minimize the size of the file. You can also link:https://access.redhat.com/solutions/5074041[run a packet analyzer between the nodes] with: +The `tcpdump` command generates a file at `/tmp/dump.pcap` containing all traffic between these two pods. You can run the analyzer shortly before the issue is reproduced and stop the analyzer shortly after the issue is finished reproducing to minimize the size of the file. You can also run a packet analyzer between the nodes with: + [source,terminal] ---- $ tcpdump -s 0 -i any -w /tmp/dump.pcap port 4789 ---- -* Use a bandwidth measuring tool, such as link:https://access.redhat.com/solutions/6129701[`iperf`], to measure streaming throughput and UDP throughput. Locate any bottlenecks by running the tool from the pods first, and then running it from the nodes. +* Use a bandwidth measuring tool, such as `iperf`, to measure streaming throughput and UDP throughput. Locate any bottlenecks by running the tool from the pods first, and then running it from the nodes. ifdef::openshift-enterprise,openshift-webscale[] -** For information on installing and using `iperf`, see this link:https://access.redhat.com/solutions/33103[Red Hat Solution]. +** For information on installing and using `iperf`, see the Red Hat Solution. endif::openshift-enterprise,openshift-webscale[] ifndef::microshift[] * In some cases, the cluster might mark the node with the router pod as unhealthy due to latency issues. Use worker latency profiles to adjust the frequency that the cluster waits for a status update from the node before taking action. * If your cluster has designated lower-latency and higher-latency nodes, configure the `spec.nodePlacement` field in the Ingress Controller to control the placement of the router pod. endif::microshift[] + +[role="_additional-resources"] +.Additional resources + +* link:https://access.redhat.com/solutions/4569211[Run the `tcpdump` tool on each pod] +* link:https://access.redhat.com/solutions/5074041[Run a packet analyzer between the nodes] +* link:https://access.redhat.com/solutions/6129701[Use `iperf` to measure throughput] +* link:https://access.redhat.com/solutions/33103[Install and use `iperf`] diff --git a/modules/oc-mirror-imageset-config-parameters-v2.adoc b/modules/oc-mirror-imageset-config-parameters-v2.adoc index d03c2fd01c4..4cbc5b3892d 100644 --- a/modules/oc-mirror-imageset-config-parameters-v2.adoc +++ b/modules/oc-mirror-imageset-config-parameters-v2.adoc @@ -42,7 +42,7 @@ ifndef::microshift[] Example: `4` |`kubeVirtContainer` -|When set to `true`, includes images from the HyperShift KubeVirt CoreOS container. +|When set to `true`, includes images from the hosted control planes KubeVirt CoreOS container. |Boolean Example `ImageSetConfiguration` file: [source,yaml,subs=attributes+]