Skip to content

feat(deployment): Azure KeyVault support #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 16, 2023
Merged

feat(deployment): Azure KeyVault support #389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dbed165
feat(deployment): Azure KeyVault support
migmartri Oct 14, 2023
09c3d68
chore: change camelcase
migmartri Oct 14, 2023
ca55c61
chore: change camelcase
migmartri Oct 14, 2023
bc8cfd5
chore: update readme
migmartri Oct 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion deployment/chainloop/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Chainloop is an open source software supply chain control plane, a

type: application
# Bump the patch (not minor, not major) version on each change in the Chart Source code
version: 1.19.0
version: 1.19.1
# Do not update appVersion, this is handled automatically by the release process
appVersion: v0.20.0

Expand Down
26 changes: 15 additions & 11 deletions deployment/chainloop/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,17 +383,21 @@ chainloop config save \

### Secrets Backend

| Name | Description | Value |
| --------------------------------------------------- | ------------------------------------------------------------------------ | ----------- |
| `secretsBackend.backend` | Secrets backend type ("vault", "awsSecretManager" or "gcpSecretManager") | `vault` |
| `secretsBackend.secretPrefix` | Prefix that will be pre-pended to all secrets in the storage backend | `chainloop` |
| `secretsBackend.vault.address` | Vault address | |
| `secretsBackend.vault.token` | Vault authentication token | |
| `secretsBackend.awsSecretManager.accessKey` | AWS Access KEY ID | |
| `secretsBackend.awsSecretManager.secretKey` | AWS Secret Key | |
| `secretsBackend.awsSecretManager.region` | AWS Secret Manager Region | |
| `secretsBackend.gcpSecretManager.projectId` | GCP Project ID | |
| `secretsBackend.gcpSecretManager.serviceAccountKey` | GCP Auth Key | |
| Name | Description | Value |
| --------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------- |
| `secretsBackend.backend` | Secrets backend type ("vault", "awsSecretManager" or "gcpSecretManager", "azureKeyVault") | `vault` |
| `secretsBackend.secretPrefix` | Prefix that will be pre-pended to all secrets in the storage backend | `chainloop` |
| `secretsBackend.vault.address` | Vault address | |
| `secretsBackend.vault.token` | Vault authentication token | |
| `secretsBackend.awsSecretManager.accessKey` | AWS Access KEY ID | |
| `secretsBackend.awsSecretManager.secretKey` | AWS Secret Key | |
| `secretsBackend.awsSecretManager.region` | AWS Secret Manager Region | |
| `secretsBackend.gcpSecretManager.projectId` | GCP Project ID | |
| `secretsBackend.gcpSecretManager.serviceAccountKey` | GCP Auth Key | |
| `secretsBackend.azureKeyVault.tenantID` | Active Directory Tenant ID | |
| `secretsBackend.azureKeyVault.clientID` | Registered application / service principal client ID | |
| `secretsBackend.azureKeyVault.clientSecret` | Service principal client secret | |
| `secretsBackend.azureKeyVault.vaultURI` | Azure Key Vault URL | |

### Authentication

Expand Down
7 changes: 6 additions & 1 deletion deployment/chainloop/templates/_helpers.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,12 @@ gcpSecretManager:
{{- if eq .gcpSecretManager.serviceAccountKey "" }}
{{- fail ".Values.secretsBackend.gcpSecretManager.serviceAccountKey not set" }}
{{- end }}

{{- else if eq .backend "azureKeyVault" }}
azure_key_vault:
tenant_id: {{ required "AD tenantID required" .azureKeyVault.tenantID | quote }}
client_id: {{ required "Service principal ID required" .azureKeyVault.clientID | quote }}
client_secret: {{ required "Service principal secret required" .azureKeyVault.clientSecret | quote }}
vault_uri: {{ required "Azure Vault URL required" .azureKeyVault.vaultURI | quote }}
{{- end }}
{{- end }}
{{- end -}}
Expand Down
16 changes: 14 additions & 2 deletions deployment/chainloop/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ GKEMonitoring:

## Location where to store sensitive data. If development.true? and no overrides provided, the setup will connect to a development instance of Vault
secretsBackend:
## @param secretsBackend.backend Secrets backend type ("vault", "awsSecretManager" or "gcpSecretManager")
## @param secretsBackend.backend Secrets backend type ("vault", "awsSecretManager" or "gcpSecretManager", "azureKeyVault")
##
backend: "vault" # "awsSecretManager"
backend: "vault" # "awsSecretManager | gcpSecretManager | azureKeyVault"
## @param secretsBackend.secretPrefix Prefix that will be pre-pended to all secrets in the storage backend
##
secretPrefix: "chainloop"
Expand Down Expand Up @@ -53,6 +53,17 @@ secretsBackend:
# projectId: ""
# serviceAccountKey: ""

## @extra secretsBackend.azureKeyVault.tenantID Active Directory Tenant ID
## @extra secretsBackend.azureKeyVault.clientID Registered application / service principal client ID
## @extra secretsBackend.azureKeyVault.clientSecret Service principal client secret
## @extra secretsBackend.azureKeyVault.vaultURI Azure Key Vault URL
##
# azureKeyVault:
# tenantID: ""
# clientID: ""
# clientSecret: ""
# vaultURI: ""

## @section Authentication
##

Expand Down Expand Up @@ -634,6 +645,7 @@ cas:
## @skip cas.ingressAPI.annotations.nginx.ingress.kubernetes.io/backend-protocol
## Tell Nginx Ingress Controller to expect gRPC traffic
nginx.ingress.kubernetes.io/backend-protocol: "GRPC"
## @skip cas.ingressAPI.annotations.nginx.ingress.kubernetes.io/client-body-buffer-size
# Improve upload speed by adding client buffering used by http2 control-flows
# https://github.com/chainloop-dev/chainloop/issues/375
nginx.ingress.kubernetes.io/client-body-buffer-size: "3M"
Expand Down