Merge pull request #96812 from ShaunaDiaz/OSDOCS-15585

ShaunaDiaz · web-flow · commit 99e2108ba319 · 2025-07-31T15:23:54.000-04:00
OSDOCS-15585: remove unused content MicroShift
diff --git a/_unused_topics/microshift-man-config-ovs-bridge.adoc b/_unused_topics/microshift-man-config-ovs-bridge.adoc
diff --git a/_unused_topics/microshift-nodeport-unreachable-workaround.adoc b/_unused_topics/microshift-nodeport-unreachable-workaround.adoc
diff --git a/microshift_running_apps/microshift-embedded-apps-on-rhel-edge.adoc b/microshift_running_apps/microshift-embedded-apps-on-rhel-edge.adoc
@@ -52,5 +52,3 @@ If you have an application that includes more than a few files, you can embed th
 * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/{op-system-version-major}/html-single/composing_installing_and_managing_rhel_for_edge_images/index#composing-a-rhel-for-edge-image-using-image-builder-command-line_composing-installing-managing-rhel-for-edge-images[Composing a RHEL for Edge image using image builder command-line]
 
 * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/{op-system-version-major}/html-single/composing_installing_and_managing_rhel_for_edge_images/index#edge-image-builder-system-requirements_setting-up-image-builder[Image Builder system requirements]
-
-//* link:https://www.redhat.com/sysadmin/create-rpm-package[How to create a Linux RPM package]
diff --git a/microshift_running_apps/microshift-observability-service.adoc b/microshift_running_apps/microshift-observability-service.adoc
@@ -15,8 +15,6 @@ include::modules/microshift-otel-install.adoc[leveloffset=+1]
 
 include::modules/microshift-otel-config.adoc[leveloffset=+1]
 
-// include::modules/microshift-otel-start-service.adoc[leveloffset=+1]
-
 include::modules/microshift-otel-config-examples.adoc[leveloffset=+1]
 
 include::modules/microshift-otel-config-small.adoc[leveloffset=+1]
diff --git a/microshift_storage/index.adoc b/microshift_storage/index.adoc
@@ -27,8 +27,3 @@ Stateful applications deployed in containers require persistent storage. {micros
 === Dynamic storage provisioning
 
 Using dynamic provisioning allows you to create storage volumes on-demand, eliminating the need for pre-provisioned storage. For more information about how dynamic provisioning works in {product-title}, read xref:../microshift_storage/microshift-storage-plugin-overview.adoc#[Dynamic provisioning using the LVMS plugin].
-
-//[id="microshift-container-storage-interface"]
-//== Container Storage Interface (CSI)
-
-//CSI is an API specification for the management of container storage across different container orchestration (CO) systems. You can manage the storage volumes within the container native environments, without having specific knowledge of the underlying storage infrastructure. With the CSI, storage works uniformly across different container orchestration systems, regardless of the storage vendors you are using. For more information about CSI, read ../microshift_storage/container_storage_interface_microshift/microshift-persistent-storage-csi.adoc#persistent-storage-csi-microshift[Using Container Storage Interface (CSI) for MicroShift].
diff --git a/microshift_storage/volume-snapshots-microshift.adoc b/microshift_storage/volume-snapshots-microshift.adoc
@@ -91,7 +91,4 @@ include::modules/microshift-storage-volume-cloning.adoc[leveloffset=+1]
 
 * link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-cloning[CSI volume cloning]
 
-//* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/storage/configuring-persistent-storage#lvms-creating-volume-clones-in-single-node-openshift_logical-volume-manager-storage[LVMS volume cloning for Single-Node OpenShift]
-//cannot find new link
-
 * To configure the host to enable cloning, see xref:../microshift_storage/volume-snapshots-microshift.adoc#microshift-lvm-thin-volumes_volume-snapshots-microshift[About LVM thin volumes]
diff --git a/microshift_support/microshift-etcd.adoc b/microshift_support/microshift-etcd.adoc
@@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]
 
 toc::[]
 
-The etcd service is delivered as part of the {product-title} RPM. The etcd service is run as a separate process and the etcd lifecycle is managed automatically by {microshift-short}.
+The {product-title} RPM includes the etcd service. The etcd service runs as a separate process. {microshift-short} automatically manages the etcd lifecycle.
 
 include::modules/microshift-observe-debug-etcd-server.adoc[leveloffset=+1]
 
