From a3ca8ba39e2fd30efc914a0ea809a47dfcfc904c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CShauna=20Diaz=E2=80=9D?= Date: Fri, 13 Sep 2024 12:46:02 -0400 Subject: [PATCH] OSDOCS-11977: create optional RPMs install title MicroShift --- _topic_maps/_topic_map_ms.yml | 329 +++++++++--------- .../microshift-install-rhel-image-mode.adoc | 2 + .../microshift-install-rpm.adoc | 28 +- microshift_install_rpm_opt/_attributes | 1 + microshift_install_rpm_opt/images | 1 + .../microshift-install-optional-rpms.adoc | 36 ++ microshift_install_rpm_opt/modules | 1 + microshift_install_rpm_opt/snippets | 1 + 8 files changed, 211 insertions(+), 188 deletions(-) create mode 120000 microshift_install_rpm_opt/_attributes create mode 120000 microshift_install_rpm_opt/images create mode 100644 microshift_install_rpm_opt/microshift-install-optional-rpms.adoc create mode 120000 microshift_install_rpm_opt/modules create mode 120000 microshift_install_rpm_opt/snippets diff --git a/_topic_maps/_topic_map_ms.yml b/_topic_maps/_topic_map_ms.yml index 9fb3c433a4..871704f35c 100644 --- a/_topic_maps/_topic_map_ms.yml +++ b/_topic_maps/_topic_map_ms.yml @@ -47,13 +47,20 @@ Topics: - Name: Understanding system health checks File: microshift-greenboot --- -Name: Installing with RPMs +Name: Installing with an RPM package Dir: microshift_install_rpm Distros: microshift Topics: -- Name: Installing from an RPM package +- Name: Installing with an RPM package File: microshift-install-rpm --- +Name: Installing optional RPM packages +Dir: microshift_install_rpm_opt +Distros: microshift +Topics: +- Name: Installing optional RPM packages + File: microshift-install-optional-rpms +--- Name: Embedding in a RHEL for Edge image Dir: microshift_install_rpm_ostree Distros: microshift @@ -98,6 +105,165 @@ Topics: - Name: Getting support File: microshift-getting-support --- +Name: Configuring +Dir: microshift_configuring +Distros: microshift +Topics: +- Name: Using the MicroShift configuration file + File: microshift-using-config-tools +- Name: Configuring IPv6 networking + File: microshift-nw-ipv6-config +- Name: Cluster access with kubeconfig + File: microshift-cluster-access-kubeconfig +- Name: Using custom certificate authorities + File: microshift-custom-ca +- Name: Checking the status of Greenboot health checks + File: microshift-greenboot-checking-status +- Name: Configuring audit logging policies + File: microshift-audit-logs-config +- Name: Configuring low latency + Dir: microshift_low_latency + Topics: + - Name: Configuring low latency + File: microshift-low-latency + - Name: Workload partitioning + File: microshift-workload-partitioning +--- +Name: Networking +Dir: microshift_networking +Distros: microshift +Topics: +- Name: About the networking plugin + File: microshift-cni +- Name: Using networking settings + File: microshift-networking-settings +- Name: Configuring the router + File: microshift-nw-router +- Name: Network policies + Dir: microshift_network_policy + Topics: + - Name: About network policies + File: microshift-network-policy-index + - Name: Creating network policies + File: microshift-creating-network-policy + - Name: Editing network policies + File: microshift-editing-network-policy + - Name: Deleting network policies + File: microshift-deleting-network-policy + - Name: Viewing network policies + File: microshift-viewing-network-policy +- Name: Multiple networks + Dir: microshift_multiple_networks + Topics: + - Name: About using multiple networks + File: microshift-cni-multus + - Name: Configuring and using multiple networks + File: microshift-cni-multus-using +- Name: Configuring routes + File: microshift-configuring-routes +- Name: Firewall configuration + File: microshift-firewall +- Name: Networking settings for fully disconnected hosts + File: microshift-disconnected-network-config +--- +Name: Storage +Dir: microshift_storage +Distros: microshift +Topics: +- Name: About storage + File: index +- Name: Understanding ephemeral storage + File: understanding-ephemeral-storage-microshift +- Name: Generic ephemeral volumes + File: generic-ephemeral-volumes-microshift +- Name: Understanding persistent storage + File: understanding-persistent-storage-microshift +- Name: Expanding persistent volumes + File: expanding-persistent-volumes-microshift +- Name: Dynamic storage using the LVMS plugin + File: microshift-storage-plugin-overview +- Name: Working with volume snapshots + File: volume-snapshots-microshift +- Name: Understanding storage migration + File: microshift-storage-migration +--- +Name: Running applications +Dir: microshift_running_apps +Distros: microshift +Topics: +- Name: Using Kustomize to deploy applications + File: microshift-applications +- 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: Creating application or workload health check scripts + File: microshift-greenboot-workload-scripts +- Name: Automating application management with GitOps + File: microshift-gitops +- Name: Pod security authentication and authorization + File: microshift-authentication +- Name: Operators + Dir: microshift_operators + Topics: + - Name: Using Operators + File: microshift-operators + - Name: Using Operator Lifecycle Manager + File: microshift-operators-olm + - Name: Creating custom catalogs with oc-mirror + File: microshift-operators-oc-mirror + - Name: Adding OLM-based Operators to a disconnected cluster + File: microshift-operators-oc-mirror-disconnected +--- +Name: Backup and restore +Dir: microshift_backup_and_restore +Distros: microshift +Topics: +- Name: Backing up and restoring data + File: microshift-backup-and-restore +--- +Name: Troubleshooting +Dir: microshift_troubleshooting +Distros: microshift +Topics: +- Name: Check your version + File: microshift-version +- Name: Troubleshoot the cluster + File: microshift-troubleshoot-cluster +- Name: Troubleshoot installation issues + File: microshift-installing-troubleshooting +- Name: Troubleshoot backup and restore + File: microshift-troubleshoot-backup-restore +- Name: Troubleshoot updates + File: microshift-troubleshoot-updates +- Name: Check the audit logs + File: microshift-audit-logs +- Name: Troubleshoot etcd + File: microshift-etcd-troubleshoot +- Name: Additional information + File: microshift-things-to-know +- Name: Data cleanup + File: microshift-cleanup-data +--- +Name: CLI tools +Dir: microshift_cli_ref +Distros: microshift +Topics: +- Name: CLI tools introduction + File: microshift-cli-tools-introduction +- Name: Installing the OpenShift CLI + File: microshift-oc-cli-install +- Name: Configuring the OpenShift CLI + File: microshift-oc-config +- Name: Using the OpenShift CLI + File: microshift-cli-using-oc +- Name: Using oc and kubectl + File: microshift-usage-oc-kubectl +- Name: List of oc CLI commands + File: microshift-oc-cli-commands-list +--- Name: API reference Dir: microshift_rest_api Distros: microshift @@ -375,162 +541,3 @@ Topics: File: mutatingwebhookconfiguration-admissionregistration-k8s-io-v1 - Name: ValidatingWebhookConfiguration [admissionregistration.k8s.io/v1] File: validatingwebhookconfiguration-admissionregistration-k8s-io-v1 ---- -Name: CLI tools -Dir: microshift_cli_ref -Distros: microshift -Topics: -- Name: CLI tools introduction - File: microshift-cli-tools-introduction -- Name: Installing the OpenShift CLI - File: microshift-oc-cli-install -- Name: Configuring the OpenShift CLI - File: microshift-oc-config -- Name: Using the OpenShift CLI - File: microshift-cli-using-oc -- Name: Using oc and kubectl - File: microshift-usage-oc-kubectl -- Name: List of oc CLI commands - File: microshift-oc-cli-commands-list ---- -Name: Configuring -Dir: microshift_configuring -Distros: microshift -Topics: -- Name: Using the MicroShift configuration file - File: microshift-using-config-tools -- Name: Configuring IPv6 networking - File: microshift-nw-ipv6-config -- Name: Cluster access with kubeconfig - File: microshift-cluster-access-kubeconfig -- Name: Using custom certificate authorities - File: microshift-custom-ca -- Name: Checking the status of Greenboot health checks - File: microshift-greenboot-checking-status -- Name: Configuring audit logging policies - File: microshift-audit-logs-config -- Name: Configuring low latency - Dir: microshift_low_latency - Topics: - - Name: Configuring low latency - File: microshift-low-latency - - Name: Workload partitioning - File: microshift-workload-partitioning ---- -Name: Networking -Dir: microshift_networking -Distros: microshift -Topics: -- Name: About the networking plugin - File: microshift-cni -- Name: Using networking settings - File: microshift-networking-settings -- Name: Configuring the router - File: microshift-nw-router -- Name: Network policies - Dir: microshift_network_policy - Topics: - - Name: About network policies - File: microshift-network-policy-index - - Name: Creating network policies - File: microshift-creating-network-policy - - Name: Editing network policies - File: microshift-editing-network-policy - - Name: Deleting network policies - File: microshift-deleting-network-policy - - Name: Viewing network policies - File: microshift-viewing-network-policy -- Name: Multiple networks - Dir: microshift_multiple_networks - Topics: - - Name: About using multiple networks - File: microshift-cni-multus - - Name: Configuring and using multiple networks - File: microshift-cni-multus-using -- Name: Configuring routes - File: microshift-configuring-routes -- Name: Firewall configuration - File: microshift-firewall -- Name: Networking settings for fully disconnected hosts - File: microshift-disconnected-network-config ---- -Name: Storage -Dir: microshift_storage -Distros: microshift -Topics: -- Name: About storage - File: index -- Name: Understanding ephemeral storage - File: understanding-ephemeral-storage-microshift -- Name: Generic ephemeral volumes - File: generic-ephemeral-volumes-microshift -- Name: Understanding persistent storage - File: understanding-persistent-storage-microshift -- Name: Expanding persistent volumes - File: expanding-persistent-volumes-microshift -- Name: Dynamic storage using the LVMS plugin - File: microshift-storage-plugin-overview -- Name: Working with volume snapshots - File: volume-snapshots-microshift -- Name: Understanding storage migration - File: microshift-storage-migration ---- -Name: Running applications -Dir: microshift_running_apps -Distros: microshift -Topics: -- Name: Using Kustomize to deploy applications - File: microshift-applications -- 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: Creating application or workload health check scripts - File: microshift-greenboot-workload-scripts -- Name: Automating application management with GitOps - File: microshift-gitops -- Name: Pod security authentication and authorization - File: microshift-authentication -- Name: Operators - Dir: microshift_operators - Topics: - - Name: Using Operators - File: microshift-operators - - Name: Using Operator Lifecycle Manager - File: microshift-operators-olm - - Name: Creating custom catalogs with oc-mirror - File: microshift-operators-oc-mirror - - Name: Adding OLM-based Operators to a disconnected cluster - File: microshift-operators-oc-mirror-disconnected ---- -Name: Backup and restore -Dir: microshift_backup_and_restore -Distros: microshift -Topics: -- Name: Backing up and restoring data - File: microshift-backup-and-restore ---- -Name: Troubleshooting -Dir: microshift_troubleshooting -Distros: microshift -Topics: -- Name: Check your version - File: microshift-version -- Name: Troubleshoot the cluster - File: microshift-troubleshoot-cluster -- Name: Troubleshoot installation issues - File: microshift-installing-troubleshooting -- Name: Troubleshoot backup and restore - File: microshift-troubleshoot-backup-restore -- Name: Troubleshoot updates - File: microshift-troubleshoot-updates -- Name: Check the audit logs - File: microshift-audit-logs -- Name: Troubleshoot etcd - File: microshift-etcd-troubleshoot -- Name: Additional information - File: microshift-things-to-know -- Name: Data cleanup - File: microshift-cleanup-data diff --git a/microshift_install_bootc/microshift-install-rhel-image-mode.adoc b/microshift_install_bootc/microshift-install-rhel-image-mode.adoc index 9a30c3f3d3..05ed2968e7 100644 --- a/microshift_install_bootc/microshift-install-rhel-image-mode.adoc +++ b/microshift_install_bootc/microshift-install-rhel-image-mode.adoc @@ -34,6 +34,8 @@ include::modules/microshift-install-rhel-image-mode-csi-vgloop.adoc[leveloffset= include::modules/microshift-install-rhel-image-mode-run-container.adoc[leveloffset=+1] +include::modules/microshift-accessing-cluster-remotely.adoc[leveloffset=+2] + include::modules/microshift-install-rhel-image-mode-csi-vgcleanup.adoc[leveloffset=+1] [id="_additional-resources_microshift-install-rhel-image-mode_{context}"] diff --git a/microshift_install_rpm/microshift-install-rpm.adoc b/microshift_install_rpm/microshift-install-rpm.adoc index 701d921f99..ef989a99af 100644 --- a/microshift_install_rpm/microshift-install-rpm.adoc +++ b/microshift_install_rpm/microshift-install-rpm.adoc @@ -28,32 +28,6 @@ include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1] include::modules/microshift-install-rpms.adoc[leveloffset=+1] -[id="microshift-install-rpm-add-ons"] -== Installing optional packages - -When you install {microshift-short}, optional RPM packages can be added. Examples of optional RPMs include those designed to expand your network, add and manage operators, and manage applications. Use the following procedures to add the packages that you need. - -include::modules/microshift-install-rpms-olm.adoc[leveloffset=+2] - -//additional resources for installing OLM -[role="_additional-resources"] -.Additional resources -* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}] - -include::modules/microshift-install-rpms-gitops.adoc[leveloffset=+2] - -//additional resources for installing GitOps -[role="_additional-resources"] -.Additional resources -* xref:../microshift_running_apps/microshift-gitops.adoc#microshift-gitops[Automating application management with the GitOps controller] - -include::modules/microshift-install-multus-rpm.adoc[leveloffset=+2] - -//additional resources for installing Multus -[role="_additional-resources"] -.Additional resources -* xref:../microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc#microshift-cni-multus[About using multiple networks] - [id="microshift-starting-and-stopping"] == Starting and stopping {microshift-short} @@ -63,7 +37,7 @@ include::modules/microshift-service-starting.adoc[leveloffset=+2] include::modules/microshift-service-stopping.adoc[leveloffset=+2] -include::modules/microshift-accessing.adoc[leveloffset=+2] +include::modules/microshift-accessing.adoc[leveloffset=+1] //additional resources for accessing module [role="_additional-resources"] diff --git a/microshift_install_rpm_opt/_attributes b/microshift_install_rpm_opt/_attributes new file mode 120000 index 0000000000..f27fd275ea --- /dev/null +++ b/microshift_install_rpm_opt/_attributes @@ -0,0 +1 @@ +../_attributes/ \ No newline at end of file diff --git a/microshift_install_rpm_opt/images b/microshift_install_rpm_opt/images new file mode 120000 index 0000000000..e4c5bd02a1 --- /dev/null +++ b/microshift_install_rpm_opt/images @@ -0,0 +1 @@ +../images/ \ No newline at end of file diff --git a/microshift_install_rpm_opt/microshift-install-optional-rpms.adoc b/microshift_install_rpm_opt/microshift-install-optional-rpms.adoc new file mode 100644 index 0000000000..d9b085736f --- /dev/null +++ b/microshift_install_rpm_opt/microshift-install-optional-rpms.adoc @@ -0,0 +1,36 @@ +:_mod-docs-content-type: ASSEMBLY +[id="microshift-install-optional-rpms"] += Installing optional RPM packages +include::_attributes/attributes-microshift.adoc[] +:context: microshift-install-optional-rpm + +toc::[] + +You can install optional RPM packages with {microshift-short} to provide additional cluster and application services. + +[id="microshift-install-rpm-add-ons"] +== Installing optional packages + +When you install {microshift-short}, optional RPM packages can be added. Examples of optional RPMs include those designed to expand your network, add and manage operators, and manage applications. Use the following procedures to add the packages that you need. + +include::modules/microshift-install-rpms-olm.adoc[leveloffset=+2] + +//additional resources for installing OLM +[role="_additional-resources"] +.Additional resources +* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}] + +include::modules/microshift-install-rpms-gitops.adoc[leveloffset=+2] + +//additional resources for installing GitOps +[role="_additional-resources"] +.Additional resources +* xref:../microshift_running_apps/microshift-gitops.adoc#microshift-gitops[Automating application management with the GitOps controller] + +include::modules/microshift-install-multus-rpm.adoc[leveloffset=+2] + +//additional resources for installing Multus +[role="_additional-resources"] +.Additional resources +* xref:../microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc#microshift-cni-multus[About using multiple networks] + diff --git a/microshift_install_rpm_opt/modules b/microshift_install_rpm_opt/modules new file mode 120000 index 0000000000..43aab75b53 --- /dev/null +++ b/microshift_install_rpm_opt/modules @@ -0,0 +1 @@ +../modules/ \ No newline at end of file diff --git a/microshift_install_rpm_opt/snippets b/microshift_install_rpm_opt/snippets new file mode 120000 index 0000000000..9d58b92e50 --- /dev/null +++ b/microshift_install_rpm_opt/snippets @@ -0,0 +1 @@ +../snippets/ \ No newline at end of file