You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 13, 2024. It is now read-only.
A requirement to run your own Chainloop instance, is to have a secure credentials backend where sensitive information such as API tokens can be stored.
8
+
9
+
If you are running your instance in Azure, you might want to leverage the [Azure KeyVault](https://azure.microsoft.com/en-us/products/key-vault) secret backend for that purpose.
10
+
During this guide we'll walk you through the process of a) create/retrieve credentials and configure the Key Vault in Azure and b) deploy Chainloop using that new configuration.
11
+
12
+
## Pre-requisites
13
+
14
+
To configure your Chainloop instance with Azure KeyVault you'll need the following information from your Azure account:
15
+
16
+
- Active Directory Tenant ID
17
+
- Service Principal ID
18
+
- Service Principal Secret
19
+
- Vault URI
20
+
21
+
We'll walk you through the process of how to find this information
22
+
23
+
## Register an application to create the service principal
24
+
25
+
First, you'll need to register an application in your Azure Active Directory tenant. You can do this using the Azure CLI or from the Azure portal
26
+
27
+

28
+
29
+
Once done, in the application overview you should be able to find the tenantID, and Service principal ID
30
+
31
+

32
+
33
+
Next, let's create a secret for the service principal.
34
+
35
+

36
+
37
+
## Create a Vault instance and give permissions
38
+
39
+
Next, we'll create a Key Vault (or you can use an existing one)
40
+
41
+

42
+
43
+
Take a note on the Vault URI
44
+
45
+

46
+
47
+
Next, in the Vault IAM section, let's give permissions to the service principal by clicking on Add Role Assignment.
48
+
49
+

50
+
51
+
on the role assignment role, select "Key Vault Secrets officer"
52
+
53
+

54
+
55
+
and in the members, search for the application we just registered
56
+
57
+

58
+
59
+
That's all, we got all the information we need, let's just to the deployment.
60
+
61
+
## Configure Chainloop deployment
62
+
63
+
As explained in the [deployment guide](../k8s), you can configure the credentials backend using the `secretsBackend` section of the `values.yaml` file.
64
+
65
+
Just put the information we gathered from the previous steps like this.
66
+
67
+
```yaml
68
+
secretsBackend:
69
+
backend: azureKeyVault
70
+
azureKeyVault:
71
+
tenantID: [TENANT_ID] # Active Directory Tenant ID
72
+
clientID: [CLIENT_ID] # Registered application / service principal client ID
73
+
clientSecret: [CLIENT_SECRET] # Service principal client secret
74
+
vaultURI: [VAULT URI] # Azure Key Vault URL
75
+
```
76
+
77
+
And deploy your Chainloop Control Plane with the update values to take effect.
78
+
79
+
Now your Chainloop instance will automatically store any sensitive information in the Azure KeyVault instance you just configured.
Copy file name to clipboardExpand all lines: docs/guides/deployment/k8s/k8s.mdx
+39-8Lines changed: 39 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ The Helm Chart in this mode includes
56
56
During installation, you'll need to provide
57
57
58
58
- Open ID Connect Identity Provider (IDp) settings i.e [Auth0 settings](https://auth0.com/docs/get-started/applications/application-settings#basic-information)
59
-
- Connection settings for a secrets storage backend, either [Hashicorp Vault](https://www.vaultproject.io/) or [AWS Secret Manager](https://aws.amazon.com/secrets-manager)
59
+
- Connection settings for a secrets storage backend, either [Hashicorp Vault](https://www.vaultproject.io/) or [AWS Secrets Manager](https://aws.amazon.com/secrets-manager)
60
60
- ECDSA (ES512) key-pair used for Controlplane <->CASAuthentication
Connect to an external PostgreSQL database instead
114
130
115
131
```console
@@ -148,7 +164,7 @@ The Helm Chart in this mode includes
148
164
During installation, you'll need to provide
149
165
150
166
- Open ID Connect Identity Provider (IDp) settings i.e [Auth0 settings](https://auth0.com/docs/get-started/applications/application-settings#basic-information)
151
-
-~~Connection settings for a secrets storage backend, either [Hashicorp Vault](https://www.vaultproject.io/) or [AWS Secret Manager](https://aws.amazon.com/secrets-manager)~~
167
+
-~~Connection settings for a secrets storage backend, either [Hashicorp Vault](https://www.vaultproject.io/) or [AWS Secrets Manager](https://aws.amazon.com/secrets-manager)~~
152
168
-~~ECDSA (ES512) key-pair used for Controlplane <->CASAuthentication~~
0 commit comments