From ee86b81f5b8844928aa4b6b9eb968e3782fb66dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20L=C3=BCscher?= Date: Mon, 27 May 2024 16:42:33 +0000 Subject: [PATCH] doc(main): updates --- docs/index.md | 19 +++++++++++-------- docs/variables.md | 22 +++++++++++----------- 2 files changed, 22 insertions(+), 19 deletions(-) diff --git a/docs/index.md b/docs/index.md index d06b925..21f04d5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -41,21 +41,24 @@ ln -s $FORGE_POD_DATA_DIR $HOME/ublue-os_forge-data With this the data folder would be available in your home directory under `~/ublue-os_forge-data` -In that folder you will find an example configuration similar to this: +In that folder you will find an **examples** folder with example configurations similar to this: ```yaml -## ublue-os forge extra-vars example configuration +## ublue-os forge example configuration ## For more details got to https://github.com/ublue-os/forge/blob/main/docs/variables.md --- forge_git_repository_url: https://github.com/ublue-os/bluefin.git -forge_git_repository_destination: /var/home/stephan/.local/share/containers/storage/volumes/ublue-os_forge-data/_data/data/bluefin -forge_git_repository_version: main -forge_registry_url: registry.ublue.local +forge_git_repository_destination: "/var/home/stephan/.local/share/containers/storage/volumes/ublue-os_forge-data/_data/data/bluefin" +forge_container_extra_args: + - --build-arg="BASE_IMAGE_NAME=silverblue" + - --build-arg="IMAGE_FLAVOR=main" + - --build-arg="AKMODS_FLAVOR=main" + - --build-arg="FEDORA_MAJOR_VERSION=39" + - --build-arg="TARGET_BASE=bluefin" ``` -This file acts as a template. It has all available settings outlined for you. Simple copy -it and modify it to your liking. For each project you want to handle with the forge you can -create a dedicated file. +These files are a good starting point for your custom configuration. Simple copy those examples +you are interested in modify them to your liking. Details about the available variables are documented [here](./variables.md). diff --git a/docs/variables.md b/docs/variables.md index 743243b..3c57f24 100644 --- a/docs/variables.md +++ b/docs/variables.md @@ -10,16 +10,16 @@ The following configuration variables are available and can be set to your likin -| Name | Type | Default value | Description | -| ---------------------------------- | ---- | ------------------------------------------------- | -------------------------------------------------------------------------------- | -| `forge_container_file` | str | Containerfile | Path to the Containerfile for Podman to build | -| `forge_container_format` | str | oci | Format of the image Podman will build. Can be either `oci` or `docker` | -| `forge_git_repository_url` | str | | Git repository url | -| `forge_git_repository_destination` | str | `{{ forge_data_volume_mountpoint }}`/data/bluefin | Git destination where repository is cloned to. Can be any directory on your host | -| `forge_git_repository_version` | str | main | Git repository branch or tag or commit version | -| `forge_registry_url` | str | registry.ublue.local | Container registry url | +| Name | Type | Default value | Description | +| ---------------------------------- | ---- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `forge_container_name` | str | Project name derived from `forge_git_repository_url` Example: `bluefin` | Container image name. | +| `forge_container_tag` | str | Evaluates to: `YYY-MM-DD_HHMMSS` Example: `2024-05-26_192206` | Container image tag. | +| `forge_container_file` | str | Containerfile | Path to the Containerfile for Podman to build | +| `forge_container_format` | str | oci | Format of the image Podman will build. Can be either `oci` or `docker` | +| `forge_container_extra_args` | list | [] | List of extra arguments which gets passed to the podman build process. Example: `[--build-arg="BASE_IMAGE_NAME=silverblue"]` | +| `forge_git_repository_url` | str | | Git repository url | +| `forge_git_repository_destination` | str | | Git destination where repository is cloned to. | +| `forge_git_repository_version` | str | main | Git repository branch or tag or commit version | +| `forge_registry_url` | str | registry.ublue.local | Container registry url | - -**_Note:_** The `{{ forge_data_volume_mountpoint }}` points to your ublue-os_forge-data -podman volume.