Install Kubernetes Platform on Standard With Controller Storage

Overview

The Standard with Controller storage deployment configuration option provides two high availability (HA) controller nodes, up to 8 storage nodes, and a pool of up to 100 worker nodes.

For more information, see Supported Deployment Models.

For information on getting started quickly using an automated virtual installation, see Automated Virtual Installation.

Standard With Controller Storage Installation Workflow

The following table shows the high-level installation flow for Standard deployment with controller storage:

Step

Section

Description

1

Prepare and Plan

Gather prerequisites, prepare servers, and obtain the ISO image.

2

Install Software on Controller-0

Install the platform OS on the first server.

3

Bootstrap System on Controller-0

Run the Ansible bootstrap playbook to initialize services.

4

Configure Controller-0

Set up OAM, MGMT interfaces, and NTP.

5

Unlock Controller-0

Unlock and bring controller-0 into service.

6

Install Software on Controller-1 and Worker Nodes

PXE boot and install controller-1 and worker nodes.

7

Configure Controller-1

Set up interfaces on controller-1.

8

Unlock Controller-1

Unlock and bring controller-1 into service.

9

Configure Worker Nodes

Configure interfaces and storage on worker nodes.

10

Unlock Worker Nodes

Unlock and bring worker nodes into service.

11

Add Ceph OSDs to Controllers

Add Ceph OSD storage to controller nodes.

12

Rook Ceph Storage Backend Configuration (Optional)

Configure Rook-Ceph for persistent volume claims.

Minimum Hardware Requirements

This section describes the hardware requirements and server preparation for a StarlingX r13.0 bare metal Standard with Controller Storage deployment configuration.

The recommended minimum hardware requirements for bare metal servers for various host types are:

Minimum Requirements

Controller Node

Worker Node

Number of servers

2

2-99

Minimum processor class

Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket

Note

All cores are used by the platform.

Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket

Note

  • Platform: 1x physical cores (2x logical cores if hyper-threading), (by default, configurable)

  • Application: Remaining cores

Minimum memory

64 GB

32 GB

Primary disk

500 GB SSD or NVMe (see NVME Configuration)

120 GB (Minimum 10k RPM)

Additional disks

  • 1 or more 500 GB (min. 10K RPM) for Ceph OSD

  • Recommended, but not required: 1 or more SSDs or NVMe drives for Ceph journals (min. 1024 MiB per OSD journal)

For StarlingX OpenStack, we recommend 1 or more 500 GB (min. 10K RPM) for VM local ephemeral storage

Recommended but not required: 1 or more 500G HDs (min. 10K RPM), SSDs or NVMe drives for Container ephemeral disk storage.

Minimum network ports

  • MGMT: 1x1GE (Recommended: MGMT 2x10GE LAG)

  • OAM: 1x1GE (Recommended: OAM: 2x1GE LAG)

  • Data: 1 or more x 10GE (Recommended: Data: 2x10GE LAG)

  • Mgmt/Cluster: 1x10GE (Recommended: MGMT 2x10GE LAG)

  • Data: 1 or more x 10GE (Recommended: Data: 2x10GE LAG)

USB

1 (Only required if used for initial installation of controller-0).

Board Management

1 BMC

Boot order

HD, PXE, USB

HD, PXE

BIOS mode

BIOS or UEFI

Note

UEFI Secure Boot and UEFI PXE boot over IPv6 are not supported. On systems with an IPv6 management network, you can use a separate IPv4 network for PXE boot. For more information, see PXE Boot Controller-0.

BIOS or UEFI

Bios settings

  • Hyper-Threading technology enabled

  • Virtualization technology (VTD, VTX) enabled

  • VT for directed I/O enabled

  • CPU power and performance policy set to performance

  • CPU C state control disabled

  • Plug & play BMC detection disabled

(Same as controller node)

Prepare and Plan

Complete the following prerequisites before starting the StarlingX installation.

Note

By default, StarlingX uses IPv4. To use StarlingX with IPv6:

  • The entire infrastructure and cluster configuration must be IPv6, with the exception of the PXE boot network.

  • Not all external servers are reachable via IPv6 addresses (for example Docker registries). Depending on your infrastructure, it may be necessary to deploy a NAT64/DNS64 gateway to translate the IPv4 addresses to IPv6.

Preparing servers is the first step of the StarlingX installation procedure.

Prior to starting the StarlingX installation, ensure that the bare metal servers are in the following state:

  • Physically installed.

  • Cabled for power.

  • Cabled for networking.

    Far-end switch ports should be properly configured to realize the networking shown in the diagram earlier in this topic.

  • All disks are wiped.

    This ensures that servers will boot from either the network or USB storage, if present.

  • BIOS configured with Intel Virtualization (VTD, VTX)

    • Disabled for controller-only servers and storage servers.

    • Enabled for controller+worker (All-in-one) servers and worker servers.

  • The servers are powered off.

After the servers are ready, download the ISO and prepare the boot mechanism. For more information, see Prepare the ISO and Boot Method.

Install Software on Controller-0

Install the StarlingX software on the first server in the deployment.

This step performs a non-interactive installation of the StarlingX operating system and RPMs on the server’s first disk. After installation, the system reboots into the newly installed OS.