diff --git a/microshift_support/microshift-sos-report.adoc b/microshift_support/microshift-sos-report.adoc
@@ -6,7 +6,6 @@ include::_attributes/attributes-microshift.adoc[]
 
 toc::[]
 
-[role="_abstract"]
 You can use the `sos` tool to collect troubleshooting information about a host. The `sos report` command generates a detailed report that shows all of the enabled plugins and data from the different components and applications in a system.
 
 include::modules/microshift-about-sos-reports.adoc[leveloffset=+1]
diff --git a/microshift_troubleshooting/microshift-audit-logs.adoc b/microshift_troubleshooting/microshift-audit-logs.adoc
@@ -8,4 +8,4 @@ toc::[]
 
 You can use audit logs to identify pod security violations.
 
-include::modules/microshift-viewing-audit-logs.adoc[leveloffset=+1]
+include::modules/microshift-viewing-audit-logs.adoc[leveloffset=+1]
diff --git a/microshift_troubleshooting/microshift-etcd-troubleshoot.adoc b/microshift_troubleshooting/microshift-etcd-troubleshoot.adoc
@@ -8,4 +8,4 @@ toc::[]
 
 To troubleshoot etcd and improve performance, configure the memory allowance for the service.
 
-include::modules/microshift-config-etcd.adoc[leveloffset=+1]
+include::modules/microshift-config-etcd.adoc[leveloffset=+1]
diff --git a/microshift_troubleshooting/microshift-installing-troubleshooting.adoc b/microshift_troubleshooting/microshift-installing-troubleshooting.adoc
@@ -15,4 +15,4 @@ include::modules/microshift-gathering-sos-report.adoc[leveloffset=+1]
 == Additional resources
 * xref:../microshift_support/microshift-sos-report.adoc#microshift-sos-report[About {microshift-short} 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]
+* 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]
diff --git a/microshift_updating/microshift-update-rhel-edge-to-image-mode.adoc b/microshift_updating/microshift-update-rhel-edge-to-image-mode.adoc
@@ -11,8 +11,3 @@ To migrate {microshift-short} from {op-system-ostree-first}, embed {microshift-s
 include::modules/microshift-update-edge-to-image.adoc[leveloffset=+1]
 
 include::modules/microshift-updates-edge-to-image-uid-drift.adoc[leveloffset=+1]
-
-//additional resources for image mode docs in RHEL
-//[role="_additional-resources"]
-//.Additional resources
-//TODO Add RHEL doc links when published
diff --git a/microshift_welcome/index.adoc b/microshift_welcome/index.adoc
@@ -20,7 +20,6 @@ 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-20-release-notes.adoc#microshift-4-20-release-notes[{product-title} release notes]
 * xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}]
 
diff --git a/modules/microshift-otel-start-service.adoc b/modules/microshift-otel-start-service.adoc
diff --git a/modules/storage-persistent-storage-pvc.adoc b/modules/storage-persistent-storage-pvc.adoc
@@ -3,12 +3,11 @@
 // * storage/understanding-persistent-storage.adoc
 //* microshift_storage/understanding-persistent-storage-microshift.adoc
 
-
+:_mod-docs-content-type: CONCEPT
 [id="persistent-volume-claims_{context}"]
 = Persistent volume claims
 
-Each `PersistentVolumeClaim` object contains a `spec` and `status`, which
-is the specification and status of the persistent volume claim (PVC), for example:
+Each `PersistentVolumeClaim` object contains `spec` and `status` fields, which are the specification and status of the persistent volume claim (PVC), for example:
 
 .`PersistentVolumeClaim` object definition example
 [source,yaml]
@@ -28,68 +27,51 @@ status:
   ...
 ----
 <1> Name of the PVC.
-<2> The access mode, defining the read-write and mount permissions.
+<2> The access mode, defining the read/write and mount permissions.
 <3> The amount of storage available to the PVC.
 <4> Name of the `StorageClass` required by the claim.
 
 [id="pvc-storage-class_{context}"]
 == Storage classes
 
