Chapter 3. Installing an OpenShift Container Platform cluster with the Agent-based Installer

Procedure

1. Log in to the OpenShift Container Platform web console using your login credentials.

2. Navigate to Datacenter.

   

   View larger image

   
3. Click Run Agent-based Installer locally. You are directed to the Install OpenShift Container Platform on Bare Metal locally with Agent page.

4. Optional: Alternatively, you can also click Bare Metal (x86_64) on the Select an OpenShift Container Platform cluster type to create page. You are directed to the Create an OpenShift Container Platform Cluster: Bare Metal page. Then, select Local Agent-based to go to the Install OpenShift Container Platform on Bare Metal locally with Agent page.

   

   View larger image

   
5. Select the operating system and architecture.
6. Click Download Installer to download and extract the install program.
7. You can either download or copy the pull secret by clicking on Download pull secret or Copy pull secret.
8. Click Download command-line tools and place the openshift-install binary in a directory that is on your PATH.

9. Install nmstate dependency by running the following command:

   $ sudo dnf install /usr/bin/nmstatectl -y

   Copy to Clipboard Toggle word wrap
10. Place the openshift-install binary in a directory that is on your PATH.

11. Create a directory to store the install configuration by running the following command:

    $ mkdir ~/<directory_name>

    Copy to Clipboard Toggle word wrap
    Note

    This is the preferred method for the Agent-based installation. Using ZTP manifests is optional.

12. Create the install-config.yaml file:

    $ cat << EOF > ./my-cluster/install-config.yaml
    apiVersion: v1
    baseDomain: test.example.com
    compute:
    - architecture: amd64
      hyperthreading: Enabled
      name: worker
      replicas: 0
    controlPlane:
      architecture: amd64
      hyperthreading: Enabled
      name: master
      replicas: 1
    metadata:
      name: sno-cluster 

    1

    
    networking:
      clusterNetwork:
      - cidr: 10.128.0.0/14
        hostPrefix: 23
      machineNetwork:
      - cidr: 192.168.111.0/16
      networkType: OVNKubernetes 

    2

    
      serviceNetwork:
      - 172.30.0.0/16
    platform:
      none: {}
    pullSecret: '<pull_secret>' 

    3

    
    sshKey: |
      <ssh_pub_key> 

    4

    
      EOF

    Copy to Clipboard Toggle word wrap

    1

    Required.

    2

    The cluster network plugin to install. The supported values are OVNKubernetes and OpenShiftSDN. The default value is OVNKubernetes.

    3

    Enter your pull secret.

    4

    Enter your ssh public key.

    Note

    If you set the platform to vSphere, none, or baremetal, you can configure IP address endpoints for cluster nodes in three ways:

    • IPv4
    • IPv6
    • IPv4 and IPv6 in parallel (dual-stack)

    Example of dual-stack networking

    networking:
      clusterNetwork:
        - cidr: 172.21.0.0/16
          hostPrefix: 23
        - cidr: fd02::/48
          hostPrefix: 64
      machineNetwork:
        - cidr: 192.168.11.0/16
        - cidr: 2001:DB8::/32
      serviceNetwork:
        - 172.22.0.0/16
        - fd03::/112
      networkType: OVNKubernetes
    platform:
      baremetal:
        apiVIPs:
        - 192.168.11.3
        - 2001:DB8::4
        ingressVIPs:
        - 192.168.11.4
        - 2001:DB8::5

    Copy to Clipboard Toggle word wrap

13. Create the agent-config.yaml file:

    $ cat > agent-config.yaml << EOF
    apiVersion: v1alpha1
    kind: AgentConfig
    metadata:
      name: sno-cluster
    rendezvousIP: 192.168.111.80 

    1

    
    hosts: 

    2

    
      - hostname: master-0 

    3

    
        interfaces:
          - name: eno1
            macAddress: 00:ef:44:21:e6:a5
        rootDeviceHints: 

    4

    
          deviceName: /dev/sdb
        networkConfig: 

    5

    
          interfaces:
            - name: eno1
              type: ethernet
              state: up
              mac-address: 00:ef:44:21:e6:a5
              ipv4:
                enabled: true
                address:
                  - ip: 192.168.111.80
                    prefix-length: 23
                dhcp: false
          dns-resolver:
            config:
              server:
                - 192.168.111.1
          routes:
            config:
              - destination: 0.0.0.0/0
                next-hop-address: 192.168.111.2
                next-hop-interface: eno1
                table-id: 254
      EOF

    Copy to Clipboard Toggle word wrap

    1

    This IP address is used to determine which node performs the bootstrapping process as well as running the assisted-service component. You must provide the rendezvous IP address when you do not specify at least one host’s IP address in the networkConfig parameter. If this address is not provided, one IP address is selected from the provided hosts' networkConfig.

    2

    Host configuration is optional. The number of hosts defined must not exceed the total number of hosts defined in the install-config.yaml file, which is the sum of the values of the compute.replicas and controlPlane.replicas parameters.

    3

    The optional hostname parameter overrides the hostname obtained from either the Dynamic Host Configuration Protocol (DHCP) or a reverse DNS lookup. Each host must have a unique hostname supplied by one of these methods.

    4

    The rootDeviceHints parameter enables provisioning of the Red Hat Enterprise Linux CoreOS (RHCOS) image to a particular device. It examines the devices in the order it discovers them, and compares the discovered values with the hint values. It uses the first discovered device that matches the hint value.

    5

    Set this optional parameter to configure the network interface of a host in NMState format.

