|
1 | | - |
2 | | -# bootc |
| 1 | +# Common synchronized files |
3 | 2 |
|
4 | | -Transactional, in-place operating system updates using OCI/Docker container images. |
5 | | - |
6 | | -## Motivation |
7 | | - |
8 | | -The original Docker container model of using "layers" to model |
9 | | -applications has been extremely successful. This project |
10 | | -aims to apply the same technique for bootable host systems - using |
11 | | -standard OCI/Docker containers as a transport and delivery format |
12 | | -for base operating system updates. |
13 | | - |
14 | | -The container image includes a Linux kernel (in e.g. `/usr/lib/modules`), |
15 | | -which is used to boot. At runtime on a target system, the base userspace is |
16 | | -*not* itself running in a "container" by default. For example, assuming |
17 | | -systemd is in use, systemd acts as pid1 as usual - there's no "outer" process. |
18 | | -More about this in the docs; see below. |
19 | | - |
20 | | -## Status |
21 | | - |
22 | | -The CLI and API are considered stable. We will ensure that every existing system |
23 | | -can be upgraded in place seamlessly across any future changes. |
24 | | - |
25 | | -## Documentation |
26 | | - |
27 | | -See the [project documentation](https://bootc-dev.github.io/bootc/). |
28 | | - |
29 | | -## Versioning |
30 | | - |
31 | | -Although bootc is not released to crates.io as a library, version |
32 | | -numbers are expected to follow [semantic |
33 | | -versioning](https://semver.org/) standards. This practice began with |
34 | | -the release of version 1.2.0; versions prior may not adhere strictly |
35 | | -to semver standards. |
36 | | - |
37 | | -## Adopters (base and end-user images) |
38 | | - |
39 | | -The bootc CLI is just a client system; it is not tied to any particular |
40 | | -operating system or Linux distribution. You very likely want to actually |
41 | | -start by looking at [ADOPTERS.md](ADOPTERS.md). |
42 | | - |
43 | | -## Community discussion |
44 | | - |
45 | | -- [Github discussion forum](https://github.com/containers/bootc/discussions) for async discussion |
46 | | -- [#bootc-dev on CNCF Slack](https://cloud-native.slack.com/archives/C08SKSQKG1L) for live chat |
47 | | -- Recurring live meeting hosted on [CNCF Zoom](https://zoom-lfx.platform.linuxfoundation.org/meeting/96540875093?password=7889708d-c520-4565-90d3-ce9e253a1f65) each Friday at 15:30 UTC. |
48 | | - |
49 | | -This project is also tightly related to the previously mentioned Fedora/CentOS bootc project, |
50 | | -and many developers monitor the relevant discussion forums there. In particular there's a |
51 | | -Matrix channel and a weekly video call meeting for example: <https://docs.fedoraproject.org/en-US/bootc/community/>. |
52 | | - |
53 | | -## Developing bootc |
54 | | - |
55 | | -Are you interested in working on bootc? Great! See our [CONTRIBUTING.md](CONTRIBUTING.md) guide. |
56 | | -There is also a list of [MAINTAINERS.md](MAINTAINERS.md). |
57 | | - |
58 | | -## Governance |
59 | | -See [GOVERNANCE.md](GOVERNANCE.md) for project governance details. |
60 | | - |
61 | | -## Badges |
62 | | - |
63 | | -[](https://www.bestpractices.dev/projects/10113) |
64 | | -[](https://insights.linuxfoundation.org/project/bootc) |
65 | | -[](https://insights.linuxfoundation.org/project/bootc) |
66 | | -[](https://insights.linuxfoundation.org/project/bootc) |
67 | | - |
68 | | -### Code of Conduct |
69 | | - |
70 | | -The bootc project is a [Cloud Native Computing Foundation (CNCF) Sandbox project](https://www.cncf.io/sandbox-projects/) |
71 | | -and adheres to the [CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). |
72 | | - |
73 | | ---- |
74 | | -The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/trademark-usage/). |
| 3 | +Files placed in this repository are automatically |
| 4 | +synchronized (via a pull request) to all repositories |
| 5 | +in the bootc-dev organization. |
0 commit comments