The initial server becomes controller-0 for the deployment.

  1. Insert the bootable USB into a bootable USB port on the host you are configuring as controller-0.

  2. Power on the host.

  3. Attach to a console, ensure the host boots from the USB, and wait for the StarlingX Installer Menus.

  4. Make the following menu selections in the installer:

    1. First menu: Select Standard Controller Configuration.

    2. Second menu: Select Graphical Console or Textual Console depending on your terminal access to the console port.

  5. Wait for non-interactive install of software to complete and server to reboot. This can take 5-10 minutes, depending on the performance of the server.

Bootstrap System on Controller-0

Use the following procedure to initialize, or bootstrap, the StarlingX software on controller-0. Provide a minimal set of system configuration parameters in the Ansible override file to complete the bootstrap process.

After the bootstrap process completes:

  • The system runs the core StarlingX services on controller-0.

  • You can access all APIs and CLIs locally.

  • The services are not yet providing operational workloads.

Note

If a manual or unexpected reboot occurs during or before the completion of the bootstrap phase, specifically before you unlock controller-0, you must reinstall the system starting from the software installation step. Back up any updated bootstrap or deployment configuration files to an external location before reinstalling.

  1. Login to controller-0 as sysadmin / sysadmin and change the password when prompted. This is required only for the first login.

    Login: sysadmin
    Password:
    Changing password for sysadmin.
    (current) UNIX Password: sysadmin
    New Password:
    (repeat) New Password:
    
  2. Verify and/or configure IP connectivity.

    External connectivity is required to run the Ansible bootstrap playbook. The StarlingX boot image will DHCP out all interfaces so the server may have obtained an IP address and have external IP connectivity if a DHCP server is present in your environment. Verify this using the ip addr and ping 8.8.8.8 commands.

    Otherwise, manually configure an IP address and default IP route. Use the PORT, IP-ADDRESS/SUBNET-LENGTH and GATEWAY-IP-ADDRESS applicable to your deployment environment.

    sudo ip address add <IP-ADDRESS>/<SUBNET-LENGTH> dev <PORT>
    sudo ip link set up dev <PORT>
    sudo ip route add default via <GATEWAY-IP-ADDRESS> dev <PORT>
    ping 8.8.8.8
    
  3. Specify user configuration overrides for the Ansible bootstrap playbook. Create the override file in the system administrator’s home directory (for example, $HOME/localhost.yml). Ansible automatically detects and applies this file during the bootstrap process.

    Using a bootstrap override file, you can customize the Ansible bootstrap process during installation. This file lets you override the default settings defined in default.yml by specifying deployment-specific parameters, such as networking and system configuration.

    Refer to Ansible Bootstrap Configurations for instructions on creating the override file and for details on advanced Ansible bootstrap configuration scenarios.

    Important

    Some Ansible bootstrap parameters cannot be changed or are very difficult to change after installation is complete.

    Review the set of install-time-only parameters before installation and confirm that your values for these parameters are correct for the desired installation.

    Refer to Ansible install-time-only parameters for details.

  4. Run the Ansible bootstrap playbook:

    Note

    Before running the Ansible bootstrap playbook, it is important that you ensure that controller-0 server time is synchronized correctly. Run the following command:

    # check the current server time
    $ date
    
    # if the current server time is not correct, update the NTP Servers configuration.
    For more information, see :ref:`Configure NTP Servers <configuring-ntp-servers-and-services-using-the-cli>`.
    
    ~(keystone_admin)]$ ansible-playbook --ask-vault-pass /usr/share/ansible/stx-ansible/playbooks/bootstrap.yml
    

    Wait for Ansible bootstrap playbook to complete. This can take 5-10 minutes, depending on the performance of the host machine.

    Note

    Use —ask-vault-pass if your overrides file has been encrypted with ansible-vault.

  1. Run the Ansible bootstrap playbook:

    ansible-playbook --ask-vault-pass /usr/share/ansible/stx-ansible/playbooks/bootstrap.yml
    

    Wait for Ansible bootstrap playbook to complete. This can take 5-10 minutes, depending on the performance of the host machine.

Configure Controller-0

Controller-0 configuration includes setting up administrative access, configuring interfaces, and configuring network time synchronization.

  1. Acquire admin credentials:

    source /etc/platform/openrc
    
  2. Configure the OAM interface of controller-0 and specify the attached network as “oam”.

    The following example configures the OAM interface on a physical untagged ethernet port, use the OAM port name that is applicable to your deployment environment, for example eth0:

    OAM_IF=<OAM-PORT>
    system host-if-modify controller-0 $OAM_IF -c platform
    system interface-network-assign controller-0 $OAM_IF oam
    

    To configure a vlan or aggregated ethernet interface, see Node Interfaces.

  3. Configure the MGMT interface of controller-0 and specify the attached networks of both “mgmt” and “cluster-host”.

    The following example configures the MGMT interface on a physical untagged ethernet port, use the MGMT port name that is applicable to your deployment environment, for example eth1:

    MGMT_IF=<MGMT-PORT>
    
    # De-provision loopback interface and
    # remove mgmt and cluster-host networks from loopback interface
    system host-if-modify controller-0 lo -c none
    IFNET_UUIDS=$(system interface-network-list controller-0 | awk '{if ($6=="lo") print $4;}')
    for UUID in $IFNET_UUIDS; do
        system interface-network-remove ${UUID}
    done
    
    # Configure management interface and assign mgmt and cluster-host networks to it
    system host-if-modify controller-0 $MGMT_IF -c platform
    system interface-network-assign controller-0 $MGMT_IF mgmt
    system interface-network-assign controller-0 $MGMT_IF cluster-host
    

    To configure a vlan or aggregated ethernet interface, see Node Interfaces.

  4. Configure NTP servers for network time synchronization:

    system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org
    

    To configure PTP instead of NTP, see PTP Server Configuration.

  5. (Optional) Configure host based Ceph Storage Backend:

    A persistent storage backend is required if your application requires PVCs.

    Important

    The StarlingX OpenStack application requires PVCs.

    system storage-backend-add ceph --confirm
    

