Installing a cluster on AWS with network customizations

    You must set most of the network configuration parameters during installation, and you can modify only kubeProxy configuration parameters in a running cluster.

    Generating a key pair for cluster node SSH access

    During an OKD installation, you can provide an SSH public key to the installation program. The key is passed to the Fedora CoreOS (FCOS) nodes through their Ignition config files and is used to authenticate SSH access to the nodes. The key is added to the ~/.ssh/authorized_keys list for the core user on each node, which enables password-less authentication.

    After the key is passed to the nodes, you can use the key pair to SSH in to the FCOS nodes as the user core. To access the nodes through SSH, the private key identity must be managed by SSH for your local user.

    If you want to SSH in to your cluster nodes to perform installation debugging or disaster recovery, you must provide the SSH public key during the installation process. The ./openshift-install gather command also requires the SSH public key to be in place on the cluster nodes.

    Do not skip this procedure in production environments, where disaster recovery and debugging is required.

    You must use a local key, not one that you configured with platform-specific approaches such as AWS key pairs.

    On clusters running Fedora CoreOS (FCOS), the SSH keys specified in the Ignition config files are written to the /home/core/.ssh/authorized_keys.d/core file. However, the Machine Config Operator manages SSH keys in the /home/core/.ssh/authorized_keys file and configures sshd to ignore the /home/core/.ssh/authorized_keys.d/core file. As a result, newly provisioned OKD nodes are not accessible using SSH until the Machine Config Operator reconciles the machine configs with the authorized_keys file. After you can access the nodes using SSH, you can delete the /home/core/.ssh/authorized_keys.d/core file.

    Procedure

    1. If you do not have an existing SSH key pair on your local machine to use for authentication onto your cluster nodes, create one. For example, on a computer that uses a Linux operating system, run the following command:

      1Specify the path and file name, such as ~/.ssh/id_rsa, of the new SSH key. If you have an existing key pair, ensure your public key is in the your ~/.ssh directory.

      If you plan to install an OKD cluster that uses FIPS Validated / Modules in Process cryptographic libraries on the x86_64 architecture, do not create a key that uses the ed25519 algorithm. Instead, create a key that uses the rsa or ecdsa algorithm.

    2. View the public SSH key:

      1. $ cat <path>/<file_name>.pub

      For example, run the following to view the ~/.ssh/id_rsa.pub public key:

      1. $ cat ~/.ssh/id_rsa.pub
    3. Add the SSH private key identity to the SSH agent for your local user, if it has not already been added. SSH agent management of the key is required for password-less SSH authentication onto your cluster nodes, or if you want to use the ./openshift-install gather command.

      On some distributions, default SSH private key identities such as ~/.ssh/id_rsa and ~/.ssh/id_dsa are managed automatically.

      1. If the ssh-agent process is not already running for your local user, start it as a background task:

        1. $ eval "$(ssh-agent -s)"

        Example output

        1. Agent pid 31874

        If your cluster is in FIPS mode, only use FIPS-compliant algorithms to generate the SSH key. The key must be either RSA or ECDSA.

    4. Add your SSH private key to the ssh-agent:

      1. $ ssh-add <path>/<file_name> (1)
      1Specify the path and file name for your SSH private key, such as ~/.ssh/id_rsa

      Example output

      1. Identity added: /home/<you>/<path>/<file_name> (<computer_name>)

    Next steps

    • When you install OKD, provide the SSH public key to the installation program.

    Obtaining the installation program

    Before you install OKD, download the installation file on a local computer.

    Prerequisites

    • You have a computer that runs Linux or macOS, with 500 MB of local disk space

    Procedure

    1. Download installer from https://github.com/openshift/okd/releases

      The installation program creates several files on the computer that you use to install your cluster. You must keep the installation program and the files that the installation program creates after you finish installing the cluster. Both files are required to delete the cluster.

      Deleting the files created by the installation program does not remove your cluster, even if the cluster failed during installation. To remove your cluster, complete the OKD uninstallation procedures for your specific cloud provider.

    2. Extract the installation program. For example, on a computer that uses a Linux operating system, run the following command:

      1. $ tar xvf openshift-install-linux.tar.gz
    3. From the page on the Red Hat OpenShift Cluster Manager site, download your installation pull secret. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for OKD components.

      Using a pull secret from the Red Hat OpenShift Cluster Manager site is not required. You can use a pull secret for another private registry. Or, if you do not need the cluster to pull images from a private registry, you can use {"auths":{"fake":{"auth":"aWQ6cGFzcwo="}}} as the pull secret when prompted during the installation.

      If you do not use the pull secret from the Red Hat OpenShift Cluster Manager site:

      • Red Hat Operators are not available.

      • The Telemetry and Insights operators do not send data to Red Hat.

      • Content from the Red Hat Container Catalog registry, such as image streams and Operators, are not available.

    Network configuration phases

    There are two phases prior to OKD installation where you can customize the network configuration.

    Phase 1

    You can customize the following network-related fields in the install-config.yaml file before you create the manifest files:

    • networking.networkType

    • networking.clusterNetwork

    • networking.serviceNetwork

    • networking.machineNetwork

      For more information on these fields, refer to Installation configuration parameters.

      Set the networking.machineNetwork to match the CIDR that the preferred NIC resides in.

    Phase 2

    After creating the manifest files by running openshift-install create manifests, you can define a customized Cluster Network Operator manifest with only the fields you want to modify. You can use the manifest to specify advanced network configuration.

    You cannot override the values specified in phase 1 in the install-config.yaml file during phase 2. However, you can further customize the cluster network provider during phase 2.

    You can customize the OKD cluster you install on Amazon Web Services (AWS).

    Prerequisites

    • Obtain the OKD installation program and the pull secret for your cluster.

    • Obtain service principal permissions at the subscription level.

    Procedure

    1. Create the install-config.yaml file.

      1. Change to the directory that contains the installation program and run the following command:

        1. $ ./openshift-install create install-config --dir=<installation_directory> (1)
        1For <installation_directory>, specify the directory name to store the files that the installation program creates.

        Specify an empty directory. Some installation assets, like 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 OKD version.

      2. At the prompts, provide the configuration details for your cloud:

        1. Optional: Select an SSH key to use to access your cluster machines.

          For production OKD clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your ssh-agent process uses.

        2. Select AWS as the platform to target.

        3. If you do not have an Amazon Web Services (AWS) profile stored on your computer, enter the AWS access key ID and secret access key for the user that you configured to run the installation program.

        4. Select the AWS region to deploy the cluster to.

        5. Select the base domain for the Route 53 service that you configured for your cluster.

        6. Enter a descriptive name for your cluster.

        7. Paste the pull secret that you obtained from the Pull Secret page on the Red Hat OpenShift Cluster Manager site. This field is optional.

    1. Modify the install-config.yaml file. You can find more information about the available parameters in the “Installation configuration parameters” section.

    2. Back up the install-config.yaml file so that you can use it to install multiple clusters.

      The install-config.yaml file is consumed during the installation process. If you want to reuse the file, you must back it up now.

    Before you deploy an OKD cluster, you provide parameter values to describe your account on the cloud platform that hosts your cluster and optionally customize your cluster’s platform. When you create the install-config.yaml installation configuration file, you provide values for the required parameters through the command line. If you customize your cluster, you can modify the install-config.yaml file to provide more details about the platform.

    After installation, you cannot modify these parameters in the install-config.yaml file.

    The openshift-install command does not validate field names for parameters. If an incorrect name is specified, the related file or object is not created, and no error is reported. Ensure that the field names for any parameters that are specified are correct.

    Required configuration parameters

    Required installation configuration parameters are described in the following table:

    Table 1. Required parameters
    ParameterDescriptionValues

    apiVersion

    The API version for the install-config.yaml content. The current version is v1. The installer may also support older API versions.

    String

    baseDomain

    The base domain of your cloud provider. The base domain is used to create routes to your OKD cluster components. The full DNS name for your cluster is a combination of the baseDomain and metadata.name parameter values that uses the <metadata.name>.<baseDomain> format.

    A fully-qualified domain or subdomain name, such as example.com.

    metadata

    Kubernetes resource ObjectMeta, from which only the name parameter is consumed.

    Object

    metadata.name

    The name of the cluster. DNS records for the cluster are all subdomains of {{.metadata.name}}.{{.baseDomain}}.

    String of lowercase letters, hyphens (-), and periods (.), such as dev.

    platform

    The configuration for the specific platform upon which to perform the installation: aws, baremetal, azure, openstack, ovirt, vsphere, or {}. For additional information about platform.<platform> parameters, consult the table for your specific platform that follows.

    Object

    Network configuration parameters

    You can customize your installation configuration based on the requirements of your existing network infrastructure. For example, you can expand the IP address block for the cluster network or provide different IP address blocks than the defaults.

    Only IPv4 addresses are supported.

    Table 2. Network parameters
    ParameterDescriptionValues

    networking

    The configuration for the cluster network.

    Object

    You cannot modify parameters specified by the networking object after installation.

    networking.networkType

    The cluster network provider Container Network Interface (CNI) plug-in to install.

    Either OpenShiftSDN or OVNKubernetes. The default value is OVNKubernetes.

    networking.clusterNetwork

    The IP address blocks for pods.

    The default value is 10.128.0.0/14 with a host prefix of /23.

    If you specify multiple IP address blocks, the blocks must not overlap.

    An array of objects. For example:

    1. networking:
    2. clusterNetwork:
    3. - cidr: 10.128.0.0/14
    4. hostPrefix: 23

    networking.clusterNetwork.cidr

    Required if you use networking.clusterNetwork. An IP address block.

    An IPv4 network.

    An IP address block in Classless Inter-Domain Routing (CIDR) notation. The prefix length for an IPv4 block is between 0 and 32.

    networking.clusterNetwork.hostPrefix

    The subnet prefix length to assign to each individual node. For example, if hostPrefix is set to 23 then each node is assigned a /23 subnet out of the given cidr. A hostPrefix value of 23 provides 510 (2^(32 - 23) - 2) pod IP addresses.

    A subnet prefix.

    The default value is 23.

    networking.serviceNetwork

    The IP address block for services. The default value is 172.30.0.0/16.

    The OpenShift SDN and OVN-Kubernetes network providers support only a single IP address block for the service network.

    An array with an IP address block in CIDR format. For example:

    1. networking:
    2. serviceNetwork:
    3. - 172.30.0.0/16

    networking.machineNetwork

    The IP address blocks for machines.

    If you specify multiple IP address blocks, the blocks must not overlap.

    An array of objects. For example:

    1. networking:
    2. machineNetwork:
    3. - cidr: 10.0.0.0/16

    networking.machineNetwork.cidr

    Required if you use networking.machineNetwork. An IP address block. The default value is 10.0.0.0/16 for all platforms other than libvirt. For libvirt, the default value is 192.168.126.0/24.

    An IP network block in CIDR notation.

    For example, 10.0.0.0/16.

    Optional configuration parameters

    Optional installation configuration parameters are described in the following table:

    Table 3. Optional parameters
    ParameterDescriptionValues

    additionalTrustBundle

    A PEM-encoded X.509 certificate bundle that is added to the nodes’ trusted certificate store. This trust bundle may also be used when a proxy has been configured.

    String

    compute

    The configuration for the machines that comprise the compute nodes.

    Array of MachinePool objects. For details, see the following “Machine-pool” table.

    compute.architecture

    Determines the instruction set architecture of the machines in the pool. Currently, heteregeneous clusters are not supported, so all pools must specify the same architecture. Valid values are amd64 (the default).

    String

    compute.hyperthreading

    Whether to enable or disable simultaneous multithreading, or hyperthreading, on compute machines. By default, simultaneous multithreading is enabled to increase the performance of your machines’ cores.

    If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance.

    Enabled or Disabled

    compute.name

    Required if you use compute. The name of the machine pool.

    worker

    compute.platform

    Required if you use compute. Use this parameter to specify the cloud provider to host the worker machines. This parameter value must match the controlPlane.platform parameter value.

    aws, azure, gcp, openstack, ovirt, vsphere, or {}

    compute.replicas

    The number of compute machines, which are also known as worker machines, to provision.

    A positive integer greater than or equal to 2. The default value is 3.

    controlPlane

    The configuration for the machines that comprise the control plane.

    Array of MachinePool objects. For details, see the following “Machine-pool” table.

    controlPlane.architecture

    Determines the instruction set architecture of the machines in the pool. Currently, heterogeneous clusters are not supported, so all pools must specify the same architecture. Valid values are amd64 (the default).

    String

    controlPlane.hyperthreading

    Whether to enable or disable simultaneous multithreading, or hyperthreading, on control plane machines. By default, simultaneous multithreading is enabled to increase the performance of your machines’ cores.

    If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance.

    Enabled or Disabled

    controlPlane.name

    Required if you use controlPlane. The name of the machine pool.

    master

    controlPlane.platform

    Required if you use controlPlane. Use this parameter to specify the cloud provider that hosts the control plane machines. This parameter value must match the compute.platform parameter value.

    aws, azure, gcp, openstack, ovirt, vsphere, or {}

    controlPlane.replicas

    The number of control plane machines to provision.

    The only supported value is 3, which is the default value.

    credentialsMode

    The Cloud Credential Operator (CCO) mode. If no mode is specified, the CCO dynamically tries to determine the capabilities of the provided credentials, with a preference for mint mode on the platforms where multiple modes are supported.

    Not all CCO modes are supported for all cloud providers. For more information on CCO modes, see the Cloud Credential Operator entry in the Red Hat Operators reference content.

    Mint, Passthrough, Manual, or an empty string (“”).

    imageContentSources

    Sources and repositories for the release-image content.

    Array of objects. Includes a source and, optionally, mirrors, as described in the following rows of this table.

    imageContentSources.source

    Required if you use imageContentSources. Specify the repository that users refer to, for example, in image pull specifications.

    String

    imageContentSources.mirrors

    Specify one or more repositories that may also contain the same images.

    Array of strings

    publish

    How to publish or expose the user-facing endpoints of your cluster, such as the Kubernetes API, OpenShift routes.

    Internal or External. To deploy a private cluster, which cannot be accessed from the internet, set publish to Internal. The default value is External.

    sshKey

    The SSH key or keys to authenticate access your cluster machines.

    For production OKD clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your ssh-agent process uses.

    One or more keys. For example:

    1. sshKey:
    2. <key1>
    3. <key2>
    4. <key3>

    Optional AWS configuration parameters

    Optional AWS configuration parameters are described in the following table:

    Table 4. Optional AWS parameters
    ParameterDescriptionValues

    compute.platform.aws.amiID

    The AWS AMI used to boot compute machines for the cluster. This is required for regions that require a custom FCOS AMI.

    Any published or custom FCOS AMI that belongs to the set AWS region.

    compute.platform.aws.iamRole

    A pre-existing AWS IAM role applied to the compute machine pool instance profiles. You can use these fields to match naming schemes and include predefined permissions boundaries for your IAM roles. If undefined, the installation program creates a new IAM role.

    The name of a valid AWS IAM role.

    compute.platform.aws.rootVolume.iops

    The Input/Output Operations Per Second (IOPS) that is reserved for the root volume.

    Integer, for example 4000.

    compute.platform.aws.rootVolume.size

    The size in GiB of the root volume.

    Integer, for example 500.

    compute.platform.aws.rootVolume.type

    The type of the root volume.

    Valid , such as io1.

    compute.platform.aws.type

    The EC2 instance type for the compute machines.

    Valid AWS instance type, such as m4.2xlarge. See the Instance types for machines table that follows.

    compute.platform.aws.zones

    The availability zones where the installation program creates machines for the compute machine pool. If you provide your own VPC, you must provide a subnet in that availability zone.

    A list of valid AWS availability zones, such as us-east-1c, in a YAML sequence.

    compute.aws.region

    The AWS region that the installation program creates compute resources in.

    Any valid , such as us-east-1.

    controlPlane.platform.aws.amiID

    The AWS AMI used to boot control plane machines for the cluster. This is required for regions that require a custom FCOS AMI.

    Any published or custom FCOS AMI that belongs to the set AWS region.

    controlPlane.platform.aws.iamRole

    A pre-existing AWS IAM role applied to the control plane machine pool instance profiles. You can use these fields to match naming schemes and include predefined permissions boundaries for your IAM roles. If undefined, the installation program creates a new IAM role.

    The name of a valid AWS IAM role.

    The EC2 instance type for the control plane machines.

    Valid AWS instance type, such as m5.xlarge. See the Instance types for machines table that follows.

    controlPlane.platform.aws.zones

    The availability zones where the installation program creates machines for the control plane machine pool.

    A list of valid AWS availability zones, such as us-east-1c, in a YAML sequence.

    controlPlane.aws.region

    The AWS region that the installation program creates control plane resources in.

    Valid , such as us-east-1.

    platform.aws.amiID

    The AWS AMI used to boot all machines for the cluster. If set, the AMI must belong to the same region as the cluster. This is required for regions that require a custom FCOS AMI.

    Any published or custom FCOS AMI that belongs to the set AWS region.

    platform.aws.hostedZone

    An existing Route 53 private hosted zone for the cluster. You can only use a pre-existing hosted zone when also supplying your own VPC. The hosted zone must already be associated with the user-provided VPC before installation. Also, the domain of the hosted zone must be the cluster domain or a parent of the cluster domain. If undefined, the installation program creates a new hosted zone.

    String, for example Z3URY6TWQ91KVV.

    platform.aws.serviceEndpoints.name

    The AWS service endpoint name. Custom endpoints are only required for cases where alternative AWS endpoints, like FIPS, must be used. Custom API endpoints can be specified for EC2, S3, IAM, Elastic Load Balancing, Tagging, Route 53, and STS AWS services.

    platform.aws.serviceEndpoints.url

    The AWS service endpoint URL. The URL must use the https protocol and the host must trust the certificate.

    Valid URL.

    platform.aws.userTags

    A map of keys and values that the installation program adds as tags to all resources that it creates.

    Any valid YAML map, such as key value pairs in the <key>: <value> format. For more information about AWS tags, see Tagging Your Amazon EC2 Resources in the AWS documentation.

    platform.aws.subnets

    If you provide the VPC instead of allowing the installation program to create the VPC for you, specify the subnet for the cluster to use. The subnet must be part of the same machineNetwork[].cidr ranges that you specify. For a standard cluster, specify a public and a private subnet for each availability zone. For a private cluster, specify a private subnet for each availability zone.

    Valid subnet IDs.

    Supported AWS machine types

    The following Amazon Web Services (AWS) instance types are supported with OKD.

    Instance types for machines

    Instance typeBootstrapControl planeCompute

    i3.large

    x

    m4.large

    x

    m4.xlarge

    x

    x

    m4.2xlarge

    x

    x

    m4.4xlarge

    x

    x

    m4.10xlarge

    x

    x

    m4.16xlarge

    x

    x

    m5.large

    x

    x

    x

    m5.2xlarge

    x

    x

    m5.4xlarge

    x

    x

    m5.8xlarge

    x

    x

    m5.12xlarge

    x

    x

    m5.16xlarge

    x

    x

    m5a.large

    x

    m5a.xlarge

    x

    x

    m5a.2xlarge

    x

    x

    m5a.4xlarge

    x

    x

    m5a.8xlarge

    x

    x

    m5a.10xlarge

    x

    x

    m5a.16xlarge

    x

    x

    c4.large

    x

    c4.xlarge

    x

    c4.2xlarge

    x

    x

    c4.4xlarge

    x

    x

    c4.8xlarge

    x

    x

    c5.large

    x

    c5.xlarge

    x

    c5.2xlarge

    x

    x

    c5.4xlarge

    x

    x

    c5.9xlarge

    x

    x

    c5.12xlarge

    x

    x

    c5.18xlarge

    x

    x

    c5.24xlarge

    x

    x

    c5a.large

    x

    c5a.xlarge

    x

    c5a.2xlarge

    x

    x

    c5a.4xlarge

    x

    x

    c5a.8xlarge

    x

    x

    c5a.12xlarge

    x

    x

    c5a.16xlarge

    x

    x

    c5a.24xlarge

    x

    x

    r4.large

    x

    r4.xlarge

    x

    x

    r4.2xlarge

    x

    x

    r4.4xlarge

    x

    x

    r4.8xlarge

    x

    x

    r4.16xlarge

    x

    x

    r5.large

    x

    r5.xlarge

    x

    x

    r5.2xlarge

    x

    x

    r5.4xlarge

    x

    x

    r5.8xlarge

    x

    x

    r5.12xlarge

    x

    x

    r5.16xlarge

    x

    x

    r5.24xlarge

    x

    x

    r5a.large

    x

    r5a.xlarge

    x

    x

    r5a.2xlarge

    x

    x

    r5a.4xlarge

    x

    x

    r5a.8xlarge

    x

    x

    r5a.12xlarge

    x

    x

    r5a.16xlarge

    x

    x

    r5a.24xlarge

    x

    x

    t3.large

    x

    t3.xlarge

    x

    t3.2xlarge

    x

    t3a.large

    x

    t3a.xlarge

    x

    t3a.2xlarge

    You can customize the install-config.yaml file to specify more details about your OKD cluster’s platform or modify the values of the required parameters.

    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.

    1. apiVersion: v1
    2. baseDomain: example.com (1)
    3. credentialsMode: Mint (2)
    4. controlPlane: (3) (4)
    5. hyperthreading: Enabled (5)
    6. name: master
    7. platform:
    8. aws:
    9. zones:
    10. - us-west-2a
    11. rootVolume:
    12. iops: 4000
    13. size: 500
    14. type: io1 (6)
    15. type: m5.xlarge
    16. replicas: 3
    17. compute: (3)
    18. - hyperthreading: Enabled (5)
    19. name: worker
    20. platform:
    21. aws:
    22. rootVolume:
    23. iops: 2000
    24. size: 500
    25. type: io1 (6)
    26. type: c5.4xlarge
    27. zones:
    28. - us-west-2c
    29. replicas: 3
    30. metadata:
    31. name: test-cluster (1)
    32. networking: (3)
    33. clusterNetwork:
    34. - cidr: 10.128.0.0/14
    35. hostPrefix: 23
    36. machineNetwork:
    37. - cidr: 10.0.0.0/16
    38. networkType: OVNKubernetes
    39. serviceNetwork:
    40. - 172.30.0.0/16
    41. platform:
    42. aws:
    43. region: us-west-2 (1)
    44. userTags:
    45. adminContact: jdoe
    46. costCenter: 7536
    47. amiID: ami-96c6f8f7 (7)
    48. serviceEndpoints: (8)
    49. - name: ec2
    50. url: https://vpce-id.ec2.us-west-2.vpce.amazonaws.com
    51. sshKey: ssh-ed25519 AAAA... (9)
    52. pullSecret: '{"auths": ...}' (1)
    1Required. The installation program prompts you for this value.
    2Optional: Add this parameter to force the Cloud Credential Operator (CCO) to use the specified mode, instead of having the CCO dynamically try to determine the capabilities of the credentials. For details about CCO modes, see the Cloud Credential Operator entry in the Red Hat Operators reference content.
    3If you do not provide these parameters and values, the installation program provides the default value.
    4The 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. Although both sections currently define a single machine pool, it is possible that future versions of OKD will support defining multiple compute pools during installation. Only one control plane pool is used.
    5Whether 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.

    If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance. Use larger instance types, such as m4.2xlarge or m5.2xlarge, for your machines if you disable simultaneous multithreading.

    6To configure faster storage for etcd, especially for larger clusters, set the storage type as io1 and set iops to 2000.
    7The ID of the AMI used to boot machines for the cluster. If set, the AMI must belong to the same region as the cluster.
    8The AWS service endpoints. Custom endpoints are required when installing to an unknown AWS region. The endpoint URL must use the https protocol and the host must trust the certificate.
    9You can optionally provide the sshKey value that you use to access the machines in your cluster.

    For production OKD clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your ssh-agent process uses.

    Configuring the cluster-wide proxy during installation

    Production environments can deny direct access to the internet and instead have an HTTP or HTTPS proxy available. You can configure a new OKD 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 reviewed the sites that your cluster requires access to and determined whether any of them need to bypass the proxy. By default, all cluster egress traffic is proxied, including calls to hosting cloud provider APIs. You added sites to the Proxy object’s spec.noProxy field to bypass the proxy if necessary.

      The Proxy object status.noProxy field is populated with 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 Platform (GCP), Microsoft Azure, and Red Hat OpenStack Platform (RHOSP), the Proxy object status.noProxy field is also populated with the instance metadata endpoint (169.254.169.254).

    • If your cluster is on AWS, you added the ec2.<region>.amazonaws.com, elasticloadbalancing.<region>.amazonaws.com, and s3.<region>.amazonaws.com endpoints to your VPC endpoint. These endpoints are required to complete requests from the nodes to the AWS EC2 API. Because the proxy works on the container level, not the node level, you must route these requests to the AWS EC2 API through the AWS private network. Adding the public IP address of the EC2 API to your allowlist in your proxy server is not sufficient.

    Procedure

    1. Edit your install-config.yaml file and add the proxy settings. For example:

      1. apiVersion: v1
      2. baseDomain: my.domain.com
      3. proxy:
      4. httpProxy: http://<username>:<pswd>@<ip>:<port> (1)
      5. httpsProxy: https://<username>:<pswd>@<ip>:<port> (2)
      6. noProxy: example.com (3)
      7. additionalTrustBundle: | (4)
      8. -----BEGIN CERTIFICATE-----
      9. <MY_TRUSTED_CA_CERT>
      10. -----END CERTIFICATE-----
      11. ...
      1A proxy URL to use for creating HTTP connections outside the cluster. The URL scheme must be http. If you use an MITM transparent proxy network that does not require additional proxy configuration but requires additional CAs, you must not specify an httpProxy value.
      2A proxy URL to use for creating HTTPS connections outside the cluster. If you use an MITM transparent proxy network that does not require additional proxy configuration but requires additional CAs, you must not specify an httpsProxy value.
      3A 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.
      4If provided, the installation program generates a config map that is named user-ca-bundle in the openshift-config namespace that contains one or more additional CA certificates that are required for proxying HTTPS connections. The Cluster Network Operator then creates a trusted-ca-bundle config map that merges these contents with the Fedora CoreOS (FCOS) trust bundle, and this config map is referenced in the trustedCA field of the Proxy object. The additionalTrustBundle field is required unless the proxy’s identity certificate is signed by an authority from the FCOS trust bundle. If you use an MITM transparent proxy network that does not require additional proxy configuration but requires additional CAs, you must provide the MITM CA certificate.

      The installation program does not support the proxy readinessEndpoints field.

    2. Save the file and reference it when installing OKD.

    The installation program creates a cluster-wide proxy that is named cluster that uses the proxy settings in the provided install-config.yaml file. If no proxy settings are provided, a cluster Proxy object is still created, but it will have a nil spec.

    Only the Proxy object named cluster is supported, and no additional proxies can be created.

    Cluster Network Operator configuration

    The configuration for the cluster network is specified as part of the Cluster Network Operator (CNO) configuration and stored in a custom resource (CR) object that is named cluster. The CR specifies the fields for the Network API in the operator.openshift.io API group.

    The CNO configuration inherits the following fields during cluster installation from the Network API in the Network.config.openshift.io API group and these fields cannot be changed:

    clusterNetwork

    IP address pools from which pod IP addresses are allocated.

    serviceNetwork

    IP address pool for services.

    defaultNetwork.type

    Cluster network provider, such as OpenShift SDN or OVN-Kubernetes.

    You can specify the cluster network provider configuration for your cluster by setting the fields for the defaultNetwork object in the CNO object named cluster.

    The fields for the Cluster Network Operator (CNO) are described in the following table:

    Table 5. Cluster Network Operator configuration object
    FieldTypeDescription

    metadata.name

    string

    The name of the CNO object. This name is always cluster.

    spec.clusterNetwork

    array

    A list specifying the blocks of IP addresses from which pod IP addresses are allocated and the subnet prefix length assigned to each individual node in the cluster. For example:

    You can customize this field only in the install-config.yaml file before you create the manifests. The value is read-only in the manifest file.

    spec.serviceNetwork

    array

    A block of IP addresses for services. The OpenShift SDN and OVN-Kubernetes Container Network Interface (CNI) network providers support only a single IP address block for the service network. For example:

    1. spec:
    2. serviceNetwork:
    3. - 172.30.0.0/14

    You can customize this field only in the install-config.yaml file before you create the manifests. The value is read-only in the manifest file.

    spec.defaultNetwork

    object

    Configures the Container Network Interface (CNI) cluster network provider for the cluster network.

    spec.kubeProxyConfig

    object

    The fields for this object specify the kube-proxy configuration. If you are using the OVN-Kubernetes cluster network provider, the kube-proxy configuration has no effect.

    defaultNetwork object configuration

    The values for the defaultNetwork object are defined in the following table:

    Table 6. defaultNetwork object
    FieldTypeDescription

    type

    string

    Either OpenShiftSDN or OVNKubernetes. The cluster network provider is selected during installation. This value cannot be changed after cluster installation.

    OKD uses the OVN-Kubernetes Container Network Interface (CNI) cluster network provider by default.

    openshiftSDNConfig

    object

    This object is only valid for the OpenShift SDN cluster network provider.

    ovnKubernetesConfig

    object

    This object is only valid for the OVN-Kubernetes cluster network provider.

    Configuration for the OpenShift SDN CNI cluster network provider

    The following table describes the configuration fields for the OpenShift SDN Container Network Interface (CNI) cluster network provider.

    Table 7. openshiftSDNConfig object
    FieldTypeDescription

    mode

    string

    Configures the network isolation mode for OpenShift SDN. The default value is NetworkPolicy.

    The values Multitenant and Subnet are available for backwards compatibility with OKD 3.x but are not recommended. This value cannot be changed after cluster installation.

    mtu

    integer

    The maximum transmission unit (MTU) for the VXLAN overlay network. This is detected automatically based on the MTU of the primary network interface. You do not normally need to override the detected MTU.

    If the auto-detected value is not what you expect it to be, confirm that the MTU on the primary network interface on your nodes is correct. You cannot use this option to change the MTU value of the primary network interface on the nodes.

    If your cluster requires different MTU values for different nodes, you must set this value to 50 less than the lowest MTU value in your cluster. For example, if some nodes in your cluster have an MTU of 9001, and some have an MTU of 1500, you must set this value to .

    This value cannot be changed after cluster installation.

    vxlanPort

    integer

    The port to use for all VXLAN packets. The default value is 4789. This value cannot be changed after cluster installation.

    If you are running in a virtualized environment with existing nodes that are part of another VXLAN network, then you might be required to change this. For example, when running an OpenShift SDN overlay on top of VMware NSX-T, you must select an alternate port for the VXLAN, because both SDNs use the same default VXLAN port number.

    On Amazon Web Services (AWS), you can select an alternate port for the VXLAN between port 9000 and port 9999.

    Example OpenShift SDN configuration

    1. defaultNetwork:
    2. type: OpenShiftSDN
    3. openshiftSDNConfig:
    4. mode: NetworkPolicy
    5. mtu: 1450
    6. vxlanPort: 4789
    Configuration for the OVN-Kubernetes CNI cluster network provider

    The following table describes the configuration fields for the OVN-Kubernetes CNI cluster network provider.

    Table 8. ovnKubernetesConfig object
    FieldTypeDescription

    mtu

    integer

    The maximum transmission unit (MTU) for the Geneve (Generic Network Virtualization Encapsulation) overlay network. This is detected automatically based on the MTU of the primary network interface. You do not normally need to override the detected MTU.

    If the auto-detected value is not what you expect it to be, confirm that the MTU on the primary network interface on your nodes is correct. You cannot use this option to change the MTU value of the primary network interface on the nodes.

    If your cluster requires different MTU values for different nodes, you must set this value to 100 less than the lowest MTU value in your cluster. For example, if some nodes in your cluster have an MTU of 9001, and some have an MTU of 1500, you must set this value to 1400.

    This value cannot be changed after cluster installation.

    genevePort

    integer

    The port to use for all Geneve packets. The default value is 6081. This value cannot be changed after cluster installation.

    ipsecConfig

    object

    Specify an empty object to enable IPsec encryption. This value cannot be changed after cluster installation.

    policyAuditConfig

    object

    Specify a configuration object for customizing network policy audit logging. If unset, the defaults audit log settings are used.

    Example OVN-Kubernetes configuration

    1. defaultNetwork:
    2. type: OVNKubernetes
    3. ovnKubernetesConfig:
    4. mtu: 1400
    5. genevePort: 6081
    6. ipsecConfig: {}

    kubeProxyConfig object configuration

    The values for the kubeProxyConfig object are defined in the following table:

    Table 10. kubeProxyConfig object
    FieldTypeDescription

    iptablesSyncPeriod

    string

    The refresh period for iptables rules. The default value is 30s. Valid suffixes include s, m, and h and are described in the Go time package documentation.

    Because of performance improvements introduced in OKD 4.3 and greater, adjusting the iptablesSyncPeriod parameter is no longer necessary.

    proxyArguments.iptables-min-sync-period

    array

    The minimum duration before refreshing iptables rules. This field ensures that the refresh does not happen too frequently. Valid suffixes include s, m, and h and are described in the . The default value is:

    1. kubeProxyConfig:
    2. proxyArguments:
    3. iptables-min-sync-period:
    4. - 0s

    Specifying advanced network configuration

    You can use advanced network configuration for your cluster network provider to integrate your cluster into your existing network environment. You can specify advanced network configuration only before you install the cluster.

    Customizing your network configuration by modifying the OKD manifest files created by the installation program is not supported. Applying a manifest file that you create, as in the following procedure, is supported.

    Prerequisites

    • You have created the install-config.yaml file and completed any modifications to it.

    Procedure

    1. Change to the directory that contains the installation program and create the manifests:

      1. $ ./openshift-install create manifests --dir=<installation_directory> (1)
      1<installation_directory> specifies the name of the directory that contains the install-config.yaml file for your cluster.
    2. Create a stub manifest file for the advanced network configuration that is named cluster-network-03-config.yml in the <installation_directory>/manifests/ directory:

      1. apiVersion: operator.openshift.io/v1
      2. kind: Network
      3. metadata:
      4. name: cluster
      5. spec:
    3. Specify the advanced network configuration for your cluster in the cluster-network-03-config.yml file, such as in the following examples:

      Specify a different VXLAN port for the OpenShift SDN network provider

      1. apiVersion: operator.openshift.io/v1
      2. kind: Network
      3. metadata:
      4. name: cluster
      5. spec:
      6. defaultNetwork:
      7. openshiftSDNConfig:
      8. vxlanPort: 4800

      Enable IPsec for the OVN-Kubernetes network provider

      1. apiVersion: operator.openshift.io/v1
      2. kind: Network
      3. metadata:
      4. spec:
      5. defaultNetwork:
      6. ovnKubernetesConfig:
      7. ipsecConfig: {}
    4. Optional: Back up the manifests/cluster-network-03-config.yml file. The installation program consumes the manifests/ directory when you create the Ignition config files.

    For more information on using a Network Load Balancer (NLB) on AWS, see .

    Configuring an Ingress Controller Network Load Balancer on a new AWS cluster

    You can create an Ingress Controller backed by an AWS Network Load Balancer (NLB) on a new cluster.

    Prerequisites

    • Create the install-config.yaml file and complete any modifications to it.

    Procedure

    Create an Ingress Controller backed by an AWS NLB on a new cluster.

    1. Change to the directory that contains the installation program and create the manifests:

      1. $ ./openshift-install create manifests --dir=<installation_directory> (1)
      1For <installation_directory>, specify the name of the directory that contains the install-config.yaml file for your cluster.
    2. Create a file that is named cluster-ingress-default-ingresscontroller.yaml in the <installation_directory>/manifests/ directory:

      1. $ touch <installation_directory>/manifests/cluster-ingress-default-ingresscontroller.yaml (1)
      1For <installation_directory>, specify the directory name that contains the manifests/ directory for your cluster.

      After creating the file, several network configuration files are in the manifests/ directory, as shown:

      1. $ ls <installation_directory>/manifests/cluster-ingress-default-ingresscontroller.yaml

      Example output

      1. cluster-ingress-default-ingresscontroller.yaml
    3. Open the cluster-ingress-default-ingresscontroller.yaml file in an editor and enter a custom resource (CR) that describes the Operator configuration you want:

      1. apiVersion: operator.openshift.io/v1
      2. kind: IngressController
      3. metadata:
      4. creationTimestamp: null
      5. name: default
      6. namespace: openshift-ingress-operator
      7. spec:
      8. endpointPublishingStrategy:
      9. loadBalancer:
      10. scope: External
      11. providerParameters:
      12. type: AWS
      13. aws:
      14. type: NLB
      15. type: LoadBalancerService
    4. Save the cluster-ingress-default-ingresscontroller.yaml file and quit the text editor.

    5. Optional: Back up the manifests/cluster-ingress-default-ingresscontroller.yaml file. The installation program deletes the manifests/ directory when creating the cluster.

    You can configure your cluster to use hybrid networking with OVN-Kubernetes. This allows a hybrid cluster that supports different node networking configurations. For example, this is necessary to run both Linux and Windows nodes in a cluster.

    You must configure hybrid networking with OVN-Kubernetes during the installation of your cluster. You cannot switch to hybrid networking after the installation process.

    Prerequisites

    • You defined OVNKubernetes for the networking.networkType parameter in the install-config.yaml file. See the installation documentation for configuring OKD network customizations on your chosen cloud provider for more information.

    Procedure

    1. Change to the directory that contains the installation program and create the manifests:

      1. $ ./openshift-install create manifests --dir=<installation_directory>

      where:

      <installation_directory>

      Specifies the name of the directory that contains the install-config.yaml file for your cluster.

    2. Create a stub manifest file for the advanced network configuration that is named cluster-network-03-config.yml in the <installation_directory>/manifests/ directory:

      where:

      <installation_directory>

      Specifies the directory name that contains the manifests/ directory for your cluster.

    3. Open the cluster-network-03-config.yml file in an editor and configure OVN-Kubernetes with hybrid networking, such as in the following example:

      Specify a hybrid networking configuration

      1. apiVersion: operator.openshift.io/v1
      2. kind: Network
      3. metadata:
      4. name: cluster
      5. spec:
      6. defaultNetwork:
      7. ovnKubernetesConfig:
      8. hybridOverlayConfig:
      9. hybridClusterNetwork: (1)
      10. - cidr: 10.132.0.0/14
      11. hostPrefix: 23
      12. hybridOverlayVXLANPort: 9898 (2)
      1Specify the CIDR configuration used for nodes on the additional overlay network. The hybridClusterNetwork CIDR cannot overlap with the clusterNetwork CIDR.
      2Specify a custom VXLAN port for the additional overlay network. This is required for running Windows nodes in a cluster installed on vSphere, and must not be configured for any other cloud provider. The custom port can be any open port excluding the default 4789 port. For more information on this requirement, see the Microsoft documentation on .

      Windows Server Long-Term Servicing Channel (LTSC): Windows Server 2019 is not supported on clusters with a custom hybridOverlayVXLANPort value because this Windows server version does not support selecting a custom VXLAN port.

    4. Save the cluster-network-03-config.yml file and quit the text editor.

    5. Optional: Back up the manifests/cluster-network-03-config.yml file. The installation program deletes the manifests/ directory when creating the cluster.

    For more information on using Linux and Windows nodes in the same cluster, see Understanding Windows container workloads.

    Deploying the cluster

    You can install OKD on a compatible cloud platform.

    You can run the create cluster command of the installation program only once, during initial installation.

    Prerequisites

    • Configure an account with the cloud platform that hosts your cluster.

    • Obtain the OKD installation program and the pull secret for your cluster.

    Procedure

    1. Change to the directory that contains the installation program and initialize the cluster deployment:

      1. $ ./openshift-install create cluster --dir=<installation_directory> \ (1)
      2. --log-level=info (2)
      1For <installation_directory>, specify the location of your customized ./install-config.yaml file.
      2To view different installation details, specify warn, debug, or error instead of info.

      If the cloud provider account that you configured on your host does not have sufficient permissions to deploy the cluster, the installation process stops, and the missing permissions are displayed.

      When the cluster deployment completes, directions for accessing your cluster, including a link to its web console and credentials for the kubeadmin user, display in your terminal.

      Example output

      1. ...
      2. INFO Install complete!
      3. INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig'
      4. INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com
      5. INFO Login to the console with user: "kubeadmin", and password: "4vYBz-Ee6gm-ymBZj-Wt5AL"
      6. INFO Time elapsed: 36m22s

      The cluster access and credential information also outputs to <installation_directory>/.openshift_install.log when an installation succeeds.

      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.

      You must not delete the installation program or the files that the installation program creates. Both are required to delete the cluster.

    2. Optional: Remove or disable the AdministratorAccess policy from the IAM account that you used to install the cluster.

      The elevated permissions provided by the AdministratorAccess policy are required only during installation.

    Installing the OpenShift CLI by downloading the binary

    You can install the OpenShift CLI (oc) to interact with OKD from a command-line interface. You can install oc on Linux, Windows, or macOS.

    If you installed an earlier version of oc, you cannot use it to complete all of the commands in OKD 4.8. Download and install the new version of oc.

    Installing the OpenShift CLI on Linux

    You can install the OpenShift CLI (oc) binary on Linux by using the following procedure.

    Procedure

    1. Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.

    2. Download oc.tar.gz.

    3. Unpack the archive:

      1. $ tar xvzf <file>
    4. Place the oc binary in a directory that is on your PATH.

      To check your PATH, execute the following command:

      1. $ echo $PATH

    After you install the OpenShift CLI, it is available using the oc command:

    1. $ oc <command>

    You can install the OpenShift CLI (oc) binary on Windows by using the following procedure.

    Procedure

    1. Navigate to and choose the folder for your operating system and architecture.

    2. Download oc.zip.

    3. Unzip the archive with a ZIP program.

    4. Move the oc binary to a directory that is on your PATH.

      To check your PATH, open the command prompt and execute the following command:

      1. C:\> path

    After you install the OpenShift CLI, it is available using the oc command:

    1. C:\> oc <command>

    Installing the OpenShift CLI on macOS

    You can install the OpenShift CLI (oc) binary on macOS by using the following procedure.

    Procedure

    1. Navigate to and choose the folder for your operating system and architecture.

    2. Download oc.tar.gz.

    3. Unpack and unzip the archive.

    4. Move the oc binary to a directory on your PATH.

      To check your PATH, open a terminal and execute the following command:

      1. $ echo $PATH

    After you install the OpenShift CLI, it is available using the oc command:

    1. $ oc <command>

    Logging in to the cluster by using the CLI

    You can log in to your cluster as a default system user by exporting the cluster kubeconfig file. The kubeconfig file contains information about the cluster that is used by the CLI to connect a client to the correct cluster and API server. The file is specific to a cluster and is created during OKD installation.

    Prerequisites

    • You deployed an OKD cluster.

    • You installed the oc CLI.

    Procedure

    1. Export the kubeadmin credentials:

      1. $ export KUBECONFIG=<installation_directory>/auth/kubeconfig (1)
      1For <installation_directory>, specify the path to the directory that you stored the installation files in.
    2. Verify you can run oc commands successfully using the exported configuration:

      1. $ oc whoami

      Example output

      1. system:admin

    The kubeadmin user exists by default after an OKD installation. You can log into your cluster as the kubeadmin user by using the OKD web console.

    Prerequisites

    • You have access to the installation host.

    • You completed a cluster installation and all cluster Operators are available.

    Procedure

    1. Obtain the password for the kubeadmin user from the kubeadmin-password file on the installation host:

      1. $ cat <installation_directory>/auth/kubeadmin-password
    2. List the OKD web console route:

      Alternatively, you can obtain the OKD route from the <installation_directory>/.openshift_install.log log file on the installation host.

      Example output

      1. console console-openshift-console.apps.<cluster_name>.<base_domain> console https reencrypt/Redirect None
    3. Navigate to the route detailed in the output of the preceding command in a web browser and log in as the kubeadmin user.

    Additional resources

    • See for more details about accessing and understanding the OKD web console.

    Additional resources

    Next steps