Merge pull request #64482 from ShaunaDiaz/OSDOCS-7557

OSDOCS-7557:PM's edits list for MicroShift GA

Author: opayne1

_topic_maps/_topic_map_ms.yml

@@ -129,16 +129,18 @@ Name: Networking
 Dir: microshift_networking
 Distros: microshift
 Topics:
-- Name: Networking settings
-  File: microshift-networking
+- Name: About the networking plugin
+  File: microshift-cni
+- Name: Using networking settings
+  File: microshift-networking-settings
 - Name: Firewall configuration
   File: microshift-firewall
 ---
 Name: Storage
 Dir: microshift_storage
 Distros: microshift
 Topics:
-- Name: MicroShift storage overview
+- Name: About MicroShift storage
   File: index
 - Name: Understanding ephemeral storage for MicroShift
   File: understanding-ephemeral-storage-microshift
@@ -157,15 +159,15 @@ Name: Running applications
 Dir: microshift_running_apps
 Distros: microshift
 Topics:
-- Name: Embedded applications on RHEL for Edge
+- Name: Embedding applications on RHEL for Edge
   File: microshift-embedded-apps-on-rhel-edge
 - Name: Embedding applications for offline use
   File: microshift-embed-apps-offline-use
 - Name: Embedding applications tutorial
   File: microshift-embedding-apps-tutorial
-- Name: Application deployment
+- Name: Deploying applications
   File: microshift-applications
-- Name: Operators
+- Name: Using operators
   File: microshift-operators
 - Name: Greenboot workload health check scripts
   File: microshift-greenboot-workload-scripts
@@ -189,7 +191,7 @@ Topics:
   File: microshift-troubleshoot-cluster
 - Name: Troubleshoot updates
   File: microshift-troubleshoot-updates
-- Name: Checking audit logs 
+- Name: Checking audit logs
   File: microshift-audit-logs
 - Name: Additional information
   File: microshift-things-to-know

microshift_backup_and_restore/microshift-backup-and-restore.adoc

@@ -8,6 +8,11 @@ toc::[]
 
 You can manually back up and restore the {product-title} database on all supported systems. The {product-title} service must be stopped and Greenboot health checks must be completed prior to any backups.
 
+[NOTE]
+====
+Only {product-title} data is backed up with the following procedures. Application data is not included.
+====
+
 * On `rpm-ostree` systems, {product-title} automatically creates a backup on every start. These automatic backups are deleted and replaced with the latest backup each time the system restarts.
 * If you are using an `rpm-ostree` system, restoring data is also automated. Otherwise, you must back up and restore data manually.
 
@@ -23,6 +28,8 @@ include::modules/microshift-backing-up-manually.adoc[leveloffset=+1]
 
 include::modules/microshift-restoring-data-backups.adoc[leveloffset=+1]
 
+include::modules/microshift-service-starting.adoc[leveloffset=+1]
+
 //additional resources for restoring-data module
 [role="_additional-resources"]
 .Additional resources

microshift_cli_ref/microshift-cli-tools-introduction.adoc

@@ -10,10 +10,9 @@ You can use different command-line interface (CLI) tools to build, deploy, and m
 
 CLI tools available for use with {product-title} are the following:
 
-* Built-in `microshift` command types
-* Linux CLI tools
 * Kubernetes CLI (`kubectl`)
 * The {oc-first} tool with an enabled subset of commands
+* Built-in `microshift` command types
 
 [NOTE]
 ====

microshift_install/microshift-embed-in-rpm-ostree.adoc

@@ -57,3 +57,7 @@ include::modules/microshift-accessing-cluster-locally.adoc[leveloffset=+2]
 include::modules/microshift-accessing-cluster-open-firewall.adoc[leveloffset=+2]
 
 include::modules/microshift-accessing-cluster-remotely.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+* xref:../microshift_configuring/microshift-cluster-access-kubeconfig.adoc#microshift-kubeconfig-generating-remote-kcfiles_microshift-cluster-access-kubeconfig[Generating additional kubeconfig files for remote access]

microshift_install/microshift-greenboot.adoc

@@ -1,16 +1,17 @@
 :_content-type: ASSEMBLY
 [id="microshift-greenboot"]
-= The greenboot health check
+= The Greenboot health check
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-greenboot
 
 toc::[]
 
-Greenboot is the generic health check framework for the `systemd` service on RPM-OSTree-based systems. The `microshift-greenboot` RPM and `greenboot-default-health-checks` are RPM packages installed with {product-title}. Greenboot is used to assess system health and automate a rollback to the last healthy state in the event of software trouble.
+Greenboot is the generic health check framework for the `systemd` service on RPM-OSTree-based systems. The `microshift-greenboot` RPM and `greenboot-default-health-checks` are RPM packages installed with {product-title}. Greenboot is used to assess system health and automate a rollback to the last healthy state in the event of software trouble, for example:
 
-This health check framework is especially useful when you need to check for software problems and perform system rollbacks on edge devices where direct serviceability is either limited or non-existent. When health check scripts are installed and configured, health checks run every time the system starts.
-
-Using greenboot can reduce your risk of being locked out of edge devices during updates and prevent a significant interruption of service if an update fails. When a failure is detected, the system boots into the last known working configuration using the `rpm-ostree` rollback capability.
+* This health check framework is especially useful when you need to check for software problems and perform system rollbacks on edge devices where direct serviceability is either limited or non-existent.
+* When health check scripts are installed and configured, health checks run every time the system starts.
+* Using Greenboot can reduce your risk of being locked out of edge devices during updates and prevent a significant interruption of service if an update fails.
+* When a failure is detected, the system boots into the last known working configuration using the `rpm-ostree` rollback capability.
 
 A {product-title} application health check script is included in the `microshift-greenboot` RPM. The `greenboot-default-health-checks` RPM also includes health check scripts verifying that DNS and `ostree` services are accessible. In addition, you can create your own health check scripts for the workloads you are running. You can write one that verifies that an application has started, for example.
 