OpenStack-Specific Host Configuration

Important

These steps are required only if the StarlingX OpenStack application (stx-openstack) will be installed.

  1. For OpenStack only: Assign OpenStack host labels to controller-0 in support of installing the stx-openstack manifest and helm-charts later.

    system host-label-assign controller-0 openstack-control-plane=enabled
    
  2. For OpenStack only: Configure the system setting for the vSwitch.

    StarlingX has OVS (kernel-based) vSwitch configured as default:

    • Runs in a container; defined within the helm charts of the stx-openstack manifest.

    • Shares the core(s) assigned to the platform.

    If you require better performance, OVS-DPDK (OVS with the Data Plane Development Kit, which is supported only on bare metal hardware) should be used:

    • Runs directly on the host (it is not containerized).

    • Requires that at least 1 core be assigned/dedicated to the vSwitch function.

    To deploy the default containerized OVS:

    system modify --vswitch_type none
    

    This does not run any vSwitch directly on the host, instead, it uses the containerized OVS defined in the helm charts of stx-openstack manifest.

    To deploy OVS-DPDK, run the following command:

    system modify --vswitch_type ovs-dpdk

    Once vswitch_type is set to OVS-DPDK, any subsequent AIO-controller or worker nodes created will default to automatically assigning 1 vSwitch core for AIO controllers and 2 vSwitch cores (both on numa-node 0; physical NICs are typically on first numa-node) for compute-labeled worker nodes.

    Note

    After controller-0 is unlocked, changing vswitch_type requires locking and unlocking controller-0 to apply the change.

Unlock Controller-0

Complete the configuration of controller-0 and unlock it to provide service.

To unlock the controller and bring it into service, use the following command:

(keystone_admin) $ system host-unlock controller-0

Controller-0 will reboot in order to apply configuration changes and come into service. This can take 5-10 minutes, depending on the performance of the host machine.

  • For OpenStack only: Due to the additional OpenStack services’ containers running on the controller host, increase the Docker filesystem size from the default 30G to 60G.

    # check existing size of docker fs
    $ system host-fs-list controller-0
    # check available space (Avail Size (GiB)) in cgts-vg LVG where docker fs is located
    $ system host-lvg-list controller-0
    # if existing docker fs size + cgts-vg available space is less than
    # 60G, you will need to add a new disk to cgts-vg.
    
       # Get device path of BOOT DISK
       $ system host-show controller-0 | fgrep rootfs
    
       # Get UUID of ROOT DISK by listing disks
       $ system host-disk-list controller-0
    
       # Add new disk to 'cgts-vg' local volume group
       $ system host-pv-add controller-0 cgts-vg <DISK_UUID>
       $ sleep 10    # wait for disk to be added
    
       # Confirm the available space and increased number of physical
       # volumes added to the cgts-vg volume group
       $ system host-lvg-list controller-0
    
    # Increase docker filesystem to 60G
    $ system host-fs-modify controller-0 docker=60
    

Install Software on Controller-1 and Worker Nodes

  1. Power on the controller-1 server and force it to network boot with the appropriate BIOS boot options for your particular server.

  2. As controller-1 boots, a message appears on its console instructing you to configure the personality of the node.

  3. On the console of controller-0, list hosts to see newly discovered controller-1 host (hostname=None):

    system host-list
    +----+--------------+-------------+----------------+-------------+--------------+
    | id | hostname     | personality | administrative | operational | availability |
    +----+--------------+-------------+----------------+-------------+--------------+
    | 1  | controller-0 | controller  | unlocked       | enabled     | available    |
    | 2  | None         | None        | locked         | disabled    | offline      |
    +----+--------------+-------------+----------------+-------------+--------------+
    
  4. Using the host id, set the personality of this host to ‘controller’:

    system host-update 2 personality=controller
    

    This initiates the install of software on controller-1. This can take 5-10 minutes, depending on the performance of the host machine.

  5. While waiting for the previous step to complete, power on the worker nodes. Set the personality to ‘worker’ and assign a unique hostname for each.

    For example, power on worker-0 and wait for the new host (hostname=None) to be discovered by checking system host-list:

    system host-update 3 personality=worker hostname=worker-0
    

    Repeat for worker-1. Power on worker-1 and wait for the new host (hostname=None) to be discovered by checking ‘system host-list’:

    system host-update 4 personality=worker hostname=worker-1
    

    Note

    A node with Edgeworker personality is also available. See Deploy Edgeworker Nodes for details.

  6. Wait for the software installation on controller-1, worker-0, and worker-1 to complete, for all servers to reboot, and for all to show as locked/disabled/online in ‘system host-list’.

    system host-list
    
    +----+--------------+-------------+----------------+-------------+--------------+
    | id | hostname     | personality | administrative | operational | availability |
    +----+--------------+-------------+----------------+-------------+--------------+
    | 1  | controller-0 | controller  | unlocked       | enabled     | available    |
    | 2  | controller-1 | controller  | locked         | disabled    | online       |
    | 3  | worker-0     | worker      | locked         | disabled    | online       |
    | 4  | worker-1     | worker      | locked         | disabled    | online       |
    +----+--------------+-------------+----------------+-------------+--------------+
    

