OSDOCS-3179: Document network customization for Azure Stack Hub

_topic_maps/_topic_map.yml

@@ -166,8 +166,12 @@ Topics:
     File: installing-azure-stack-hub-account
   - Name: Manually creating IAM for Azure Stack Hub
     File: manually-creating-iam-azure-stack-hub
+  - Name: Installing a cluster quickly on Azure Stack Hub
+    File: installing-azure-stack-hub-default
   - Name: Installing a cluster on Azure Stack Hub using ARM templates
     File: installing-azure-stack-hub-user-infra
+  - Name: Installing a cluster on Azure Stack Hub with network customizations
+    File: installing-azure-stack-hub-network-customizations
 - Name: Installing on GCP
   Dir: installing_gcp
   Distros: openshift-origin,openshift-enterprise

installing/installing-preparing.adoc

@@ -46,7 +46,7 @@ Because you need to provision machines as part of the {product-title} cluster in
 
 Because the operating system is integral to {product-title}, it is easier to let the installation program for {product-title} stand up all of the infrastructure. These are called _installer provisioned infrastructure_ installations. In this type of installation, you can provide some existing infrastructure to the cluster, but the installation program deploys all of the machines that your cluster initially needs.
 
-You can deploy an installer-provisioned infrastructure cluster without specifying any customizations to the cluster or its underlying machines to xref:../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[AWS], xref:../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[Azure], xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[GCP], or xref:../installing/installing_vmc/installing-vmc.adoc#installing-vmc[VMC on AWS]. These installation methods are the fastest way to deploy a production-capable {product-title} cluster.
+You can deploy an installer-provisioned infrastructure cluster without specifying any customizations to the cluster or its underlying machines to xref:../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[AWS], xref:../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[Azure], xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[Azure Stack Hub], xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[GCP], or xref:../installing/installing_vmc/installing-vmc.adoc#installing-vmc[VMC on AWS]. These installation methods are the fastest way to deploy a production-capable {product-title} cluster.
 
 If you need to perform basic configuration for your installer-provisioned infrastructure cluster, such as the instance type for the cluster machines, you can customize an installation for xref:../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[AWS], xref:../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[Azure], xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[GCP], or xref:../installing/installing_vmc/installing-vmc-customizations.adoc#installing-vmc-customizations[VMC on AWS].
 
@@ -118,7 +118,7 @@ Not all installation options are supported for all platforms, as shown in the fo
 .Installer-provisioned infrastructure options
 |===
 ifndef::openshift-origin[]
-||AWS |Azure |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |RHV |Bare metal |vSphere |VMC |IBM Z |IBM Power
+||AWS |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |RHV |Bare metal |vSphere |VMC |IBM Z |IBM Power
 endif::openshift-origin[]
 ifdef::openshift-origin[]
 ||AWS |Azure |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |oVirt |Bare metal |vSphere |VMC |IBM Z |IBM Power
@@ -127,6 +127,7 @@ endif::openshift-origin[]
 |Default
 |xref:../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[X]
 |xref:../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[X]
+|xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[X]
 |xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[X]
 |
 |
@@ -140,6 +141,7 @@ endif::openshift-origin[]
 |Custom
 |xref:../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[X]
 |xref:../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[X]
+|
 |xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[X]
 |xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[X]
 |xref:../installing/installing_openstack/installing-openstack-installer-sr-iov.adoc#installing-openstack-installer-sr-iov[X]
@@ -153,6 +155,7 @@ endif::openshift-origin[]
 |Network customization
 |xref:../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[X]
 |xref:../installing/installing_azure/installing-azure-network-customizations.adoc#installing-azure-network-customizations[X]
+|
 |xref:../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[X]
 |xref:../installing/installing_openstack/installing-openstack-installer-kuryr.adoc#installing-openstack-installer-kuryr[X]
 |
@@ -166,6 +169,7 @@ endif::openshift-origin[]
 |Restricted network
 |xref:../installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[X]
 |
+|
 |xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[X]
 |xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[X]
 |
@@ -179,6 +183,7 @@ endif::openshift-origin[]
 |Private clusters
 |xref:../installing/installing_aws/installing-aws-private.adoc#installing-aws-private[X]
 |xref:../installing/installing_azure/installing-azure-private.adoc#installing-azure-private[X]
+|
 |xref:../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[X]
 |
 |
@@ -192,6 +197,7 @@ endif::openshift-origin[]
 |Existing virtual private networks
 |xref:../installing/installing_aws/installing-aws-vpc.adoc#installing-aws-vpc[X]
 |xref:../installing/installing_azure/installing-azure-vnet.adoc#installing-azure-vnet[X]
