forked from rook/rook
Blaine Gardner
1d830207a2
Update some old typos that say "synk" instead of "snyk". out of sync. This should fix the top-level README.md to use the latest snyk security scan badge -- as opposed to only referring to the last one that used the misspelled file from about a month ago. Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
19 lines
1.2 KiB
Markdown
19 lines
1.2 KiB
Markdown
---
|
|
title: CI Configuration
|
|
---
|
|
|
|
This page contains information regarding the CI configuration used for the Rook project to test, build and release the project.
|
|
|
|
## Secrets
|
|
|
|
* Snyk (Security Scan):
|
|
* `SNYK_TOKEN` - API Token for the [snyk security scanner](https://snyk.io/) (workflow file: `snyk.yaml`).
|
|
* Testing:
|
|
* `IBM_INSTANCE_ID`: Used for KMS (Key Management System) IBM Key Protect access (see [`.github/workflows/encryption-pvc-kms-ibm-kp/action.yml`](https://github.com/rook/rook/blob/master/.github/workflows/encryption-pvc-kms-ibm-kp/action.yml)).
|
|
* `IBM_SERVICE_API_KEY`: Used for KMS (Key Management System) IBM Key Protect access (see [`.github/workflows/encryption-pvc-kms-ibm-kp/action.yml`](https://github.com/rook/rook/blob/master/.github/workflows/encryption-pvc-kms-ibm-kp/action.yml)).
|
|
* Publishing:
|
|
* `DOCKER_USERNAME` + `DOCKER_PASSWORD`: Username and password of registry.
|
|
* `DOCKER_REGISTRY`: Target registry namespace (e.g., `rook`)
|
|
* `AWS_USR` + `AWS_PSW`: AWS credentials with access to S3 for Helm chart publishing.
|
|
* `GIT_API_TOKEN`: GitHub access token, used to push docs changes to the docs repositories `gh-pages` branch.
|