Configure Controller-1

  1. Configure the OAM interface of controller-1 and specify the attached network of “oam”.

    The following example configures the OAM interface on a physical untagged ethernet port, use the OAM port name that is applicable to your deployment environment, for example eth0:

    OAM_IF=<OAM-PORT>
    system host-if-modify controller-1 $OAM_IF -c platform
    system interface-network-assign controller-1 $OAM_IF oam
    

    To configure a vlan or aggregated ethernet interface, see Node Interfaces.

  2. The MGMT interface is partially set up by the network install procedure; configuring the port used for network install as the MGMT port and specifying the attached network of “mgmt”.

    Complete the MGMT interface configuration of controller-1 by specifying the attached network of “cluster-host”.

    system interface-network-assign controller-1 mgmt0 cluster-host
    

OpenStack-specific host configuration

Important

This step is required only if the StarlingX OpenStack application (stx-openstack) will be installed.

For OpenStack only: Assign OpenStack host labels to controller-1 in support of installing the stx-openstack manifest and helm-charts later.

system host-label-assign controller-1 openstack-control-plane=enabled

Unlock Controller-1

Unlock controller-1 in order to bring it into service:

system host-unlock controller-1

Controller-1 will reboot in order to apply configuration changes and come into service. This can take 5-10 minutes, depending on the performance of the host machine.

  • For OpenStack only: Due to the additional OpenStack services’ containers running on the controller host, increase the Docker filesystem size from the default 30G to 60G.

    # check existing size of docker fs
    $ system host-fs-list controller-1
    # check available space (Avail Size (GiB)) in cgts-vg LVG where docker fs is located
    $ system host-lvg-list controller-1
    # if existing docker fs size + cgts-vg available space is less than
    # 80G, you will need to add a new disk to cgts-vg.
    
       # Get device path of BOOT DISK
       $ system host-show controller-1 | fgrep rootfs
    
       # Get UUID of ROOT DISK by listing disks
       $ system host-disk-list controller-1
    
       # Add new disk to 'cgts-vg' local volume group
       $ system host-pv-add controller-1 cgts-vg <DISK_UUID>
       $ sleep 10    # wait for disk to be added
    
       # Confirm the available space and increased number of physical
       # volumes added to the cgts-vg volume group
       $ system host-lvg-list controller-1
    
    # Increase docker filesystem to 60G
    $ system host-fs-modify controller-1 docker=60
    

Note

Controller-0 and controller-1 use IP multicast messaging for synchronization. If loss of synchronization occurs a few minutes after controller-1 becomes available, ensure that the switches and other devices on the management and infrastructure networks are configured with appropriate settings.

In particular, if IGMP snooping is enabled on ToR switches, then a device acting as an IGMP querier is required on the network (on the same VLAN) to prevent nodes from being dropped from the multicast group. The IGMP querier periodically sends IGMP queries to all nodes on the network, and each node sends an IGMP join or report in response. Without an IGMP querier, the nodes do not periodically send IGMP join messages after the initial join sent when the link first goes up, and they are eventually dropped from the multicast group.

Configure Worker Nodes

  1. (Optional) Configure host based Ceph Storage Backend:

    1. Add the third Ceph monitor to a worker node:

      (The first two Ceph monitors are automatically assigned to controller-0 and controller-1.)

      system ceph-mon-add worker-0
      
    2. Wait for the worker node monitor to complete the configuration:

      system ceph-mon-list
      +--------------------------------------+-------+--------------+------------+------+
      | uuid                                 | ceph_ | hostname     | state      | task |
      |                                      | mon_g |              |            |      |
      |                                      | ib    |              |            |      |
      +--------------------------------------+-------+--------------+------------+------+
      | 64176b6c-e284-4485-bb2a-115dee215279 | 20    | controller-1 | configured | None |
      | a9ca151b-7f2c-4551-8167-035d49e2df8c | 20    | controller-0 | configured | None |
      | f76bc385-190c-4d9a-aa0f-107346a9907b | 20    | worker-0     | configured | None |
      +--------------------------------------+-------+--------------+------------+------+
      
  2. Assign the cluster-host network to the MGMT interface for the worker nodes:

    (Note that the MGMT interfaces are partially set up automatically by the network install procedure.)

    for NODE in worker-0 worker-1; do
       system interface-network-assign $NODE mgmt0 cluster-host
    done
    

