Skip to content

Conversation

@frankdavid
Copy link
Contributor

@frankdavid frankdavid commented Jan 6, 2026

🚨🚨 WARNING: DO NOT SUBMIT UNTIL #8234 HAS ROLLED OUT TO ALL NODES 🚨🚨

Config files are passed from the HostOS into the GuestOS using a config media (aka virtual USB stick) which the GuestOS sees as a block device (usually under /dev/sda) containing a vfat filesystem. Previously config files were not directly stored in the filesystem, but they were tarred into a single ic-bootstrap.tar file which was then written to the config media.

The tarring step is unnecessary and makes accessing the config files more difficult since the files have to be untarred first. Furthermore, tars can contain unwanted entries, such as symlinks, devices etc. which can be misused by a malicious host (these are not supported by vfat).

The migration consists of 3 steps:

  1. Prepare GuestOS to read files directly from the config media and fall back to ic-bootstrap.tar when it exists for backwards compatibility. (chore: Consume config directly without untarring (Guest) #8234)

  2. (this PR) Once 1) has been rolled out to all nodes, stop tarring in HostOS.

  3. Once 2) has been rolled out to all nodes, remove fallback from GuestOS.

Config files are passed from the HostOS into the GuestOS using a config media (aka virtual USB stick) which the GuestOS sees as a block device (usually under `/dev/sda`) containing a vfat filesystem. Previously config files were not directly stored in the filesystem, but they were tarred into a single ic-bootstrap.tar file which was then written to the config media.

The tarring step is unnecessary and makes accessing the config files more difficult since the files have to be untarred first. Furthermore, tars can contain unwanted entries, such as symlinks, devices etc. which can be misused by a malicious host (these are not supported by vfat).

The migration consists of 3 steps:
1) Prepare GuestOS to read files directly from the config media and fall back to `ic-bootstrap.tar` when it exists for backwards compatibility. (#8234)
2) (this PR) Once 1) has been rolled out to all nodes, stop tarring in HostOS.
3) Once 2) has been rolled out to all nodes, remove fallback from GuestOS.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also update the documentation here: db75b95057e/ic-os/docs/Configuration.adoc#hostos--guestos

It doesn’t need to be detailed—just want to keep it accurate

.arg("--sort=name")
.arg("--owner=root:0")
.arg("--group=root:0")
.arg("--mtime=UTC 1970-01-01 00:00:00")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fine to drop the mtime. This doesn't impact reproducibility because this code only runs at runtime.

github-merge-queue bot pushed a commit that referenced this pull request Jan 7, 2026
Config files are passed from the HostOS into the GuestOS using a config
media (aka virtual USB stick) which the GuestOS sees as a block device
(usually under `/dev/sda`) containing a vfat filesystem. Previously
config files were not directly stored in the filesystem, but they were
tarred into a single ic-bootstrap.tar file which was then written to the
config media.

The tarring step is unnecessary and makes accessing the config files
more difficult since the files have to be untarred first. Furthermore,
tars can contain unwanted entries, such as symlinks, devices etc. which
can be misused by a malicious host (these are not supported by vfat).

The migration consists of 3 steps:
1) (this PR) Prepare GuestOS to read files directly from the config
media and fall back to `ic-bootstrap.tar` when it exists for backwards
compatibility.

2) Once 1) has been rolled out to all nodes, stop tarring in HostOS
(#8235)

3) Once 2) has been rolled out to all nodes, remove fallback from
GuestOS.
…o-tar-host

# Conflicts:
#	rs/ic_os/config/tool/src/hostos/guestos_bootstrap_image.rs
frankdavid added a commit that referenced this pull request Jan 8, 2026
… tar

This is a temporary solution before #8235 lands so config files necessary during early-boot are available without having to run untar. The HostOS will now include config.json and nns_public_key_override.pem directly on the config media passed to the GuestOS.
github-merge-queue bot pushed a commit that referenced this pull request Jan 8, 2026
… tar (#8269)

This is a temporary solution before
#8235 lands so config files necessary
during early-boot are available without having to run untar. The HostOS
will now include `config.json` and `nns_public_key_override.pem`
directly on the config media passed to the GuestOS.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants