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

docs: add Trivy scan badges

parent 747ade16

README.md

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


| Input / Variable | Description                            | Default value     |

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

| `cli-image` / `HELM_CLI_IMAGE` | The Docker image used to run Helm <br/>:warning: **set the version required by your Kubernetes server** | `registry.hub.docker.com/alpine/helm:latest` |

| `cli-image` / `HELM_CLI_IMAGE` | The Docker image used to run Helm <br/>:warning: **set the version required by your Kubernetes server** | `registry.hub.docker.com/alpine/helm:latest` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-HELM_CLI_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-HELM_CLI_IMAGE) |

| `chart-dir` / `HELM_CHART_DIR` | The folder where the Helm chart is located | `.`  _(root project dir)_ |

| `scripts-dir` / `HELM_SCRIPTS_DIR` | The folder where hook scripts are located | `.` _(root project dir)_ |

| `common-values` / `HELM_COMMON_VALUES` | Common values file (used for all environments, overridden by specific per-env values files) | undefined (none) |
@@ -368,7 +368,7 @@ These jobs perform a [Yaml Lint](https://github.com/adrienverge/yamllint) of you 


| Input / Variable | Description                           | Default value     |

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

| `yamllint-image` / `HELM_YAMLLINT_IMAGE` | The Docker image used to run YamlLint test | `registry.hub.docker.com/cytopia/yamllint` |

| `yamllint-image` / `HELM_YAMLLINT_IMAGE` | The Docker image used to run YamlLint test | `registry.hub.docker.com/cytopia/yamllint` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-HELM_YAMLLINT_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-HELM_YAMLLINT_IMAGE) |

| `yamllint-disabled` / `HELM_YAMLLINT_DISABLED` | Set to `true` to disable Yaml lint              | _none_ (enabled) |

| `yamllint-config` / `HELM_YAMLLINT_CONFIG` | Config used with the yamllint tool    | `{extends: relaxed, rules: {line-length: {max: 160}}}` |

| `yamllint-args` / `HELM_YAMLLINT_ARGS` | Arguments used by the lint job        | `-f colored --strict` |
@@ -380,7 +380,7 @@ This job runs [Kube-Score](https://kube-score.com/) on the resources to be creat 
| Input / Variable | Description                              | Default value     |

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

| `kube-score-disabled` / `HELM_KUBE_SCORE_DISABLED` | Set to `true` to disable [Kube-Score](https://kube-score.com/)   | _none_ (enabled) |

| `kube-score-image` / `HELM_KUBE_SCORE_IMAGE` | The Docker image used to run [Kube-Score](https://kube-score.com/)   | `registry.hub.docker.com/zegl/kube-score` |

| `kube-score-image` / `HELM_KUBE_SCORE_IMAGE` | The Docker image used to run [Kube-Score](https://kube-score.com/)   | `registry.hub.docker.com/zegl/kube-score` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-HELM_KUBE_SCORE_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-HELM_KUBE_SCORE_IMAGE) |

| `kube-score-args` / `HELM_KUBE_SCORE_ARGS` | Arguments used by the helm-score job   | _none_ |

| `k8s-version` / `HELM_K8S_VERSION` | Kubernetes version (_so that `.Capabilities.KubeVersion.Version` can be correctly interpreted_).<br/> Expected format: `vX.YY` | _none_ |