From f55d10f106f9755451d01b23736ae00e1baeb834 Mon Sep 17 00:00:00 2001 From: Tiara Rodney Date: Mon, 2 Jun 2025 15:53:19 +0200 Subject: [PATCH] doc(README): simplify --- README.md | 136 +++++++++++------------------------------------------- 1 file changed, 27 insertions(+), 109 deletions(-) diff --git a/README.md b/README.md index b743d0e..432af95 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,17 @@ # Tiara's OCI Images -Standardization for building, archiving, vulnerability scanning and publishing -lots of actively managed GNU/Linux and Microsoft Windows OCI (Docker) images -under a multitude of circumstances - Do it fast, conveniently and -conventionally. +Tiara's workflow for actively managing OCI (Docker) image ownership - factory +for building, publishing and archiving OCI images with a verifiable chain of +trust -# Images +# Usage (Producing) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ImageOSArch
atlassian-bitbucketrunner323-windowsservercoreMicrosoft Windowsamd64
build-node19-ubuntuGNU/Linuxamd64
build-node20-ubuntuGNU/Linuxamd64
build-node21-ubuntuGNU/Linuxamd64
build-node22-ubuntuGNU/Linuxamd64
build-node23-ubuntuGNU/Linuxamd64
build-openjdk21-windowsservercoreMicrosoft Windowsamd64
build-python39-ubuntuGNU/Linuxamd64
build-python310-ubuntuGNU/Linuxamd64
build-python311-ubuntuGNU/Linuxamd64
build-python312-ubuntuGNU/Linuxamd64
build-python313-ubuntuGNU/Linuxamd64
build-ubuntuGNU/Linuxamd64
build-windowsservercoreMicrosoft Windowsamd64
+* [Docker Hub](https://hub.docker.com/repositories/byteb4rb1e) +* [Downloads](https://bitbucket.org/byteb4rb1e/oci-images/downloads/) -# Usage +# Usage (Producing) -## Set up and verify your build environment +## Configure environment ``` $> sh ./configure @@ -105,10 +29,10 @@ make all- ``` $> make build-python39-ubuntu -$> make all-build-python-ubuntu -$> make all-build-ubuntu +$> make _all-build-python-ubuntu +$> make _all-build-ubuntu $> make build-ubuntu -$> make all-ubuntu +$> make _all-ubuntu ``` ## Archive Images @@ -126,6 +50,13 @@ Output path can be adjusted via `$ARCHIVE_DIST_PATH`. $> make build-python39-ubuntu ARCHIVE=1 ARCHIVE_DIST_PATH=dist2 ``` +Sign compressed archived, requires `GPG_SIGNER_FINGERPRINT` + +``` +$> make build-python39-ubuntu ARCHIVE=1 SIGN_ARCHIVE=1 +``` + + ## Publish Images Push image to a Docker registry. @@ -140,7 +71,7 @@ By default, will publish to `docker.io/byteb4rb1e`. Can be modified through `DOCKER_REGISTRY` and `DOCKER_REPO_SLUG`. ``` -$> make all-ubuntu \ +$> make _all-ubuntu \ PUBLISH=1 \ DOCKER_REGISTRY=contoso.com \ DOCKER_REPO_SLUG=not-byteb4rb1e @@ -152,7 +83,13 @@ Scan image with AquaSecurity Trivy Scanner for vulnerabilities and publish reports under `test-reports/`. ``` -$> make all-ubuntu SCAN=1 +$> make _all-ubuntu SCAN=1 +``` + +Sign scan + +``` +$> make _all-ubuntu SCAN=1 SIGN_SCAN=1 ``` ## Mix & Match @@ -168,24 +105,5 @@ $> make build-node23-ubuntu build-python313-ubuntu SCAN=1 ARCHIVE=1 PUBLISH=1 Run independent image builds and other jobs in parallel. ``` -make all-ubuntu -j8 +make _all-ubuntu -j8 ``` - -# Setup - -Ensure the following tools are installed before proceeding: - - * GNU Make (make) – Required for executing automation scripts. - * Docker CLI (docker) – Used for building and managing OCI images. - * curl, gzip, and tar – Needed for archiving and uploading image dumps. - -Requirements - -You need the optional *Containers* feature enabled, which is possible with at -least Microsoft Windows 11 Professional (and Windows Server Editions). - -Additionally you need the Docker daemon and Docker client and have configured -them. - -Also, you will need a build of *GNU Make*, which is available through -environments such as Cygwin, MinGW or MSYS2. I suggest using MSYS2