Skip to content

Commit

Permalink
Improved image names & README Improvements (#29)
Browse files Browse the repository at this point in the history
* Add documentation improvements from my brief fork

* Postfix public image names with -nvidia

* Add install commands for both editions.

* Add a dispatch trigger to facilitate triggering builds manually and on different branches

* Add notice of image name change
  • Loading branch information
xynydev authored Feb 8, 2023
1 parent d84a54f commit a655d7a
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
8 changes: 6 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ on:
- main
paths-ignore:
- '**/README.md'
workflow_dispatch:

env:
IMAGE_REGISTRY: ghcr.io/${{ github.repository_owner }}

Expand Down Expand Up @@ -76,7 +78,9 @@ jobs:
with:
containerfiles: |
./Containerfile
image: ${{ matrix.image_name }}
# Postfix image name with -nvidia to make it a little more descriptive
# Syntax: https://docs.github.com/en/actions/learn-github-actions/expressions#format
image: ${{ format('{0}-nvidia', matrix.image_name) }}
tags: |
${{ steps.generate-tags.outputs.alias_tags }}
${{ steps.generate-tags.outputs.date }}
Expand Down Expand Up @@ -132,7 +136,7 @@ jobs:

- name: Sign container image
run: |
cosign sign --key cosign.key ${{ steps.registry_case.outputs.lowercase }}/${{ matrix.image_name }}@${TAGS}
cosign sign --key cosign.key ${{ steps.registry_case.outputs.lowercase }}/${{ steps.build_image.outputs.image }}@${TAGS}
env:
TAGS: ${{ steps.push.outputs.digest }}
COSIGN_EXPERIMENTAL: false
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,14 @@ Note: This project is a work-in-progress. You should at a minimum be familiar wi

Any system running `rpm-ostree` should be able to rebase onto one of the images built in this project:

rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/nvidia:latest

Note: The image previously titled "nvidia" will not be updated anymore. If you wish to retain the same functionality, switch to "silverblue-nvidia".

Silverblue:
```rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/silverblue-nvidia:latest```

Kinoite:
```rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/kinoite-nvidia:latest```

And then reboot.

2. Set kargs after rebasing
Expand Down Expand Up @@ -54,7 +60,7 @@ These images are signed with sisgstore's [cosign](https://docs.sigstore.dev/cosi

cosign verify --key cosign.pub ghcr.io/ublue-os/base

If you're forking this repo you should [read the docs](https://docs.github.com/en/actions/security-guides/encrypted-secrets) on keeping secrets in github. You need to [generate a new keypair](https://docs.sigstore.dev/cosign/overview/) with cosign. The public key can be in your public repo (your users need it to check the signatures), and you can paste the private key in Settings -> Secrets -> Actions.
If you're forking this repo you should [read the docs](https://docs.github.com/en/actions/security-guides/encrypted-secrets) on keeping secrets in github. You need to [generate a new keypair](https://docs.sigstore.dev/cosign/overview/) with cosign. The public key can be in your public repo (your users need it to check the signatures), and you can paste the private key in Settings -> Secrets -> Actions with the name SIGNING_SECRET.

## Building locally

Expand All @@ -66,6 +72,8 @@ If you're forking this repo you should [read the docs](https://docs.github.com/e
$ ./generate-akmod-key
```

If you are forking this repo, you also need to add the private key to the repository secrets under the name AKMOD_PRIVKEY.

2. Build container

A container build can be invoked by simply running:
Expand Down

0 comments on commit a655d7a

Please sign in to comment.