Skip to content

Latest commit

 

History

History
182 lines (133 loc) · 5.72 KB

metal3-setup.md

File metadata and controls

182 lines (133 loc) · 5.72 KB
Raw

Intro

Metal3

Metal3 (Metal-Kubed) is an open source tool that provides components for bare metal host management utilizing the Kubernetes native API. (see https://metal3.io/)

Pre-requisite Dependencies

Currently requires one of the following OS choices:

  1. Create a non-root user with sudo access

If one does not already exist e.g:

sudo useradd auser -m -s /bin/bash
sudo echo "auser ALL=NOPASSWD: ALL" > /etc/sudoers.d/auser
sudo su - auser
  1. Clone this metal3-demo repo
git clone https://github.com/suse-edge/metal3-demo.git
  1. Install pre-requisite packages
cd metal3-demo
./01_prepare_host.sh

Configure the host environment

  1. (optional) customize extra_vars.yml

If desired the defaults from extra_vars.yml can be customized, copy the file and export EXTRA_VARS_FILE to reference the copied file location.

  1. Configure the host

  • In the main directory of the repository, execute the script to configure the host:

    ./02_configure_host.sh

Command-line flags may be passed to Ansible via the script, for example to disable DHCP for testing with static-ips you can do:

./02_configure_host.sh -vvv -e "libvirt_network_dhcp=false"

Build images

./03_build_images.sh

Note this configures the environment to deploy management and downstream clusters with openSUSE Leap Micro 6.0, for SLMicro 6.0 follow the additional steps below.

Enable deploying with SLEMicro

If you want to use SLEMicro then a few additional steps are required:

  1. Download the SLE Micro image from the SUSE Customer Center. The version must be 6.0 in raw format.

Note The file downloaded is a xz compressed file. It must be uncompressed before using it as a valid image.

  1. Move the image downloaded into the local directory which will be defined in the environment variable OS_LOCAL_IMAGE.

  2. Generate a registration code so we can install additional packages when customizing the downloaded image, this is defined in the environment variable EIB_REGISTRATION_CODE.

  3. Execute the script to configure the host using the local image:

export OS_LOCAL_IMAGE=/path/to/image.raw
export EIB_REGISTRATION_CODE=<generated registration code>
./03_build_images.sh

Deploy the management cluster and prepare hosts

  1. Create management cluster
./04_launch_mgmt_cluster.sh
  1. Apply the BareMetalHost manifests
kubectl apply -f ~/metal3-demo-files/baremetalhosts

The host will now be registered and inspected, which will take several minutes, you can monitor progress via kubectl get bmh until the host reaches available state

kubectl get bmh

The expected output should resemble the following:

NAME             STATE       CONSUMER   ONLINE   ERROR   AGE
controlplane-0   available              true             9m44s
worker-0         available              true             9m44s

Testing with Static IPs

It is possible to disable the libvirt DHCP server via the libvirt_network_dhcp ansible variable, for example when configuring the host:

./02_configure_host.sh -vvv -e "libvirt_network_dhcp=false"

This disables the <dhcp> stanza in the egress network (check with virsh net-dumpxml egress), and configures the BareMetalHost resources with a static IP via a secret containing nmstate syntax, e.g:

apiVersion: metal3.io/v1alpha1
kind: BareMetalHost
metadata:
  name: controlplane-0
  labels:
    cluster-role: control-plane
spec:
  online: true
  bootMACAddress: "00:bc:1f:c3:8f:f0"
  bmc:
    address: redfish-virtualmedia://192.168.125.1:8000/redfish/v1/Systems/112815c5-b60f-4753-86d9-b25063c7bfc3
    disableCertificateVerification: true
    credentialsName: controlplane-0-credentials
  preprovisioningNetworkDataName: controlplane-0-networkdata
---
apiVersion: v1
kind: Secret
metadata:
  name: controlplane-0-networkdata
type: Opaque
stringData:
  networkData: |
    interfaces:
    - name: enp1s0
      type: ethernet
      state: up
      mac-address: "00:bc:1f:c3:8f:f0"
      ipv4:
        address:
        - ip:  "192.168.125.200"
          prefix-length: "24"
        enabled: true
        dhcp: false
    dns-resolver:
      config:
        server:
        - "192.168.125.1"
    routes:
      config:
      - destination: 0.0.0.0/0
        next-hop-address: "192.168.125.1"
        next-hop-interface: enp1s0

This networkData is consumed by nm-configurator at two stages during deployment:

  • During inspection the IPA ramdisk image runs nmc to configure networking so it can connect back to the ironic/inspector APIs
  • During first-boot the EIB-prepared image contains a script which runs nmc via combustion during the prepare phase

Development Notes

  • You may pass -vvv at the end of the scripts to see more verbose output, or to pass arbitrary additional arguments to ansible-playbook
  • You can interact with Ironic directly on the management-cluster VM for debugging e.g ssh [email protected] baremetal node list
  • For more information about the BareMetalHost resource states refer to the Metal3 documentation
  • If a BareMetalHost resource is stuck in the inspecting state, virsh console can be useful to view the inspection ramdisk output
  • Note that you may need to export LIBVIRT_DEFAULT_URI="qemu:///system" to access the VMs via virsh as a non-root user