Skip to content

Commit

Permalink
Update the README.md file for build-image-index task.
Browse files Browse the repository at this point in the history
Signed-off-by: haripate <[email protected]>
  • Loading branch information
haripate committed Oct 17, 2024
1 parent 3038ced commit a76a0cf
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions task/build-image-index/0.1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ This takes existing Image Manifests and combines them in an Image Index.
|IMAGE_EXPIRES_AFTER|Delete image tag after specified time resulting in garbage collection of the digest. Empty means to keep the image tag. Time values could be something like 1h, 2d, 3w for hours, days, and weeks, respectively.|""|false|
|ALWAYS_BUILD_INDEX|Build an image index even if IMAGES is of length 1. Default true. If the image index generation is skipped, the task will forward values for params.IMAGES[0] to results.IMAGE_*. In order to properly set all results, use the repository:tag@sha256:digest format for the IMAGES parameter.|true|false|
|STORAGE_DRIVER|Storage driver to configure for buildah|vfs|false|
|caTrustConfigMapName|The name of the ConfigMap to read CA bundle data from.|trusted-ca|false|
|caTrustConfigMapKey|The name of the key in the ConfigMap that contains the CA bundle data.|ca-bundle.crt|false|
|SQUASH|Squash all new and previous layers added as a part of this build, as per --squash|false|false|

## Results
|name|description|
Expand All @@ -20,4 +23,5 @@ This takes existing Image Manifests and combines them in an Image Index.
|IMAGE_URL|Image repository and tag where the built image was pushed|
|IMAGES|List of all referenced image manifests|
|IMAGE_REF|Image reference of the built image containing both the repository and the digest|
|SBOM_BLOB_URL|Reference, including digest to the SBOM blob|

0 comments on commit a76a0cf

Please sign in to comment.