17.4. Deploying single-node OpenShift clusters

Procedure

1. Create the ibi-ns namespace by running the following command:

   $ oc create namespace ibi-ns

2. Create the Secret resource for your image registry:

   1. Create a YAML file that defines the Secret resource for your image registry:

      Example secret-image-registry.yaml file:

      apiVersion: v1
      kind: Secret
      metadata:
        name: ibi-image-pull-secret
        namespace: ibi-ns
      stringData:
        .dockerconfigjson: <base64_docker_auth_code>
      type: kubernetes.io/dockerconfigjson

      where:

      <base64_docker_auth_code>

      Specifies base64-encoded credential details. See the "Additional resources" section for more information about using image pull secrets.

   2. Create the Secret resource for your image registry by running the following command:

      $ oc create -f secret-image-registry.yaml

3. Optional: Configure static networking for the host:

   1. Create a Secret resource containing the static network configuration in nmstate format:

      Example host-network-config-secret.yaml file:

      apiVersion: v1
      kind: Secret
      metadata:
       name: <network_secret_name>
       namespace: ibi-ns
      type: Opaque
      stringData:
       nmstate: |
        interfaces:
          - name: <interface_name>
            type: ethernet
            state: up
            ipv4:
              enabled: true
              address:
                - ip: 192.168.200.25
                  prefix-length: 24
              dhcp: false
            ipv6:
              enabled: false
        dns-resolver:
          config:
            server:
              - <dns_server_1>
              - 192.168.15.48
        routes:
          config:
            - destination: 0.0.0.0/0
              metric: 150
              next-hop-address: 192.168.200.254
              next-hop-interface: <interface_name>
              table-id: 254

      where:

      <network_secret_name>

      Specifies the name for the Secret resource, for example host-network-config-secret.

      nmstate

      Specifies the static network configuration in nmstate format.

      <interface_name>

      Specifies the name of the interface on the host, for example ens1f0. The name of the interface must match the actual NIC name as shown in the operating system. To use your MAC address for NIC matching, set the identifier field to mac-address.

      dhcp: false

      Specifies that DHCP is disabled to ensure nmstate assigns the static IP address to the interface.

      <dns_server_1>

      Specifies one or more DNS servers that the system will use to resolve domain names, for example 192.168.15.47.

      config

      Specifies the default route through the ens1f0 interface to the next hop IP address 192.168.200.254.

4. Create the BareMetalHost and Secret resources:

   1. Create a YAML file that defines the BareMetalHost and Secret resources:

      Example ibi-bmh.yaml file:

      apiVersion: metal3.io/v1alpha1
      kind: BareMetalHost
      metadata:
        name: <baremetalhost_name>
        namespace: ibi-ns
      spec:
        online: <online_status>
        bootMACAddress: <boot_mac_address>
        bmc:
          address: <bmc_address>
          credentialsName: <bmh_secret_name>
        preprovisioningNetworkDataName: <network_secret_name>
        automatedCleaningMode: disabled
        externallyProvisioned: true
      ---
      apiVersion: v1
      kind: Secret
      metadata:
        name: <bmh_secret_name>
        namespace: ibi-ns
      type: Opaque
      data:
        username: <username>
        password: <password>

      where:

      <baremetalhost_name>

      Specifies the name for the BareMetalHost resource, for example ibi-bmh.

      <online_status>

      Specifies if the host should be online, for example false.

      <boot_mac_address>

      Specifies the host boot MAC address, for example 00:a5:12:55:62:64.

      <bmc_address>

      Specifies the BMC address, for example redfish-virtualmedia+http://192.168.111.1:8000/redfish/v1/Systems/8a5babac-94d0-4c20-b282-50dc3a0a32b5. You can only use bare-metal host drivers that support virtual media networking booting, for example redfish-virtualmedia and idrac-virtualmedia.

      <bmh_secret_name>

      Specifies the name of the bare-metal host Secret resource, for example ibi-bmh-bmc-secret.

      <network_secret_name>

      (Optional) Specifies the name of the Secret resource containing the static network configuration for the host, for example host-network-config-secret.

      automatedCleaningMode: disabled

      Specifies that automated cleaning is disabled to prevent the provisioning service from deleting all preinstallation artifacts, such as the seed image, during disk inspection.

      externallyProvisioned: true

      Specifies that the host is externally provisioned to enable it to boot from the preinstalled disk, instead of the configuration ISO.

      <username>

      Specifies the username for BMC authentication.

      <password>

      Specifies the password for BMC authentication.

   2. Create the BareMetalHost and Secret resources by running the following command:

      $ oc create -f ibi-bmh.yaml

5. Create the ClusterImageSet resource:

   1. Create a YAML file that defines the ClusterImageSet resource:

      Example ibi-cluster-image-set.yaml file:

      apiVersion: hive.openshift.io/v1
      kind: ClusterImageSet
      metadata:
        name: <clusterimageset_name>
      spec:
        releaseImage: <release_image>

      where:

      <clusterimageset_name>

      Specifies the name for the ClusterImageSet resource, for example ibi-img-version-arch.

      <release_image>

      Specifies the address for the release image to use for the deployment, for example ibi.example.com:path/to/release/images:version-arch. If you use a different image registry compared to the image registry used during seed image generation, ensure that the OpenShift Container Platform version for the release image remains the same.

   2. Create the ClusterImageSet resource by running the following command:

      $ oc apply -f ibi-cluster-image-set.yaml

