containers / containers/podman.io_old

Unclear dependencies

Open
#560 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
254
Forks
126
PR merge metrics
No merged PRs in 30d

Description

Currently, the [installation instructions for building podman from source][building] say that

> The latest version of at least one container runtime is expected to be installed on the system.
> `crun` or `runc` are some of the possibilities, and one is picked up as the default runtime by Podman (crun has priority over runc).
> Supported versions of `crun` or `runc` are available for example on Ubuntu 22.04.
> `runc` version 1.0.0-rc4 is the minimal requirement, which is available since Ubuntu 18.04.
>
> To double-check, `runc --version` should produce at least `spec: 1.0.1`

[building]: https://github.com/containers/podman.io/blob/2a159abffab6e59efc61fc9f5c1c0772cfb44f56/getting-started/installation.md?plain=1#L424

It's not at all clear to me from this what the minimum version for `crun` is. The first sentence says "the latest version is *expected* [my emphasis]" (is this a "minimum requirement", or something more?), and at present the latest version of `crun` [is 1.6](https://github.com/containers/crun/releases/tag/1.6).

If that *is* a minimum requirement, then this sentence seems to be contradicted by the next, which says that "Supported versions of `crun` or `runc` are available for example on Ubuntu 22.04", and the version of `crun` in Ubuntu 22.04 seems to currently be [0.17](https://packages.ubuntu.com/jammy/crun).

And that second sentence seems to be contradicted by the third; on Ubuntu 22.04, running `crun --version` produces the output `spec: 1.0.0`, which is apparently *not* suitable.

Would it not be simpler just to *say* what the minimum required version of `crun` is, once, and what the minimum required version of `runc` is, once, and delete any additional, contradictory sentences?

Contributor guide

No contributing guide indexed for this repository

Research direction

Review getting-started/installation.md at the linked build-from-source section, focusing on the crun and runc requirements and the version checks quoted in the issue. Clarify one minimum version for each runtime, remove contradictory wording, and verify that the instructions state what `crun --version` and `runc --version` should show.

Written by the indexing model from the issue text.

Assessment

Tech stack
ubuntu
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.