From 3b7bdc45afe16ca93e9bf01e79bb42ccb27a3370 Mon Sep 17 00:00:00 2001 From: Shubha Narayanan Date: Tue, 23 Jul 2024 14:53:05 +0530 Subject: [PATCH] IPI improvements --- .../ipi/installing-azure-customizations.adoc | 29 +------------------ .../ipi/installing-azure-default.adoc | 9 +++--- .../installing-azure-government-region.adoc | 17 ----------- ...stalling-azure-network-customizations.adoc | 16 ---------- .../ipi/installing-azure-preparing-ipi.adoc | 2 +- .../ipi/installing-azure-private.adoc | 16 ---------- .../ipi/installing-azure-vnet.adoc | 16 ---------- .../preparing-to-install-on-azure.adoc | 24 +++++++-------- modules/installation-azure-config-yaml.adoc | 4 +-- 9 files changed, 20 insertions(+), 113 deletions(-) diff --git a/installing/installing_azure/ipi/installing-azure-customizations.adoc b/installing/installing_azure/ipi/installing-azure-customizations.adoc index d4ff939f02..71209991b2 100644 --- a/installing/installing_azure/ipi/installing-azure-customizations.adoc +++ b/installing/installing_azure/ipi/installing-azure-customizations.adoc @@ -7,27 +7,10 @@ include::_attributes/common-attributes.adoc[] toc::[] -In {product-title} version {product-version}, you can install a customized -cluster on infrastructure that the installation program provisions on -Microsoft Azure. To customize the installation, you modify -parameters in the `install-config.yaml` file before you install the cluster. - -== Prerequisites - -* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. -* You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to. -* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. -* If you use customer-managed encryption keys, you xref:../../../installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc#preparing-disk-encryption-sets_installing-azure-preparing-ipi[prepared your Azure environment for encryption]. - -include::modules/cluster-entitlements.adoc[leveloffset=+1] - -include::modules/ssh-agent-using.adoc[leveloffset=+1] +You can install a customized cluster on infrastructure that the installation program provisions on {azure-first}. To customize the installation, modify parameters in the `install-config.yaml` file before you install the cluster. include::modules/installation-azure-marketplace-subscribe.adoc[leveloffset=+1] -include::modules/installation-obtaining-installer.adoc[leveloffset=+1] - include::modules/installation-initializing.adoc[leveloffset=+1] [role="_additional-resources"] @@ -61,9 +44,6 @@ include::modules/installation-user-defined-tags-azure.adoc[leveloffset=+1] include::modules/querying-user-defined-tags-azure.adoc[leveloffset=+1] -//Installing the OpenShift CLI by downloading the binary: Moved up to precede manual cred (short and long) steps, which require the use of `oc` -include::modules/cli-installing-cli.adoc[leveloffset=+1] - [id="installing-azure-manual-modes_{context}"] == Alternatives to storing administrator-level secrets in the kube-system project @@ -100,13 +80,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] * See xref:../../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console. -include::modules/cluster-telemetry.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service - == Next steps * xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. diff --git a/installing/installing_azure/ipi/installing-azure-default.adoc b/installing/installing_azure/ipi/installing-azure-default.adoc index d102eb484b..99c2c37434 100644 --- a/installing/installing_azure/ipi/installing-azure-default.adoc +++ b/installing/installing_azure/ipi/installing-azure-default.adoc @@ -1,13 +1,12 @@ :_mod-docs-content-type: ASSEMBLY -[id="installing-azure-default"] -= Installing a cluster quickly on Azure include::_attributes/common-attributes.adoc[] +[id="installing-azure-default"] += Installing a cluster on {azure-short} :context: installing-azure-default toc::[] -In {product-title} version {product-version}, you can install a cluster on -Microsoft Azure that uses the default configuration options. +You can install a cluster on {azure-first} that uses the default configuration options. include::modules/installation-launching-installer.adoc[leveloffset=+1] @@ -16,7 +15,7 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* See xref:../../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console. +* For more information about accessing and understanding the {product-title} web console, see xref:../../../web_console/web-console.adoc#web-console[Accessing the web console]. == Next steps diff --git a/installing/installing_azure/ipi/installing-azure-government-region.adoc b/installing/installing_azure/ipi/installing-azure-government-region.adoc index 4ad75025a2..d2b1b9cbe6 100644 --- a/installing/installing_azure/ipi/installing-azure-government-region.adoc +++ b/installing/installing_azure/ipi/installing-azure-government-region.adoc @@ -37,14 +37,6 @@ include::modules/installation-about-custom-azure-vnet.adoc[leveloffset=+1] * xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] - - -include::modules/cluster-entitlements.adoc[leveloffset=+1] - -include::modules/ssh-agent-using.adoc[leveloffset=+1] - -include::modules/installation-obtaining-installer.adoc[leveloffset=+1] - include::modules/installation-initializing-manual.adoc[leveloffset=+1] [role="_additional-resources"] @@ -74,8 +66,6 @@ include::modules/installation-configure-proxy.adoc[leveloffset=+2] include::modules/installation-launching-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] - include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] [role="_additional-resources"] @@ -83,13 +73,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] * See xref:../../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console. -include::modules/cluster-telemetry.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service - == Next steps * xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. diff --git a/installing/installing_azure/ipi/installing-azure-network-customizations.adoc b/installing/installing_azure/ipi/installing-azure-network-customizations.adoc index d520340cb0..41651270f3 100644 --- a/installing/installing_azure/ipi/installing-azure-network-customizations.adoc +++ b/installing/installing_azure/ipi/installing-azure-network-customizations.adoc @@ -24,12 +24,6 @@ cluster. * If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * If you use customer-managed encryption keys, you xref:../../../installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc#preparing-disk-encryption-sets_installing-azure-preparing-ipi[prepared your Azure environment for encryption]. -include::modules/cluster-entitlements.adoc[leveloffset=+1] - -include::modules/ssh-agent-using.adoc[leveloffset=+1] - -include::modules/installation-obtaining-installer.adoc[leveloffset=+1] - include::modules/installation-initializing.adoc[leveloffset=+1] [role="_additional-resources"] @@ -70,9 +64,6 @@ For more information on using Linux and Windows nodes in the same cluster, see x * For more details about Accelerated Networking, see xref:../../../machine_management/creating_machinesets/creating-machineset-azure.adoc#machineset-azure-accelerated-networking_creating-machineset-azure[Accelerated Networking for Microsoft Azure VMs]. -//Installing the OpenShift CLI by downloading the binary: Moved up to precede manual cred (short and long) steps, which require the use of `oc` -include::modules/cli-installing-cli.adoc[leveloffset=+1] - [id="installing-azure-manual-modes_{context}"] == Alternatives to storing administrator-level secrets in the kube-system project @@ -109,13 +100,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] * See xref:../../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console. -include::modules/cluster-telemetry.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service - == Next steps * xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. diff --git a/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc b/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc index 77a0188972..0f0e40ac85 100644 --- a/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc +++ b/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc @@ -10,7 +10,7 @@ To prepare for installation of an {product-title} cluster on {azure-short}, comp * You have xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selected a cluster installation method]. -* You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to. +* You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an {azure-short} account] to host the cluster and determined the tested and validated region to deploy the cluster to. * If you use a firewall, you have xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_azure/ipi/installing-azure-private.adoc b/installing/installing_azure/ipi/installing-azure-private.adoc index 4c850477eb..03d7e0d295 100644 --- a/installing/installing_azure/ipi/installing-azure-private.adoc +++ b/installing/installing_azure/ipi/installing-azure-private.adoc @@ -31,12 +31,6 @@ include::modules/installation-about-custom-azure-vnet.adoc[leveloffset=+1] * xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] -include::modules/cluster-entitlements.adoc[leveloffset=+1] - -include::modules/ssh-agent-using.adoc[leveloffset=+1] - -include::modules/installation-obtaining-installer.adoc[leveloffset=+1] - include::modules/installation-initializing-manual.adoc[leveloffset=+1] [role="_additional-resources"] @@ -66,9 +60,6 @@ include::modules/installation-configure-proxy.adoc[leveloffset=+2] * For more details about Accelerated Networking, see xref:../../../machine_management/creating_machinesets/creating-machineset-azure.adoc#machineset-azure-accelerated-networking_creating-machineset-azure[Accelerated Networking for Microsoft Azure VMs]. -//Installing the OpenShift CLI by downloading the binary: Moved up to precede manual cred (short and long) steps, which require the use of `oc` -include::modules/cli-installing-cli.adoc[leveloffset=+1] - [id="installing-azure-manual-modes_{context}"] == Alternatives to storing administrator-level secrets in the kube-system project @@ -112,13 +103,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] * See xref:../../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console. -include::modules/cluster-telemetry.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service - == Next steps * xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. diff --git a/installing/installing_azure/ipi/installing-azure-vnet.adoc b/installing/installing_azure/ipi/installing-azure-vnet.adoc index 8261bdebd9..f3e7d91fd0 100644 --- a/installing/installing_azure/ipi/installing-azure-vnet.adoc +++ b/installing/installing_azure/ipi/installing-azure-vnet.adoc @@ -25,12 +25,6 @@ include::modules/installation-about-custom-azure-vnet.adoc[leveloffset=+1] * xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] -include::modules/cluster-entitlements.adoc[leveloffset=+1] - -include::modules/ssh-agent-using.adoc[leveloffset=+1] - -include::modules/installation-obtaining-installer.adoc[leveloffset=+1] - include::modules/installation-initializing.adoc[leveloffset=+1] [role="_additional-resources"] @@ -60,9 +54,6 @@ include::modules/installation-configure-proxy.adoc[leveloffset=+2] * For more details about Accelerated Networking, see xref:../../../machine_management/creating_machinesets/creating-machineset-azure.adoc#machineset-azure-accelerated-networking_creating-machineset-azure[Accelerated Networking for Microsoft Azure VMs]. -//Installing the OpenShift CLI by downloading the binary: Moved up to precede manual cred (short and long) steps, which require the use of `oc` -include::modules/cli-installing-cli.adoc[leveloffset=+1] - [id="installing-azure-manual-modes_{context}"] == Alternatives to storing administrator-level secrets in the kube-system project @@ -97,13 +88,6 @@ include::modules/installation-launching-installer.adoc[leveloffset=+1] * See xref:../../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console. -include::modules/cluster-telemetry.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service - == Next steps * xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. diff --git a/installing/installing_azure/preparing-to-install-on-azure.adoc b/installing/installing_azure/preparing-to-install-on-azure.adoc index be0086016e..032628510d 100644 --- a/installing/installing_azure/preparing-to-install-on-azure.adoc +++ b/installing/installing_azure/preparing-to-install-on-azure.adoc @@ -13,32 +13,32 @@ See xref:../../architecture/architecture-installation.adoc#installation-process_ [id="choosing-an-method-to-install-ocp-on-azure-installer-provisioned"] == Installing a cluster on installer-provisioned infrastructure -You can install a cluster on Azure infrastructure that is provisioned by the {product-title} installation program, by using one of the following methods: +You can install a cluster on {azure-first} infrastructure that is provisioned by the {product-title} installation program, by using one of the following methods: -* **xref:../../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[Installing a cluster quickly on Azure]**: You can install {product-title} on Azure infrastructure that is provisioned by the {product-title} installation program. You can install a cluster quickly by using the default configuration options. +* **xref:../../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[Installing a cluster quickly on Azure]**: You can install {product-title} on {azure-short} infrastructure that is provisioned by the {product-title} installation program. You can install a cluster quickly by using the default configuration options. -* **xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[Installing a customized cluster on Azure]**: You can install a customized cluster on Azure infrastructure that the installation program provisions. The installation program allows for some customization to be applied at the installation stage. Many other customization options are available xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[post-installation]. +* **xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[Installing a customized cluster on {azure-short}]**: You can install a customized cluster on {azure-short} infrastructure that the installation program provisions. The installation program allows for some customization to be applied at the installation stage. Many other customization options are available xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[post-installation]. -* **xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[Installing a cluster on Azure with network customizations]**: You can customize your {product-title} network configuration during installation, so that your cluster can coexist with your existing IP address allocations and adhere to your network requirements. +* **xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[Installing a cluster on {azure-short} with network customizations]**: You can customize your {product-title} network configuration during installation, so that your cluster can coexist with your existing IP address allocations and adhere to your network requirements. -* **xref:../../installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc#installing-restricted-networks-azure-installer-provisioned[Installing a cluster on Azure in a restricted network]** : You can install a cluster on Microsoft Azure in a restricted network by creating an internal mirror of the installation release content on an existing Azure Virtual Network (VNet). +* **xref:../../installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc#installing-restricted-networks-azure-installer-provisioned[Installing a cluster on {azure-short} in a restricted network]** : You can install a cluster on {azure-short} in a restricted network by creating an internal mirror of the installation release content on an existing Azure Virtual Network (VNet). -* **xref:../../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[Installing a cluster on Azure into an existing VNet]**: You can install {product-title} on an existing Azure Virtual Network (VNet) on Azure. You can use this installation method if you have constraints set by the guidelines of your company, such as limits when creating new accounts or infrastructure. +* **xref:../../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[Installing a cluster on {azure-short} into an existing VNet]**: You can install {product-title} on an existing Azure Virtual Network (VNet) on Azure. You can use this installation method if you have constraints set by the guidelines of your company, such as limits when creating new accounts or infrastructure. -* **xref:../../installing/installing_azure/ipi/installing-azure-private.adoc#installing-azure-private[Installing a private cluster on Azure]**: You can install a private cluster into an existing Azure Virtual Network (VNet) on Azure. You can use this method to deploy {product-title} on an internal network that is not visible to the internet. +* **xref:../../installing/installing_azure/ipi/installing-azure-private.adoc#installing-azure-private[Installing a private cluster on {azure-short}]**: You can install a private cluster into an existing Azure Virtual Network (VNet) on {azure-short}. You can use this method to deploy {product-title} on an internal network that is not visible to the internet. -* **xref:../../installing/installing_azure/ipi/installing-azure-government-region.adoc#installing-azure-government-region[Installing a cluster on Azure into a government region]**: {product-title} can be deployed into Microsoft Azure Government (MAG) regions that are specifically designed for US government agencies at the federal, state, and local level, as well as contractors, educational institutions, and other US customers that must run sensitive workloads on Azure. +* **xref:../../installing/installing_azure/ipi/installing-azure-government-region.adoc#installing-azure-government-region[Installing a cluster on {azure-short} into a government region]**: {product-title} can be deployed into Microsoft Azure Government (MAG) regions that are specifically designed for US government agencies at the federal, state, and local level, as well as contractors, educational institutions, and other US customers that must run sensitive workloads on {azure-short}. [id="choosing-an-method-to-install-ocp-on-azure-user-provisioned"] == Installing a cluster on user-provisioned infrastructure -You can install a cluster on Azure infrastructure that you provision, by using one of the following methods: +You can install a cluster on {azure-short} infrastructure that you provision, by using one of the following methods: -* **xref:../../installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc#installing-restricted-networks-azure-user-provisioned[Installing a cluster on Azure in a restricted network with user-provisioned infrastructure]**: You can perform an installation on Azure that does not require an active connection to the internet to obtain software components. +* **xref:../../installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc#installing-restricted-networks-azure-user-provisioned[Installing a cluster on {azure-short} in a restricted network with user-provisioned infrastructure]**: You can perform an installation on Azure that does not require an active connection to the internet to obtain software components. -* **xref:../../installing/installing_azure/upi/installing-azure-user-infra.adoc#installing-azure-user-infra[Installing a cluster on Azure using ARM templates]**: You can install {product-title} on Azure by using infrastructure that you provide. You can use the provided Azure Resource Manager (ARM) templates to assist with an installation. +* **xref:../../installing/installing_azure/upi/installing-azure-user-infra.adoc#installing-azure-user-infra[Installing a cluster on {azure-short} using ARM templates]**: You can install {product-title} on {azure-short} by using infrastructure that you provide. You can use the provided Azure Resource Manager (ARM) templates to assist with an installation. [id="preparing-to-install-on-azure-next-steps"] == Next steps -* xref:../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[Configuring an Azure account] +* xref:../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[Configuring an {azure-short} account] diff --git a/modules/installation-azure-config-yaml.adoc b/modules/installation-azure-config-yaml.adoc index 614675fa15..6f18655ed0 100644 --- a/modules/installation-azure-config-yaml.adoc +++ b/modules/installation-azure-config-yaml.adoc @@ -62,7 +62,7 @@ controlPlane: <2> type: Standard_D8s_v3 replicas: 3 compute: <2> -- hyperthreading: Enabled <3> +- hyperthreading: Enabled <3> <4> name: worker platform: azure: @@ -222,7 +222,7 @@ ifdef::gov[] endif::gov[] <2> If you do not provide these parameters and values, the installation program provides the default value. <3> The `controlPlane` section is a single mapping, but the `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Only one control plane pool is used. -<4> Whether to enable or disable simultaneous multithreading, or `hyperthreading`. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to `Disabled`. If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines. +<4> Whether to enable or disable simultaneous multithreading, or `hyperthreading`. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to `Disabled`. If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines. + [IMPORTANT] ====