• Stars
    star
    649
  • Rank 69,373 (Top 2 %)
  • Language
    Rust
  • License
    Apache License 2.0
  • Created almost 2 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Boot and upgrade via container images

bootc

Transactional, in-place operating system updates using OCI/Docker container images.

STATUS: Experimental, subject to change!

Motivation

The original Docker container model of using "layers" to model applications has been extremely successful. This project aims to apply the same technique for bootable host systems - using standard OCI/Docker containers as a transport and delivery format for base operating system updates.

The container image includes a Linux kernel (in e.g. /usr/lib/modules), which is used to boot. At runtime on a target system, the base userspace is not itself running in a container by default. For example, assuming systemd is in use, systemd acts as pid1 as usual - there's no "outer" process.

ostree

This project currently leverages significant work done in the ostree project.

In the future, there may be non-ostree backends.

Modeling operating system hosts as containers

The bootc project suggests that Linux operating systems and distributions to provide a new kind of "bootable" base image, distinct from "application" base images. See below for available images.

Effectively, these images contain a Linux kernel - and while this kernel is not used when the image is used via e.g. podman|docker run, it is used when booted via bootc.

In the current defaults, /etc and /var both act a bit like mounted, persistent volumes. More on this in the ostree docs.

Status

At the current time, bootc is in active development and is not quite considered ready for production use. The command line interface might change. There is not yet stable RPC API.

However, it heavily relies on a lot of underlying technologies which are tested, and the goal is to stabilize everything sometime in 2023.

Using bootc

Installing

  • Fedora, CentOS Stream 9: There is a COPR tracking git main with binary packages.

You can also build this project like any other Rust project, e.g. cargo build --release from a git clone.

Base images

Many users will be more interested in base (container) images.

However, bootc itself is not tied to Fedora derivatives; this issue tracks the main blocker for other distributions.

Deriving from and switching to base images

A toplevel goal is that every tool and technique a Linux system administrator knows around how to build, inspect, mirror and manage application containers also applies to bootable host systems.

There are a number of examples in e.g. coreos/layering-examples.

First, build a derived container using any container build tooling.

Using bootc install

The bootc install command will write the current container to a disk, and set it up for booting. In brief, the idea is that every container image shipping bootc also comes with a simple installer that can set a system up to boot from it. Crucially, if you create a derivative container image from a stock OS container image, it also automatically supports bootc install.

For more information, please see docs/install.md.

Switching from an existing ostree-based system

If you have an operating system already using ostree then you can use bootc switch:

$ bootc switch --no-signature-verification quay.io/examplecorp/custom:latest

This will preserve existing state in /etc and /var - for example, host SSH keys and home directories. There may be some issues with uid/gid drift in this scenario however.

Upgrading

Once a chosen container image is used as the boot source, further invocations of bootc upgrade will look for newer versions - again preserving state.

Relationship with other projects

Relationship with podman

It gets a bit confusing to talk about shipping bootable operating systems in container images. Again, to be clear: we are reusing container images as:

  • A build mechanism (including running as a standard OCI container image)
  • A transport mechanism

But, actually when a bootc container is booted, podman (or docker, etc.) is not involved. The storage used for the operating system content is distinct from /var/lib/containers. podman image prune --all will not delete your operating system.

That said, a toplevel goal of bootc is alignment with the https://github.com/containers ecosystem, which includes podman. But more specifically at a technical level, today bootc uses skopeo and hence indirectly containers/image as a way to fetch container images.

This means that bootc automatically also honors many of the knobs available in /etc/containers - specifically things like containers-registries.conf.

In other words, if you configure podman to pull images from your local mirror registry, then bootc will automatically honor that as well.

The simple way to say it is: A goal of bootc is to be the bootable-container analogue for podman, which runs application containers. Everywhere one might run podman, one could also consider using bootc.

Relationship with Kubernetes

Just as podman does not depend on a Kubernetes API server, bootc will also not depend on one.

However, there are also plans for bootc to also understand Kubernetes API types. See configmap/secret support for example.

Perhaps in the future we may actually support some kind of Pod analogue for representing the host state. Or we may define a CRD which can be used inside and outside of Kubernetes.

Relationship with rpm-ostree

Today rpm-ostree directly links to ostree-rs-ext, and hence gains all the same container functionality. This will likely continue. For example, with rpm-ostree (or, perhaps re-framed as "dnf image"), it will continue to work to e.g. dnf install (i.e. rpm-ostree install) on the client side system. However, bootc upgrade would (should) then error out as it will not understand how to upgrade the system.

rpm-ostree also has significant other features such as rpm-ostree kargs etc.

