Use the following procedures to create the assets needed to PXE boot an OpenShift Container Platform cluster using the Agent-based Installer.

The assets you create in these procedures will deploy a single-node OpenShift Container Platform installation. You can use these procedures as a basis and modify configurations according to your requirements.


Downloading the Agent-based Installer

Use this procedure to download the Agent-based Installer and the CLI needed for your installation.

Currently, downloading the Agent-based Installer is not supported on the IBM Z® (s390x) architecture. The recommended method is by creating PXE assets.

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

  2. Navigate to Datacenter.

  3. Click Run Agent-based Installer locally.

  4. Select the operating system and architecture for the OpenShift Installer and Command line interface.

  5. Click Download Installer to download and extract the install program.

  6. You can either download or copy the pull secret by clicking on Download pull secret or Copy pull secret.

  7. Click Download command-line tools and place the openshift-install binary in a directory that is on your PATH.

Creating the preferred configuration inputs

Use this procedure to create the preferred configuration inputs used to create the PXE files.

  1. Install nmstate dependency by running the following command:

    $ sudo dnf install /usr/bin/nmstatectl -y
  2. Place the openshift-install binary in a directory that is on your PATH.

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

    $ mkdir ~/<directory_name>

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

  4. Create the install-config.yaml file:

    $ cat << EOF > ./my-cluster/install-config.yaml
    apiVersion: v1
    baseDomain: test.example.com
    - architecture: amd64 (1)
      hyperthreading: Enabled
      name: worker
      replicas: 0
      architecture: amd64
      hyperthreading: Enabled
      name: master
      replicas: 1
      name: sno-cluster (2)
      - cidr:
        hostPrefix: 23
      - cidr:
      networkType: OVNKubernetes (3)
    platform: (4)
      none: {}
    pullSecret: '<pull_secret>' (5)
    sshKey: '<ssh_pub_key>' (6)
    1 Specify the system architecture, valid values are amd64, arm64, ppc64le, and s390x.
    2 Required. Specify your cluster name.
    3 The cluster network plugin to install. The default value OVNKubernetes is the only supported value.
    4 Specify your platform.

    For bare metal platforms, host settings made in the platform section of the install-config.yaml file are used by default, unless they are overridden by configurations made in the agent-config.yaml file.

    5 Specify your pull secret.
    6 Specify your SSH public key.

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

    • IPv4

    • IPv6

    • IPv4 and IPv6 in parallel (dual-stack)

    IPv6 is supported only on bare metal platforms.

    Example of dual-stack networking
        - cidr:
          hostPrefix: 23
        - cidr: fd02::/48
          hostPrefix: 64
        - cidr:
        - cidr: 2001:DB8::/32
        - fd03::/112
      networkType: OVNKubernetes
        - 2001:DB8::4
        - 2001:DB8::5
  5. Create the agent-config.yaml file:

    $ cat > agent-config.yaml << EOF
    apiVersion: v1beta1
    kind: AgentConfig
      name: sno-cluster
    rendezvousIP: (1)
    hosts: (2)
      - hostname: master-0 (3)
          - name: eno1
            macAddress: 00:ef:44:21:e6:a5
        rootDeviceHints: (4)
          deviceName: /dev/sdb
        networkConfig: (5)
            - name: eno1
              type: ethernet
              state: up
              mac-address: 00:ef:44:21:e6:a5
                enabled: true
                  - ip:
                    prefix-length: 23
                dhcp: false
              - destination:
                next-hop-interface: eno1
                table-id: 254
    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 Optional: Host configuration. 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 Optional: 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 Enables provisioning of the Red Hat Enterprise Linux CoreOS (RHCOS) image to a particular device. The installation program 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 Optional: Configures the network interface of a host in NMState format.
  6. Optional: To create an iPXE script, add the bootArtifactsBaseURL to the agent-config.yaml file:

    apiVersion: v1beta1
    kind: AgentConfig
      name: sno-cluster
    bootArtifactsBaseURL: <asset_server_URL>

    Where <asset_server_URL> is the URL of the server you will upload the PXE assets to.

Creating the PXE assets

Use the following procedure to create the assets and optional script to implement in your PXE infrastructure.

  1. Create the PXE assets by running the following command:

    $ openshift-install agent create pxe-files

    The generated PXE assets and optional iPXE script can be found in the boot-artifacts directory.

    Example filesystem with PXE assets and optional iPXE script
        ├─ agent.x86_64-initrd.img
        ├─ agent.x86_64.ipxe
        ├─ agent.x86_64-rootfs.img
        └─ agent.x86_64-vmlinuz

    The contents of the boot-artifacts directory vary depending on the specified architecture.

    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.

  2. Upload the PXE assets and optional script to your infrastructure where they will be accessible during the boot process.

    If you generated an iPXE script, the location of the assets must match the bootArtifactsBaseURL you added to the agent-config.yaml file.

