Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Note 1.0 status re CLI/APIs #519

Merged
merged 1 commit into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ 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.

# Status

NOTE: At the current time, bootc has not reached 1.0, and it is possible
that some APIs and CLIs may change.

# More information

See the [project documentation](https://containers.github.io/bootc/).
11 changes: 11 additions & 0 deletions docs/src/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,14 @@ 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.

# Status

At the current time, bootc has not reached 1.0, and it is possible
that some APIs and CLIs may change. For more information, see
the [1.0 milestone](https://github.com/containers/bootc/milestone/1).

However, the core underlying code uses the [ostree](https://github.com/ostreedev/ostree)
project which has been powering stable operating system updates for
many years. The stability here generally refers to the surface
APIs, not the underlying logic.