+|
 |xref:../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[X]
 |
 |
@@ -214,6 +220,7 @@ endif::openshift-origin[]
 |
 |
 |
+|
 
 |China regions
 |xref:../installing/installing_aws/installing-aws-china.adoc#installing-aws-china-region[X]
@@ -227,6 +234,7 @@ endif::openshift-origin[]
 |
 |
 |
+|
 
 |===
 

installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc

@@ -0,0 +1,58 @@
+[id="installing-azure-stack-hub-default"]
+= Installing a cluster quickly on Azure Stack Hub
+include::modules/common-attributes.adoc[]
+:context: installing-azure-stack-hub-default
+
+toc::[]
+
+In {product-title} version {product-version}, you can install a cluster on
+Microsoft Azure Stack Hub that uses the default configuration options. However, you must manually configure the `install-config.yaml` file to specify values that are specific to Azure Stack Hub.
+
+[NOTE]
+====
+While you can select `azure` when using the installation program to deploy a cluster using installer-provisioned infrastructure, this option is only supported for the Azure Public Cloud.
+====
+
+== 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/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
+* You xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc#installing-azure-stack-hub-account[configured an Azure Stack Hub account] to host the 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.
+* You put the Cloud Credential Operator (COO) into xref:../../installing/installing_azure_stack_hub/manually-creating-iam-azure-stack-hub.adoc#manually-creating-iam-azure-stack-hub[manual mode]. Manual mode is used in environments where the cloud IAM APIs are not reachable.
+
+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]
+include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
+include::modules/installation-azure-stack-hub-config-yaml.adoc[leveloffset=+2]
+
+//include::modules/installation-launching-installer.adoc[leveloffset=+1]
+//Leaving this stubbed in case future might remove the requirement to manually configure the install configuration file.
+
+include::modules/cli-installing-cli.adoc[leveloffset=+1]
+
+include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
+
+include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1]
+
+.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.
+
+include::modules/cluster-telemetry.adoc[leveloffset=+1]
+
+.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:../../installing/validating-an-installation.adoc#validating-an-installation[Validating an installation].
+* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
+* If necessary, you can xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
+* If necessary, you can xref:../../authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc#manually-removing-cloud-creds_cco-mode-mint[remove cloud provider credentials].

installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc

@@ -0,0 +1,69 @@
+[id="installing-azure-stack-hub-network-customizations"]
+= Installing a cluster on Azure Stack Hub with network customizations
+include::modules/common-attributes.adoc[]
+:context: installing-azure-stack-hub-network-customizations
+
+toc::[]
+
+In {product-title} version {product-version}, you can install a cluster on
+Microsoft Azure Stack Hub that uses the default configuration options. However, you must manually configure the `install-config.yaml` file to specify values that are specific to Azure Stack Hub.
+
+[NOTE]
+====
+While you can select `azure` when using the installation program to deploy a cluster using installer-provisioned infrastructure, this option is only supported for the Azure Public Cloud.
+====
+
+== 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/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
+* You xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc#installing-azure-stack-hub-account[configured an Azure Stack Hub account] to host the 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.
+* You put the Cloud Credential Operator (COO) into xref:../../installing/installing_azure_stack_hub/manually-creating-iam-azure-stack-hub.adoc#manually-creating-iam-azure-stack-hub[manual mode]. Manual mode is used in environments where the cloud IAM APIs are not reachable.
+
+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]
+include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
+include::modules/installation-azure-stack-hub-config-yaml.adoc[leveloffset=+2]
+
+//include::modules/installation-launching-installer.adoc[leveloffset=+1]
+//Leaving this stubbed in case future might remove the requirement to manually configure the install configuration file.
+
+// Network Operator specific configuration
+include::modules/nw-network-config.adoc[leveloffset=+1]
+include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
+include::modules/nw-operator-cr.adoc[leveloffset=+1]
+include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1]
+
+[NOTE]
+====
+For more information on using Linux and Windows nodes in the same cluster, see xref:../../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads[Understanding Windows container workloads].
+====
+
+include::modules/cli-installing-cli.adoc[leveloffset=+1]
+
+include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
+
+include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1]
+
+.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.
+
+include::modules/cluster-telemetry.adoc[leveloffset=+1]
+
+.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:../../installing/validating-an-installation.adoc#validating-an-installation[Validating an installation].
+* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
+* If necessary, you can xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
+* If necessary, you can xref:../../authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc#manually-removing-cloud-creds_cco-mode-mint[remove cloud provider credentials].