-Claims can optionally request a specific storage class by specifying the
-storage class's name in the `storageClassName` attribute. Only PVs of the
-requested class, ones with the same `storageClassName` as the PVC, can be
-bound to the PVC. The cluster administrator can configure dynamic
-provisioners to service one or more storage classes. The cluster
-administrator can create a PV on demand that matches the specifications
-in the PVC.
+Claims can optionally request a specific storage class by specifying the storage class's name in the `storageClassName` attribute. Only PVs of the requested class, ones with the same `storageClassName` as the PVC, can be bound to the PVC. The cluster administrator can configure dynamic provisioners to service one or more storage classes. The cluster administrator can create a PV on-demand that matches the specifications in the PVC.
 
 ifndef::microshift,openshift-rosa,openshift-rosa-hcp[]
 [IMPORTANT]
 ====
-The Cluster Storage Operator might install a default storage class depending
-on the platform in use. This storage class is owned and controlled by the
-Operator. It cannot be deleted or modified beyond defining annotations
-and labels. If different behavior is desired, you must define a custom
-storage class.
+The Cluster Storage Operator might install a default storage class depending on the platform in use. This storage class is owned and controlled by the Operator. It cannot be deleted or modified beyond defining annotations and labels. If different behavior is desired, you must define a custom storage class.
 ====
 endif::microshift,openshift-rosa,openshift-rosa-hcp[]
+
 ifdef::openshift-rosa,openshift-rosa-hcp[]
 [IMPORTANT]
 ====
 The Cluster Storage Operator installs a default storage class. This storage class is owned and controlled by the Operator. It cannot be deleted or modified beyond defining annotations and labels. If different behavior is desired, you must define a custom storage class.
 ====
 endif::openshift-rosa,openshift-rosa-hcp[]
 
-The cluster administrator can also set a default storage class for all PVCs.
-When a default storage class is configured, the PVC must explicitly ask for
-`StorageClass` or `storageClassName` annotations set to `""` to be bound
+The cluster administrator can also set a default storage class for all PVCs. When you configure a default storage class, the PVC must explicitly ask for `StorageClass` or `storageClassName` annotations set to `""` to be bound
 to a PV without a storage class.
 
 [NOTE]
 ====
-If more than one storage class is marked as default, a PVC can only be created if the `storageClassName` is explicitly specified. Therefore, only one storage class should be set as the default.
+If more than one storage class is marked as default, a PVC can only be created if the `storageClassName` is explicitly specified. Therefore, only set one storage class as the default.
 ====
 
 [id="pvc-access-modes_{context}"]
 == Access modes
 
-Claims use the same conventions as volumes when requesting storage with
-specific access modes.
+Claims use the same conventions as volumes when requesting storage with specific access modes.
 
 [id="pvc-resources_{context}"]
 == Resources
 
-Claims, such as pods, can request specific quantities of a resource. In
-this case, the request is for storage. The same resource model applies to
-volumes and claims.
+Claims, such as pods, can request specific quantities of a resource. In this case, the request is for storage. The same resource model applies to volumes and claims.
 
 [id="pvc-claims-as-volumes_{context}"]
 == Claims as volumes
 
-Pods access storage by using the claim as a volume. Claims must exist in the
-same namespace as the pod using the claim. The cluster finds the claim
-in the pod's namespace and uses it to get the `PersistentVolume` backing
-the claim. The volume is mounted to the host and into the pod, for example:
+Pods access storage by using the claim as a volume. Claims must exist in the same namespace as the pod that is using the claim. The cluster finds the claim in the pod's namespace and uses it to get the `PersistentVolume` backing the claim. The volume is mounted to the host and into the pod, for example:
 
 .Mount volume to the host and into the pod example
 [source,yaml]
@@ -122,7 +104,7 @@ You can view usage statistics for persistent volume claims (PVCs).
 :FeatureName: PVC usage statistics command
 include::snippets/technology-preview.adoc[leveloffset=+1]
 
-=== User permissions required to view PVC usage statistics
+User permissions required to view PVC usage statistics::
 To view PVC usage statistics, you must have the necessary privileges.
 
 To log on with the necessary privileges:
@@ -131,17 +113,30 @@ To log on with the necessary privileges:
 
 * If you do _not_ have admin privileges:
 
-. Create and add cluster roles to the user by running the following commands:
+. Create cluster roles for the user by running the following command:
 +
 [source,terminal]
 ----
 $ oc create clusterrole routes-view --verb=get,list --resource=routes
