run.md

MicroShift Host Deployment

MicroShift can be run on the host or inside a Bootc container. This document describes how to run MicroShift on the host.

See MicroShift Bootc Deployment on how to run MicroShift inside a Bootc container.

MicroShift RPM Packages

Install RPM

The following optional RPM packages are available in the repository. It is mandatory to install either microshift-kindnet or microshift-networking to enable the Kindnet or OVN-K networking support.

Package	Description	Comments
microshift-kindnet	Kindnet CNI	Overrides OVN-K
microshift-networking	OVN-K CNI	Uninstall Kindnet to enable OVN-K
microshift-topolvm	TopoLVM CSI	Install to enable storage support
microshift-olm	Operator Lifecycle Manager	See Operator Hub Catalogs

RPMs from Releases or built locally

Run the following commands to install MicroShift RPM packages from a local repository. This repository should be either built locally or downloaded from Releases.

RPM_REPO_DIR=/tmp/microshift-rpms

sudo ./src/rpm/create_repos.sh -create "${RPM_REPO_DIR}"
sudo dnf install -y microshift microshift-kindnet
sudo ./src/rpm/create_repos.sh -delete

RPMs from the COPR

Run the following commands to install MicroShift nightly RPM packages from the COPR. Before installing MicroShift, RHOCP beta mirror must be enabled to provide dependencies.

Note: By skipping create_repos.sh -delete users can keep the RPM repositories configuration and use dnf update to update MicroShift and its dependencies (withing single Major.Minor release when new MicroShift minor version is released, rerunning the create_repos.sh -rhocp-mirror might be necessary to enable newer dependency repository).

sudo dnf copr enable -y @microshift-io/microshift-nightly
sudo ./src/rpm/create_repos.sh -rhocp-mirror
sudo dnf install -y microshift microshift-kindnet
# Optionally run the following command to remove the configured MicroShift COPR and dependencies repositories.
# sudo ./src/rpm/create_repos.sh -delete

Start MicroShift Service

Run the following commands to configure the minimum required firewall rules, disable LVMS, and start the MicroShift service.

sudo ./src/rpm/postinstall.sh
sudo systemctl start microshift.service

Verify that all the MicroShift pods are up and running successfully.

mkdir -p ~/.kube
sudo cat /var/lib/microshift/resources/kubeadmin/kubeconfig > ~/.kube/config

kubectl get pods -A

MicroShift DEB Packages

Install DEB

Run the following commands to install MicroShift DEB packages from the RPM repository. This repository should be either built locally or downloaded from Releases.

DEB_REPO_DIR=/tmp/microshift-rpms/deb
sudo ./src/deb/install.sh "${DEB_REPO_DIR}"

The following optional DEB packages are available in the repository.

Package	Description	Comments
microshift-topolvm	TopoLVM CSI	Install to enable storage support
microshift-olm	Operator Lifecycle Manager	See Operator Hub Catalogs

Note: All of the optional packages are installed by default.

Start MicroShift Service

Run the following command to start the MicroShift service. All the necessary system configuration was performed during the installation step.

sudo systemctl start microshift.service

Verify that all the MicroShift pods are up and running successfully.

mkdir -p ~/.kube
sudo cat /var/lib/microshift/resources/kubeadmin/kubeconfig > ~/.kube/config

kubectl get pods -A

Cleanup

RPM

Run the following commands to delete all the MicroShift data and uninstall the MicroShift RPM packages.

echo y | sudo microshift-cleanup-data --all
sudo dnf remove -y 'microshift*'

DEB

Run the following commands to delete all the MicroShift data and uninstall the MicroShift DEB packages.

echo y | sudo microshift-cleanup-data --all
sudo apt purge -y 'microshift*'