Image Builder

Please see our Book for more in-depth documentation.

What is Image Builder?

Image Builder is a tool for building Kubernetes virtual machine images across multiple infrastructure providers. The resulting VM images are specifically intended to be used with Cluster API but should be suitable for other setups that rely on Kubeadm.

Useful links

Quick Start for Cluster API Image Builder

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

Image Builder office hours: Mondays (biweekly) at 08:30 PT (Pacific Time) (biweekly). Convert to your timezone.
- Meeting recordings.
Slack channel
Mailing list

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

Goals

To build images for Kubernetes-conformant clusters in a consistent way across infrastructures, providers, and business needs.
- To install all software, containers, and configuration needed by downstream tools such as Cluster API providers, to enable them to pass conformance tests
- Support end users requirements to customize images for their business needs.
To provide assurances in the binaries and configuration in images for purposes of security auditing and operational stability.
- Allow introspection of artifacts, software versions, and configurations in a given image.
- Support repeatable build processes where the same inputs of requested install versions result in the same installed binaries.
To ensure that the creation of images is performed via well defined phases. Where users could choose specific phases that they needed.

Non-Goals

To provide upgrade or downgrade semantics.
To provide guarantees that the software installed provides a fully functional system.
To prescribe the hardware architecture of the build system.

vexxhost/image-builder