search

coreos / ignition

First boot installer and configuration tool
https://coreos.github.io/ignition/
Apache License 2.0
807 stars 243 forks source link

docs: mention known users #1887

Closed tormath1 closed 2 weeks ago

tormath1 commented 2 weeks ago

Flatcar is using Ignition since the beginning and we are more than happy with it.

-- Let's make it official? And I would like to mention this again: https://github.com/coreos/afterburn/issues/1076#issuecomment-2163353183

as Flatcar is a good user of Ignition / Afterburn maybe we can help in the maintenance/release process of those software

prestist commented 2 weeks ago

Looking into failing ci (its spans the repo atm)

laenion commented 2 weeks ago

If you want to list more users it would be possible to also add openSUSE MicroOS and SUSE Linux Enterprise Micro to the list :)

tormath1 commented 2 weeks ago

If you want to list more users it would be possible to also add openSUSE MicroOS and SUSE Linux Enterprise Micro to the list :)

@prestist @laenion then what about a "Users" section? I think it's hard to read if we have all the OS in the same sentence. Something like:

# Ignition

Ignition is the utility to manipulate disks during the initramfs.[...]

## Users

- Fedora CoreOS
- RHEL CoreOS
- Flatcar
- openSUSE
- MicroOS
- SUSE Linux Enterprise Micro
laenion commented 2 weeks ago

If you want to list more users it would be possible to also add openSUSE MicroOS and SUSE Linux Enterprise Micro to the list :)

@prestist @laenion then what about a "Users" section? I think it's hard to read if we have all the OS in the same sentence. Something like:

Thanks for doing this - I didn't want to crash your submission, I just wanted to ask whether there was interest in adding more distributions from the maintainers side.

In case there is:

- Fedora CoreOS
- RHEL CoreOS
- Flatcar
- openSUSE
- MicroOS
- SUSE Linux Enterprise Micro

It would be "openSUSE MicroOS" (it's one name).

How about something like:

Ignition is the utility used by several distributions to manipulate disks during the initramfs. This includes partitioning disks, formatting partitions, writing files (regular files, systemd units, etc.), and configuring users. On first boot, Ignition reads its configuration from a source of truth (remote URL, network metadata service, hypervisor bridge, etc.) and applies the configuration.

Known users are:
- Fedora CoreOS
- RHEL CoreOS
- Flatcar
- openSUSE MicroOS
- SUSE Linux Enterprise Micro

Maybe this could also prefixed by

Originally developed for Fedora CoreOS and RHEL CoreOS,

prestist commented 2 weeks ago

@tormath1 and @laenion Yeah that sounds good, I dont see why not. If we are to add a user section, maybe we keep the first bit of the readme i.e instead of what we have now just change the first line to something like

Ignition is a utility created to manipulate disks during the initramfs.

Then we can have the users section and maybe call it "known users" wdyt?

Thank you for working on this! great idea :)

travier commented 2 weeks ago

👍🏻

now just change the first line to something like

s/line/sentence/

RHEL CoreOS

Red Hat Enterprise Linux CoreOS