From 55179fc50fcbb0ffdc6dca97745fa94cd5d58ab4 Mon Sep 17 00:00:00 2001 From: Jeana Routh Date: Fri, 20 Dec 2024 08:36:21 -0500 Subject: [PATCH] Fixes UPI Machine API admonition snippet --- machine_management/creating-infrastructure-machinesets.adoc | 2 +- .../creating_machinesets/creating-machineset-alibaba.adoc | 2 +- .../creating_machinesets/creating-machineset-aws.adoc | 2 +- .../creating-machineset-azure-stack-hub.adoc | 2 +- .../creating_machinesets/creating-machineset-azure.adoc | 2 +- .../creating_machinesets/creating-machineset-bare-metal.adoc | 2 +- .../creating_machinesets/creating-machineset-gcp.adoc | 2 +- .../creating_machinesets/creating-machineset-ibm-cloud.adoc | 2 +- .../creating_machinesets/creating-machineset-ibm-power-vs.adoc | 2 +- .../creating_machinesets/creating-machineset-nutanix.adoc | 2 +- .../creating_machinesets/creating-machineset-osp.adoc | 2 +- .../creating_machinesets/creating-machineset-vsphere.adoc | 2 +- machine_management/deploying-machine-health-checks.adoc | 2 +- machine_management/manually-scaling-machineset.adoc | 2 +- nodes/nodes/nodes-nodes-creating-infrastructure-nodes.adoc | 2 +- post_installation_configuration/node-tasks.adoc | 2 +- {modules => snippets}/machine-user-provisioned-limitations.adoc | 2 ++ 17 files changed, 18 insertions(+), 16 deletions(-) rename {modules => snippets}/machine-user-provisioned-limitations.adoc (97%) diff --git a/machine_management/creating-infrastructure-machinesets.adoc b/machine_management/creating-infrastructure-machinesets.adoc index 38f0ec770e..33a00b3fc6 100644 --- a/machine_management/creating-infrastructure-machinesets.adoc +++ b/machine_management/creating-infrastructure-machinesets.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] You can use infrastructure machine sets to create machines that host only infrastructure components, such as the default router, the integrated container image registry, and the components for cluster metrics and monitoring. These infrastructure machines are not counted toward the total number of subscriptions that are required to run the environment. diff --git a/machine_management/creating_machinesets/creating-machineset-alibaba.adoc b/machine_management/creating_machinesets/creating-machineset-alibaba.adoc index 2d21cfd3bd..debbc94358 100644 --- a/machine_management/creating_machinesets/creating-machineset-alibaba.adoc +++ b/machine_management/creating_machinesets/creating-machineset-alibaba.adoc @@ -9,7 +9,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on Alibaba Cloud. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. //[IMPORTANT] admonition for UPI -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] //Sample YAML for a compute machine set custom resource on Alibaba Cloud include::modules/machineset-yaml-alibaba.adoc[leveloffset=+1] diff --git a/machine_management/creating_machinesets/creating-machineset-aws.adoc b/machine_management/creating_machinesets/creating-machineset-aws.adoc index 3ff49cd0c5..54bf7ce179 100644 --- a/machine_management/creating_machinesets/creating-machineset-aws.adoc +++ b/machine_management/creating_machinesets/creating-machineset-aws.adoc @@ -9,7 +9,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on Amazon Web Services (AWS). For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. //[IMPORTANT] admonition for UPI -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] //Sample YAML for a compute machine set custom resource on AWS include::modules/machineset-yaml-aws.adoc[leveloffset=+1] diff --git a/machine_management/creating_machinesets/creating-machineset-azure-stack-hub.adoc b/machine_management/creating_machinesets/creating-machineset-azure-stack-hub.adoc index dc8fbc04ce..b71bec8114 100644 --- a/machine_management/creating_machinesets/creating-machineset-azure-stack-hub.adoc +++ b/machine_management/creating_machinesets/creating-machineset-azure-stack-hub.adoc @@ -9,7 +9,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on Microsoft Azure Stack Hub. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. //[IMPORTANT] admonition for UPI -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] //Sample YAML for a compute machine set custom resource on Azure Stack Hub include::modules/machineset-yaml-azure-stack-hub.adoc[leveloffset=+1] diff --git a/machine_management/creating_machinesets/creating-machineset-azure.adoc b/machine_management/creating_machinesets/creating-machineset-azure.adoc index b6ab58ac6c..4915771491 100644 --- a/machine_management/creating_machinesets/creating-machineset-azure.adoc +++ b/machine_management/creating_machinesets/creating-machineset-azure.adoc @@ -9,7 +9,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on Microsoft Azure. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. //[IMPORTANT] admonition for UPI -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] //Sample YAML for a compute machine set custom resource on Azure include::modules/machineset-yaml-azure.adoc[leveloffset=+1] diff --git a/machine_management/creating_machinesets/creating-machineset-bare-metal.adoc b/machine_management/creating_machinesets/creating-machineset-bare-metal.adoc index 07bdf0d360..282f3a1574 100644 --- a/machine_management/creating_machinesets/creating-machineset-bare-metal.adoc +++ b/machine_management/creating_machinesets/creating-machineset-bare-metal.adoc @@ -8,7 +8,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on bare metal. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] include::modules/machineset-yaml-baremetal.adoc[leveloffset=+1] diff --git a/machine_management/creating_machinesets/creating-machineset-gcp.adoc b/machine_management/creating_machinesets/creating-machineset-gcp.adoc index 8223a19c9e..967d55e415 100644 --- a/machine_management/creating_machinesets/creating-machineset-gcp.adoc +++ b/machine_management/creating_machinesets/creating-machineset-gcp.adoc @@ -9,7 +9,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on Google Cloud Platform (GCP). For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. //[IMPORTANT] admonition for UPI -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] //Sample YAML for a compute machine set custom resource on GCP include::modules/machineset-yaml-gcp.adoc[leveloffset=+1] diff --git a/machine_management/creating_machinesets/creating-machineset-ibm-cloud.adoc b/machine_management/creating_machinesets/creating-machineset-ibm-cloud.adoc index 1609131a75..03b7382a77 100644 --- a/machine_management/creating_machinesets/creating-machineset-ibm-cloud.adoc +++ b/machine_management/creating_machinesets/creating-machineset-ibm-cloud.adoc @@ -9,7 +9,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on {ibm-cloud-name}. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. //[IMPORTANT] admonition for UPI -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] //Sample YAML for a machine set custom resource on IBM Cloud include::modules/machineset-yaml-ibm-cloud.adoc[leveloffset=+1] diff --git a/machine_management/creating_machinesets/creating-machineset-ibm-power-vs.adoc b/machine_management/creating_machinesets/creating-machineset-ibm-power-vs.adoc index 1ad8359950..ce8c8e5c40 100644 --- a/machine_management/creating_machinesets/creating-machineset-ibm-power-vs.adoc +++ b/machine_management/creating_machinesets/creating-machineset-ibm-power-vs.adoc @@ -9,7 +9,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on {ibm-power-server-name}. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. //[IMPORTANT] admonition for UPI -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] //Sample YAML for a machine set custom resource on IBM Cloud include::modules/machineset-yaml-ibm-power-vs.adoc[leveloffset=+1] diff --git a/machine_management/creating_machinesets/creating-machineset-nutanix.adoc b/machine_management/creating_machinesets/creating-machineset-nutanix.adoc index 72a971abf5..b60d8a86cb 100644 --- a/machine_management/creating_machinesets/creating-machineset-nutanix.adoc +++ b/machine_management/creating_machinesets/creating-machineset-nutanix.adoc @@ -9,7 +9,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on Nutanix. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. //[IMPORTANT] admonition for UPI -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] //Sample YAML for a compute machine set custom resource on Nutanix include::modules/machineset-yaml-nutanix.adoc[leveloffset=+1] diff --git a/machine_management/creating_machinesets/creating-machineset-osp.adoc b/machine_management/creating_machinesets/creating-machineset-osp.adoc index db359a9821..ec2325f47f 100644 --- a/machine_management/creating_machinesets/creating-machineset-osp.adoc +++ b/machine_management/creating_machinesets/creating-machineset-osp.adoc @@ -8,7 +8,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on {rh-openstack-first}. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] include::modules/machineset-yaml-osp.adoc[leveloffset=+1] diff --git a/machine_management/creating_machinesets/creating-machineset-vsphere.adoc b/machine_management/creating_machinesets/creating-machineset-vsphere.adoc index f91e4b69bd..ad6c21701d 100644 --- a/machine_management/creating_machinesets/creating-machineset-vsphere.adoc +++ b/machine_management/creating_machinesets/creating-machineset-vsphere.adoc @@ -8,7 +8,7 @@ toc::[] You can create a different compute machine set to serve a specific purpose in your {product-title} cluster on VMware vSphere. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] //Sample YAML for a compute machine set custom resource on vSphere include::modules/machineset-yaml-vsphere.adoc[leveloffset=+1] diff --git a/machine_management/deploying-machine-health-checks.adoc b/machine_management/deploying-machine-health-checks.adoc index c1c61553e6..6751fc6edd 100644 --- a/machine_management/deploying-machine-health-checks.adoc +++ b/machine_management/deploying-machine-health-checks.adoc @@ -8,7 +8,7 @@ toc::[] You can configure and deploy a machine health check to automatically repair damaged machines in a machine pool. -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] include::modules/machine-health-checks-about.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/machine_management/manually-scaling-machineset.adoc b/machine_management/manually-scaling-machineset.adoc index aad837de20..f71f052a91 100644 --- a/machine_management/manually-scaling-machineset.adoc +++ b/machine_management/manually-scaling-machineset.adoc @@ -17,7 +17,7 @@ If you need to modify aspects of a compute machine set outside of scaling, see x * If you enabled the cluster-wide proxy and scale up compute machines not included in `networking.machineNetwork[].cidr` from the installation configuration, you must xref:../networking/enable-cluster-wide-proxy.adoc#nw-proxy-configure-object_config-cluster-wide-proxy[add the compute machines to the Proxy object's `noProxy` field] to prevent connection issues. -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] include::modules/machineset-manually-scaling.adoc[leveloffset=+1] diff --git a/nodes/nodes/nodes-nodes-creating-infrastructure-nodes.adoc b/nodes/nodes/nodes-nodes-creating-infrastructure-nodes.adoc index 08c8b5996b..0aa3b7c8df 100644 --- a/nodes/nodes/nodes-nodes-creating-infrastructure-nodes.adoc +++ b/nodes/nodes/nodes-nodes-creating-infrastructure-nodes.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+1] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] You can use infrastructure machine sets to create machines that host only infrastructure components, such as the default router, the integrated container image registry, and the components for cluster metrics and monitoring. These infrastructure machines are not counted toward the total number of subscriptions that are required to run the environment. diff --git a/post_installation_configuration/node-tasks.adoc b/post_installation_configuration/node-tasks.adoc index d5daeda7df..c3ba08233d 100644 --- a/post_installation_configuration/node-tasks.adoc +++ b/post_installation_configuration/node-tasks.adoc @@ -61,7 +61,7 @@ include::modules/machine-node-custom-partition.adoc[leveloffset=+2] Understand and deploy machine health checks. -include::modules/machine-user-provisioned-limitations.adoc[leveloffset=+2] +include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+2] include::modules/machine-health-checks-about.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources diff --git a/modules/machine-user-provisioned-limitations.adoc b/snippets/machine-user-provisioned-limitations.adoc similarity index 97% rename from modules/machine-user-provisioned-limitations.adoc rename to snippets/machine-user-provisioned-limitations.adoc index 16f9c3fa13..b076c5159a 100644 --- a/modules/machine-user-provisioned-limitations.adoc +++ b/snippets/machine-user-provisioned-limitations.adoc @@ -12,6 +12,8 @@ // * post_installation_configuration/node-tasks.adoc // * nodes-nodes-creating-infrastructure-nodes.adoc +:_mod-docs-content-type: SNIPPET + [IMPORTANT] ==== You can use the advanced machine management and scaling capabilities only in clusters where the Machine API is operational. Clusters with user-provisioned infrastructure require additional validation and configuration to use the Machine API.