Merge branch 'add-vault-variant' into 'main' (16dfaf2a) · Commits · to be continuous... / Docker Compose

README.md

+60 −0

Original line number	Diff line number	Diff line
		@@ -420,3 +420,63 @@ Here are its parameters:
		\| `kics-enabled` / `DCMP_KICS_ENABLED` \| Set to `true` to enable `kics` \| false \|
		\| `kics-image` / `DCMP_KICS_IMAGE` \| kics docker image \| `docker.io/checkmarx/kics:latest` \|
		\| `kics-args` / `DCMP_KICS_ARGS` \| kics scan [options and args](https://docs.kics.io/latest/commands/#scan_command_options) \| `--ci` \|


		## Variants

		### Vault variant

		This variant allows delegating your secrets management to a [Vault](https://www.vaultproject.io/) server.

		#### :warning: `DCMP_IMAGE` requirements

		The Vault variant requires `curl` or `wget` to retrieve secrets from the Vault server.

		As a result, when using the Vault variant, you'll have to select a `DCMP_IMAGE` that - in addition to `docker` - contains `curl` or `wget`.

		#### Configuration

		In order to be able to communicate with the Vault server, the variant requires the additional configuration parameters:

		\| Input / Variable \| Description \| Default value \|
		\| ----------------- \| -------------------------------------- \| ----------------- \|
		\| `TBC_VAULT_IMAGE` \| The [Vault Secrets Provider](https://gitlab.com/to-be-continuous/tools/vault-secrets-provider) image to use (can be overridden) \| `registry.gitlab.com/to-be-continuous/tools/vault-secrets-provider:latest` \|
		\| `vault-base-url` / `VAULT_BASE_URL` \| The Vault server base API url \| must be defined \|
		\| `vault-oidc-aud` / `VAULT_OIDC_AUD` \| The `aud` claim for the JWT \| `$CI_SERVER_URL` \|
		\| :lock: `VAULT_ROLE_ID` \| The [AppRole](https://www.vaultproject.io/docs/auth/approle) RoleID \| _none_ \|
		\| :lock: `VAULT_SECRET_ID` \| The [AppRole](https://www.vaultproject.io/docs/auth/approle) SecretID \| _none_ \|

		By default, the variant will authentifacte using a [JWT ID token](https://docs.gitlab.com/ci/secrets/id_token_authentication/). To use [AppRole](https://www.vaultproject.io/docs/auth/approle) instead the `VAULT_ROLE_ID` and `VAULT_SECRET_ID` should be defined as secret project variables.

		#### Usage

		Then you may retrieve any of your secret(s) from Vault using the following syntax:

		```text
		@url@http://vault-secrets-provider/api/secrets/{secret_path}?field={field}
		```

		With:

		\| Parameter \| Description \|
		\| -------------------------------- \| -------------------------------------- \|
		\| `secret_path` (_path parameter_) \| this is your secret location in the Vault server \|
		\| `field` (_query parameter_) \| parameter to access a single basic field from the secret JSON payload \|

		#### Example

		```yaml
		include:
		# main template
		- component: $CI_SERVER_FQDN/to-be-continuous/docker-compose/gitlab-ci-docker-compose@1.5.0
		# Vault variant
		- component: $CI_SERVER_FQDN/to-be-continuous/docker-compose/gitlab-ci-docker-compose-vault@1.5.0
		inputs:
		# audience claim for JWT
		vault-oidc-aud: "https://vault.acme.host"
		vault-base-url: "https://vault.acme.host/v1"

		variables:
		# Secrets managed by Vault
		DCMP_PROD_SSH_PRIVATE_KEY: "@url@http://vault-secrets-provider/api/secrets/b7ecb6ebabc231/my-app/prod?field=ssh_key"
		```

kicker.json

+37 −0

Original line number	Diff line number	Diff line
		@@ -231,5 +231,42 @@
		}
		]
		}
		],
		"variants": [
		{
		"id": "vault",
		"name": "Vault",
		"description": "Retrieve secrets from a [Vault](https://www.vaultproject.io/) server",
		"template_path": "templates/gitlab-ci-docker-compose-vault.yml",
		"variables": [
		{
		"name": "TBC_VAULT_IMAGE",
		"description": "The [Vault Secrets Provider](https://gitlab.com/to-be-continuous/tools/vault-secrets-provider) image to use",
		"default": "registry.gitlab.com/to-be-continuous/tools/vault-secrets-provider:latest",
		"advanced": true
		},
		{
		"name": "VAULT_BASE_URL",
		"description": "The Vault server base API url"
		},
		{
		"name": "VAULT_OIDC_AUD",
		"description": "The `aud` claim for the JWT",
		"default": "$CI_SERVER_URL"
		},
		{
		"name": "VAULT_ROLE_ID",
		"description": "The [AppRole](https://www.vaultproject.io/docs/auth/approle) RoleID",
		"mandatory": true,
		"secret": true
		},
		{
		"name": "VAULT_SECRET_ID",
		"description": "The [AppRole](https://www.vaultproject.io/docs/auth/approle) SecretID",
		"mandatory": true,
		"secret": true
		}
		]
		}
		]
		}

templates/gitlab-ci-docker-compose-vault.yml

0 → 100644

+37 −0

Original line number	Diff line number	Diff line
		# =====================================================================================================================
		# === Vault template variant
		# =====================================================================================================================
		spec:
		inputs:
		vault-base-url:
		description: The Vault server base API url
		default: ''
		vault-oidc-aud:
		description: The `aud` claim for the JWT
		default: $CI_SERVER_URL
		---
		variables:
		# variabilized vault-secrets-provider image
		TBC_VAULT_IMAGE: registry.gitlab.com/to-be-continuous/tools/vault-secrets-provider:latest
		# variables have to be explicitly declared in the YAML to be exported to the service
		VAULT_ROLE_ID: $VAULT_ROLE_ID
		VAULT_SECRET_ID: $VAULT_SECRET_ID
		VAULT_OIDC_AUD: $[[ inputs.vault-oidc-aud ]]
		VAULT_BASE_URL: $[[ inputs.vault-base-url ]]

		.compose-base:
		services:
		- name: "$TBC_TRACKING_IMAGE"
		command: ["--service", "--port", "8082", "kubernetes", "9.0.2"]
		- name: "$TBC_VAULT_IMAGE"
		alias: "vault-secrets-provider"
		variables:
		SKIP_SSL: "false"
		variables:
		VAULT_JWT_TOKEN: "$VAULT_JWT_TOKEN"
		VAULT_CA_CERTS: \|
		$DEFAULT_CA_CERTS
		$CUSTOM_CA_CERTS
		id_tokens:
		VAULT_JWT_TOKEN:
		aud: "$VAULT_OIDC_AUD"