--- title: Installing a private cluster on Azure --- # Installing a private cluster on Azure {#installing-azure-private} In OpenShift Container Platform version 4.22, you can install a private cluster into an existing Azure Virtual Network (VNet) on Microsoft Azure. The installation program provisions the rest of the required infrastructure, which you can further customize. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster. ## Private clusters {#private-clusters-default_installing-azure-private} You can deploy a private OpenShift Container Platform cluster that does not expose external endpoints. Private clusters are accessible from only an internal network and are not visible to the internet. By default, OpenShift Container Platform is provisioned to use publicly-accessible DNS and endpoints. A private cluster sets the DNS, Ingress Controller, and API server to private when you deploy your cluster. This means that the cluster resources are only accessible from your internal network and are not visible to the internet. > [!IMPORTANT] > If the cluster has any public subnets, load balancer services created by administrators might be publicly accessible. To ensure cluster security, verify that these services are explicitly annotated as private. To deploy a private cluster, you must: - Use existing networking that meets your requirements. Your cluster resources might be shared between other clusters on the network. - Deploy from a machine that has access to: \*\* The API services for the cloud to which you provision. \*\* The hosts on the network that you provision. \*\* The internet to obtain installation media. ### Private clusters in Azure {#private-clusters-about-azure_installing-azure-private} To create a private cluster on Microsoft Azure, you must provide an existing private VNet and subnets to host the cluster. The installation program must also be able to resolve the DNS records that the cluster requires. The installation program configures the Ingress Operator and API server for only internal traffic. Depending how your network connects to the private VNET, you might need to use a DNS forwarder to resolve the cluster’s private DNS records. The cluster’s machines use `168.63.129.16` internally for DNS resolution. For more information, see "What is Azure Private DNS?" and "What is IP address 168.63.129.16?". The cluster still requires access to internet to access the Azure APIs. The following items are not required or created when you install a private cluster: - A `BaseDomainResourceGroup`, since the cluster does not create public records - Public IP addresses - Public DNS records - Public endpoints ``` The cluster is configured so that the Operators do not create public records for the cluster and all cluster machines are placed in the private subnets that you specify. ``` #### Limitations {#private-clusters-limitations-azure_installing-azure-private} Private clusters on Azure are subject to only the limitations that are associated with the use of an existing VNet. ### User-defined outbound routing {#installation-azure-user-defined-routing_installing-azure-private} You can configure user-defined outbound routing for a OpenShift Container Platform cluster to reach the internet without public IP addresses or a public load balancer. You must use a pre-existing `VNet` for outbound routing when you install a cluster. The installation program does not configure this network. When you configure a cluster to use user-defined routing, the installation program does not create the following resources: - Outbound rules for access to the internet. - Public IPs for the public load balancer. - Kubernetes Service object to add the cluster machines to the public load balancer for outbound requests. Before you set user-defined routing, ensure that the following items are available: - Egress to the internet so that you can pull container images, unless you use an OpenShift image registry mirror. - Access from the cluster to Azure APIs. - Access to the required allowlist endpoints. Several pre-existing networking setups support internet access by using user-defined routing. #### Private cluster with network address translation {#private-cluster-with-network-address-translation_installing-azure-private} You can use Azure Virtual Network (`VNet`) network address translation (NAT) to provide outbound internet access for the subnets in your cluster. When you use a `VNet` setup with Azure NAT and user-defined routing configured, you can create a private cluster with no public endpoints. #### Private cluster with Azure Firewall {#private-cluster-with-azure-firewall_installing-azure-private} You can use Azure Firewall to provide outbound routing for the `VNet` used to install the cluster. When you use a `VNet` setup with Azure Firewall and user-defined routing configured, you can create a private cluster with no public endpoints. #### Private cluster with a proxy configuration {#private-cluster-with-proxy-configuration_installing-azure-private} You can use a proxy with user-defined routing to allow egress to the internet. You must ensure that cluster Operators do not access Azure APIs by using a proxy; Operators must have access to Azure APIs outside of the proxy. When you use the default route table for subnets, with `0.0.0.0/0` populated automatically by Azure, all Azure API requests are routed over Azure’s internal network even though the IP addresses are public. As long as the Network Security Group rules allow egress to Azure API endpoints, proxies with user-defined routing configured allow you to create private clusters with no public endpoints. #### Private cluster with no internet access {#private-cluster-with-no-internet-access_installing-azure-private} You can install a private network that restricts all access to the internet, except the Azure API. Mirror the release image registry locally. Your cluster must have access to the following: - An OpenShift image registry mirror that allows for pulling container images - Access to Azure APIs With these requirements available, you can use user-defined routing to create private clusters with no public endpoints. **Additional resources** {._additional-resources} - [Azure VNet network address translation (NAT)](https://docs.microsoft.com/en-us/azure/virtual-network/nat-overview) - [Create a NAT gateway by using Azure CLI](https://docs.microsoft.com/en-us/azure/virtual-network/quickstart-create-nat-gateway-cli) - [Providing user-defined routing with Azure Firewall](https://docs.microsoft.com/en-us/azure/aks/egress-outboundtype#deploy-a-cluster-with-outbound-type-of-udr-and-azure-firewall) ## About reusing a VNet for your OpenShift Container Platform cluster {#installation-about-custom-azure-vnet_installing-azure-private} In OpenShift Container Platform 4.22, you can deploy a cluster into an existing Microsoft Azure Virtual Network (VNet). Deployments in an existing VNet require existing subnets and routing rules. By deploying OpenShift Container Platform into an existing Azure VNet, you might be able to avoid service limit constraints in new accounts or more easily abide by the operational constraints that your company’s guidelines set. This is a good option to use if you cannot obtain the infrastructure creation permissions that are required to create the VNet. ### Requirements for using your VNet {#installation-about-custom-azure-vnet-requirements_installing-azure-private} When you deploy a cluster by using an existing VNet, you must perform additional network configuration before you install the cluster. In installer-provisioned infrastructure clusters, the installation program usually creates the following components, but it does not create them when you install into an existing VNet: - Subnets - Route tables - VNets - Network Security Groups > [!NOTE] > The installation program requires that you use the cloud-provided DNS server. Using a custom DNS server is not supported and causes the installation to fail. If you use a custom VNet, you must correctly configure it and its subnets for the installation program and the cluster to use. The installation program cannot subdivide network ranges for the cluster to use, set route tables for the subnets, or set VNet options like DHCP, so you must do so before you install the cluster. The cluster must be able to access the resource group that contains the existing VNet and subnets. While all of the resources that the cluster creates are placed in a separate resource group that it creates, some network resources are used from a separate group. Some cluster Operators must be able to access resources in both resource groups. For example, the Machine API controller attaches NICs for the virtual machines that it creates to subnets from the networking resource group. Your VNet must meet the following characteristics: - The VNet’s CIDR block must contain the `Networking.MachineCIDR` range, which is the IP address pool for cluster machines. - The VNet and its subnets must belong to the same resource group, and the subnets must be configured to use Azure-assigned DHCP IP addresses instead of static IP addresses. You must provide two subnets within your VNet, one for the control plane machines and one for the compute machines. Because Azure distributes machines in different availability zones within the region that you specify, your cluster will have high availability by default. > [!NOTE] > By default, if you specify availability zones in the `install-config.yaml` file, the installation program distributes the control plane machines and the compute machines across availability zones within a region. To ensure high availability for your cluster, select a region with at least three availability zones. If your region contains fewer than three availability zones, the installation program places more than one control plane machine in the available zones. For more information, see "Availability zones" and "Regions". To ensure that the subnets that you provide are suitable, the installation program confirms the following data: - All the specified subnets exist. - There are two private subnets, one for the control plane machines and one for the compute machines. - The subnet CIDRs belong to the machine CIDR that you specified. Machines are not provisioned in availability zones that you do not provide private subnets for. > [!NOTE] > If you destroy a cluster that uses an existing VNet, the VNet is not deleted. #### Network security group requirements {#installation-about-custom-azure-vnet-nsg-requirements_installing-azure-private} The network security groups for the subnets that host the compute and control plane machines require specific access to ensure that the cluster communication is correct. You must create rules to allow access to the required cluster communication ports. > [!IMPORTANT] > The network security group rules must be in place before you install the cluster. If you attempt to install a cluster without the required access, the installation program cannot reach the Azure APIs, and installation fails. **Required ports**
Port Description Control plane Compute
80 Allows HTTP traffic x
443 Allows HTTPS traffic x
6443 Allows communication to the control plane machines x
22623 Allows internal communication to the machine config server for provisioning machines x
1. If you are using Azure Firewall to restrict the internet access, then you can configure Azure Firewall to allow the Azure APIs. A network security group rule is not needed. For more information, see "Configuring your firewall" in "Additional resources". > [!IMPORTANT] > Currently, there is no supported way to block or restrict the machine config server endpoint. The machine config server must be exposed to the network so that newly-provisioned machines, which have no existing configuration or state, are able to fetch their configuration. In this model, the root of trust is the certificate signing requests (CSR) endpoint, which is where the kubelet sends its certificate signing request for approval to join the cluster. Because of this, machine configs should not be used to distribute sensitive information, such as secrets and certificates. > > To ensure that the machine config server endpoints, ports 22623 and 22624, are secured in bare metal scenarios, customers must configure proper network policies. Because cluster components do not modify the user-provided network security groups, which the Kubernetes controllers update, a pseudo-network security group is created for the Kubernetes controller to modify without impacting the rest of the environment. **Ports used for all-machine to all-machine communications**
Protocol Port Description
ICMP N/A Network reachability tests
TCP 1936 Metrics
9000-9999 Host level services, including the node exporter on ports 9100-9101 and the Cluster Version Operator on port 9099.
10250-10259 The default ports that Kubernetes reserves
UDP 6081 Geneve
9000-9999 Host level services, including the node exporter on ports 9100-9101.
500 IPsec IKE packets
4500 IPsec NAT-T packets
123 Network Time Protocol (NTP) on UDP port 123. If you configure an external NTP time server, you must open UDP port 123.
TCP/UDP 30000-32767 Kubernetes node port
ESP N/A IPsec Encapsulating Security Payload (ESP)
**Ports used for control plane machine to control plane machine communications**
Protocol Port Description
TCP 2379-2380 etcd server and peer ports
### Division of permissions {#installation-about-custom-azure-permissions_installing-azure-private} Starting with OpenShift Container Platform 4.3, you do not need all of the permissions that are required for an installation program-provisioned infrastructure cluster to deploy a cluster. This change mimics the division of permissions that you might have at your company: some individuals can create different resources in your clouds than others. For example, you might be able to create application-specific items, like instances, storage, and load balancers, but not networking-related components such as VNets, subnet, or ingress rules. The Azure credentials that you use when you create your cluster do not need the networking permissions that are required to make VNets and core networking components within the VNet, such as subnets, routing tables, internet gateways, NAT, and VPN. You still need permission to make the application resources that the machines within the cluster require, such as load balancers, security groups, storage accounts, and nodes. ### Isolation between clusters {#installation-about-custom-azure-vnet-isolation_installing-azure-private} Because the cluster is unable to modify network security groups in an existing subnet, there is no way to isolate clusters from each other on the VNet. **Additional resources** {._additional-resources} - [About the OVN-Kubernetes network plugin](/openshift-docs-markdown/networking/ovn_kubernetes_network_provider/about-ovn-kubernetes#about-ovn-kubernetes) - [Configuring your firewall](/openshift-docs-markdown/installing/install_config/configuring-firewall#configuring-firewall-module_configuring-firewall) - [Availability zones](https://azure.microsoft.com/en-us/global-infrastructure/availability-zones/) - [Regions](https://azure.microsoft.com/en-us/global-infrastructure/regions/) ## Manually creating the installation configuration file {#installation-initializing-manual_installing-azure-private} Installing the cluster requires that you manually create the installation configuration file. **Prerequisites** - You have an SSH public key on your local machine for use with the installation program. You can use the key for SSH authentication onto your cluster nodes for debugging and disaster recovery. - You have obtained the OpenShift Container Platform installation program and the pull secret for your cluster. **Procedure** 1. Create an installation directory to store your required installation assets in: ```terminal $ mkdir ``` > [!IMPORTANT] > You must create a directory. Some installation assets, such as bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier OpenShift Container Platform version. 2. Customize the provided sample `install-config.yaml` file template and save the file in the ``. 1. Edit the `install-config.yaml` file to set the `publish: Internal` parameter. 2. If you use your own outbound routing to connect to the internet, set the `outboundType: UserDefinedRouting` parameter. > [!NOTE] > You must name this configuration file `install-config.yaml`. 3. Back up the `install-config.yaml` file so that you can use it to install many clusters. > [!IMPORTANT] > Back up the `install-config.yaml` file now, because the installation process consumes the file in the next step. **Additional resources** {._additional-resources} - [Installation configuration parameters for Azure](/openshift-docs-markdown/installing/installing_azure/installation-config-parameters-azure#installation-config-parameters-azure) ### Minimum resource requirements for cluster installation {#installation-minimum-resource-requirements_installing-azure-private} To ensure that your OpenShift Container Platform cluster runs as expected, each cluster machine must meet minimum CPU, memory, and storage requirements. **Minimum resource requirements**
Machine Operating system vCPU Virtual RAM Storage Input/Output Per Second (IOPS)
Bootstrap RHCOS 4 16 GB 100 GB 300
Control plane RHCOS 4 16 GB 100 GB 300
Compute RHCOS 2 8 GB 100 GB 300
- One vCPU is equal to one physical core when simultaneous multithreading (SMT), or Hyper-Threading, is not enabled. When enabled, use the following formula to calculate the corresponding ratio: (threads per core × cores) × sockets = vCPUs. - OpenShift Container Platform and Kubernetes are sensitive to disk performance, and Red Hat recommends faster storage, particularly for etcd on the control plane nodes which require a 10 ms p99 fsync duration. On many cloud platforms, storage size and IOPS scale together, so you might need to provision more storage to get enough performance. - As with all user-provisioned installations, if you choose to use RHEL compute machines in your cluster, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. OpenShift Container Platform 4.10 and later do not support RHEL 7 compute machines. > [!NOTE] > In OpenShift Container Platform version 4.22, RHCOS uses RHEL version 9.8, which updates the micro-architecture requirements. Each architecture requires the following minimum instruction set architectures (ISA): > > - x86-64 architecture requires x86-64-v2 ISA > - ARM64 architecture requires ARMv8.0-A ISA > - ppc64le architecture requires IBM(R) Power9 ISA > - s390x architecture requires IBM(R) z14 ISA > > For more information, see [Architectures](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/9.8_release_notes/index#architectures) in the RHEL documentation. > [!IMPORTANT] > You must use Azure virtual machines that have the `premiumIO` parameter set to `true`. If an instance type for your platform meets the minimum requirements for cluster machines, it is supported to use in OpenShift Container Platform. **Additional resources** {._additional-resources} - [Optimizing storage](/openshift-docs-markdown/scalability_and_performance/optimization/optimizing-storage#optimizing-storage) ### Tested instance types for Azure {#installation-azure-tested-machine-types_installing-azure-private} There are several Microsoft Azure instance types tested with OpenShift Container Platform. Choose a listed instance type when you install a cluster on 64-bit x86 infrastructure. See the following machine types based on 64-bit x86 architecture: ##### General Purpose {#general-purpose} | Azure VM Series | Family Name | | --- | --- | | Basv2-series | `standardBasv2Family` | | BS-series | `standardBSFamily` | | Bsv2-series | `standardBsv2Family` | | Dadsv5-series | `standardDADSv5Family` | | Dadsv6-series | `standardDadv6Family` | | Daldsv6-series | `standardDaldv6Family` | | Dalsv6-series | `standardDalv6Family` | | Dasv4-series | `standardDASv4Family` | | Dasv5-series | `standardDASv5Family` | | Dasv6-series | `standardDav6Family` | | DCas_cc_v5-series | `standardDCACCV5Family` | | DCads_cc_v5-series | `standardDCADCCV5Family` | | DCadsv5-series | `standardDCADSv5Family` | | DCasv5-series | `standardDCASv5Family` | | DCsv2-series | `standardDCSv2Family` | | DCsv3-series | `standardDCSv3Family` | | DCdsv3-series | `standardDDCSv3Family` | | DCedsv5-series | `standardDCEDV5Family` | | DCesv5-series | `standardDCEV5Family` | | Ddsv4-series | `standardDDSv4Family` | | Ddsv5-series | `standardDDSv5Family` | | Ddsv6-series | `StandardDdsv6Family` | | Dldsv5-series | `standardDLDSv5Family` | | Dldsv6-series | `StandardDldsv6Family` | | Dlsv5-series | `standardDLSv5Family` | | Dlsv6-series | `StandardDlsv6Family` | | DS-series | `standardDSFamily` | | Dsv2-series | `standardDSv2Family` | | Dsv3-series | `standardDSv3Family` | | Dsv4-series | `standardDSv4Family` | | Dsv5-series | `standardDSv5Family` | | Dsv6-series | `StandardDsv6Family` | ##### Memory Optimized {#memory-optimized} | Azure VM Series | Family Name | | --- | --- | | Eadsv5-series | `standardEADSv5Family`, `standardEIADSv5Family` | | Eadsv6-series | `standardEadv6Family` | | Easv4-series | `standardEASv4Family`, `standardEIASv4Family` | | Easv5-series | `standardEASv5Family`, `standardEIASv5Family` | | Easv6-series | `standardEav6Family` | | Ebdsv5-series | `standardEBDSv5Family`, `standardEIBDSv5Family` | | Ebsv5-series | `standardEBSv5Family`, `standardEIBSv5Family` | | ECas_cc_v5-series | `standardECACCV5Family` | | ECads_cc_v5-series | `standardECADCCV5Family` | | ECadsv5-series | `standardECADSv5Family` | | ECasv5-series | `standardECASv5Family` | | ECedsv5-series | `standardECEDV5Family` | | ECesv5-series | `standardECEV5Family` | | Edsv4-series | `standardEDSv4Family` | | Edsv5-series | `standardEDSv5Family`, `standardEIDSv5Family` | | Edsv6-series | `StandardEdsv6Family` | | Esv3-series | `standardESv3Family`, `standardEISv3Family` | | Esv4-series | `standardESv4Family`, `standardXEISv4Family` | | Esv5-series | `standardESv5Family`, `standardEISv5Family` | | Esv6-series | `StandardEsv6Family` | | M-series | `standardMSFamily` | | Mbdsv3-series | `StandardMBDSMediumMemoryv3Family` | | Mbsv3-series | `StandardMBSMediumMemoryv3Family` | | Mdsv3 High Memory-series | `standardMDSHighMemoryv3Family`, `standardMIDSHighMemoryv3Family` | | Mdsv2 Medium Memory-series | `standardMDSMediumMemoryv2Family`, `standardMIDSMediumMemoryv2Family` | | Mdsv3 Medium Memory-series | `standardMDSMediumMemoryv3Family` | | Msv3 High Memory-series | `standardMISHighMemoryv3Family`, `standardMSHighMemoryv3Family` | | Msv2 Medium Memory-series | `standardMISMediumMemoryv2Family`, `standardMSMediumMemoryv2Family` | | Msv3 Medium Memory-series | `standardMSMediumMemoryv3Family` | ##### Compute Optimized {#compute-optimized} | Azure VM Series | Family Name | | --- | --- | | Falsv6-series | `StandardFalsv6Family` | | Famsv6-series | `StandardFamsv6Family` | | Fasv6-series | `StandardFasv6Family` | | FS-series | `standardFSFamily` | | Fsv2-series | `standardFSv2Family` | | FXmdsv2-series | `StandardFXmdsv2Family` | | FX-series | `standardFXMDVSFamily` | | FXmsv2-series | `StandardFXmsv2Family` | ##### Storage Optimized {#storage-optimized} | Azure VM Series | Family Name | | --- | --- | | GS-series | `standardGSFamily` | | Laosv4-series | `standardLaosv4Family` | | Lasv3-series | `standardLASv3Family` | | Lasv4-series | `standardLasv4Family` | | Ls-series | `standardLSFamily` | | Lsv2-series | `standardLSv2Family` | | Lsv3-series | `standardLSv3Family` | | Lsv4-series | `standardLsv4Family` | ##### GPU Accelerated {#gpu-accelerated} | Azure VM Series | Family Name | | --- | --- | | NC_A100_v4-series | `StandardNCADSA100v4Family` | | NCads_H100_v5-series | `StandardNCadsH100v5Family` | | NCCads_H100_v5-series | `StandardNCCads2023Family` | | NCasT4_v3-series | `Standard NCASv3_T4 Family` | | NCv3-series | `standardNCSv3Family` | | NDasrA100_v4-series | `Standard NDASv4_A100 Family` | | ND-H200-v5-series | `standardNDISRH200V5Family` | | ND-H100-v5-series | `standardNDSH100v5Family` | | NDv2-series | `standardNDSv2Family` | | NGads_V620-series | `StandardNGADSV620v1Family` | | NVadsA10_v5-series | `StandardNVADSA10v5Family` | | NVads V710 v5-series | `StandardNVadsV710v5Family` | | NVv3-series | `standardNVSv3Family` | ##### FPGA Accelerated {#fpga-accelerated} | Azure VM Series | Family Name | | --- | --- | | NPS-series | `standardNPSFamily` | ##### High Performance Compute {#high-performance-compute} | Azure VM Series | Family Name | | --- | --- | | HBv2-series | `standardHBrsv2Family` | | HBv4-series | `standardHBv4Family` | | HBv5-series | `standardHBv5Family` | | HC-series | `standardHCSFamily` | | HX-series | `standardHXFamily` | ### Tested instance types for Azure on 64-bit ARM infrastructures {#installation-azure-arm-tested-machine-types_installing-azure-private} There are several Microsoft Azure ARM64 instance types tested with OpenShift Container Platform. Choose a listed instance type when you install a cluster on 64-bit ARM infrastructure. See the following machine types based on 64-bit ARM architecture: ##### General Purpose (ARM64) {#general-purpose-arm64} | Azure VM Series | Family Name | | --- | --- | | Bpsv2-series | `standardBpsv2Family` | | Dpdsv5-series | `standardDPDSv5Family` | | Dpldsv5-series | `standardDPLDSv5Family` | | Dplsv5-series | `standardDPLSv5Family` | | Dpsv5-series | `standardDPSv5Family` | | Dpdsv6-series | `StandardDpdsv6Family` | | Dpldsv6-series | `StandardDpldsv6Family` | | Dplsv6-series | `StandardDplsv6Family` | | Dpsv6-series | `StandardDpsv6Family` | ##### Memory Optimized (ARM64) {#memory-optimized-arm64} | Azure VM Series | Family Name | | --- | --- | | Epdsv5-series | `standardEPDSv5Family` | | Epsv5-series | `standardEPSv5Family` | | Epdsv6-series | `StandardEpdsv6Family` | | Epsv6-series | `StandardEpsv6Family` | ### Enabling trusted launch for Azure VMs {#installation-azure-trusted-launch_installing-azure-private} To enable trusted launch on Azure virtual machines for your OpenShift Container Platform cluster, you can configure secure boot and virtualized Trusted Platform Modules in the `install-config.yaml` file. Apply the settings to control plane nodes, compute nodes, or all nodes as needed. For more information about the sizes of virtual machines that support the trusted launch features, secure boot, and virtualized Trusted Platform Modules, see the Additional resources section. > [!IMPORTANT] > Trusted launch is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. > > For more information about the support scope of Red Hat Technology Preview features, see [Technology Preview Features Support Scope](https://access.redhat.com/support/offerings/techpreview/). **Prerequisites** - You have created an `install-config.yaml` file. **Procedure** - Edit the `install-config.yaml` file before deploying your cluster: - Enable trusted launch only on control plane by adding the following stanza: ```yaml controlPlane: platform: azure: settings: securityType: TrustedLaunch trustedLaunch: uefiSettings: secureBoot: Enabled virtualizedTrustedPlatformModule: Enabled ``` - Enable trusted launch only on compute node by adding the following stanza: ```yaml compute: platform: azure: settings: securityType: TrustedLaunch trustedLaunch: uefiSettings: secureBoot: Enabled virtualizedTrustedPlatformModule: Enabled ``` - Enable trusted launch on all nodes by adding the following stanza: ```yaml platform: azure: settings: securityType: TrustedLaunch trustedLaunch: uefiSettings: secureBoot: Enabled virtualizedTrustedPlatformModule: Enabled ``` ### Enabling confidential VMs {#installation-azure-confidential-vms_installing-azure-private} To enable confidential VMs on Azure for your OpenShift Container Platform cluster, you can configure the `install-config.yaml` file before deployment. Apply the settings to control plane nodes, compute nodes, or all nodes as needed. You can use confidential VMs with the following VM sizes: - DCasv5-series - DCadsv5-series - ECasv5-series - ECadsv5-series - DCesv5-series - DCedsv5-series - ECesv5-series - ECedsv5-series - NCCads_H100_v5 > [!IMPORTANT] > Confidential VMs are currently not supported on 64-bit ARM architectures. **Prerequisites** - You have created an `install-config.yaml` file. **Procedure** - Edit the `install-config.yaml` file before deploying your cluster: - Enable confidential VMs only on control plane by adding the following stanza: ```yaml controlPlane: platform: azure: settings: securityType: ConfidentialVM confidentialVM: uefiSettings: secureBoot: Enabled virtualizedTrustedPlatformModule: Enabled osDisk: securityProfile: securityEncryptionType: VMGuestStateOnly ``` - Enable confidential VMs only on compute nodes by adding the following stanza: ```yaml compute: platform: azure: settings: securityType: ConfidentialVM confidentialVM: uefiSettings: secureBoot: Enabled virtualizedTrustedPlatformModule: Enabled osDisk: securityProfile: securityEncryptionType: VMGuestStateOnly ``` - Enable confidential VMs on all nodes by adding the following stanza: ```yaml platform: azure: defaultMachinePlatform: settings: securityType: ConfidentialVM confidentialVM: uefiSettings: secureBoot: Enabled virtualizedTrustedPlatformModule: Enabled osDisk: securityProfile: securityEncryptionType: VMGuestStateOnly ``` ### Enabling a user-managed DNS {#installation-azure-enabling-user-managed-DNS_installing-azure-private} You can install a cluster with a domain name server (DNS) solution that you manage instead of the default cluster-provisioned DNS solution. As a result, you can manage the API and Ingress DNS records in your own system rather than adding the records to the DNS of the cloud. For example, your organization’s security policies might not allow the use of public DNS services such as Microsoft Azure. In such scenarios, you can use your own DNS service to bypass the public DNS service and manage your own DNS for the IP addresses of the API and Ingress services. If you enable user-managed DNS during installation, the installation program provisions DNS records for the API and Ingress services only within the cluster. To ensure access from outside the cluster, you must provision the DNS records in an external DNS service of your choice for the API and Ingress services after installation. **Prerequisites** - You installed the `jq` package. **Procedure** - Before you deploy your cluster, use a text editor to open the `install-config.yaml` file and add the following stanza: - To enable user-managed DNS: ```yaml # ... platform: azure: userProvisionedDNS: Enabled ``` where: `userProvisionedDNS` : Enables user-provisioned DNS management. **Next steps** For information about provisioning your DNS records for the API server and the Ingress services, see "Provisioning your own DNS records". ### Sample customized install-config.yaml file for Azure {#installation-azure-config-yaml-simple_installing-azure-private} You can customize the `install-config.yaml` file to specify more details about your OpenShift Container Platform cluster’s platform or modify the values of the required parameters. > [!IMPORTANT] > This sample YAML file is provided for reference only. You must obtain your `install-config.yaml` file by using the installation program and modify it. For a full list and description of all installation configuration parameters, see *Installation configuration parameters for Azure*. ```yaml {title="Sample install-config.yaml file for Azure"} apiVersion: v1 baseDomain: example.com pullSecret: '{"auths": ...}' sshKey: ssh-ed25519 AAAA... metadata: name: example-cluster controlPlane: hyperthreading: Enabled name: master platform: azure: type: Standard_D8s_v3 replicas: 3 compute: - hyperthreading: Enabled name: worker platform: azure: type: Standard_D2s_v3 replicas: 3 networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 platform: azure: baseDomainResourceGroupName: example-basedomain-resourcegroup-name region: centralus ``` where: `controlPlane` : Specifies parameters that apply to control plane machines. `compute` : Specifies parameters that apply to compute machines. `networking` : Specifies parameters that apply to the cluster networking configuration. If you do not provide networking values, the installation program provides default values. `platform` : Specifies parameters that apply to the infrastructure platform that hosts the cluster. **Additional resources** {._additional-resources} - [Installation configuration parameters for Azure](/openshift-docs-markdown/installing/installing_azure/installation-config-parameters-azure#installation-config-parameters-azure) ### Configuring the cluster-wide proxy during installation {#installation-configure-proxy_installing-azure-private} Production environments can deny direct access to the internet and instead have an HTTP or HTTPS proxy available. You can configure a new OpenShift Container Platform cluster to use a proxy by configuring the proxy settings in the `install-config.yaml` file. **Prerequisites** - You have an existing `install-config.yaml` file. - You have reviewed the sites that your cluster requires access to and determined whether any of them need to bypass the proxy. By default, the proxy handles all cluster egress traffic, including calls to hosting cloud provider APIs. You added sites to the `Proxy` object’s `spec.noProxy` field to bypass the proxy if necessary. > [!NOTE] > The `Proxy` object `status.noProxy` field includes the values of the `networking.machineNetwork[].cidr`, `networking.clusterNetwork[].cidr`, and `networking.serviceNetwork[]` fields from your installation configuration. > > For installations on Amazon Web Services (AWS), Google Cloud, Microsoft Azure, and Red Hat OpenStack Platform (RHOSP), the `Proxy` object `status.noProxy` field also includes the instance metadata endpoint (`169.254.169.254`). **Procedure** 1. Edit your `install-config.yaml` file and add the proxy settings. For example: ```yaml apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://:@: httpsProxy: https://:@: noProxy: example.com additionalTrustBundle: | -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- additionalTrustBundlePolicy: # ... ``` where: `proxy.httpProxy` : Specifies a proxy URL to use for creating HTTP connections outside the cluster. The URL scheme must be `http`. `proxy.httpsProxy` : Specifies a proxy URL to use for creating HTTPS connections outside the cluster. `proxy.noProxy` : Specifies a comma-separated list of destination domain names, IP addresses, or other network CIDRs to exclude from proxying. Preface a domain with `.` to match subdomains only. For example, `.y.com` matches `x.y.com`, but not `y.com`. Use `*` to bypass the proxy for all destinations. `additionalTrustBundle` : If you specify this value, the installation program generates a config map named `user-ca-bundle` in the `openshift-config` namespace to hold the additional CA certificates. If you specify `additionalTrustBundle` and at least one proxy setting, the `Proxy` object references the `user-ca-bundle` config map in the `trustedCA` field. The Cluster Network Operator then creates a `trusted-ca-bundle` config map that merges the contents specified for the `trustedCA` parameter with the RHCOS trust bundle. You must set the `additionalTrustBundle` field unless an authority from the RHCOS trust bundle signs the proxy’s identity certificate. `additionalTrustBundlePolicy` : Specifies the policy that determines the configuration of the `Proxy` object to reference the `user-ca-bundle` config map in the `trustedCA` field. The allowed values are `Proxyonly` and `Always`. Use `Proxyonly` to reference the `user-ca-bundle` config map only when you configure an `http/https` proxy. Use `Always` to always reference the `user-ca-bundle` config map. The default value is `Proxyonly`. Optional parameter. > [!NOTE] > The installation program does not support the proxy `readinessEndpoints` field. > [!NOTE] > If the installation program times out, restart and then complete the deployment by using the `wait-for` command of the installation program. For example: > > ```terminal > $ ./openshift-install wait-for install-complete --log-level debug > ``` 2. Save the file and reference it when installing OpenShift Container Platform. The installation program creates a cluster-wide proxy named `cluster` that uses the proxy settings in the `install-config.yaml` file. If you do not give proxy settings, the installation program still creates a `cluster` `Proxy` object, but it has a nil `spec`. > [!NOTE] > Only the `Proxy` object named `cluster` is supported, and you cannot create additional proxies. **Additional resources** {._additional-resources} - For more details about Accelerated Networking, see [Accelerated Networking for Microsoft Azure VMs](/openshift-docs-markdown/machine_management/creating_machinesets/creating-machineset-azure#machineset-azure-accelerated-networking_creating-machineset-azure). ## Alternatives to storing administrator-level secrets in the kube-system project {#installing-azure-manual-modes_installing-azure-private ._additional-resources} By default, administrator secrets are stored in the `kube-system` project. If you configured the `credentialsMode` parameter in the `install-config.yaml` file to `Manual`, you must use one of the following alternatives: - To manage long-term cloud credentials manually, follow the procedure in [Manually creating long-term credentials](/openshift-docs-markdown/installing/installing_azure/ipi/installing-azure-private#manually-create-iam_installing-azure-private). - To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in [Configuring an Azure cluster to use short-term credentials](/openshift-docs-markdown/installing/installing_azure/ipi/installing-azure-private#installing-azure-with-short-term-creds_installing-azure-private). ### Manually creating long-term credentials {#manually-create-iam_installing-azure-private} You can put the Cloud Credential Operator (CCO) into manual mode before OpenShift Container Platform installation if the cloud identity and access management (IAM) APIs are not reachable, or if you prefer not to store an administrator-level credential secret in the cluster `kube-system` namespace. **Procedure** 1. If you did not set the `credentialsMode` parameter in the `install-config.yaml` configuration file to `Manual`, modify the value as shown: ```yaml {title="Sample configuration file snippet"} apiVersion: v1 baseDomain: example.com credentialsMode: Manual # ... ``` 2. If you have not previously created installation manifest files, do so by running the following command: ```terminal $ openshift-install create manifests --dir ``` where `` is the directory in which the installation program creates files. 3. Set a `$RELEASE_IMAGE` variable with the release image from your installation file by running the following command: ```terminal $ RELEASE_IMAGE=$(./openshift-install version | awk '/release image/ {print $3}') ``` 4. Extract the list of `CredentialsRequest` custom resources (CRs) from the OpenShift Container Platform release image by running the following command: ```terminal $ oc adm release extract \ --from=$RELEASE_IMAGE \ --credentials-requests \ --included \ --install-config=/install-config.yaml \ --to= ``` where: `--included` : Specifies only the manifests that your specific cluster configuration requires. `` : Specifies the location of the `install-config.yaml` file. `` : Specifies the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it. This command creates a YAML file for each `CredentialsRequest` object. ```yaml {title="Sample CredentialsRequest object"} apiVersion: cloudcredential.openshift.io/v1 kind: CredentialsRequest metadata: name: namespace: openshift-cloud-credential-operator ... spec: providerSpec: apiVersion: cloudcredential.openshift.io/v1 kind: AzureProviderSpec roleBindings: - role: Contributor ... ``` 5. Create YAML files for secrets in the `openshift-install` manifests directory that you generated previously. The secrets must be stored using the namespace and secret name defined in the `spec.secretRef` for each `CredentialsRequest` object. ```yaml {title="Sample CredentialsRequest object with secrets"} apiVersion: cloudcredential.openshift.io/v1 kind: CredentialsRequest metadata: name: namespace: openshift-cloud-credential-operator ... spec: providerSpec: apiVersion: cloudcredential.openshift.io/v1 kind: AzureProviderSpec roleBindings: - role: Contributor ... secretRef: name: namespace: ... ``` ```yaml {title="Sample Secret object"} apiVersion: v1 kind: Secret metadata: name: namespace: data: azure_subscription_id: azure_client_id: azure_client_secret: azure_tenant_id: azure_resource_prefix: azure_resourcegroup: azure_region: ``` > [!IMPORTANT] > Before upgrading a cluster that uses manually maintained credentials, you must ensure that the CCO is in an upgradeable state. ### Configuring an Azure cluster to use short-term credentials {#installing-azure-with-short-term-creds_installing-azure-private} To install a cluster that uses Microsoft Entra Workload ID, you must configure the Cloud Credential Operator utility and create the required Azure resources for your cluster. #### Configuring the Cloud Credential Operator utility {#cco-ccoctl-configuring_installing-azure-private} To create and manage cloud credentials from outside of the cluster when the Cloud Credential Operator (CCO) is operating in manual mode, extract and prepare the CCO utility (`ccoctl`) binary. > [!NOTE] > The `ccoctl` utility is a Linux binary that must run in a Linux environment. **Prerequisites** - You have access to an OpenShift Container Platform account with cluster administrator access. - You have installed the OpenShift CLI (`oc`). - You have created a global Azure account for the `ccoctl` utility to use with the following permissions: - `Microsoft.Resources/subscriptions/resourceGroups/read` - `Microsoft.Resources/subscriptions/resourceGroups/write` - `Microsoft.Resources/subscriptions/resourceGroups/delete` - `Microsoft.Authorization/roleAssignments/read` - `Microsoft.Authorization/roleAssignments/delete` - `Microsoft.Authorization/roleAssignments/write` - `Microsoft.Authorization/roleDefinitions/read` - `Microsoft.Authorization/roleDefinitions/write` - `Microsoft.Authorization/roleDefinitions/delete` - `Microsoft.Storage/storageAccounts/listkeys/action` - `Microsoft.Storage/storageAccounts/delete` - `Microsoft.Storage/storageAccounts/read` - `Microsoft.Storage/storageAccounts/write` - `Microsoft.Storage/storageAccounts/blobServices/containers/delete` - `Microsoft.Storage/storageAccounts/blobServices/containers/read` - `Microsoft.Storage/storageAccounts/blobServices/containers/write` - `Microsoft.ManagedIdentity/userAssignedIdentities/delete` - `Microsoft.ManagedIdentity/userAssignedIdentities/read` - `Microsoft.ManagedIdentity/userAssignedIdentities/write` - `Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials/read` - `Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials/write` - `Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials/delete` - `Microsoft.Storage/register/action` - `Microsoft.ManagedIdentity/register/action` **Procedure** 1. Set a variable for the OpenShift Container Platform release image by running the following command: ```terminal $ RELEASE_IMAGE=$(./openshift-install version | awk '/release image/ {print $3}') ``` 2. Obtain the CCO container image from the OpenShift Container Platform release image by running the following command: ```terminal $ CCO_IMAGE=$(oc adm release info --image-for='cloud-credential-operator' $RELEASE_IMAGE -a ~/.pull-secret) ``` > [!NOTE] > Ensure that the architecture of the `$RELEASE_IMAGE` matches the architecture of the environment in which you will use the `ccoctl` tool. 3. Extract the `ccoctl` binary from the CCO container image within the OpenShift Container Platform release image by running the following command: ```terminal $ oc image extract $CCO_IMAGE \ --file="/usr/bin/ccoctl." \ -a ~/.pull-secret ``` For ``, specify the value that corresponds to the version of Red Hat Enterprise Linux (RHEL) that the host uses. If no value is specified, `ccoctl.rhel8` is used by default. The following values are valid: - `rhel8`: Specify this value for hosts that use RHEL 8. - `rhel9`: Specify this value for hosts that use RHEL 9. > [!NOTE] > The `ccoctl` binary is created in the directory from where you executed the command and not in `/usr/bin/`. You must rename the directory or move the `ccoctl.` binary to `ccoctl`. 4. Change the permissions to make `ccoctl` executable by running the following command: ```terminal $ chmod 775 ccoctl ``` **Verification** - To verify that `ccoctl` is ready to use, display the help file. Use a relative file name when you run the command, for example: ```terminal $ ./ccoctl ``` ```terminal {title="Example output"} OpenShift credentials provisioning tool Usage: ccoctl [command] Available Commands: aws Manage credentials objects for AWS cloud azure Manage credentials objects for Azure gcp Manage credentials objects for Google cloud help Help about any command ibmcloud Manage credentials objects for IBM Cloud nutanix Manage credentials objects for Nutanix Flags: -h, --help help for ccoctl Use "ccoctl [command] --help" for more information about a command. ``` = Creating Azure resources with the Cloud Credential Operator utility You can use the `ccoctl azure create-all` command to automate the creation of Azure resources. > [!NOTE] > By default, `ccoctl` creates objects in the directory in which the commands are run. To create the objects in a different directory, use the `--output-dir` flag. This procedure uses `` to refer to this directory. **Prerequisites** You must have: - Extracted and prepared the `ccoctl` binary. - Access to your Microsoft Azure account by using the Azure CLI. **Procedure** 1. Set a `$RELEASE_IMAGE` variable with the release image from your installation file by running the following command: ```terminal $ RELEASE_IMAGE=$(./openshift-install version | awk '/release image/ {print $3}') ``` 2. Extract the list of `CredentialsRequest` objects from the OpenShift Container Platform release image by running the following command: ```terminal $ oc adm release extract \ --from=$RELEASE_IMAGE \ --credentials-requests \ --included \ --install-config=/install-config.yaml \ --to= ``` where: `--included` : Specifies to include only the manifests that your specific cluster configuration requires. `` : Specifies the location of the `install-config.yaml` file. `` : Specifies the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it. > [!NOTE] > This command might take a few moments to run. 3. To enable the `ccoctl` utility to detect your Azure credentials automatically, log in to the Azure CLI by running the following command: ```terminal $ az login ``` 4. Use the `ccoctl` tool to process all `CredentialsRequest` objects by running the following command: ```terminal $ ccoctl azure create-all \ --name= \ --output-dir= \ --region= \ --subscription-id= \ --credentials-requests-dir= \ --dnszone-resource-group-name= \ --tenant-id= \ --network-resource-group-name \ --preserve-existing-roles ``` where: `` : Specifies the user-defined name for all created Azure resources used for tracking. `` : Specifies the directory in which you want the `ccoctl` utility to create objects. By default, the utility creates objects in the directory in which the commands are run. This parameter is optional. `` : Specifies the Azure region in which cloud resources will be created. `` : Specifies the Azure subscription ID to use. `` : Specifies the directory containing the files for the component `CredentialsRequest` objects. `` : Specifies the name of the resource group containing the cluster’s base domain Azure DNS zone. `` : Specifies the Azure tenant ID to use. `` : Specifies the virtual network resource group if it is different from the cluster resource group. This parameter is optional. `--preserve-existing-roles` : Specifies that any custom role assignments you define on managed identities are not removed during OpenShift Container Platform updates. This parameter is optional. > [!NOTE] > If your cluster uses Technology Preview features that are enabled by the `TechPreviewNoUpgrade` feature set, you must include the `--enable-tech-preview` parameter. > > To see additional optional parameters and explanations of how to use them, run the `azure create-all --help` command. **Verification** - To verify that the OpenShift Container Platform secrets are created, list the files in the `/manifests` directory: ```terminal $ ls /manifests ``` ```text {title="Example output"} azure-ad-pod-identity-webhook-config.yaml cluster-authentication-02-config.yaml openshift-cloud-controller-manager-azure-cloud-credentials-credentials.yaml openshift-cloud-network-config-controller-cloud-credentials-credentials.yaml openshift-cluster-api-capz-manager-bootstrap-credentials-credentials.yaml openshift-cluster-csi-drivers-azure-disk-credentials-credentials.yaml openshift-cluster-csi-drivers-azure-file-credentials-credentials.yaml openshift-image-registry-installer-cloud-credentials-credentials.yaml openshift-ingress-operator-cloud-credentials-credentials.yaml openshift-machine-api-azure-cloud-credentials-credentials.yaml ``` You can verify that the Microsoft Entra ID service accounts are created by querying Azure. For more information, refer to Azure documentation on listing Entra ID service accounts. #### Incorporating the Cloud Credential Operator utility manifests {#cco-ccoctl-install-creating-manifests_installing-azure-private} To implement short-term security credentials managed outside the cluster for individual OpenShift Container Platform components, you must move the manifest files that the Cloud Credential Operator utility (`ccoctl`) created to the correct directories for the installation program. **Prerequisites** - You have configured an account with the cloud platform that hosts your cluster. - You have configured the Cloud Credential Operator utility (`ccoctl`). - You have created the cloud provider resources that are required for your cluster with the `ccoctl` utility. **Procedure** 1. If you did not set the `credentialsMode` parameter in the `install-config.yaml` configuration file to `Manual`, modify the value as shown: ```yaml {title="Sample configuration file snippet"} apiVersion: v1 baseDomain: example.com credentialsMode: Manual # ... ``` 2. If you used the `ccoctl` utility to create a new Azure resource group instead of using an existing resource group, modify the `resourceGroupName` parameter in the `install-config.yaml` as shown: ```yaml {title="Sample configuration file snippet"} apiVersion: v1 baseDomain: example.com # ... platform: azure: resourceGroupName: # ... ``` The `` value must match the user-defined name for Azure resources that was specified with the `--name` argument of the `ccoctl azure create-all` command. 3. If you have not previously created installation manifest files, do so by running the following command: ```terminal $ openshift-install create manifests --dir ``` where `` is the directory in which the installation program creates files. 4. Copy the manifests that the `ccoctl` utility generated to the `manifests` directory that the installation program created by running the following command: ```terminal $ cp //manifests/* ./manifests/ ``` 5. Copy the `tls` directory that contains the private key to the installation directory: ```terminal $ cp -a //tls . ``` ## Optional: Preparing a private Microsoft Azure cluster for a private image registry {#installing-private-image-registry-private-azure} By installing a private image registry on a private Microsoft Azure cluster, you can create private storage endpoints. Private storage endpoints disable public facing endpoints to the registry’s storage account, adding an extra layer of security to your OpenShift Container Platform deployment. > [!IMPORTANT] > Do not install a private image registry on Microsoft Azure Red Hat OpenShift (ARO), because the endpoint can put your Microsoft Azure Red Hat OpenShift cluster in an unrecoverable state. Use the following guide to prepare your private Microsoft Azure cluster for installation with a private image registry. **Prerequisites** - You have access to an OpenShift Container Platform account with cluster administrator access. - You have installed the OpenShift CLI (oc). - You have prepared an `install-config.yaml` that includes the following information: - The `publish` field is set to `Internal` - You have set the permissions for creating a private storage endpoint. For more information, see "Azure permissions for installer-provisioned infrastructure". **Procedure** 1. If you have not previously created installation manifest files, do so by running the following command: ```terminal $ ./openshift-install create manifests --dir ``` This command displays the following messages: ```terminal {title="Example output"} INFO Consuming Install Config from target directory INFO Manifests created in: /manifests and /openshift ``` 2. Create an image registry configuration object and pass in the `networkResourceGroupName`, `subnetName`, and `vnetName` provided by Microsoft Azure. For example: ```terminal $ touch imageregistry-config.yaml ``` ```yaml apiVersion: imageregistry.operator.openshift.io/v1 kind: Config metadata: name: cluster spec: managementState: "Managed" replicas: 2 rolloutStrategy: RollingUpdate storage: azure: networkAccess: internal: networkResourceGroupName: (1) subnetName: (2) vnetName: (3) type: Internal ``` 1. Optional. If you have an existing VNet and subnet setup, replace `` with the resource group name that contains the existing virtual network (VNet). 2. Optional. If you have an existing VNet and subnet setup, replace `` with the name of the existing compute subnet within the specified resource group. 3. Optional. If you have an existing VNet and subnet setup, replace `` with the name of the existing virtual network (VNet) in the specified resource group. > [!NOTE] > The `imageregistry-config.yaml` file is consumed during the installation process. If desired, you must back it up before installation. 3. Move the `imageregistry-config.yaml` file to the `` folder by running the following command: ```terminal $ mv imageregistry-config.yaml ``` **Next steps** - After you have moved the `imageregistry-config.yaml` file to the `` folder and set the required permissions, proceed to "Deploying the cluster". **Additional resources** {._additional-resources} - For the list of permissions needed to create a private storage endpoint, see [Required Azure permissions for installer-provisioned infrastructure](/openshift-docs-markdown/installing/installing_azure/installing-azure-account#minimum-required-permissions-ipi-azure_installing-azure-account). ## Deploying the cluster {#installation-launching-installer_installing-azure-private} To deploy your OpenShift Container Platform cluster, you initialize installation by running the `openshift-install create cluster` command from the directory that contains the installation program. The installation program provisions the required infrastructure and completes the cluster setup. > [!IMPORTANT] > You can run the `create cluster` command of the installation program only once, during initial installation. **Prerequisites** - You have configured an account with the cloud platform that hosts your cluster. - You have the OpenShift Container Platform installation program and the pull secret for your cluster. - You have an Azure subscription ID and tenant ID. - If you are installing the cluster using a service principal, you have its application ID and password. - If you are installing the cluster using a system-assigned managed identity, you have enabled it on the virtual machine that you will run the installation program from. - If you are installing the cluster using a user-assigned managed identity, you have met these prerequisites: - You have its client ID. - You have assigned it to the virtual machine that you will run the installation program from. **Procedure** ``` . Optional: If you have run the installation program on this computer before, and want to use an alternative service principal or managed identity, go to the `~/.azure/` directory and delete the `osServicePrincipal.json` configuration file. ``` Deleting this file prevents the installation program from automatically reusing subscription and authentication values from a previous installation. 1. In the directory that contains the installation program, initialize the cluster deployment by running the following command: ```terminal $ ./openshift-install create cluster --dir \ --log-level=info ``` where: - ``: Specifies the location of your customized `./install-config.yaml` file. - `--log-level`: Specifies the log level. To view different installation details, specify `warn`, `debug`, or `error` instead of `info`. If the installation program cannot locate the `osServicePrincipal.json` configuration file from a previous installation, you are prompted for Azure subscription and authentication values. . Enter the following Azure parameter values for your subscription: \*\*\* *azure subscription id*\*: Enter the subscription ID to use for the cluster. \*\*\* *azure tenant id*\*: Enter the tenant ID. . Depending on the Azure identity you are using to deploy the cluster, do one of the following when prompted for the **azure service principal client id**: \*\* If you are using a service principal, enter its application ID. \*\* If you are using a system-assigned managed identity, leave this value blank. \*\* If you are using a user-assigned managed identity, specify its client ID. . Depending on the Azure identity you are using to deploy the cluster, do one of the following when prompted for the **azure service principal client secret**: \*\* If you are using a service principal, enter its password. \*\* If you are using a system-assigned managed identity, leave this value blank. \*\* If you are using a user-assigned managed identity,leave this value blank. > [!NOTE] > If previously not detected, the installation program creates an `osServicePrincipal.json` configuration file and stores this file in the `~/.azure/` directory on your computer. This ensures that the installation program can load the profile when it is creating an OpenShift Container Platform cluster on the target platform. **Verification** When the cluster deployment completes successfully: - The terminal displays directions for accessing your cluster, including a link to the web console and credentials for the `kubeadmin` user. - Credential information also outputs to `/.openshift_install.log`. > [!IMPORTANT] > Do not delete the installation program or the files that the installation program creates. Both are required to delete the cluster. The following example shows the expected output: ```terminal ... INFO Install complete! INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig' INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com INFO Login to the console with user: "kubeadmin", and password: "password" INFO Time elapsed: 36m22s ``` > [!IMPORTANT] > - The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending `node-bootstrapper` certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for *Recovering from expired control plane certificates* for more information. > - It is recommended that you use Ignition config files within 12 hours after they are generated because the 24-hour certificate rotates from 16 to 22 hours after the cluster is installed. By using the Ignition config files within 12 hours, you can avoid installation failure if the certificate update runs during installation. ## Provisioning your own DNS records {#installation-azure-provisioning-own-dns-records_installing-azure-private} Use the IP address of the API server to provision your own DNS record with the `api...` hostname by using your cluster name and base cluster domain. Use the IP address of the Ingress service to provision your own DNS record with the `*.apps...` hostname by using your cluster name and base cluster domain. **Prerequisite** - You have installed the Azure CLI client `(az)`. **Procedure** 1. Add the `userProvisionedDNS` parameter to the `install-config.yaml` file and enable the parameter. For more information, see "Enabling a user-managed DNS". 2. Install your cluster. 3. If you are installing a private cluster, set the `lb_name` variable by running the following command: ```terminal $ lb_name="${infra_id}-internal" ``` 1. Set the `frontendipconfig_id` variable by running the following command: ```terminal $ frontendipconfig_id=$(az network lb show -n ${lb_name} -g ${cluster_resource_group_name} -ojson | jq -r ".loadBalancingRules[] | select(.frontendPort == 6443) | .frontendIPConfiguration.id") ``` 2. Set the `frontendipconfig_name` variable by running the following command: ```terminal $ frontendipconfig_name=${frontendipconfig_id##*/} ``` 3. To retrieve the IP address of the API service, run the following command: ```terminal $ az network lb frontend-ip show -n ${frontendipconfig_name} --lb-name ${lb_name} -g ${cluster_resource_group_name} --query "privateIPAddress" -otsv ``` 4. If you are installing a public cluster, set the `lb_name` variable by running the following command: ```terminal $ lb_name="${infra_id}" ``` 1. Set the `frontendipconfig_id` variable by running the following command: ```terminal $ frontendipconfig_id=$(az network lb show -n ${lb_name} -g ${cluster_resource_group_name} -ojson | jq -r ".loadBalancingRules[] | select(.frontendPort == 6443) | .frontendIPConfiguration.id") ``` 2. Set the `frontendipconfig_name` variable by running the following command: ```terminal $ frontendipconfig_name=${frontendipconfig_id##*/} ``` 3. Set the `frontendpublicip_id` variable by running the following command: ```terminal $ frontendpublicip_id=$(az network lb frontend-ip show -n ${frontendipconfig_name} --lb-name ${lb_name} -g ${cluster_resource_group_name} --query "publicIPAddress.id" -otsv) ``` 4. To retrieve the IP address of the API service, run the following command: ```terminal $ az network public-ip show --ids ${frontendpublicip_id} --query 'ipAddress' -otsv ``` 5. Use the IP address and your cluster name and base cluster domain to configure your own DNS record with the `api...` hostname. 6. If you are installing a private cluster, set the `lb_name` variable by running the following command: ```terminal $ lb_name="${infra_id}-internal" ``` 1. Set the `frontendipconfig_id` variable by running the following command: ```terminal $ frontendipconfig_id=$(az network lb show -n ${lb_name} -g ${cluster_resource_group_name} -ojson | jq -r ".loadBalancingRules[] | select(.frontendPort == 443) | .frontendIPConfiguration.id") ``` 2. Set the `frontendipconfig_name` variable by running the following command: ```terminal $ frontendipconfig_name=${frontendipconfig_id##*/} ``` 3. To retrieve the IP address of the Ingress service, run the following command: ```terminal $ az network lb frontend-ip show -n ${frontendipconfig_name} --lb-name ${lb_name} -g ${cluster_resource_group_name} --query "privateIPAddress" -otsv ``` 7. If you are installing a public cluster, set the `lb_name` variable by running the following command: ```terminal $ lb_name="${infra_id}" ``` 1. Set the `frontendipconfig_id` variable by running the following command: ```terminal $ frontendipconfig_id=$(az network lb show -n ${lb_name} -g ${cluster_resource_group_name} -ojson | jq -r ".loadBalancingRules[] | select(.frontendPort == 443) | .frontendIPConfiguration.id") ``` 2. Set the `frontendipconfig_name` variable by running the following command: ```terminal $ frontendipconfig_name=${frontendipconfig_id##*/} ``` 3. Set the `frontendpublicip_id` variable by running the following command: ```terminal $ frontendpublicip_id=$(az network lb frontend-ip show -n ${frontendipconfig_name} --lb-name ${lb_name} -g ${cluster_resource_group_name} --query "publicIPAddress.id" -otsv) ``` 4. To retrieve the IP address of the Ingress service, run the following command: ```terminal $ az network public-ip show --ids ${frontendpublicip_id} --query 'ipAddress' -otsv ``` 8. Use the IP address and your cluster name and base cluster domain to configure your own DNS record with the `*.apps...` hostname. ## Logging in to the cluster by using the CLI {#cli-logging-in-kubeadmin_installing-azure-private} To log in to your cluster as the default system user, export the `kubeconfig` file. This configuration enables the CLI to authenticate and connect to the specific API server created during OpenShift Container Platform installation. The `kubeconfig` file is specific to a cluster and OpenShift Container Platform generates it during installation. **Prerequisites** - You deployed an OpenShift Container Platform cluster. - You installed the OpenShift CLI (`oc`). **Procedure** 1. Export the `kubeadmin` credentials by running the following command: ```terminal $ export KUBECONFIG=/auth/kubeconfig ``` where: `` : Specifies the path to the directory that stores the installation files. 2. Verify you can run `oc` commands successfully using the exported configuration by running the following command: ```terminal $ oc whoami ``` ```terminal {title="Example output"} system:admin ``` **Next steps** - "Customize your cluster" - "Remote health reporting" **Additional resources** {._additional-resources} - [Accessing the web console](/openshift-docs-markdown/web_console/web-console#web-console) **Next steps** {._additional-resources} - [Customize your cluster](/openshift-docs-markdown/post_installation_configuration/cluster-tasks#available_cluster_customizations). - If necessary, you can [Remote health reporting](/openshift-docs-markdown/support/remote_health_monitoring/remote-health-reporting#remote-health-reporting).