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

Document dependencies of flatcar-install script #88

Closed
invidian opened this issue Apr 22, 2020 · 4 comments
Closed

Document dependencies of flatcar-install script #88

invidian opened this issue Apr 22, 2020 · 4 comments
Labels
good first issue Get started with Flatcar contribution with this issue. kind/feature A feature request

Comments

@invidian
Copy link
Member

Current situation
One of the install method of flatcar is using flatcar-install script, which turns out depends on some binaries, which are not documented anywhere. Those binaries may not be available in all environments.

Impact
flatcar-install script may randomly fail when executed across different environments.

Ideal future situation
There should be a documentation of which binaries are used by the script.

Implementation options
Just a list of binaries (and possibly version requirements, if needed) in the documentation would be sufficient.

e.g. to run flatcar-install script from alpine Docker image, following packages needs to be installed (snippets in Dockerfile format):

FROM alpine

RUN apk add -U bash util-linux coreutils gnupg eudev

For Ubuntu, it is:

FROM ubuntu

RUN apt update && apt install -y udev gpg wget
@invidian invidian added the kind/feature A feature request label Apr 22, 2020
@t-lo t-lo added the good first issue Get started with Flatcar contribution with this issue. label Aug 19, 2021
@invidian
Copy link
Member Author

NOTE: with flatcar/init@6371236, it now also require btrfs-progs on Ubuntu or btrfs-progs-extra on alpine.

@invidian
Copy link
Member Author

BTW, this is sort of addressed by flatcar/init#50 ?

@krnowak
Copy link
Member

krnowak commented Sep 14, 2021

Yeah, there are no version checks. I suppose that the documentation could point to the toolset variable in the script for the list of required tools.

@tormath1
Copy link
Contributor

Hi @invidian,

Requirements for flatcar-install have been documented by a Flatcar's contributor in here: flatcar-archive/flatcar-docs#180: https://www.flatcar.org/docs/latest/installing/bare-metal/installing-to-disk/#required-dependencies

Thanks for opening this :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Get started with Flatcar contribution with this issue. kind/feature A feature request
Projects
None yet
Development

No branches or pull requests

4 participants