Skip to content

Conversation

@bchalios
Copy link
Contributor

@bchalios bchalios commented Oct 16, 2024

Changes

Add a devtool command to build CI artifacts. The command calls resources/rebuild.sh within the dev container, since the script itself assumes an Ubuntu host environment.

Also, update the documentation about building guest kernels to point to this script

Reason

Add a command that allows us to build CI artifact kernels locally and also fix the broken documentation about building guest kernels.

Fixes #4757

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.

PR Checklist

  • If a specific issue led to this PR, this PR closes the issue.
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this
    PR.
  • API changes follow the Runbook for Firecracker API changes.
  • User-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.
  • New TODOs link to an issue.
  • Commits meet
    contribution quality standards.

  • This functionality cannot be added in rust-vmm.

@bchalios bchalios requested a review from pb8o October 16, 2024 15:02
@bchalios bchalios added the Status: Awaiting review Indicates that a pull request is ready to be reviewed label Oct 16, 2024
@codecov
Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.05%. Comparing base (588e77a) to head (3b602dc).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4856   +/-   ##
=======================================
  Coverage   84.05%   84.05%           
=======================================
  Files         251      251           
  Lines       28061    28061           
=======================================
  Hits        23588    23588           
  Misses       4473     4473           
Flag Coverage Δ
5.10-c5n.metal 84.68% <ø> (ø)
5.10-m5n.metal 84.67% <ø> (ø)
5.10-m6a.metal 83.97% <ø> (-0.01%) ⬇️
5.10-m6g.metal 80.67% <ø> (ø)
5.10-m6i.metal 84.66% <ø> (-0.01%) ⬇️
5.10-m7g.metal 80.67% <ø> (ø)
6.1-c5n.metal 84.68% <ø> (ø)
6.1-m5n.metal 84.66% <ø> (ø)
6.1-m6a.metal 83.97% <ø> (ø)
6.1-m6g.metal 80.67% <ø> (ø)
6.1-m6i.metal 84.66% <ø> (-0.01%) ⬇️
6.1-m7g.metal 80.67% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Script `resources/rebuild.sh` is used mainly to help us re-build CI
artifacts. Sometimes, for debugging we would like to be able to build
kernels or the rootfs locally. Also, we would like to be able to build
each component individually, e.g. only the root filesystem or only guest
kernel 6.1.

Make the script a bit more clever, adding options for building only
rootfs or only kernels (all of them or a single one). Leave the default
behaviour intact so we don't break any of its current users.

Signed-off-by: Babis Chalios <[email protected]>
Running resources/rebuild.sh script assumes an Ubuntu host (it relies on
apt). Add a new `build_ci_artifacts` command in devtool that runs the
script inside devctr. This allows us to build CI artifacts without
necessarily being in an Ubuntu system.

Also, extend resources/rebuild.sh to perform some cleanup after running
commands so, at the end, it only produces the directory with the
artifacts and no intermediate by-products.

Signed-off-by: Babis Chalios <[email protected]>
Building CI artifacts produces some folders under resources/ directory.
Include them in .gitignore to avoid, mistakenly, adding them in a git
commit.

Signed-off-by: Babis Chalios <[email protected]>
Documentation for building guest kernels was pointing to a devtool
command that does not exist any more. Fix that by pointing to the newly
added `./tools/devtool build_ci_artifacts` command. Also, fix rootfs
instructions to use this command rather than directly calling
`resources/rebuild.sh` which assumes an Ubuntu host.

Signed-off-by: Babis Chalios <[email protected]>
@bchalios bchalios merged commit d84d76c into firecracker-microvm:main Oct 17, 2024
5 checks passed
bchalios added a commit to bchalios/firecracker that referenced this pull request Oct 17, 2024
PR firecracker-microvm#4856
extended the `fix_perms` devtool command to also fix permissions of the
directory in which we put CI artifacts from `build_ci_artifacts`
command.

Since, we are now calling `fix_perms` from two different "workflows",
i.e. build/test and CI artifacts building, it might be the case that
some of the directories `fix_perms` is trying to fix permissions for,
don't exist.

Add `-f` flag to `chown` command of `fix_perms`, to avoid issues.

Signed-off-by: Babis Chalios <[email protected]>
@bchalios bchalios mentioned this pull request Oct 17, 2024
9 tasks
bchalios added a commit that referenced this pull request Oct 17, 2024
PR #4856
extended the `fix_perms` devtool command to also fix permissions of the
directory in which we put CI artifacts from `build_ci_artifacts`
command.

Since, we are now calling `fix_perms` from two different "workflows",
i.e. build/test and CI artifacts building, it might be the case that
some of the directories `fix_perms` is trying to fix permissions for,
don't exist.

Add `-f` flag to `chown` command of `fix_perms`, to avoid issues.

Signed-off-by: Babis Chalios <[email protected]>
@bchalios bchalios deleted the ci_build_kernels branch October 22, 2024 15:05
ShadowCurse pushed a commit to ShadowCurse/firecracker that referenced this pull request Nov 5, 2024
PR firecracker-microvm#4856
extended the `fix_perms` devtool command to also fix permissions of the
directory in which we put CI artifacts from `build_ci_artifacts`
command.

Since, we are now calling `fix_perms` from two different "workflows",
i.e. build/test and CI artifacts building, it might be the case that
some of the directories `fix_perms` is trying to fix permissions for,
don't exist.

Add `-f` flag to `chown` command of `fix_perms`, to avoid issues.

Signed-off-by: Babis Chalios <[email protected]>
ShadowCurse pushed a commit to ShadowCurse/firecracker that referenced this pull request Nov 5, 2024
PR firecracker-microvm#4856
extended the `fix_perms` devtool command to also fix permissions of the
directory in which we put CI artifacts from `build_ci_artifacts`
command.

Since, we are now calling `fix_perms` from two different "workflows",
i.e. build/test and CI artifacts building, it might be the case that
some of the directories `fix_perms` is trying to fix permissions for,
don't exist.

Add `-f` flag to `chown` command of `fix_perms`, to avoid issues.

Signed-off-by: Babis Chalios <[email protected]>
ShadowCurse pushed a commit to ShadowCurse/firecracker that referenced this pull request Nov 5, 2024
PR firecracker-microvm#4856
extended the `fix_perms` devtool command to also fix permissions of the
directory in which we put CI artifacts from `build_ci_artifacts`
command.

Since, we are now calling `fix_perms` from two different "workflows",
i.e. build/test and CI artifacts building, it might be the case that
some of the directories `fix_perms` is trying to fix permissions for,
don't exist.

Add `-f` flag to `chown` command of `fix_perms`, to avoid issues.

Signed-off-by: Babis Chalios <[email protected]>
ShadowCurse pushed a commit to ShadowCurse/firecracker that referenced this pull request Nov 5, 2024
PR firecracker-microvm#4856
extended the `fix_perms` devtool command to also fix permissions of the
directory in which we put CI artifacts from `build_ci_artifacts`
command.

Since, we are now calling `fix_perms` from two different "workflows",
i.e. build/test and CI artifacts building, it might be the case that
some of the directories `fix_perms` is trying to fix permissions for,
don't exist.

Add `-f` flag to `chown` command of `fix_perms`, to avoid issues.

Signed-off-by: Babis Chalios <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Status: Awaiting review Indicates that a pull request is ready to be reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix stale documentation regrading building guest kernels

3 participants