-$ oc adm policy add-cluster-role-to-user routes-view <user-name> <1>
-$ oc adm policy add-cluster-role-to-user cluster-monitoring-view <user-name> <1>
 ----
-<1> The user's name.
 
-=== Viewing PVC usage statistics
+. Add the `routes-view` cluster role for the user by running the following command:
++
+[source,terminal]
+----
+$ oc admin policy add-cluster-role-to-user routes-view <user_name> <1>
+----
+<1> Replace <user_name> with the user name.
+
+. Add the `cluster-monitoring-view` cluster role for the user by running the following command:
++
+[source,terminal]
+----
+$ oc admin policy add-cluster-role-to-user cluster-monitoring-view <user_name> <1>
+----
+<1> Replace <user_name> with the user name.
+
+Viewing PVC usage statistics::
 
 * To view statistics across a cluster, run the following command:
 +
@@ -156,9 +151,9 @@ $ oc adm top pvc -A
 NAMESPACE     NAME         USAGE(%)
 namespace-1   data-etcd-1  3.82%
 namespace-1   data-etcd-0  3.81%
-namespace-1   data-etcd-2  3.81% 
-namespace-2   mypvc-fs-gp3 0.00%    
-default       mypvc-fs     98.36% 
+namespace-1   data-etcd-2  3.81%
+namespace-2   mypvc-fs-gp3 0.00%
+default       mypvc-fs     98.36%
 ----
 
 * To view PVC usage statistics for a specified namespace, run the following command:
@@ -167,30 +162,30 @@ default       mypvc-fs     98.36%
 ----
 $ oc adm top pvc -n <namespace-name> <1>
 ----
-<1> Where `<namespace-name>` is the name of the specified namespace. 
+<1> Where `<namespace-name>` is the name of the specified namespace.
 +
 .Example command output
 [source, terminal]
 ----
-NAMESPACE     NAME        USAGE(%) 
-namespace-1   data-etcd-2 3.81% <1>
+NAMESPACE     NAME        USAGE(%)
+namespace-1   data-etcd-2 3.81%
 namespace-1   data-etcd-0 3.81%
-namespace-1   data-etcd-1 3.82%  
+namespace-1   data-etcd-1 3.82%
 ----
-<1> In this example, the specified namespace is `namespace-1`.
+In this example, the specified namespace is `namespace-1`.
 
 * To view usage statistics for a specified PVC and for a specified namespace, run the following command:
 +
 [source, terminal]
 ----
 $ oc adm top pvc <pvc-name> -n <namespace-name> <1>
 ----
-<1> Where `<pvc-name>` is the name of specified PVC and `<namespace-name>` is the name of the specified namespace. 
+<1> Where `<pvc-name>` is the name of specified PVC and `<namespace-name>` is the name of the specified namespace.
 +
 .Example command output
 [source, terminal]
 ----
 NAMESPACE   NAME        USAGE(%)
-namespace-1 data-etcd-0 3.81% <1>
+namespace-1 data-etcd-0 3.81%
 ----
-<1> In this example, the specified namespace is `namespace-1` and the specified PVC is `data-etcd-0`.
+In this example, the specified namespace is `namespace-1` and the specified PVC is `data-etcd-0`.
diff --git a/snippets/microshift-tech-preview-snip.adoc b/snippets/microshift-tech-preview-snip.adoc
diff --git a/snippets/microshift-upload-cont2-mirror-script.adoc b/snippets/microshift-upload-cont2-mirror-script.adoc

Original file line number	Diff line number	Diff line change
`@@ -8,4 +8,4 @@ toc::[]`
`8`	`8`
`9`	`9`	`You can use audit logs to identify pod security violations.`
`10`	`10`
`11`		`-include::modules/microshift-viewing-audit-logs.adoc[leveloffset=+1]`
	`11`	`+include::modules/microshift-viewing-audit-logs.adoc[leveloffset=+1]`
Original file line number	Diff line number	Diff line change
`@@ -8,4 +8,4 @@ toc::[]`
`8`	`8`
`9`	`9`	`To troubleshoot etcd and improve performance, configure the memory allowance for the service.`
`10`	`10`
`11`		`-include::modules/microshift-config-etcd.adoc[leveloffset=+1]`
	`11`	`+include::modules/microshift-config-etcd.adoc[leveloffset=+1]`