This repository provides scripts to build and run MicroShift upstream (i.e. without Red Hat subscriptions or a pull secrets).
MicroShift is a project that optimizes OpenShift Kubernetes for small form factor and edge computing. MicroShift Upstream is intended for upstream development and testing by allowing to build MicroShift directly from the original OpenShift MicroShift sources, while replacing the default payload images with OKD (the community distribution of Kubernetes that powers OpenShift).
The goal is to enable contributors and testers to work with an upstream build of MicroShift set up using OKD components, making it easier to develop, verify, and iterate on features outside the downstream Red Hat payloads.
MicroShift and its main components are available on the x86_64
architecture.
RPM packages built in a CentOS Stream 9 Bootc container can be installed and
run on the following operating systems.
OS | Bootc | OVN-K | Kindnet | TopoLVM | Comments |
---|---|---|---|---|---|
CentOS 9 | Y | Y | Y | Y | Latest version in Stream 9 |
CentOS 10 | Y | Y | Y | Y | Latest version in Stream 10 |
Fedora | Y | N | Y | Y | Latest released version (e.g. 42) |
Notes:
- MicroShift Bootc container images can be run on any operating system supported by Podman.
- The support for the
aarch64
architecture depends on OKD Build of OpenShift on Arm.
Prebuilt MicroShift artifacts are published at the Releases page.
Run the following command to quickly run the latest build of MicroShift inside a Bootc container on your host.
curl -s https://microshift-io.github.io/microshift/quickstart.sh | sudo bash
When completed successfully, the command displays information about the system setup, next steps for accessing MicroShift and uninstall instructions.
MicroShift is running in a bootc container
Hostname: 127.0.0.1.nip.io
Container: microshift-okd
LVM disk: /var/lib/microshift-okd/lvmdisk.image
VG name: myvg1
To access the container, run the following command:
- sudo podman exec -it microshift-okd /bin/bash
To verify that MicroShift pods are up and running, run the following command:
- sudo podman exec -it microshift-okd oc get pods -A
To uninstall MicroShift, run the following command:
- curl -s https://microshift-io.github.io/microshift/quickclean.sh | sudo bash