Merge pull request #99337 from ShaunaDiaz/OSDOCS-15755

OSDOCS-15755: breaks up topics into assemblies MS config

Author: ShaunaDiaz

_topic_maps/_topic_map_ms.yml

@@ -113,15 +113,19 @@ Name: Configuring
 Dir: microshift_configuring
 Distros: microshift
 Topics:
-- Name: Using the MicroShift configuration file
+- Name: About the default MicroShift configuration file
+  File: microshift-default-config-yaml
+- Name: Customizing MicroShift by using the configuration file
   File: microshift-using-config-yaml
+- Name: Using configuration snippets
+  File: microshift-config-snippets
 - Name: Configuring IPv6 networking
   File: microshift-nw-ipv6-config
 - Name: Using ingress control for a MicroShift cluster
   File: microshift-ingress-controller
 - Name: Disabling LVMS CSI provider and CSI snapshot
   File: microshift-disable-lvms-csi-provider-csi-snapshot
-- Name: Checking the status of Greenboot health checks
+- Name: Checking the status of greenboot health checks
   File: microshift-greenboot-checking-status
 - Name: Cluster access with kubeconfig files
   File: microshift-cluster-access-kubeconfig

microshift_configuring/microshift-config-snippets.adoc

@@ -0,0 +1,15 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="microshift-config-snippets"]
+include::_attributes/attributes-microshift.adoc[]
+= Using {microshift-short} configuration snippets
+:context: microshift-config-snippets
+
+If you want to configure one or two settings, use the `/etc/microshift/config.d/` configuration directory to drop in configuration snippet YAML files.
+
+include::modules/microshift-how-config-snippets-work.adoc[leveloffset=+1]
+
+include::modules/microshift-example-config-snippets-list.adoc[leveloffset=+1]
+
+include::modules/microshift-example-config-snippets-objects.adoc[leveloffset=+1]
+
+include::modules/microshift-example-mixed-config-snippets.adoc[leveloffset=+1]

microshift_configuring/microshift-default-config-yaml.adoc

@@ -0,0 +1,23 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="microshift-default-config-yaml"]
+include::_attributes/attributes-microshift.adoc[]
+= About the default {microshift-short} configuration file
+:context: microshift-default-config-yaml
+
+toc::[]
+
+The {microshift-short} built-in default settings are listed in a YAML file.
+
+include::modules/microshift-config-rhde-con.adoc[leveloffset=+1]
+
+include::snippets/microshift-greenboot-status-snip.adoc[leveloffset=+2]
+
+include::modules/microshift-config-yaml.adoc[leveloffset=+1]
+
+include::modules/microshift-default-settings.adoc[leveloffset=+2]
+
+//[id="additional-resources_microshift-using-config-yaml_{context}"]
+//[role="_additional-resources"]
+//== Additional resources
+
+//* xref:../microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]

microshift_configuring/microshift-gdp.adoc

@@ -27,7 +27,7 @@ include::modules/microshift-ref-generic-device-plugin-troubleshooting.adoc[level
 [id="_additional-resources_microshift-gdp_{context}"]
 == Additional resources
 
-* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-yaml_microshift-configuring[The {microshift-short} YAML configuration file]
+//* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
 * xref:../microshift_networking/microshift-networking-settings.adoc#microshift-understanding-networking-settings[Understanding networking settings]
 * xref:../microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc#microshift-cni-multus[About using multiple networks]
 * xref:../microshift_networking/microshift_network_policy/microshift-network-policy-index.adoc#microshift-network-policies[About network policies]

microshift_configuring/microshift-ingress-controller.adoc

@@ -20,6 +20,6 @@ include::modules/microshift-ingress-controller-tls-config.adoc[leveloffset=+2]
 [role="_additional-resources"]
 == Additional resources
 
-* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-snippets_microshift-configuring[Using configuration snippets]
+//* xref:../microshift_configuring/microshift-config-snippets.adoc#microshift-config-snippets[Using configuration snippets]
 
 * link:https://docs.redhat.com/container-platform/latest/networking/networking_operators/ingress-operator.html#nw-http2-haproxy_configuring-ingress[Enabling HTTP/2 Ingress connectivity] ({OCP} documentation)

microshift_configuring/microshift-using-config-yaml.adoc

@@ -1,37 +1,27 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="microshift-using-config-yaml"]
 include::_attributes/attributes-microshift.adoc[]
-= Using the {microshift-short} configuration file
-:context: microshift-configuring
-
-:FeatureName: The Generic Device Plugin for {microshift-short}
-
-include::snippets/technology-preview.adoc[]
+= Customizing {microshift-short} by using the configuration file
+:context: microshift-using-config-yaml
 
 toc::[]
 
-A YAML file customizes {microshift-short} instances with your preferences, settings, and parameters.
-
-include::modules/microshift-config-rhde-con.adoc[leveloffset=+1]
-
-include::snippets/microshift-greenboot-status-snip.adoc[leveloffset=+2]
+Use the {microshift-short} YAML file to customize your preferences, settings, and parameters.
 
