coreos / coreos/fedora-coreos-docs

Storage: Clarify that device names such `/dev/sda` may not be stable and recommend using labels for partitions

Open
#643 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
68
Forks
156
Avg merge
14d 2h
Merged PRs (30d)
1

Description

As a first step toward improving things for https://github.com/coreos/fedora-coreos-tracker/issues/1732, we should audit our docs (and Butane's & Ignition's ones) to make sure that we explicitly note that disk devices names may not be stable across boots.

Partitioning using Ignition and mount points should thus use labels as much as possible to reference to disk partitions to make sure they are stable across boots.

Ideally we should provide examples to update existing setups / mount units.

See: https://github.com/openshift/os/blob/master/docs/faq.md#q-how-do-i-configure-a-secondary-block-device-via-ignitionmc-if-the-name-varies-on-each-node

--

As a second step, we need to mention using truly stable names for disks in Ignition config and the corresponding downsides that we have for now.


See: https://github.com/coreos/fedora-coreos-tracker/issues/1732

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by auditing the Fedora CoreOS documentation for storage, partitioning, and mount points, then compare the corresponding Butane and Ignition documentation. Use the linked OpenShift FAQ and Fedora CoreOS tracker issue as references; the work is done when the docs explain device-name instability, recommend stable labels or names, and include guidance for existing setups where appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
linux
Domain
documentation, operating-systems
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.