installing/installing_azure_stack_hub/manually-creating-iam-azure-stack-hub.adoc

@@ -27,4 +27,6 @@ include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
 [id="next-steps_manually-creating-iam-azure-stack-hub"]
 == Next steps
 
-* Install an {product-title} cluster on Azure Stack Hub with user-provisioned infrastructure by following xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc#installing-azure-stack-hub-user-infra[Installing a cluster on Azure Stack Hub using ARM templates].
+* Install an {product-title} cluster:
+** xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[Installing a cluster quickly on Azure Stack Hub].
+** xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc#installing-azure-stack-hub-user-infra[Installing a cluster on Azure Stack Hub using ARM templates].

installing/installing_azure_stack_hub/preparing-to-install-on-azure-stack-hub.adoc

@@ -14,17 +14,25 @@ toc::[]
 [id="requirements-for-installing-ocp-on-ash"]
 == Requirements for installing {product-title} on Azure Stack Hub
 
-Before installing {product-title} on Microsoft Azure Stack Hub, you must configure an Azure account. See xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc#installing-azure-stack-hub-account[Configuring an Azure Stack Hub account] for details about account configuration, account limits, DNS zone configuration, required roles, and creating service principals.
+Before installing {product-title} on Microsoft Azure Stack Hub, you must:
 
-You must manually manage your cloud credentials when installing a cluster to Azure Stack Hub. Do this by configuring the Cloud Credential Operator (CCO) for manual mode before you install the cluster. For more information, see xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[Manually creating IAM for Azure].
+* Configure an Azure account. See xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc#installing-azure-stack-hub-account[Configuring an Azure Stack Hub account] for details about account configuration, account limits, DNS zone configuration, required roles, and creating service principals.
+* Manually manage your cloud credentials when installing a cluster to Azure Stack Hub. Do this by configuring the Cloud Credential Operator (CCO) for manual mode before you install the cluster. For more information, see xref:../../installing/installing_azure_stack_hub/manually-creating-iam-azure-stack-hub.adoc#manually-creating-iam-azure-stack-hub[Manually creating IAM for Azure].
 
 [id="choosing-a-method-to-install-ocp-on-ash"]
 == Choosing a method to install {product-title} on Azure Stack Hub
 
-You can install {product-title} on Azure Stack Hub using user-provisioned infrastructure. This means you must manage and maintain the cluster resources yourself. Installing {product-title} on Azure Stack Hub using an installation program that automatically provisions the cluster infrastructure is not supported at this time.
+You can install {product-title} on installer-provisioned or user-provisioned infrastructure. The default installation type uses installer-provisioned infrastructure, where the installation program provisions the underlying infrastructure for the cluster. You can also install {product-title} on infrastructure that you provision. If you do not use infrastructure that the installation program provisions, you must manage and maintain the cluster resources yourself.
 
 See xref:../../architecture/architecture-installation.adoc#installation-process_architecture-installation[Installation process] for more information about installer-provisioned and user-provisioned installation processes.
 
+[id="choosing-a-method-to-install-ocp-on-ash-installer-provisioned"]
+=== Installing a cluster on installer-provisioned infrastructure
+
+You can install a cluster on Azure Stack Hub infrastructure that is provisioned by the {product-title} installation program, by using one of the following methods:
+
+* **xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[Installing a cluster quickly on Azure Stack Hub]**: You can install {product-title} on Azure Stack Hub infrastructure that is provisioned by the {product-title} installation program. You can install a cluster quickly by using the default configuration options.
+
 [id="choosing-a-method-to-install-ocp-on-ash-user-provisioned"]
 === Installing a cluster on user-provisioned infrastructure
 

modules/cluster-entitlements.adoc

@@ -17,6 +17,7 @@
 // * installing/installing_ibm_z/installing-ibm-z.adoc
 // * installing/installing_azure/installing-azure-vnet.adoc
 // * installing/installing_azure/installing-azure-user-infra.adoc
+// * installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc
 // * installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc
 // * installing/installing_azure/installing-azure-default.adoc
 // * installing/installing_azure/installing-azure-network-customizations.adoc

modules/configuring-hybrid-ovnkubernetes.adoc

@@ -2,6 +2,7 @@
 //
 // * installing/installing_aws/installing-aws-network-customizations.adoc
 // * installing/installing_azure/installing-azure-network-customizations.adoc
+// * installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc
 // * networking/ovn_kubernetes_network_provider/configuring-hybrid-networking.adoc
 
 [id="configuring-hybrid-ovnkubernetes_{context}"]