MetalĀ³ Installer Dev Scripts
This set of scripts configures some libvirt VMs and associated virtualbmc processes to enable deploying to them as dummy baremetal nodes.
We are using this repository as a work space for development environment setup and convenience/test scripts, the main logic needed to enable bare metal provisioning is now integrated into the go-based openshift-installer and other components of OpenShift via support for a baremetal platform type.
Pre-requisites
- CentOS 7.5 or greater (installed from 7.4 or newer) or RHEL8 host
- file system that supports d_type (see Troubleshooting section for more information)
- ideally on a bare metal host with at least 64G or RAM
- run as a user with passwordless sudo access
- get a valid pull secret (json string) from https://cloud.openshift.com/clusters/install#pull-secret
- hostnames for masters and workers must be in the format XX-master-# (e.g. openshift-master-0), or XX-worker-# (e.g. openshift-worker-0)
Instructions
Configuration
Make a copy of the config_example.sh
to config_$USER.sh
, and set the
PULL_SECRET
variable to the secret obtained from cloud.openshift.com.
There are variable defaults set in both the common.sh
and the ocp_install_env.sh
scripts, which may be important to override for your particular environment. You can
set override values in your config_$USER.sh
script.
Baremetal
For baremetal test setups where you don't require the VM fake-baremetal nodes,
you may also set NODES_FILE
to reference a manually created json file with
the node details (see ironic_hosts.json.example -
make sure the ironic nodes names follow the openshift-master-* and openshift-worker-*
format), and NODES_PLATFORM
which can be set to e.g "baremetal" to disable the libvirt
master/worker node setup. See common.sh for other variables that
can be overridden.
Important values to consider for override in your config_$USER.sh
script:
# Deploy only the masters and no workers
NUM_WORKERS=0
# Indicate that this is a baremetal deployment
NODES_PLATFORM="baremetal"
# Path to your ironic_hosts.json file per the above
NODES_FILE="/root/dev-scripts/ironic_hosts.json"
# Set to the interface used by the baremetal bridge
INT_IF="em2"
# Set to the interface used by the provisioning bridge on the bootstrap host
PRO_IF="em1"
# Set to the interface used as the provisioning interface on the cluster nodes
CLUSTER_PRO_IF="ens1"
# Don't allow the baremetal bridge to be managed by libvirt
MANAGE_BR_BRIDGE="n"
# Set your valid DNS domain
BASE_DOMAIN=your.valid.domain.com
# Set your valid DNS cluster name
# (will be used as ${CLUSTER_NAME}.${BASE_DOMAIN}
CLUSTER_NAME=clustername
# Set your valid DNS VIP, such as 1.1.1.1 for 'ns1.example.com'
DNS_VIP="1.1.1.1"
# Set to the subnet in use on the external (baremetal) network
EXTERNAL_SUBNET="192.168.111.0/24"
Installation
For a new setup, run:
make
The Makefile will run the scripts in this order:
./01_install_requirements.sh
This installs any prerequisite packages, and also starts a local container registry to enable subsequent scripts to build/push images for testing. Any other dependencies for development/test are also installed here.
./02_configure_host.sh
This does necessary configuration on the host, e.g networking/firewall and also creates the libvirt resources necessary to deploy on VMs as emulated baremetal.
This should result in some (stopped) VMs on the local virthost and some
additional bridges/networks for the baremetal
and provisioning
networks.
./04_setup_ironic.sh
This will setup containers related to the Ironic deployment services which run on the bootstrap VM and deployed cluster. It will start a webserver which caches the necessary images, starts virtual BMC services to control the VMs via IPMI or Redfish.
This script also can optionally build/push custom images for Ironic and other components see the Testing custom container images section below.
./06_create_cluster.sh
This will extract openshift-install from the OCP release payload and
run openshift-install
to generate ignition configs for the
bootstrap node and the masters. The installer then launches both the
bootstrap VM and master nodes using the Terraform providers for libvirt
and Ironic. Once bootstrap is complete, the installer removes the
bootstrap node and the cluster will be online.
You can view the IP for the bootstrap node by running virsh net-dhcp-leases baremetal
. You can SSH to it using ssh core@IP.
Then you can interact with the k8s API on the bootstrap VM e.g
sudo oc status --verbose --config /etc/kubernetes/kubeconfig
.
You can also see the status of the bootkube.sh script which is running via
journalctl -b -f -u bootkube.service
.
Interacting with the deployed cluster
When the master nodes are up and the cluster is active, you can interact with the API:
$ oc --config ocp/auth/kubeconfig get nodes
NAME STATUS ROLES AGE VERSION
master-0 Ready master 20m v1.12.4+50c2f2340a
master-1 Ready master 20m v1.12.4+50c2f2340a
master-2 Ready master 20m v1.12.4+50c2f2340a
Interacting with Ironic directly
The dev-scripts repository contains a clouds.yaml
file with
connection settings for both instances of Ironic. The copy of Ironic
that runs on the bootstrap node during installation can be accessed by
using the cloud name metal3-bootstrap
and the copy running inside
the cluster once deployment is finished can be accessed by using the
cloud name metal3
.
The dev-scripts will install the openstack
command line tool on the
provisioning host as part of setting up the cluster. The openstack
tool will look for clouds.yaml
in the current directory or you can
copy it to ~/.config/openstack/clouds.yaml
. Version 3.19.0 or
higher is needed to interact with ironic using clouds.yaml
.
$ openstack --version
openstack 3.19.0
For manual debugging via the openstack client connecting to the bootstrap VM, which is ephemeral and won't be available once the masters have been deployed:
export OS_CLOUD=metal3-bootstrap
openstack baremetal node list
...
To access the Ironic instance running in the baremetal-operator pod:
export OS_CLOUD=metal3
openstack baremetal node list
NOTE: If you use a provisioning network other than the default, you may need to modify the IP addresses used in
Cleanup
-
To clean up the ocp deployment run
./ocp_cleanup.sh
-
To clean up the dummy baremetal VMs and associated libvirt resources run
./host_cleanup.sh
e.g. to clean and re-install ocp run:
./ocp_cleanup.sh
rm -fr ocp
./06_create_cluster.sh
Or, you can run make clean
which will run all of the cleanup steps.
Troubleshooting
If you're having trouble, try systemctl restart libvirtd
.
You can use:
virsh console domain_name
Determining your filesystem type
If you're not sure what filesystem you have, try df - T
and the second
column will include the type.
Determining if your filesystem supports d_type
If the above command returns ext4 or btrfs, d_type is supported by default. If not, at the command line, try:
xfs_info /mount-point
If you see ftype=1
then you have d_type support.
Modifying cpu/memory/disk resources
The default cpu/memory/disk resources when using virtual machines are provided by the vm_setup_vars.yml file, which sets some dev-scripts variables that override the defaults in metal3-dev-env
Testing custom container images
dev-scripts uses an openshift release image that contains references to openshift
containers, any of these containers can be overridden by setting environment
variables of the form <NAME>_LOCAL_IMAGE
to build or use copy of container
images locally e.g. to use a custom ironic container image and build a container
image from a git repository for the machine-config-operator you could set
export IRONIC_LOCAL_IMAGE=quay.io/username/ironic
export MACHINE_CONFIG_OPERATOR_LOCAL_IMAGE=https://github.com/openshift/machine-config-operator
The value for <NAME>
needs to match the name of the tags for images (found in the
openshift release images in /release-manifests/image-references), converted to uppercase
and with "-"'s converted to "_"'s.
Testing a custom machine-api-operator image with this deployment
The script run-custom-mao.sh
allows the machine-api-operator pod to be re-deployed with a custom image.
For example:
./run-custom-mao.sh <path in quay.io for the custom MAO image with tag> <repo name> <branch name>
Custom MAO image name is a mandatory parameter but the others are optional with defaults.
Alternatively, all input parameters can be set via CUSTOM_MAO_IMAGE
, REPO_NAME
and MAO_BRANCH
variables respectively,
and run-custom-mao.sh
can be run automatically if you set TEST_CUSTOM_MAO
to true.