doc(README): simplify
This commit is contained in:
Tiara Rodney
parent
0561ae4369
commit
f55d10f106
1 changed files with 27 additions and 109 deletions
136
README.md
136
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)
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Image</th>
|
||||
<th>OS</th>
|
||||
<th>Arch</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>atlassian-bitbucketrunner323-windowsservercore</td>
|
||||
<td>Microsoft Windows</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-node19-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-node20-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-node21-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-node22-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-node23-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-openjdk21-windowsservercore</td>
|
||||
<td>Microsoft Windows</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-python39-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-python310-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-python311-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-python312-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-python313-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-ubuntu</td>
|
||||
<td>GNU/Linux</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>build-windowsservercore</td>
|
||||
<td>Microsoft Windows</td>
|
||||
<td>amd64</td>
|
||||
</tr>
|
||||
</table>
|
||||
* [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-<platform>
|
|||
|
||||
```
|
||||
$> 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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue