Commit d1b6f074 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: add Trivy scan badges

parent ced8a3d7

README.md

+3 −3
Original line number Diff line number Diff line
@@ -45,7 +45,7 @@ The CNB template uses some global configuration used throughout all jobs. 


| Input / Variable | Description                            | Default value     |

| --------------------- | -------------------------------------- | ----------------- |

| `builder-image` / `CNB_BUILDER_IMAGE` | The CNB builder image used to build your application image<br/>_depending on your needs, [choose the most appropriate one](https://paketo.io/docs/concepts/builders/#what-paketo-builders-are-available)_ | `docker.io/paketobuildpacks/builder-jammy-base:latest` |

| `builder-image` / `CNB_BUILDER_IMAGE` | The CNB builder image used to build your application image<br/>_depending on your needs, [choose the most appropriate one](https://paketo.io/docs/concepts/builders/#what-paketo-builders-are-available)_ | `docker.io/paketobuildpacks/builder-jammy-base:latest` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-CNB_BUILDER_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-CNB_BUILDER_IMAGE) |

| `platform-api` / `CNB_PLATFORM_API` | The CNB [platform API version](https://github.com/buildpacks/spec/blob/main/platform.md#platform-api-version) | `0.9` |



### Available Builders
@@ -214,7 +214,7 @@ It is bound to the `package-test` stage, and uses the following variables: 


| Input / Variable | Description                            | Default value     |

| ---------------------- | -------------------------------------- | ----------------- |

| `trivy-image` / `CNB_TRIVY_IMAGE` | The docker image used to scan images with Trivy | `docker.io/aquasec/trivy:latest` |

| `trivy-image` / `CNB_TRIVY_IMAGE` | The docker image used to scan images with Trivy | `docker.io/aquasec/trivy:latest` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-CNB_TRIVY_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-CNB_TRIVY_IMAGE) |

| `trivy-disabled` / `CNB_TRIVY_DISABLED` | Set to `true` to disable Trivy analysis          | _(none)_ |

| `trivy-args` / `CNB_TRIVY_ARGS` | Additional [`trivy image` options](https://aquasecurity.github.io/trivy/latest/docs/references/configuration/cli/trivy_image/#options) | `--ignore-unfixed --vuln-type os` |
@@ -239,7 +239,7 @@ This job pushes (_promotes_) the built image as the _release_ image using [skope 


| Input / Variable | Description                                                                 | Default value     |

| --------------------- | --------------------------------------------------------------------------- | ----------------- |

| `skopeo-image` / `CNB_SKOPEO_IMAGE` | The Docker image used to run [skopeo](https://github.com/containers/skopeo) | `quay.io/skopeo/stable:latest` |

| `skopeo-image` / `CNB_SKOPEO_IMAGE` | The Docker image used to run [skopeo](https://github.com/containers/skopeo) | `quay.io/skopeo/stable:latest` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-CNB_SKOPEO_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-CNB_SKOPEO_IMAGE) |

| `publish-args` / `CNB_PUBLISH_ARGS` | Additional [`skopeo copy` arguments](https://github.com/containers/skopeo/blob/master/docs/skopeo-copy.1.md#options) | _(none)_          |

| `prod-publish-strategy` / `CNB_PROD_PUBLISH_STRATEGY` | Defines the publish to production strategy. One of `manual` (i.e. _one-click_), `auto` or `none` (disabled). | `manual` |