-
Notifications
You must be signed in to change notification settings - Fork 28
reference: development: the-kernel-snap: extend information #281
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,81 @@ | ||
| (reference-development-yaml-schemas-the-kernel-snap)= | ||
| # The kernel snap | ||
|
|
||
| As the name implies, the _kernel_ snap is responsible for defining the Linux kernel that will run in a snap-based system. The correct kernel snap for a given system is selected via the model assertion, produced and signed by the device's brand account before the image is built. Once the image is built, the kernel snap may be updated, but it cannot be replaced by a completely different kernel snap. | ||
| The kernel snap is responsible for providing the Linux kernel image and modules | ||
| for the system. The kernel snap to be used is defined in the device's model | ||
| assertion, which is produced and signed by the Brand authority. | ||
|
|
||
| Canonical publishes some reference kernel snaps as well as kernel snaps for main Canonical models such as official Ubuntu Core VMs on various certified public clouds, as well as general purpose computing images for popular physical devices such as the 64-bit x86 PC and Raspberry Pi 2 and 3. | ||
| Canonical publishes some reference kernel snaps as well as kernel snaps for main | ||
| Canonical models such as official Ubuntu Core VMs on various certified public | ||
| clouds, as well as general purpose computing images for popular physical devices | ||
| such as the 64-bit x86 PC and Raspberry Pi. | ||
|
|
||
| For details on building a kernel snap, see [Build a kernel snap](https://documentation.ubuntu.com/core/how-to-guides/image-creation/build-a-kernel-snap/) | ||
| in the Ubuntu Core documentation. | ||
|
|
||
| ## Setup files | ||
|
|
||
| In addition to traditional snap metadata, the kernel snap also holds some setup files fundamental to the initialization and lifecycle of the device. | ||
| In addition to traditional snap metadata, the kernel snap also holds some setup | ||
| files fundamental to the initialization and lifecycle of the device. | ||
|
|
||
| The current layout for a kernel snap is straightforward: | ||
| The layout for a kernel snap has some variation, but usually follows: | ||
|
|
||
| - `meta/snap.yaml` - Traditional snap details, with `type: kernel` explicitly defined | ||
| - `kernel.img` - The actual kernel image | ||
| - `initrd.img` - The respective initrd image | ||
| - `meta/kernel.yaml` - Optional kernel-specific metadata defining kernel-provided assets | ||
| - `snapd-info` - Information about the snapd packaged in the initrd | ||
| - `modules/<version>/` - Kernel modules; version must match the one in `snap.yaml` | ||
| - `firmware/` - Optional firmware files. | ||
| - `firmware/` - Optional firmware files | ||
| - `dtbs/` - Optional binary device-tree files, if gadget.yaml states `device-tree-origin: kernel` | ||
| - kernel - The actual kernel image | ||
| - initrd - The initrd image | ||
|
|
||
| The kernel and initrd may be discrete objects, usually named `kernel.img` and | ||
| `initrd.img`, respectively. However, they could also be distributed as a single [Unified Kernel Image](https://uapi-group.org/specifications/specs/unified_kernel_image/) | ||
| (UKI) or as a [Flatted Image Tree](https://fitspec.osfw.foundation/) (FIT) image. | ||
| These are usually named `kernel.efi` or `kernel.img`, respectively. | ||
|
|
||
| ### kernel.yaml | ||
|
|
||
| The `kernel.yaml` provides information used by snapd to determine | ||
| kernel-specific asset information. Primarily, this is about device trees and | ||
| kernel modules. The standard format is: | ||
|
|
||
| ```yaml | ||
| dynamic-modules: $SNAP_DATA | ||
| assets: | ||
| dtbs: | ||
| update: true | ||
| content: | ||
| - dtbs/ | ||
| ``` | ||
|
|
||
| * `dynamic-modules` points to a folder which contains `modules/` and `firmware/` | ||
| directories, usually created by a kernel component. | ||
|
|
||
| * `assets` details a list of content the kernel snap provides, usually device | ||
| tree files, to the gadget snap. These are then referenceable in the gadget | ||
| snap's `gadget.yaml` like so: | ||
|
|
||
| ```yaml | ||
| volumes: | ||
| platform: | ||
| schema: gpt | ||
| bootloader: grub | ||
| structure: | ||
| - name: ubuntu-seed | ||
| role: system-seed | ||
| filesystem: vfat | ||
| type: C12A7328-F81F-11D2-BA4B-00A0C93EC93B | ||
| size: 800M | ||
| offset: 8M | ||
| content: | ||
| - source: $kernel:dtbs/dtbs/ | ||
| target: /dtbs/ | ||
| ``` | ||
|
|
||
| ## initrd | ||
|
|
||
| Sample configuration files may be found in the reference gadget snaps. For further details, see [Build a kernel snap](https://documentation.ubuntu.com/core/how-to-guides/image-creation/build-a-kernel-snap/) in the Ubuntu Core documentation. | ||
| The initrd component of the kernel snap plays a fundamental role in the booting | ||
| of an Ubuntu Core system. | ||
|
|
||
| The initrd is usually built using the ubuntu-core-initramfs tool. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If we keep this, should we put a link to a documentation about how to build initrd for a Ubuntu Core system ? If the kernel plugin build initrd, then what does it bring to this doc ?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There isn't much in the way of documentation on the initrd for Core (or initrds in general...) - the initrd plugin provides an explanation for how to use the plugin, but doesn't in itself really explain what an initrd is for or why one is required. So yeah, maybe we drop the section for now and have a TODO for documenting the initrd as a separate, multi-pulse ideal. |
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does it bring? It is like we miss further explanation when reading this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe I intended to flesh this section out more; the initrd needs some actual explaining as it plays a pretty pivotal (haha) role.
I did an investigation but thought we'd be better served by a separate doc. I'm not certain. I'd rather see the Core/SnapD teams take a stab at this.
Perhaps it would be more correct to drop the section.