From 7487d89ba22c38e668b7101df274799dfecea34b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CShauna=20Diaz=E2=80=9D?= Date: Tue, 16 Sep 2025 13:34:04 -0400 Subject: [PATCH] OSDOCS-16189-417: adds corections 4.17+ --- _topic_maps/_topic_map_ms.yml | 2 +- .../microshift-cluster-access-kubeconfig.adoc | 2 +- microshift_networking/microshift-cni.adoc | 1 + microshift_welcome/index.adoc | 9 ++++----- modules/microshift-arch-design.adoc | 5 +++-- modules/microshift-check-journal-logs-updates.adoc | 8 +++----- 6 files changed, 13 insertions(+), 14 deletions(-) diff --git a/_topic_maps/_topic_map_ms.yml b/_topic_maps/_topic_map_ms.yml index 416bbb745f..a96e9cfa6c 100644 --- a/_topic_maps/_topic_map_ms.yml +++ b/_topic_maps/_topic_map_ms.yml @@ -115,7 +115,7 @@ Topics: File: microshift-using-config-yaml - Name: Configuring IPv6 networking File: microshift-nw-ipv6-config -- Name: Cluster access with kubeconfig +- Name: Cluster access with kubeconfig files File: microshift-cluster-access-kubeconfig - Name: Using custom certificate authorities File: microshift-custom-ca diff --git a/microshift_configuring/microshift-cluster-access-kubeconfig.adoc b/microshift_configuring/microshift-cluster-access-kubeconfig.adoc index e1979879dd..77715abac8 100644 --- a/microshift_configuring/microshift-cluster-access-kubeconfig.adoc +++ b/microshift_configuring/microshift-cluster-access-kubeconfig.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="microshift-kubeconfig"] -= Cluster access with kubeconfig += Cluster access with kubeconfig files include::_attributes/attributes-microshift.adoc[] :context: microshift-kubeconfig diff --git a/microshift_networking/microshift-cni.adoc b/microshift_networking/microshift-cni.adoc index 52067aa5c9..981b1ae258 100644 --- a/microshift_networking/microshift-cni.adoc +++ b/microshift_networking/microshift-cni.adoc @@ -66,6 +66,7 @@ Bridge mappings allow provider network traffic to reach the physical network. Tr include::modules/microshift-nw-topology.adoc[leveloffset=+1] [id="_additional-resources_microshift-cni_{context}"] +[role="_additional-resources"] == Additional resources * xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-yaml_microshift-configuring[Using a YAML configuration file] diff --git a/microshift_welcome/index.adoc b/microshift_welcome/index.adoc index 9ab5ce53d7..2b9dbc54ca 100644 --- a/microshift_welcome/index.adoc +++ b/microshift_welcome/index.adoc @@ -20,15 +20,14 @@ To browse the {microshift-short} {product-version} documentation, use one of the To get started with {microshift-short}, use the following links: -//text is in main assembly for the sake of cross references * xref:../microshift_release_notes/microshift-4-17-release-notes.adoc#microshift-4-17-release-notes[{product-title} release notes] -* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}] +* xref:../microshift_install_get_ready/microshift-install-get-ready.adoc#microshift-install-get-ready[Getting ready to install MicroShift] For related information, use the following links: -* link:https://access.redhat.com/documentation/en-us/red_hat_device_edge/4/html/overview/device-edge-overview[Red Hat Device Edge overview] -* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/index[RHEL for Edge documentation] -* link:https://docs.openshift.com/container-platform/latest/welcome/index.html[{OCP} documentation] +* link:https://docs.redhat.com/documentation/en-us/red_hat_device_edge/4/html/overview/device-edge-overview[Red Hat Device Edge overview] +* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/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] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/[{OCP} documentation] include::modules/microshift-about.adoc[leveloffset=+1] diff --git a/modules/microshift-arch-design.adoc b/modules/microshift-arch-design.adoc index 48a66068ff..363cf4ab32 100644 --- a/modules/microshift-arch-design.adoc +++ b/modules/microshift-arch-design.adoc @@ -5,9 +5,10 @@ :_mod-docs-content-type: CONCEPT [id="microshift-architectural-design_{context}"] == Architectural design + {microshift-short} is a single-node container orchestration runtime designed to extend the benefits of using containers for running applications to low-resource edge environments. Because {microshift-short} is primarily a platform for deploying applications, only the APIs and features essential to operating in edge and small form factor computing environments are included. -For example, {microshift-short} contains only the following Kubernetes cluster capabilities: +For example, {microshift-short} has only the following Kubernetes cluster capabilities: * Networking * Ingress @@ -51,4 +52,4 @@ The figure "{product-title} differences from {oke}" shows that {oke} has the sam * Cloud Integration * Virtual Machines (VMs) through {VirtProductName} -In {oke} and other {OCP} deployments, all of the components from the operating system through the cluster capabilities work as one comprehensive unit, with full cluster services for a multi-node Kubernetes workload. With {microshift-short}, functions such as over-the-air-updates, monitoring, and logging, are performed by the operating system. \ No newline at end of file +In {oke} and other {OCP} deployments, all of the components from the operating system through the cluster capabilities work as one comprehensive unit, with full cluster services for a multi-node Kubernetes workload. With {microshift-short}, functions such as over-the-air-updates, monitoring, and logging, are performed by the operating system. diff --git a/modules/microshift-check-journal-logs-updates.adoc b/modules/microshift-check-journal-logs-updates.adoc index 196dc3e21e..c2e12679f3 100644 --- a/modules/microshift-check-journal-logs-updates.adoc +++ b/modules/microshift-check-journal-logs-updates.adoc @@ -22,7 +22,7 @@ The default configuration of the `systemd` journal service stores data in a vola $ sudo journalctl -u microshift ---- -* Check the Greenboot journal logs by running the following command: +* Check the greenboot journal logs by running the following command: + [source,terminal] ---- @@ -48,8 +48,7 @@ IDX BOOT ID FIRST ENTRY LAST ENTRY ** Check the journal logs for the specific boot you want by running the following command: + -[source,terminal] -[subs="+quotes"] +[source,terminal,subs="+quotes"] ---- $ sudo journalctl --boot ____ <1> ---- @@ -57,8 +56,7 @@ $ sudo journalctl --boot ____ <1> ** Check the journal logs for the boot of a specific service by running the following command: + -[source,terminal] -[subs="+quotes"] +[source,terminal,subs="+quotes"] ---- $ sudo journalctl --boot ____ -u ____ <1> <2> ----