-include::modules/microshift-config-yaml.adoc[leveloffset=+1]
+:FeatureName: The Generic Device Plugin for {microshift-short}
 
-include::modules/microshift-default-settings.adoc[leveloffset=+2]
+include::snippets/technology-preview.adoc[]
 
 include::modules/microshift-config-yaml-custom.adoc[leveloffset=+1]
 
 include::modules/microshift-config-parameters-table.adoc[leveloffset=+2]
 
-include::modules/microshift-config-snippets.adoc[leveloffset=+2]
-
 include::modules/microshift-nw-advertise-address.adoc[leveloffset=+2]
 
 include::modules/microshift-config-nodeport-limits.adoc[leveloffset=+2]
 
-[role="_additional-resources"]
 [id="additional-resources_microshift-using-config-yaml_{context}"]
+[role="_additional-resources"]
 == Additional resources
 
 * xref:../../microshift-greenboot-checking-status.adoc#microshift-greenboot-checking-status[Checking Greenboot status]

microshift_configuring/microshift_auth_security/microshift-tls-config.adoc

@@ -18,10 +18,10 @@ include::modules/microshift-tls-default-cipher-suites.adoc[leveloffset=+2]
 [role="_additional-resources"]
 == Additional resources
 
-* xref:../../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-snippets_microshift-configuring[Using configuration snippets].
+//* xref:../microshift-config-snippets.adoc#microshift-config-snippets[Using configuration snippets]
 
-* To secure pods using security content constraints (SCC), see xref:../../microshift_running_apps/microshift-authentication.adoc#authentication-microshift[Pod security authentication and authorization].
+* To secure pods using security content constraints (SCC), see xref:../../microshift_running_apps/microshift-authentication.adoc#authentication-microshift[Pod security authentication and authorization]
 
-* xref:../../microshift_configuring/microshift-cluster-access-kubeconfig.adoc#microshift-kubeconfig[Cluster access with kubeconfig].
+* xref:../../microshift_configuring/microshift-cluster-access-kubeconfig.adoc#microshift-kubeconfig[Cluster access with kubeconfig]
 
-* xref:../microshift_auth_security/microshift-custom-ca.adoc#microshift-custom-ca[Configuring custom certificate authorities].
+* xref:../microshift_auth_security/microshift-custom-ca.adoc#microshift-custom-ca[Configuring custom certificate authorities]

microshift_configuring/microshift_low_latency/microshift-low-latency.adoc

@@ -23,7 +23,7 @@ include::modules/microshift-low-latency-config-yaml.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 //TODO * workload partitioning crossref here
-* xref:../../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-yaml_microshift-configuring[Using a YAML configuration file]
+//* xref:../../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
 * link:https://kubernetes.io/docs/reference/config-api/kubelet-config.v1beta1/#kubelet-config-k8s-io-v1beta1-KubeletConfiguration[KubeletConfiguration reference] (Kubernetes upstream documentation)
 
 //RHEL TuneD

microshift_install_rpm/microshift-install-rpm.adoc

@@ -20,11 +20,11 @@ include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
 //additional resources for install rpm prep module
 [role="_additional-resources"]
 .Additional resources
-* Download the link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red Hat Hybrid Cloud Console.
-* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Configuring MicroShift].
-* For more options on partition configuration, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/performing_a_standard_rhel_9_installation/index#manual-partitioning_graphical-installation[Configuring Manual Partitioning].
+* Download the link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red Hat Hybrid Cloud Console
+//* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
+* For more options on partition configuration, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/performing_a_standard_rhel_9_installation/index#manual-partitioning_graphical-installation[Configuring Manual Partitioning]
 * For more information about resizing your existing LVs to free up capacity in your VGs, read link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html-single/configuring_and_managing_logical_volumes/index#managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM Volume Groups].
-* For more information about creating VGs and PVs, read 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].
+* For more information about creating VGs and PVs, read 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]
 
 include::modules/microshift-install-rpms.adoc[leveloffset=+1]
 
@@ -43,7 +43,7 @@ include::modules/microshift-accessing.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Installing the OpenShift CLI tool].
+* xref:../microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Installing the OpenShift CLI tool]
 
 include::modules/microshift-accessing-cluster-locally.adoc[leveloffset=+2]
 

microshift_networking/microshift-cni.adoc

@@ -69,7 +69,7 @@ include::modules/microshift-nw-topology.adoc[leveloffset=+1]
 [role="_additional-resources"]
 == Additional resources
 
-* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-yaml_microshift-configuring[Using a YAML configuration file]
+//* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
 * xref:../microshift_networking/microshift-networking-settings.adoc#microshift-understanding-networking-settings[Understanding networking settings]
 * xref:../microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc#microshift-cni-multus[About using multiple networks]
 * xref:../microshift_networking/microshift_network_policy/microshift-network-policy-index.adoc#microshift-network-policies[About network policies]