14. Create the agent image by running the following command:

    $ openshift-install --dir <install_directory> agent create image

    Copy to Clipboard Toggle word wrap
    Note

    Red Hat Enterprise Linux CoreOS (RHCOS) supports multipathing on the primary disk, allowing stronger resilience to hardware failure to achieve higher host availability. Multipathing is enabled by default in the agent ISO image, with a default /etc/multipath.conf configuration.

15. Boot the agent.x86_64.iso image on the bare metal machines.

16. Optional: To know when the bootstrap host (which is the rendezvous host) reboots, run the following command:

    $ ./openshift-install --dir <install_directory> agent wait-for bootstrap-complete \ 

    1

    
        --log-level=info 

    2

    Copy to Clipboard Toggle word wrap

    1

    For <install_directory>, specify the path to the directory where the agent ISO was generated.

    2

    To view different installation details, specify warn, debug, or error instead of info.

    Example output

    ...................................................................
    ...................................................................
    INFO Bootstrap configMap status is complete
    INFO cluster bootstrap is complete

    Copy to Clipboard Toggle word wrap

    The command succeeds when the Kubernetes API server signals that it has been bootstrapped on the control plane machines.

17. To track the progress and verify sucessful installation, run the following command:

    $ openshift-install --dir <install_directory> agent wait-for install-complete 

    1

    Copy to Clipboard Toggle word wrap

    1

    For <install_directory> directory, specify the path to the directory where the agent ISO was generated.

    Example output

    ...................................................................
    ...................................................................
    INFO Cluster is installed
    INFO Install complete!
    INFO To access the cluster as the system:admin user when using 'oc', run
    INFO     export KUBECONFIG=/home/core/installer/auth/kubeconfig
    INFO Access the OpenShift web-console here: https://console-openshift-console.apps.sno-cluster.test.example.com

    Copy to Clipboard Toggle word wrap

Procedure

1. Run the following command and collect the output:

   $ ./openshift-install --dir <install_directory> agent wait-for bootstrap-complete --log-level=debug

   Copy to Clipboard Toggle word wrap

   Example error message

   ...
   ERROR Bootstrap failed to complete: : bootstrap process timed out: context deadline exceeded

   Copy to Clipboard Toggle word wrap

2. If the output from the previous command indicates a failure, or if the bootstrap is not progressing, run the following command on node 0 and collect the output:

   $ ssh core@<node-ip> sudo /usr/local/bin/agent-gather -O > <local_tmp_path>/agent-gather.tar.xz

   Copy to Clipboard Toggle word wrap
   Note

   You only need to gather data from node 0, but gathering this data from every node can be helpful.

3. If the bootstrap completes and the cluster nodes reboot, run the following command and collect the output:

   $ ./openshift-install --dir <install_directory> agent wait-for install-complete --log-level=debug

   Copy to Clipboard Toggle word wrap

4. If the output from the previous command indicates a failure, perform the following steps:

   1. Export the kubeconfig file to your environment by running the following command:

      $ export KUBECONFIG=<install_directory>/auth/kubeconfig

      Copy to Clipboard Toggle word wrap

   2. To gather information for debugging, run the following command:

      $ oc adm must-gather

      Copy to Clipboard Toggle word wrap

   3. Create a compressed file from the must-gather directory that was just created in your working directory by running the following command:

      $ tar cvaf must-gather.tar.gz <must_gather_directory>

      Copy to Clipboard Toggle word wrap
5. Excluding the /auth subdirectory, attach the installation directory used during the deployment to your support case on the Red Hat Customer Portal.
6. Attach all other data gathered from this procedure to your support case.