OpenStack-specific host configuration

Important

These steps are required only if the StarlingX OpenStack application (stx-openstack) will be installed.

  1. For OpenStack only: Assign OpenStack host labels to the worker nodes in support of installing the stx-openstack manifest and helm-charts later.

    for NODE in worker-0 worker-1; do
      system host-label-assign $NODE openstack-compute-node=enabled
      kubectl taint nodes $NODE openstack-compute-node:NoSchedule
      system host-label-assign $NODE openvswitch=enabled
      system host-label-assign $NODE dpdk=enabled
    done

    Note

    When using OVS, the DPDK label must not be applied, that is dpdk=enabled is not applicable to OVS. Otherwise, the open vSwitch chart will be disabled.

    Note

    If you have a NIC that supports SR-IOV, then you can enable it by using the following:

    system host-label-assign $NODE sriov=enabled
    
  2. For OpenStack only: Configure the host settings for the vSwitch.

    If using OVS-DPDK vswitch, run the following commands:

    Default recommendation for worker node is to use two cores on numa-node 0 for OVS-DPDK vSwitch; physical NICs are typically on first numa-node. This should have been automatically configured, if not run the following command.

    for NODE in worker-0 worker-1; do
    
       # assign 2 cores on processor/numa-node 0 on worker-node to vswitch
       system host-cpu-modify -f vswitch -p0 2 $NODE
    
    done
    

    When using OVS-DPDK, configure 1G of huge pages for vSwitch memory on each NUMA node on the host. It is recommended to configure 1x 1G huge page (-1G 1) for vSwitch memory on each NUMA node on the host.

    However, due to a limitation with Kubernetes, only a single huge page size is supported on any one host. If your application VMs require 2M huge pages, then configure 500x 2M huge pages (-2M 500) for vSwitch memory on each NUMA node on the host.

    for NODE in worker-0 worker-1; do
    
      # assign 1x 1G huge page on processor/numa-node 0 on worker-node to vswitch
      system host-memory-modify -f vswitch -1G 1 $NODE 0
    
      # assign 1x 1G huge page on processor/numa-node 0 on worker-node to vswitch
      system host-memory-modify -f vswitch -1G 1 $NODE 1
    
    done
    

    Important

    VMs created in an OVS-DPDK environment must be configured to use huge pages to enable networking and must use a flavor with the property hw:mem_page_size=large

    Configure the huge pages for VMs in an OVS-DPDK environment on this host, the following commands are an example that assumes that 1G huge page size is being used on this host:

    for NODE in worker-0 worker-1; do
    
      # assign 10x 1G huge page on processor/numa-node 0 on worker-node to applications
      system host-memory-modify -f application -1G 10 $NODE 0
    
      # assign 10x 1G huge page on processor/numa-node 1 on worker-node to applications
      system host-memory-modify -f application -1G 10 $NODE 1
    
    done
    
  3. For OpenStack only: Add an instances filesystem OR Set up a disk based nova-local volume group, which is needed for stx-openstack nova ephemeral disks.

    Note

    Both cannot exist at the same time.

    Add an ‘instances’ filesystem:

    # Create ‘instances’ filesystem
    for NODE in worker-0 worker-1; do
       system host-fs-add ${NODE} instances=<size>
    done
    

    OR add a ‘nova-local’ volume group

    for NODE in worker-0 worker-1; do
        # Create ‘nova-local’ local volume group
        system host-lvg-add ${NODE} nova-local
    
        # Get UUID of an unused DISK to to be added to the ‘nova-local’ volume
        # group. CEPH OSD Disks can NOT be used. Assume /dev/sdb is unused
        # on all workers
        DISK_UUID=$(system host-disk-list ${NODE} | awk '/sdb/{print $2}')
    
        # Add the unused disk to the ‘nova-local’ volume group
       system host-pv-add ${NODE} nova-local ${DISK_UUID}
    done
    
  4. For OpenStack only: Configure data interfaces for worker nodes. Data class interfaces are vswitch interfaces used by vswitch to provide VM virtio vNIC connectivity to OpenStack Neutron Tenant Networks on the underlying assigned Data Network.

    Important

    A compute-labeled worker host MUST have at least one Data class interface.

    • Configure the data interfaces for worker nodes.

      # Execute the following lines with
      export NODE=worker-0
      # and then repeat with
      export NODE=worker-1
      
         # List inventoried host’s ports and identify ports to be used as ‘data’ interfaces,
         # based on displayed linux port name, pci address and device type.
         system host-port-list ${NODE}
      
         # List host’s auto-configured ‘ethernet’ interfaces,
         # find the interfaces corresponding to the ports identified in previous step, and
         # take note of their UUID
         system host-if-list -a ${NODE}
      
         # Modify configuration for these interfaces
         # Configuring them as ‘data’ class interfaces, MTU of 1500 and named data#
         system host-if-modify -m 1500 -n data0 -c data ${NODE} <data0-if-uuid>
         system host-if-modify -m 1500 -n data1 -c data ${NODE} <data1-if-uuid>
      
         # Create Data Networks that vswitch 'data' interfaces will be connected to
         DATANET0='datanet0'
         DATANET1='datanet1'
         system datanetwork-add ${DATANET0} vlan
         system datanetwork-add ${DATANET1} vlan
      
         # Assign Data Networks to Data Interfaces
         system interface-datanetwork-assign ${NODE} <data0-if-uuid> ${DATANET0}
         system interface-datanetwork-assign ${NODE} <data1-if-uuid> ${DATANET1}
      

