Skip to content

Gh issues #235

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.

Sign up for GitHub

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

Merged
degville merged 4 commits into from
Jul 2, 2025
Merged

Gh issues #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bd7a8ab
fixes #180. Thanks @toabctl and @dilyn-corner
degville Jul 1, 2025
6befd03
fixes #226
degville Jul 1, 2025
267e46a
fixes #221
degville Jul 1, 2025
57d2556
fixes #230
degville Jul 2, 2025
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
4 changes: 2 additions & 2 deletions docs/how-to-guides/image-creation/build-a-gadget-snap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ There are typically two methods for building a gadget snap, _native building_ an

### Requirements

The build system must support [snap](https://snapcraft.io/docs/installing-snapd), and have both the [Snapcraft](https://snapcraft.io/docs/snapcraft-overview) build tool and the [LXD](https://canonical.com/lxd) virtualisation platform installed, all of which are provided by any Ubuntu release.
The build system must support [snap](https://snapcraft.io/docs/installing-snapd), and have both the [Snapcraft](https://snapcraft.io/docs/snapcraft-overview) build tool and the [LXD](https://canonical.com/lxd/install) virtualisation platform installed, all of which are provided by any Ubuntu release. Ensure your user has been added to the `lxd` group and you've initialized LXD with `lxd init` before proceeding. See [Set up Snapcraft](https://documentation.ubuntu.com/snapcraft/stable/how-to/setup/set-up-snapcraft/#install-lxd) for further details.

### Native building

Expand All @@ -384,7 +384,7 @@ git checkout 22-amd64-pc

With the correct git branch selected, `snap/snapcraft.yaml` now contains everything required to build the PC gadget snap.

This example embeds the pre-built [Canonical reference PC gadget](https://github.com/snapcore/pc-gadget) as a base from the *snapcraft.yaml*. To build the gadget, run the the _snapcraft_ command:
This example embeds the pre-built [Canonical reference PC gadget](https://github.com/snapcore/pc-gadget) as a base from the *snapcraft.yaml*. To build the gadget, run the _snapcraft_ command:

```bash
$ snapcraft
Expand Down
9 changes: 7 additions & 2 deletions docs/how-to-guides/image-creation/build-a-kernel-snap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ parts:
# part used instead. This will most commonly happen on non-x86_64 platforms.
initrd:
after: [firmware, kernel]
# The initrd plugin handles the work of running ubuntu-core-initramfs
# The initrd plugin handles the work of running ubuntu-core-initramfs.
plugin: initrd
# Set this to true if:
# * the gadget bootloader is GRUB
Expand All @@ -459,6 +459,11 @@ parts:
# https://github.com/canonical/iot-field-gadget-snap/blob/main/u-boot/boot.scr.in
# * the IoT Field example gadget on the 22-arm64-odroid-hc4 branch uses separate files:
# https://github.com/canonical/iot-field-gadget-snap/blob/22-arm64-odroid-hc4/u-boot/boot.scr
#
# Missing snapcraft support?
# If snapcraft does not include support for the initrd plugin, a pre-built snapcraft snap with
# the initrd plugin included can be downloaded from here:
# https://launchpad.net/~ondrak/+snap/snapcraft-kernel-initrd-split
initrd-build-efi-image: true
# NOTE: any modules required for booting the target hardware (like those
# required to mount the root filesystem, such as squashfs or mmc drivers)
Expand Down Expand Up @@ -533,7 +538,7 @@ snap install snapcraft --classic
With _snapcraft.yaml_ complete, and the kernel source either cloned locally or linked to from the snapcraft.yaml, the `snapcraft` command will build the kernel. As mentioned earlier, it's often more convenient to build the kernel within the host environment, using `--destructive-mode`:

```bash
# snapcraft --destructive-mode --target-arch=arm64
# snapcraft --destructive-mode --build-for=arm64
[...]
Snapped kernal-snap-name_arm64.snap
```
Expand Down
9 changes: 5 additions & 4 deletions docs/tutorials/build-your-first-image/build-the-image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,17 @@ Images are built from the recipe contained in the [model assertion](/tutorials/b
First, install the `ubuntu-image` command from its snap:

```
sudo snap install ubuntu-image --classic
sudo snap install ubuntu-image --classic --edge
```

The `ubuntu-image` command requires two arguments; `snap` to indicate we're building a snap-based Ubuntu Core image, and the filename of our previously-signed model assertion to build an image:
The `ubuntu-image` command requires three arguments; `snap` to indicate we're building a snap-based Ubuntu Core image, `--allow-snapd-kernel-mismatch` to ignore a difference in the versions of snapd we're using, and finally, the filename of our previously-signed model assertion to build an image:

```bash
$ ubuntu-image snap my-model.model
$ ubuntu-image snap --allow-snapd-kernel-mismatch my-model.model
[0] prepare_image
WARNING: proceeding to download snaps ignoring validations, this default will change in the future. For now use --validation=enforce for validations to be taken into account, pass instead --validation=ignore to preserve current behavior going forward
WARNING: the kernel for the specified UC20+ model does not carry assertion max formats information, assuming possibly incorrectly the kernel revision can use the same formats as snapd
WARNING: snapd 2.68+ is not compatible with a kernel containing snapd prior to 2.68
[1] load_gadget_yaml
[2] set_artifact_names
[3] populate_rootfs_contents
Expand All @@ -28,7 +29,7 @@ WARNING: the kernel for the specified UC20+ model does not carry assertion max f
[9] generate_snap_manifest
Build successful
```
You can safely ignore both of the above warnings, and the entire process should only take a few minutes (depending on your connectivity), with the creation of a `pi.img` Ubuntu Core image file being the end result.
You can safely ignore the warnings, and the entire process should only take a few minutes (depending on your connectivity), with the creation of a `pi.img` Ubuntu Core image file being the end result.

```{admonition} Console-conf as a separate snap in Ubuntu Core 24+
:class: tip
Expand Down