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

EBLINUX-26196: Update initrd-generator docs #24

Merged
merged 4 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/images/params.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,11 @@ a meta-package for the kernel binary and modules.

- **packages** _(boot/initrd/root/config)_ \[default: None \]: A list of packages.
For the _root generator_, these packages are installed in the base _deboostrap_ environment.
For the _initrd generator_, these packages will be downloaded and extracted to get the kernel modules.
For the _initrd generator_, these packages will be downloaded, extracted and integrated into the resutling _initrd.img_.
For the _boot generator_, these packages will be downloaded and extracted to get the kernel binary.

- **kernel** _(boot/initrd/root)_ \[default: None \]: Name of the kernel package.
For the _initrd generator_, these packages will be downloaded and extracted to a temporary folder to get the required kernel modules.

- **tar** _(boot)_ \[default: True \]: Flag for packing the boot artifacts as a tarball.
If _embdgen_ is used to write the artifacts to an image, this will preserve the owner and mode of the artifacts.
Expand Down
15 changes: 10 additions & 5 deletions docs/tools/initrd.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ The internal steps are:

1. Read in YAML configuration file
2. Add BusyBox binary
3. Add kernel modules, extracts the specified modules
4. Creates device nodes for initrd image based on the configuration.
5. Copy all specified files and directories into the initrd image
6. Generates init script
7. Generate initrd based on all the files with `cpio`
3. Download and extract additional packages
4. Add kernel modules, extracts the specified modules
5. Creates device nodes for initrd image based on the configuration.
6. Copy all specified files and directories into the initrd image
7. Generate the init script
8. Generate initrd based on all the files using `cpio`

## Configuration options

Expand Down Expand Up @@ -53,4 +54,8 @@ devices:
major: <major_number>
minor: <minor_number>
- ...
# Packages to add, e.g. e2fstools
packages:
- <package name>
- ...
```