Cockpit MicroShift

cockpit-microshift is a Cockpit plugin for guided single-node MicroShift deployment. It installs onto an existing RHEL host over SSH, or creates a local libvirt guest first and then applies the same in-guest RPM-based MicroShift install model.

Quick Start

RPM install

sudo dnf install -y rpm-build
cd /path/to/cockpit-microshift
./build-rpm.sh
sudo dnf install -y ./rpmbuild/RPMS/noarch/cockpit-microshift-*.noarch.rpm

Use the RPM path when you want a package-managed local install.

Source install

sudo mkdir -p /usr/share/cockpit/cockpit-microshift
sudo install -m 0644 src/cockpit-microshift/manifest.json /usr/share/cockpit/cockpit-microshift/
sudo install -m 0644 src/cockpit-microshift/index.html /usr/share/cockpit/cockpit-microshift/
sudo install -m 0644 src/cockpit-microshift/create.html /usr/share/cockpit/cockpit-microshift/
sudo install -m 0644 src/cockpit-microshift/overview.html /usr/share/cockpit/cockpit-microshift/
sudo install -m 0644 src/cockpit-microshift/cockpit-microshift.css /usr/share/cockpit/cockpit-microshift/
sudo install -m 0644 src/cockpit-microshift/cockpit-microshift.js /usr/share/cockpit/cockpit-microshift/
sudo install -m 0644 src/cockpit-microshift/cluster-list.js /usr/share/cockpit/cockpit-microshift/
sudo install -m 0644 src/cockpit-microshift/cluster-overview.js /usr/share/cockpit/cockpit-microshift/
sudo install -m 0755 src/cockpit-microshift/microshift_backend.py /usr/share/cockpit/cockpit-microshift/

Use the source path when you are iterating on local plugin files.

Open Cockpit

sudo systemctl enable --now cockpit.socket

Open https://<host>:9090 and navigate to MicroShift.

Current Support

Area	Current path
MicroShift	4.21
Architecture	x86_64
Cluster shape	single-node
Networking	static host and guest networking
Existing target	RHEL host over SSH
Local target	libvirt/KVM guest created on the Cockpit host
Local storage	directory-backed or logical libvirt pools

Install Model

The final MicroShift installation follows the Red Hat Build of MicroShift host-based RPM model. The create-host path is a convenience layer: it creates a RHEL guest first, waits for SSH, and then runs the same in-guest install flow used by an existing host.

Operator Screens

The create flow keeps target selection, repository access, host preparation, artifact review, and deployment status in one workspace.

The workflow stays host-first: validate the target, render artifacts, install MicroShift, then return for inventory, access, and cleanup.

First Workflow

Existing host

1. Choose Use an existing RHEL host.
2. Provide SSH host, SSH user, SSH key path, registry authentication, and the repository access mode.
3. Review the rendered config.yaml, request summary, and install plan.
4. Start the deployment and watch status from the same Cockpit page.

Create host

1. Choose Create a local libvirt guest.
2. Provide a RHEL qcow2 image source, bridge, static IP, gateway, DNS servers, and guest sizing.
3. Review cloud-init inputs, guest plan, virt-install plan, and MicroShift config.
4. Provision the guest, install MicroShift inside it, and return later for kubeconfig access or cleanup.

Review only

1. Stay in the create flow until artifact review.
2. Inspect config.yaml, request JSON, install plan, and any create-host provisioning artifacts.
3. Deploy only after host networking, repository access, firewall intent, and registry authentication match the intended target.

Workflow Shape

01

Prepare

Confirm Cockpit, SSH access, registry authentication, repository access, and host networking.

Target model ready

02

Create

Choose an existing host or local libvirt guest, then enter host, network, and MicroShift settings.

Deployment intent captured

03

Review

Inspect rendered config, install plan, request summary, and create-host provisioning artifacts.

Generated artifacts verified

04

Install

Run the RPM-based install, track status, retrieve kubeconfig details, rebuild, or destroy local guests.

Local state tracked

Explore

Getting StartedInstall the plugin, check the host, and run the first target-specific workflow.CapabilitiesCheck target patterns, supported assumptions, and backend boundaries.ExamplesUse practical checklists for existing hosts, local guests, review, and cleanup.ReferenceFind install commands, packaging details, runtime files, and backend commands.

What The Plugin Covers

• guided MicroShift deployment onto an existing RHEL host over SSH
• optional local libvirt guest creation before the in-guest install
• rendered config.yaml, request summary, install plan, cloud-init inputs, and virt-install plan review
• deployment status, recent output, kubeconfig retrieval, and local inventory
• destroy and clean rebuild actions for local create-host deployments