82 lines
3.3 KiB
Markdown
82 lines
3.3 KiB
Markdown
# ublue-custom-template
|
|
|
|
# Purpose
|
|
|
|
This repository is meant to be a template for building your own custom Universal Blue image. This template is the recommended way to make customizations to any image published by the Universal Blue Project:
|
|
- [Aurora](https://getaurora.dev/)
|
|
- [Bazzite](https://bazzite.gg/)
|
|
- [Bluefin](https://projectbluefin.io/)
|
|
- [uCore](https://projectucore.io/)
|
|
- [main](https://github.com/ublue-os/main/)
|
|
- [hwe](https://github.com/ublue-os/hwe/)
|
|
|
|
This template includes a Containerfile and a Github workflow for building the container image. As soon as the workflow is enabled in your repository, it will build the container image and push it to the Github Container Registry.
|
|
|
|
# Prerequisites
|
|
|
|
Working knowledge in the following topics:
|
|
|
|
- Containers
|
|
- https://www.youtube.com/watch?v=SnSH8Ht3MIc
|
|
- https://www.mankier.com/5/Containerfile
|
|
- rpm-ostree
|
|
- https://coreos.github.io/rpm-ostree/container/
|
|
- Fedora Silverblue (and other Fedora Atomic variants)
|
|
- https://docs.fedoraproject.org/en-US/fedora-silverblue/
|
|
- Github Workflows
|
|
- https://docs.github.com/en/actions/using-workflows
|
|
|
|
# How to Use
|
|
|
|
## Template
|
|
|
|
Select `Use this Template` and create a new repository from it. To enable the workflows, you will need to go the `Actions` tab of the new repository and click to enable workflows.
|
|
|
|
## Containerfile
|
|
|
|
This file defines the operations used to customize the selected image. It contains examples of possible modifications, including how to:
|
|
- change the upstream from which the custom image is derived
|
|
- add additional RPM packages
|
|
- add binaries as a layer from other images
|
|
- modify system files (like /etc/systemd/system.conf)
|
|
|
|
## Workflows
|
|
|
|
### build.yml
|
|
|
|
This workflow creates your custom OCI image and publishes it to the Github Container Registry (GHCR).
|
|
|
|
#### Container Signing
|
|
|
|
Container signing is important for end-user security and is enabled on all Universal Blue images. It is recommended you set this up, and by default the image builds *will fail* if you don't.
|
|
|
|
This provides users a method of verifying the image.
|
|
|
|
1. Install the [cosign CLI tool](https://edu.chainguard.dev/open-source/sigstore/cosign/how-to-install-cosign/#installing-cosign-with-the-cosign-binary)
|
|
|
|
2. Run inside your repo folder:
|
|
|
|
```bash
|
|
cosign generate-key-pair
|
|
```
|
|
|
|
|
|
- Do NOT put in a password when it asks you to, just press enter. The signing key will be used in GitHub Actions and will not work if it is encrypted.
|
|
|
|
> [!WARNING]
|
|
> Be careful to *never* accidentally commit `cosign.key` into your git repo.
|
|
|
|
3. Add the private key to GitHub
|
|
|
|
- This can also be done manually. Go to your repository settings, under Secrets and Variables -> Actions
|
|
|
|
Add a new secret and name it `SIGNING_SECRET`, then paste the contents of `cosign.key` into the secret and save it. Make sure it's the .key file and not the .pub file. Once done, it should look like this:
|
|
|
|
|
|
- (CLI instructions) If you have the `github-cli` installed, run:
|
|
|
|
```bash
|
|
gh secret set SIGNING_SECRET < cosign.key
|
|
```
|
|
|
|
4. Commit the `cosign.pub` file into your git repository
|