Configure PCI-SRIOV Interfaces (Optional)

  1. Optionally, configure pci-sriov interfaces for worker nodes.

    This step is optional for Kubernetes. Do this step if using SR-IOV network attachments in hosted application containers.

    This step is optional for OpenStack. Do this step if using SR-IOV vNICs in hosted application VMs. Note that pci-sriov interfaces can have the same Data Networks assigned to them as vswitch data interfaces.

    • Configure the pci-sriov interfaces for worker nodes.

      # Execute the following lines with
      export NODE=worker-0
      # and then repeat with
      export NODE=worker-1
      
         # List inventoried host’s ports and identify ports to be used as ‘pci-sriov’ interfaces,
         # based on displayed linux port name, pci address and device type.
         system host-port-list ${NODE}
      
         # List host’s auto-configured ‘ethernet’ interfaces,
         # find the interfaces corresponding to the ports identified in previous step, and
         # take note of their UUID
         system host-if-list -a ${NODE}
      
         # Modify configuration for these interfaces
         # Configuring them as ‘pci-sriov’ class interfaces, MTU of 1500 and named sriov#
         system host-if-modify -m 1500 -n sriov0 -c pci-sriov ${NODE} <sriov0-if-uuid> -N <num_vfs>
         system host-if-modify -m 1500 -n sriov1 -c pci-sriov ${NODE} <sriov1-if-uuid> -N <num_vfs>
      
         # If not already created, create Data Networks that the 'pci-sriov'
         # interfaces will be connected to
         DATANET0='datanet0'
         DATANET1='datanet1'
         system datanetwork-add ${DATANET0} vlan
         system datanetwork-add ${DATANET1} vlan
      
         # Assign Data Networks to PCI-SRIOV Interfaces
         system interface-datanetwork-assign ${NODE} <sriov0-if-uuid> ${DATANET0}
         system interface-datanetwork-assign ${NODE} <sriov1-if-uuid> ${DATANET1}
      
    • For Kubernetes only: To enable using SR-IOV network attachments for the above interfaces in Kubernetes hosted application containers:

      • Configure the Kubernetes SR-IOV device plugin.

        for NODE in worker-0 worker-1; do
           system host-label-assign $NODE sriovdp=enabled
        done
        
      • If planning on running DPDK in Kubernetes hosted application containers on this host, configure the number of 1G Huge pages required on both NUMA nodes.

        for NODE in worker-0 worker-1; do
        
           # assign 10x 1G huge page on processor/numa-node 0 on worker-node to applications
           system host-memory-modify -f application $NODE 0 -1G 10
        
           # assign 10x 1G huge page on processor/numa-node 1 on worker-node to applications
           system host-memory-modify -f application $NODE 1 -1G 10
        
        done
        

Unlock Worker Nodes

Unlock worker nodes in order to bring them into service:

for NODE in worker-0 worker-1; do
   system host-unlock $NODE
done

The worker nodes will reboot in order to apply configuration changes and come into service. This can take 5-10 minutes, depending on the performance of the host machine.

Add Ceph OSDs to Controllers

If configuring host-based Ceph Storage Backend, add Ceph OSDs to controllers.

  1. Add OSDs to controller-0. The following example adds OSDs to the sdb disk:

    HOST=controller-0
    
    # List host's disks and identify disks you want to use for CEPH OSDs, taking note of their UUID
    # By default, /dev/sda is being used as system disk and can not be used for OSD.
    system host-disk-list ${HOST}
    
    # Add disk as an OSD storage
    system host-stor-add ${HOST} osd <disk-uuid>
    
    # List OSD storage devices and wait for configuration of newly added OSD to complete.
    system host-stor-list ${HOST}
    
  2. Add OSDs to controller-1. The following example adds OSDs to the sdb disk:

    HOST=controller-1
    
    # List host's disks and identify disks you want to use for CEPH OSDs, taking note of their UUID
    # By default, /dev/sda is being used as system disk and can not be used for OSD.
    system host-disk-list ${HOST}
    
    # Add disk as an OSD storage
    system host-stor-add ${HOST} osd <disk-uuid>
    
    # List OSD storage devices and wait for configuration of newly added OSD to complete.
    system host-stor-list ${HOST}
    

Rook Ceph Storage Backend Configuration (Optional)

To configure the Rook Ceph storage backend, complete the following steps:

Note

Each deployment model enforces a different structure for the Rook Ceph cluster and its integration with the platform.