Overall, rpm-ostree is used in several important projects and will continue to be maintained for many years to come.

However, for use cases which want a "pure" image based model, using bootc will be more appealing. bootc also does not e.g. drag in dependencies on libdnf and the RPM stack.

bootc also has the benefit of starting as a pure Rust project; and while it doesn't have an IPC mechanism today, the surface of such an API will be significantly smaller.

Further, bootc does aim to include some of the functionality of zincati.

But all this said: It will be supported to use both bootc and rpm-ostree together; they are not exclusive. For example, bootc status at least will still function even if packages are layered.

Relationship with Fedora CoreOS (and Silverblue, etc.)

Per above, it is a toplevel goal to support a seamless, transactional update from existing OSTree based systems, which includes these Fedora derivatives.

For Fedora CoreOS specifically, see this tracker issue.

See also OstreeNativeContainerStable.

More links

More Repositories

1

podman

Podman: A tool for managing OCI containers and pods.
Go
23,573
star
2

skopeo

Work with remote images registries - retrieving information, images, signing content
Go
8,189
star
3

buildah

A tool that facilitates building OCI images.
Go
7,364
star
4

youki

A container runtime written in Rust
Rust
6,267
star
5

podman-compose

a script to run docker-compose.yml using podman
Python
5,047
star
6

podman-desktop

Podman Desktop is the best free and open source tool to work with Containers and Kubernetes for developers. Get an intuitive and user-friendly interface to effortlessly build, manage, and deploy containers and Kubernetes โ€” all from your desktop.
TypeScript
4,824
star
7

bubblewrap

Low-level unprivileged sandboxing tool used by Flatpak and similar projects
C
3,920
star
8

crun

A fast and lightweight fully featured OCI runtime and C library for running containers
C
3,021
star
9

toolbox

Tool for interactive command line environments on Linux
Shell
2,537
star
10

krunvm

Create microVMs from OCI images
Rust
1,422
star
11

libkrun

A dynamic library providing Virtualization-based process isolation capabilities
Rust
871
star
12

image

Work with containers' images
Go
866
star
13

podman-tui

Podman Terminal UI
Go
639
star
14

storage

Container Storage Library
Go
560
star
15

fuse-overlayfs

FUSE implementation for overlayfs
C
528
star
16

netavark

Container network stack
Rust
528
star
17

udica

This repository contains a tool for generating SELinux security profiles for containers
Python
487
star
18

podlet

Generate Podman Quadlet files from a Podman command, compose file, or existing object
Rust
460
star
19

composefs

a file system for mounting container images
C
441
star
20

conmon

An OCI container runtime monitor.
C
420
star
21

podman-desktop-extension-bootc

Support for bootable OS containers (bootc) and generating disk images
TypeScript
411
star
22

build