@@ -39,6 +40,7 @@ include::modules/microshift-greenboot-prerollback-log.adoc[leveloffset=+1]
 
 include::modules/microshift-greenboot-check-update.adoc[leveloffset=+1]
 
+[id="additional-resources_microshift-greenboot_{context}"]
 [role="_additional-resources_microshift-greenboot"]
-.Additional resources
+== Additional resources
 * xref:../microshift_running_apps/microshift-greenboot-workload-scripts.adoc#microshift-greenboot-workload-scripts[Greenboot workload health check scripts]

microshift_install/microshift-installing-troubleshooting.adoc

@@ -10,8 +10,9 @@ To troubleshoot a failed {product-title} installation, you can run an sos report
 
 include::modules/microshift-gathering-sos-report.adoc[leveloffset=+1]
 
+[id="additional-resources_microshift-installing-troubleshooting_{context}"]
 [role="_additional-resources"]
-.Additional resources
+== Additional resources
 * xref:../microshift_support/microshift-sos-report.adoc#microshift-sos-report[About MicroShift sos reports]
 
 * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/getting_the_most_from_your_support_experience/generating-an-sos-report-for-technical-support_getting-the-most-from-your-support-experience[Generating an sos report for technical support]

modules/microshift-cni.adoc renamed to microshift_networking/microshift-cni.adoc

@@ -1,10 +1,10 @@
-// Module included in the following assemblies:
-//
-// * microshift_networking/microshift-understanding networking.adoc
-
-:_content-type: CONCEPT
-[id="microshift-cni_{context}"]
+:_content-type: ASSEMBLY
+[id="microshift-cni"]
 = About the OVN-Kubernetes network plugin
+include::_attributes/attributes-microshift.adoc[]
+:context: microshift-about-ovn-k-plugin
+
+toc::[]
 
 OVN-Kubernetes is the default networking solution for {product-title} deployments. OVN-Kubernetes is a virtualized network for pods and services that is based on Open Virtual Network (OVN). The OVN-Kubernetes Container Network Interface (CNI) plugin is the network plugin for the cluster. A cluster that uses the OVN-Kubernetes network plugin also runs Open vSwitch (OVS) on the node. OVN configures OVS on the node to implement the declared network configuration.
 
@@ -104,7 +104,7 @@ OVN-Kubernetes manifests and startup logic are built into {product-title}. The s
 
 * `/etc/NetworkManager/conf.d/microshift-nm.conf` for NetworkManager.service
 * `/etc/systemd/system/ovs-vswitchd.service.d/microshift-cpuaffinity.conf` for ovs-vswitchd.service
-* `/etc/systemd/system/ovsdb-server.service.d/microshift-cpuaffinity.conf`
+* `/etc/systemd/system/ovsdb-server.service.d/microshift-cpuaffinity.conf`for ovs-server.service
 * `/usr/bin/configure-ovs-microshift.sh` for microshift-ovs-init.service
 * `/usr/bin/configure-ovs.sh` for microshift-ovs-init.service
 * `/etc/crio/crio.conf.d/microshift-ovn.conf` for CRI-O service

microshift_networking/microshift-firewall.adoc

@@ -29,9 +29,9 @@ include::modules/microshift-firewall-apply-settings.adoc[leveloffset=+1]
 
 include::modules/microshift-firewall-verify-settings.adoc[leveloffset=+1]
 
+[id="additional-resources_microshift-using-a-firewall_{context}"]
 [role="_additional-resources"]
-[id="additional-resources_microshift-using-a-firewall"]
-.Additional resources
+== Additional resources
 
 * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_firewalls_and_packet_filters/using-and-configuring-firewalld_firewall-packet-filters[RHEL: Using and configuring firewalld]
 

microshift_networking/microshift-networking.adoc renamed to microshift_networking/microshift-networking-settings.adoc

@@ -21,8 +21,6 @@ By default, Kubernetes allocates each pod an internal IP address for application
 To troubleshoot connection problems with the NodePort service, read about the known issue in the Release Notes.
 ====
 
-include::modules/microshift-cni.adoc[leveloffset=+1]
-
 include::modules/microshift-configuring-ovn.adoc[leveloffset=+1]
 
 include::modules/microshift-restart-ovnkube-master.adoc[leveloffset=+1]
@@ -41,8 +39,7 @@ include::modules/microshift-blocking-nodeport-access.adoc[leveloffset=+1]
 
 include::modules/microshift-mDNS.adoc[leveloffset=+1]
 
+[id="additional-resources_microshift-understanding-networking-settings_{context}"]
 [role="_additional-resources"]
-[id="additional-resources_microshift-understanding-networking-settings"]
-.Additional resources
-
+== Additional resources
 * xref:../microshift_release_notes/microshift-4-14-release-notes.adoc#microshift-4-14-known-issues[{product-title} {product-version} release notes --> Known issues]

microshift_running_apps/microshift-embedded-apps-on-rhel-edge.adoc

@@ -1,6 +1,6 @@
 :_content-type: ASSEMBLY
 [id="microshift-embedded-apps-on-rhel-edge"]
-= Options for embedding {product-title} applications in a {op-system-ostree} image
+= Options for embedding {product-title} applications in a RHEL for Edge image
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-embedded-apps-on-rhel-edge