For more details see StarlingX Storage Configuration and Management: Install Rook Ceph.

  1. Check if the rook-ceph app is uploaded.

    $ source /etc/platform/openrc
    $ system application-list
    
  2. Add Storage-Backend with Deployment Model.

    There are three deployment models: Controller, Dedicated, and Open.

    For the simplex and duplex environments you can use the Controller and Open configuration.

    Controller (default)

    OSDs must only be added to host with controller personality set.

    Replication factor is limited to a maximum of 2.

    This model aligns with the existing Bare-metal Ceph assignment of OSDs to controllers.

    Dedicated

    OSDs must be added only to hosts with the worker personality.

    The replication factor is limited to a maximum of 3.

    This model aligns with existing Bare-metal Ceph use of dedicated storage hosts in groups of 2 or 3.

    Open

    OSDs can be added to any host without limitations.

    Replication factor has no limitations.

    Application Strategies for deployment model controller.

    Duplex, Duplex+ or Standard

    OSDs: Added to controller nodes.

    Replication Factor: Default 1, maximum ‘Any’.

    $ system storage-backend-add ceph-rook --deployment open --confirmed
    $ system storage-backend-list
    +--------------------------------------+-----------------+-----------+----------------------+----------+------------------+---------------------------------------------+
    | uuid                                 | name            | backend   | state                | task     | services         | capabilities                                |
    +--------------------------------------+-----------------+-----------+----------------------+----------+------------------+---------------------------------------------+
    | 0dfef1f0-a5a4-4b20-a013-ef76e92bcd42 | ceph-rook-store | ceph-rook | configuring-with-app | uploaded | block,filesystem | deployment_model: open replication: 2       |
    |                                      |                 |           |                      |          |                  | min_replication: 1                          |
    +--------------------------------------+-----------------+-----------+----------------------+----------+------------------+---------------------------------------------+
    
  3. Set up a host-fs ceph filesystem.

    $ system host-fs-add controller-0 ceph=20
    $ system host-fs-add controller-1 ceph=20
    $ system host-fs-add compute-0 ceph=20
    
  4. List all the disks.

    $ system host-disk-list controller-0
    +--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
    | uuid                                 | device_node | device_num | device_type | size_gib | available_gib | rpm          | serial_id           | device_path                                |
    +--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
    | 7f2b9ff5-b6ee-4eaf-a7eb-cecd3ba438fd | /dev/sda    | 2048       | HDD         | 292.968  | 0.0           | Undetermined | VB3e6c5449-c7224b07 | /dev/disk/by-path/pci-0000:00:0d.0-ata-1.0 |
    | fdaf3f71-a2df-4b40-9e70-335900f953a3 | /dev/sdb    | 2064       | HDD         | 9.765    | 0.0           | Undetermined | VB323207f8-b6b9d531 | /dev/disk/by-path/pci-0000:00:0d.0-ata-2.0 |
    | ced60373-0dbc-4bc7-9d03-657c1f92164a | /dev/sdc    | 2080       | HDD         | 9.765    | 9.761         | Undetermined | VB49833b9d-a22a2455 | /dev/disk/by-path/pci-0000:00:0d.0-ata-3.0 |
    +--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
    $ system host-disk-list controller-1
    +--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
    | uuid                                 | device_node | device_num | device_type | size_gib | available_gib | rpm          | serial_id           | device_path                                |
    +--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
    | 119533a5-bc66-47e0-a448-f0561871989e | /dev/sda    | 2048       | HDD         | 292.968  | 0.0           | Undetermined | VBb1b06a09-6137c63a | /dev/disk/by-path/pci-0000:00:0d.0-ata-1.0 |
    | 03cbb10e-fdc1-4d84-a0d8-6e02c22e3251 | /dev/sdb    | 2064       | HDD         | 9.765    | 0.0           | Undetermined | VB5fcf59a9-7c8a531b | /dev/disk/by-path/pci-0000:00:0d.0-ata-2.0 |
    | 7351013f-8280-4ff3-88bd-76e88f14fa2f | /dev/sdc    | 2080       | HDD         | 9.765    | 9.761         | Undetermined | VB0d1ce946-d0a172c4 | /dev/disk/by-path/pci-0000:00:0d.0-ata-3.0 |
    +--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
    $ system host-disk-list compute-0
    +--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
    | uuid                                 | device_node | device_num | device_type | size_gib | available_gib | rpm          | serial_id           | device_path                                |
    +--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
    | 14245695-46df-43e8-b54b-9fb3c22ac359 | /dev/sda    | 2048       | HDD         | 292.     | 0.0           | Undetermined | VB8ac41a93-82275093 | /dev/disk/by-path/pci-0000:00:0d.0-ata-1.0 |
    | 765d8dff-e584-4064-9c95-6ea3aa25473c | /dev/sdb    | 2064       | HDD         | 9.765    | 0.0           | Undetermined | VB569d6dab-9ae3e6af | /dev/disk/by-path/pci-0000:00:0d.0-ata-2.0 |
    | c9b4ed65-da32-4770-b901-60b56fd68c35 | /dev/sdc    | 2080       | HDD         | 9.765    | 9.761         | Undetermined | VBf88762a8-9aa3315c | /dev/disk/by-path/pci-0000:00:0d.0-ata-3.0 |
    +--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
    
  5. Choose empty disks and provide hostname and uuid to finish OSD configuration:

    $ system host-stor-add controller-0 osd fdaf3f71-a2df-4b40-9e70-335900f953a3
    $ system host-stor-add controller-1 osd 03cbb10e-fdc1-4d84-a0d8-6e02c22e3251
    $ system host-stor-add compute-0 osd c9b4ed65-da32-4770-b901-60b56fd68c35
    
  6. Apply the rook-ceph application.

    $ system application-apply rook-ceph
    
  7. Wait for OSDs pod to be ready.

    $ kubectl get pods -n rook-ceph
    NAME                                                     READY   STATUS      RESTARTS      AGE
    ceph-mgr-provision-nh6dl                                 0/1     Completed   0                18h
    csi-cephfsplugin-2nnwf                                   2/2     Running     10 (3h9m ago)    18h
    csi-cephfsplugin-flbll                                   2/2     Running     14 (3h42m ago)   18h
    csi-cephfsplugin-provisioner-5467c6c4f-98fxk             5/5     Running     5 (4h7m ago)     18h
    csi-cephfsplugin-zzskz                                   2/2     Running     17 (168m ago)    18h
    csi-rbdplugin-42ldl                                      2/2     Running     17 (168m ago)    18h
    csi-rbdplugin-8xzxz                                      2/2     Running     14 (3h42m ago)   18h
    csi-rbdplugin-b6dvk                                      2/2     Running     10 (3h9m ago)    18h
    csi-rbdplugin-provisioner-fd84899c-6795x                 5/5     Running     5 (4h7m ago)     18h
    rook-ceph-crashcollector-compute-0-59f554f6fc-5s5cz      1/1     Running     0                4m19s
    rook-ceph-crashcollector-controller-0-589f5f774-b2297    1/1     Running     0                3h2m
    rook-ceph-crashcollector-controller-1-68d66b9bff-njrhg   1/1     Running     1 (4h7m ago)     18h
    rook-ceph-exporter-compute-0-569b65cf6c-xhfjk            1/1     Running     0                4m14s
    rook-ceph-exporter-controller-0-5fd477bb8-rzkqd          1/1     Running     0                3h2m
    rook-ceph-exporter-controller-1-6f5d8695b9-772rb         1/1     Running     1 (4h7m ago)     18h
    rook-ceph-mds-kube-cephfs-a-654c56d89d-mdklw             2/2     Running     11 (166m ago)    18h
    rook-ceph-mds-kube-cephfs-b-6c498f5db4-5hbcj             2/2     Running     2 (166m ago)     3h2m
    rook-ceph-mgr-a-5d6664f544-rgfpn                         3/3     Running     9 (3h42m ago)    18h
    rook-ceph-mgr-b-5c4cb984b9-cl4qq                         3/3     Running     0                168m
    rook-ceph-mgr-c-7d89b6cddb-j9hxp                         3/3     Running     0                3h9m
    rook-ceph-mon-a-6ffbf95cdf-cvw8r                         2/2     Running     0                3h9m
    rook-ceph-mon-b-5558b5ddc7-h7nhz                         2/2     Running     2 (4h7m ago)     18h
    rook-ceph-mon-c-6db9c888cb-mfxfh                         2/2     Running     0                167m
    rook-ceph-operator-69b5674578-k6k4j                      1/1     Running     0                8m10s
    rook-ceph-osd-0-dd94574ff-dvrrs                          2/2     Running     2 (4h7m ago)     18h
    rook-ceph-osd-1-5d7f598f8f-88t2j                         2/2     Running     0                3h9m
    rook-ceph-osd-2-6776d44476-sqnlj                         2/2     Running     0                4m20s
    rook-ceph-osd-prepare-compute-0-ls2xw                    0/1     Completed   0                5m16s
    rook-ceph-osd-prepare-controller-0-jk6bz                 0/1     Completed   0                5m27s
    rook-ceph-osd-prepare-controller-1-d845s                 0/1     Completed   0                5m21s
    rook-ceph-provision-vtvc4                                0/1     Completed   0                17h
    rook-ceph-tools-7dc9678ccb-srnd8                         1/1     Running     1 (4h7m ago)     18h
    stx-ceph-manager-664f8585d8-csl7p                        1/1     Running     1 (4h7m ago)     18h
    
  8. Check ceph cluster health.

    $ ceph -s
       cluster:
          id:     5b579aca-617f-4f2a-b059-73e7071111dc
          health: HEALTH_OK
    
       services:
          mon: 3 daemons, quorum a,b,c (age 2h)
          mgr: a(active, since 2h), standbys: c, b
          mds: 1/1 daemons up, 1 hot standby
          osd: 3 osds: 3 up (since 82s), 3 in (since 2m)
    
       data:
          volumes: 1/1 healthy
          pools:   4 pools, 113 pgs
          objects: 26 objects, 648 KiB
          usage:   129 MiB used, 29 GiB / 29 GiB avail
          pgs:     110 active+clean
                   2   active+clean+scrubbing+deep
                   1   active+clean+scrubbing
    
       io:
          client:   1.2 KiB/s rd, 2 op/s rd, 0 op/s wr
    

Post-Installation Tasks

After completing the installation, perform the following post-installation tasks to fully configure and prepare the system for use. For more information, see Post-Installation Tasks.