another build tool for container images (archived, see https://github.com/rkt/rkt/issues/4024)
Go
342
star
23

quadlet

C
342
star
24

oci-seccomp-bpf-hook

OCI hook to trace syscalls and generate a seccomp profile
Go
301
star
25

ansible-podman-collections

Repository for Ansible content that can include playbooks, roles, modules, and plugins for use with the Podman tool
Python
266
star
26

gvisor-tap-vsock

A new network stack based on gVisor
Go
258
star
27

podman.io_old

Repository for podman.io website using GitHub Pages.
CSS
258
star
28

container-selinux

SELinux policy files for Container Runtimes
Roff
254
star
29

podman-py

Python bindings for Podman's RESTful API
Python
253
star
30

ramalama

The goal of RamaLama is to make working with AI boring.
Shell
231
star
31

oci-spec-rs

OCI Runtime, Image and Distribution Spec in Rust
Rust
208
star
32

common

Location for shared common files in github.com/containers repos.
Go
188
star
33

conmon-rs

An OCI container runtime monitor written in Rust
Rust
186
star
34

aardvark-dns

Authoritative dns server for A/AAAA container records. Forwards other request to host's /etc/resolv.conf
Rust
184
star
35

dnsname

name resolution for containers
Go
177
star
36

podman-desktop-extension-ai-lab

Work with LLMs on a local environment using containers
TypeScript
175
star
37

docker-lvm-plugin

Docker volume plugin for LVM volumes
Go
155
star
38

crun-vm

Run VM disk images using Podman / Docker / Kubernetes.
Rust
146
star
39

ocicrypt

Encryption libraries for Encrypted OCI Container images
Go
144
star
40

virtcontainers

A Go package for building hardware virtualized container runtimes
Go
139
star
41

prometheus-podman-exporter

Prometheus exporter for podman environments exposing containers, pods, images, volumes and networks information.
Go
134
star
42

fetchit

FetchIt is used to manage the life cycle and configuration of Podman containers
Go
124
star
43

containrs

General purpose container library
Rust
120
star
44

ai-lab-recipes

Examples for building and running LLM services and applications locally with Podman
Python
108
star
45

bluechi

Bluechi is a systemd service controller intended for multi-node environments with a predefined number of nodes and with a focus on highly regulated ecosystems such as those requiring functional safety.
C
96
star
46

Demos

Repository is a location of user demos for technologies listed on github.com/containers
Shell
80
star
47

libkrunfw

A dynamic library bundling the guest payload consumed by libkrun
C
77
star
48

omlmd

OCI Artifact for ML model & metadata
Python
69
star
49

shortnames

Shortnames project is collecting registry alias names for shortnames to fully specified container image names.
Python
68
star
50

psgo

A ps(1) AIX-format compatible golang library
Go
58
star
51

nri-plugins

A collection of community maintained NRI plugins
Go
57
star
52

podman.io

The new podman.io design project
TypeScript
53
star
53

libocispec

a C library for accessing OCI runtime and image spec files
Python
52
star
54

tar-diff

Go
51
star
55

python-podman

Python bindings and code examples for using Varlink access to Podman Service
Python
49
star
56

podman-security-bench

Shell
40
star
57

initoverlayfs

C
39
star
58

selinuxd

A daemon that manages SELinux policies on a filesystem
Go
36
star
59

krunkit

Launch configurable virtual machines with libkrun
Rust
36
star
60

nydus-storage-plugin

A storage plugin that provided CRI-O/Podman with the ability to lazy mount nydus images.
Go
34
star
61

podman-desktop-swift

Swift
34
star
62

appstore

Example directory of Kubernetes YAML and Quadlets tested with Podman
Python
30
star
63

BuildSourceImage

Tool to build a source image based on an existing OCI image
Shell
29
star
64

buildah.io

Repository for the buildah.io web site using GitHub Pages.
HTML
26
star
65

ansible-podman

Ansible podman is a package to allow ansible playbooks to manage podman containers
Python
26
star
66

oci-fetch

Simple command line tool for fetching the Open Container Initiative image format over various transports.
Go
24
star
67

containertoolbx.org

Website for the Toolbx project
CSS
24
star
68

qm

QM is a containerized environment for running Functional Safety qm (Quality Management) software
Shell
22
star
69

libhvee

Special purposed library for Windows HyperV control
Go
21
star
70

automation_images

Shell
21
star
71

containers-image-proxy-rs

containers-image-proxy-rs
Rust
20
star
72

podman-wsl-fedora

Root FS image of Fedora for Podman Machine on Windows
20
star
73

podman-machine-qemu

Qemu build for macOS used by the self-contained `podman machine` installer
Shell
19
star
74

podman-bootc

Go
18
star
75

automation

Automation scripts and configurations common across the containers org. repositories
Shell
15
star
76

podman-machine-wsl-os

WSL OS Images for Podman Machine 5.x - based on Fedora
15
star
77

oci-umount

C
13
star
78

docs

Repository for all documentation written about tools hosted at github.com/containers
Shell
12
star
79

bootable

Ruby
11
star
80

netavark-dhcp-proxy-deprecated

DHCP proxy for Netavark
Rust
11
star
81

image_build

Monorepo menagerie of container images and associated build automation
Shell
11
star
82

podhawk

Python
9
star
83

podman-desktop-catalog

Catalog of extensions of Podman Desktop
7
star
84

validator

C
7
star
85

podman-machine-cni

Go
6
star
86

arty

Arty is a tool for managing OCI Artifacts on OCI Registries.
6
star
87

ocidir-rs

Low level Rust library for working with OCI (opencontainers) directories
Rust
5
star
88

PodmanHello

Podman Hello Image Repository
Dockerfile
4
star
89

.github

The README for the containers organization
4
star
90

automation_sandbox

Test-repository for experimenting with in-repo automation tools/settings.
4
star
91

fetchit-desktop-extension

TypeScript
4
star
92

winquit

golang module that supports graceful shutdown of Windows applications
Go
4
star
93

kubensmnt

Shell
4
star
94

podman-desktop-extension-layers-explorer

An extension for Podman Desktop to explore files in Images layers
TypeScript
4
star
95

podman-desktop-e2e

Podman desktop e2e tests
Go
3
star
96

podman-desktop-extension-minikube

TypeScript
3
star
97

nri-plugins-operator

Makefile
3
star
98

luksy

offline encryption/decryption using LUKS formats
Go
3
star
99

release-keys

2
star
100

ContainerPlumbing

Container Plumbing Conference information.
2
star