6. Create the ImageClusterInstall resource:

   1. Create a YAML file that defines the ImageClusterInstall resource:

      Example ibi-image-cluster-install.yaml file:

      apiVersion: extensions.hive.openshift.io/v1alpha1
      kind: ImageClusterInstall
      metadata:
        name: <imageclusterinstall_name>
        namespace: ibi-ns
      spec:
        bareMetalHostRef:
          name: <baremetalhost_name>
          namespace: ibi-ns
        clusterDeploymentRef:
          name: <clusterdeployment_name>
        hostname: <cluster_hostname>
        imageSetRef:
          name: <clusterimageset_name>
        machineNetworks:
        - cidr: 10.0.0.0/24
        #- cidr: fd01::/64
        proxy:
          httpProxy: "http://proxy.example.com:8080"
          #httpsProxy: "http://proxy.example.com:8080"
          #noProxy: "no_proxy.example.com"

      where:

      <imageclusterinstall_name>

      Specifies the name for the ImageClusterInstall resource, for example ibi-image-install.

      <baremetalhost_name>

      Specifies the BareMetalHost resource that you want to target for the image-based installation, for example ibi-bmh.

      <clusterdeployment_name>

      Specifies the name of the ClusterDeployment resource that you want to use for the image-based installation of the target host, for example ibi-cluster-deployment.

      <cluster_hostname>

      Specifies the hostname for the cluster, for example ibi-host.

      <clusterimageset_name>

      Specifies the name of the ClusterImageSet resource you used to define the container release images to use for deployment, for example ibi-img-version-arch.

      machineNetworks

      Specifies the public Classless Inter-Domain Routing (CIDR) of the external network. For dual-stack networking, you can specify both IPv4 and IPv6 CIDRs using a list format. The first CIDR in the list is the primary address family and must match the primary address family of the seed cluster.

      proxy

      (Optional) Specifies a proxy to use for the cluster deployment.

      중요

      If your cluster deployment requires a proxy configuration, you must do the following:

      • Create a seed image from a seed cluster featuring a proxy configuration. The proxy configurations do not have to match.
      • Configure the machineNetwork field in your installation manifest.

   2. Create the ImageClusterInstall resource by running the following command:

      $ oc create -f ibi-image-cluster-install.yaml

7. Create the ClusterDeployment resource:

   1. Create a YAML file that defines the ClusterDeployment resource:

      Example ibi-cluster-deployment.yaml file:

      apiVersion: hive.openshift.io/v1
      kind: ClusterDeployment
      metadata:
        name: <clusterdeployment_name>
        namespace: <namespace>
      spec:
        baseDomain: <base_domain>
        clusterInstallRef:
          group: extensions.hive.openshift.io
          kind: ImageClusterInstall
          name: <imageclusterinstall_name>
          version: v1alpha1
        clusterName: <cluster_name>
        platform:
          none: {}
        pullSecretRef:
          name: <pull_secret_name>

      where:

      <clusterdeployment_name>

      Specifies the name for the ClusterDeployment resource, for example ibi-cluster-deployment.

      <namespace>

      Specifies the namespace for the ClusterDeployment resource, for example ibi-ns.

      <base_domain>

      Specifies the base domain that the cluster should belong to, for example example.com.

      <imageclusterinstall_name>

      Specifies the name of the ImageClusterInstall in which you defined the container images to use for the image-based installation of the target host, for example ibi-image-install.

      <cluster_name>

      Specifies a name for the cluster, for example ibi-cluster.

      <pull_secret_name>

      Specifies the secret to use for pulling images from your image registry, for example ibi-image-pull-secret.

   2. Create the ClusterDeployment resource by running the following command:

      $ oc apply -f ibi-cluster-deployment.yaml

8. Create the ManagedCluster resource:

   1. Create a YAML file that defines the ManagedCluster resource:

      Example ibi-managed.yaml file:

      apiVersion: cluster.open-cluster-management.io/v1
      kind: ManagedCluster
      metadata:
        name: <managedcluster_name>
      spec:
        hubAcceptsClient: <hub_accepts_client>

      where:

      <managedcluster_name>

      Specifies the name for the ManagedCluster resource, for example sno-ibi.

      <hub_accepts_client>

      Specifies whether RHACM manages the cluster. Set to true to enable management.

   2. Create the ManagedCluster resource by running the following command:

      $ oc apply -f ibi-managed.yaml

Verification

1. Check the status of the ImageClusterInstall in the hub cluster to monitor the progress of the target host installation by running the following command:

   $ oc get imageclusterinstall

   Example output:

   NAME       REQUIREMENTSMET           COMPLETED                     BAREMETALHOSTREF
   target-0   HostValidationSucceeded   ClusterInstallationSucceeded  ibi-bmh

   주의

   If the ImageClusterInstall resource is deleted, the IBI Operator reattaches the BareMetalHost resource and reboots the machine.

2. When the installation completes, you can retrieve the kubeconfig secret to log in to the managed cluster by running the following command:

   $ oc extract secret/<cluster_name>-admin-kubeconfig -n <cluster_namespace>  --to - > <directory>/<cluster_name>-kubeconfig

   where:

   <cluster_name>

   Specifies the name of the cluster.

   <cluster_namespace>

   Specifies the namespace of the cluster.

   <directory>

   Specifies the directory in which to create the file.