Skip to content

workflows.md

Latest commit

 

History

History
152 lines (109 loc) · 6.78 KB

workflows.md

File metadata and controls

152 lines (109 loc) · 6.78 KB
Raw

GitHub Workflows

The GitHub Workflows are defined at the .github/workflows folder, including pre-submit tests and software release procedures.

  • Pre-submit tests are run automatically before a pull request can be merged
  • Software release procedures can be run under the Actions tab by the repository maintainers, or scheduled for regular automatic execution

Note: Contributors can create a fork from the MicroShift Upstream repository and run software release workflows in their private repository branches.

The remainder of this document describes the existing workflows and their functionality.

Pre-submit Workflows

The workflows described in this section are run as a prerequisite for merging a pull request into the main branch. If any of these procedures exit with errors, the pull request cannot be merged before all the errors are fixed.

Builders

Build a MicroShift Bootc image from the main MicroShift source branch and the latest published OKD version tag. Run this image to verify that all the MicroShift services are functional.

The following operating systems are tested:

  • Fedora for RPM packages and Bootc images on the x86_64 and aarch64 architectures
  • CentOS 9 and CentOS 10 for RPM packages and Bootc images on the x86_64 architecture
  • Ubuntu for DEB packages on the x86_64 architecture

The following configurations are tested:

  • Multi-node (2-node) clusters for all online Bootc image tests
  • Online networking for the Kindnet CNI and isolated networking for the OVN-K and Kindnet CNIs, including primary pod traffic and cluster DNS. Isolated tests also verify that node egress is blocked. The OVN-K with Multus variant verifies same-node traffic over a bridge network with host-local IP address management.

Installers

Run the Quick Start procedures to verify:

  • The latest published RPM packages on the supported operating systems and architectures
  • The latest published Bootc images on the supported architectures

The quick clean script is called in the end to verify the uninstall procedure.

Linters

Run ShellCheck on all shell scripts and hadolint on all container files in the repository.

Software Release Procedures

MicroShift

The workflow implements a build process producing MicroShift RPM packages, DEB packages and Bootc container image artifacts. It is executed manually by the repository maintainers - no scheduled runs are configured at this time.

The following parameters determine the MicroShift source code branch and the OKD container image dependencies used during the build process.

The following actions are supported:

  • packages: Build MicroShift RPM and DEB packages
  • bootc-image: Build a MicroShift Bootc container image
  • all: Build all of the above

Note: After the Bootc container image is built, a workflow step checks it by attempting to run the container image and verifying that all the MicroShift services are functional.

If the build job finishes successfully, the artifact download and installation instructions are available at Releases.

Note: The available container images can be listed at Packages and pulled from the ghcr.io/microshift-io registry.

OKD on ARM

The workflow implements a build process producing a subset of OKD container image artifacts that are required by MicroShift on the aarch64 architecture. It runs every day at 03:00 UTC to make sure ARM artifacts are available for the latest OKD releases.

Note: OKD aarch64 builds are performed using MicroShift-specific build procedure until OKD Build of OpenShift on Arm is implemented by the OKD team.

The following parameters determine the MicroShift source code branch and the OKD container image dependencies used during the build process.

The default target registry for publishing OKD container image artifacts is ghcr.io/microshift-io/okd.

Note: After the OKD container images are built, a workflow step checks them by creating a MicroShift Bootc image with the new artifacts, attempting to run it, and verifying that all the MicroShift services work.

If the build job finishes successfully, the available container images can be listed at Packages and pulled from the ghcr.io/microshift-io registry.

COPR Nightly

The workflow builds and publishes MicroShift RPM packages to the Fedora COPR @microshift-io/microshift-nightly repository every day at 01:00 UTC. It can also be triggered manually with a custom COPR repository name.

The build process includes MicroShift RPMs, dependency RPMs and CNI plugin RPMs. After the RPMs are built, a Bootc image is created from the COPR packages and tested using the quick-start procedure on both x86_64 and aarch64 architectures.

Note: This workflow uses the reusable copr-build-and-test workflow internally.

COPR Experimental

The workflow allows contributors to build MicroShift RPM packages from a fork repository branch and publish them to a specified COPR repository. It is executed manually by the repository maintainers.

The following parameters are required:

  • Fork repository (e.g., user/microshift)
  • Branch name to build
  • COPR repository name (e.g., @microshift-io/experimental-name)

Note: This workflow uses the reusable copr-build-and-test workflow internally.

Scheduled Tests

CNCF Conformance

The workflow runs the CNCF conformance test suite using Sonobuoy in certified-conformance mode for official Kubernetes conformance certification. It runs every day at 04:00 UTC and can also be triggered manually.

The tests are executed on a 2-node MicroShift cluster using pre-built Bootc images from the latest published release. Both x86_64 and aarch64 architectures are tested. Test results are uploaded as workflow artifacts with 30-day retention.

The following parameters can be configured for manual runs:

  • MicroShift version to test (default: latest published release)
  • Container registry to pull Bootc images from (default: ghcr.io/microshift-io)
  • Sonobuoy test timeout in seconds (default: 8400)