diff options
| author | Christian Glombek <LorbusChris@users.noreply.github.com> | 2025-06-10 02:15:44 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-06-09 20:15:44 -0400 |
| commit | 299c8e0e2f9054c07dfc2d26cadcc3164f7510cb (patch) | |
| tree | 5796eb9e21ed2311b1183355bc9536a7ddbede2a /README.md | |
| parent | 2fa28f0598b94db3b842cc24df1e0d02e8ab43f6 (diff) | |
| download | AeroCore-OS-299c8e0e2f9054c07dfc2d26cadcc3164f7510cb.tar.gz AeroCore-OS-299c8e0e2f9054c07dfc2d26cadcc3164f7510cb.zip | |
chore: simplify (#111)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 13 insertions, 19 deletions
@@ -46,11 +46,11 @@ This file defines the operations used to customize the selected image. It contai - add additional RPM packages - add binaries as a layer from other images -## Building an ISO +## Building disk images -This template provides an out of the box workflow for getting an ISO image for your custom OCI image which can be used to directly install onto your machines. +This template provides an out of the box workflow for creating ISO and other disk images for your custom OCI image which can be used to directly install onto your machines. -This template provides a way to upload the ISO that is generated from the workflow to a S3 bucket or it will be available as an artifact from the job. To upload to S3 we use a tool called [rclone](https://rclone.org/) which is able to use [many S3 providers](https://rclone.org/s3/). For more details on how to configure this see the details [below](#build-isoyml). +This template provides a way to upload the disk images that is generated from the workflow to a S3 bucket or it will be available as an artifact from the job. To upload to S3 we use a tool called [rclone](https://rclone.org/) which is able to use [many S3 providers](https://rclone.org/s3/). For more details on how to configure this see the details [below](#build-isoyml). ## Workflows @@ -58,13 +58,13 @@ This template provides a way to upload the ISO that is generated from the workfl This workflow creates your custom OCI image and publishes it to the Github Container Registry (GHCR). By default, the image name will match the Github repository name. -### build-iso.yml +### build-disk.yml -This workflow creates an ISO from your OCI image by utilizing the [bootc-image-builder](https://osbuild.org/docs/bootc/) to generate an ISO. In order to use this workflow you must complete the following steps: +This workflow creates a disk images from your OCI image by utilizing the [bootc-image-builder](https://osbuild.org/docs/bootc/). In order to use this workflow you must complete the following steps: -- Modify `iso.toml` to point to your custom image before generating an ISO. -- If you changed your image name from the default in `build.yml` then in the `build-iso.yml` file edit the `IMAGE_REGISTRY` and `DEFAULT_TAG` environment variables with the correct values. If you did not make changes, skip this step. -- Finally, if you want to upload your ISOs to S3 then you will need to add your S3 configuration to the repository's Action secrets. This can be found by going to your repository settings, under `Secrets and Variables` -> `Actions`. You will need to add the following +- Modify `disk_config/iso.toml` to point to your custom container image before generating an ISO image. +- If you changed your image name from the default in `build.yml` then in the `build-disk.yml` file edit the `IMAGE_REGISTRY`, `IMAGE_NAME` and `DEFAULT_TAG` environment variables with the correct values. If you did not make changes, skip this step. +- Finally, if you want to upload your disk images to S3 then you will need to add your S3 configuration to the repository's Action secrets. This can be found by going to your repository settings, under `Secrets and Variables` -> `Actions`. You will need to add the following - `S3_PROVIDER` - Must match one of the values from the [supported list](https://rclone.org/s3/) - `S3_BUCKET_NAME` - Your unique bucket name - `S3_ACCESS_KEY_ID` - It is recommended that you make a separate key just for this workflow @@ -72,7 +72,7 @@ This workflow creates an ISO from your OCI image by utilizing the [bootc-image-b - `S3_REGION` - The region your bucket lives in. If you do not know then set this value to `auto`. - `S3_ENDPOINT` - This value will be specific to the bucket as well. -Once the workflow is done, you'll find it either in your S3 bucket or as part of the summary under `Artifacts` after the workflow is completed. +Once the workflow is done, you'll find the disk images either in your S3 bucket or as part of the summary under `Artifacts` after the workflow is completed. #### Container Signing @@ -130,10 +130,7 @@ This `Justfile` contains various commands and configurations for building and ma #### Environment Variables -- `repo_organization`: The GitHub repository owner (default: "yourname"). -- `image_name`: The name of the image (default: "yourimage"). -- `centos_version`: The CentOS version (default: "stream10"). -- `fedora_version`: The Fedora version (default: "41"). +- `image_name`: The name of the image (default: "image-template"). - `default_tag`: The default tag for the image (default: "latest"). - `bib_image`: The Bootc Image Builder (BIB) image (default: "quay.io/centos-bootc/bootc-image-builder:latest"). @@ -165,15 +162,12 @@ Cleans the repository by removing build artifacts. Builds a container image using Podman. ```bash -just build $target_image $tag $dx $hwe $gdx +just build $target_image $tag ``` Arguments: -- `$target_image`: The tag you want to apply to the image (default: aurora). -- `$tag`: The tag for the image (default: lts). -- `$dx`: Enable DX (default: "0"). -- `$hwe`: Enable HWE (default: "0"). -- `$gdx`: Enable GDX (default: "0"). +- `$target_image`: The tag you want to apply to the image (default: `$image_name`). +- `$tag`: The tag for the image (default: `$default_tag`). ##### Building Virtual Machines and ISOs |