Manually adding IBM Z agents

After creating the PXE assets, you can add IBM Z® agents.

Currently ISO boot is not supported on IBM Z® (s390x) architecture. Therefore, manually adding IBM Z® agents is required for Agent-based installations on IBM Z®.

Depending on your IBM Z® environment, you can choose from the following options:

  • Adding IBM Z® agents with z/VM

  • Adding IBM Z® agents with RHEL KVM

Adding IBM Z agents with z/VM

Use the following procedure to manually add IBM Z® agents with z/VM.

  1. Create a parameter file for the z/VM guest:

    Example parameter file
    rd.neednet=1 \
    console=ttysclp0 \
    coreos.live.rootfs_url=<rootfs_url> \ (1)
    ip= nameserver= \ (2)
    zfcp.allow_lun_scan=0 \ (3)
    rd.znet=qeth,0.0.bdd0,0.0.bdd1,0.0.bdd2,layer2=1 \
    rd.dasd=0.0.4411 \ (4)
    rd.zfcp=0.0.8001,0x50050763040051e3,0x4000406300000000 \ (5)
    random.trust_cpu=on rd.luks.options=discard \
    ignition.firstboot ignition.platform.id=metal \
    console=tty1 console=ttyS1,115200n8 \
    coreos.inst.persistent-kargs="console=tty1 console=ttyS1,115200n8"
    1 For the coreos.live.rootfs_url artifact, specify the matching rootfs artifact for the kernel and initramfs that you are booting. Only HTTP and HTTPS protocols are supported.
    2 For the ip parameter, assign the IP address automatically using DHCP, or manually assign the IP address, as described in "Installing a cluster with z/VM on IBM Z® and IBM® LinuxONE".
    3 The default is 1. Omit this entry when using an OSA network adapter.
    4 For installations on DASD-type disks, use rd.dasd to specify the DASD where Red Hat Enterprise Linux CoreOS (RHCOS) is to be installed. Omit this entry for FCP-type disks.
    5 For installations on FCP-type disks, use rd.zfcp=<adapter>,<wwpn>,<lun> to specify the FCP disk where RHCOS is to be installed. Omit this entry for DASD-type disks.

    Leave all other parameters unchanged.

  2. Punch the kernel.img,generic.parm, and initrd.img files to the virtual reader of the z/VM guest virtual machine.

    For more information, see PUNCH in IBM Documentation.

    You can use the CP PUNCH command or, if you use Linux, the vmur command, to transfer files between two z/VM guest virtual machines.

  3. Log in to the conversational monitor system (CMS) on the bootstrap machine.

  4. IPL the bootstrap machine from the reader by running the following command:

    $ ipl c

    For more information, see IPL in IBM Documentation.

Adding IBM Z® agents with RHEL KVM

Use the following procedure to manually add IBM Z® agents with RHEL KVM.

  1. Boot your RHEL KVM machine.

  2. To deploy the virtual server, run the virt-install command with the following parameters:

    $ virt-install \
       --name <vm_name> \
       --autostart \
       --ram=16384 \
       --cpu host \
       --vcpus=8 \
       --location <path_to_kernel_initrd_image>,kernel=kernel.img,initrd=initrd.img \(1)
       --disk <qcow_image_path> \
       --network network:macvtap ,mac=<mac_address> \
       --graphics none \
       --noautoconsole \
       --wait=-1 \
       --extra-args "rd.neednet=1 nameserver=<nameserver>" \
       --extra-args "ip=<IP>::<nameserver>::<hostname>:enc1:none" \
       --extra-args "coreos.live.rootfs_url=http://<http_server>:8080/agent.s390x-rootfs.img" \
       --extra-args "random.trust_cpu=on rd.luks.options=discard" \
       --extra-args "ignition.firstboot ignition.platform.id=metal" \
       --extra-args "console=tty1 console=ttyS1,115200n8" \
       --extra-args "coreos.inst.persistent-kargs=console=tty1 console=ttyS1,115200n8" \
       --osinfo detect=on,require=off
    1 For the --location parameter, specify the location of the kernel/initrd on the HTTP or HTTPS server.

Additional resources