Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit fecba77

Browse files
authored
feat: active directory setup (#142)
Signed-off-by: Miguel Martinez Trivino <migmartri@gmail.com>
1 parent 128eb69 commit fecba77

File tree

16 files changed

+64
-8
lines changed

16 files changed

+64
-8
lines changed

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Yes, Chainloop source code has been Open Sourced and can be found [here](https:/
1010

1111
#### Can I run my own instance of Chainloop end to end?
1212

13-
Yes, please refer to this [guide](./guides/deployment/)
13+
Yes, please refer to this [guide](./guides/deployment/k8s)
1414

1515
#### In this documentation site there are references to Chainloop Cloud, what is it?
1616

docs/getting-started/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,11 @@ cd chainloop && make -C app/cli build
6767

6868
Downloading the CLI is everything you need to give Chainloop a try since, by default, it points to a [running instance of Chainloop](https://docs.chainloop.dev/chainloop-cloud).
6969

70-
**To run a Chainloop instance** on your Kubernetes cluster follow [these instructions](/guides/deployment).
70+
**To run a Chainloop instance** on your Kubernetes cluster follow [these instructions](/guides/deployment/k8s).
7171

7272
## Configure CLI (optional)
7373

74-
If you [are running your own instance](/guides/deployment) of Chainloop Control Plane. You can make the CLI point to your instance by using the `chainloop config save` command.
74+
If you [are running your own instance](/guides/deployment/k8s) of Chainloop Control Plane. You can make the CLI point to your instance by using the `chainloop config save` command.
7575

7676
```sh
7777
chainloop config save \
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Deployment",
3+
"collapsed": true
4+
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Use Active Directory as Single Sign-On provider
3+
---
4+
5+
import Image from "@theme/IdealImage";
6+
7+
Chainloop authentication backend is delegated to an OpenID Connect (OIDC) compatible Identity Provider (IdP) such as Google, GitHub, Auth0 or Azure Active Directory.
8+
9+
This guide will show you how to configure your Chainloop instance to run authentication over Azure Active Directory.
10+
11+
The process comprises two steps:
12+
13+
1. Register a new App in your Azure Active Directory tenant
14+
2. Configure Chainloop deployment with the new OIDC settings
15+
16+
## Register a new App
17+
18+
In your Azure console go to **App registrations** and click on **New registration**.
19+
20+
<Image img={require("./register-app.png")} />
21+
22+
Fill out a descriptive name and your custom callback URL that should point to your instance of Chainloop control plane.
23+
24+
<Image img={require("./register-app-2.png")} />
25+
26+
Once done, take note of the generated **Application (client) ID** and the tenant ID.
27+
28+
<Image img={require("./register-app-0.png")} />
29+
30+
Next Create a new client secret and copy the generated value by clicking on "Certificate & secrets" > "New client secret"
31+
32+
<Image img={require("./register-app-3.png")} />
33+
34+
Once done, copy the "value" which will be used as the `clientSecret` in the next step.
35+
36+
<Image img={require("./register-app-4.png")} />
37+
38+
## Configure Chainloop deployment
39+
40+
As explained in the [deployment guide](../k8s), Open ID Connect configuration is done using the `auth.oidc` section of the `values.yaml` file.
41+
42+
Use the ClientID, Secret and URL from the previous step to configure the OIDC backend as shown below
43+
44+
```yaml
45+
auth:
46+
oidc:
47+
url: https://login.microsoftonline.com/[TENANT_ID]/v2.0
48+
clientID: [APP-CLIENT-ID]
49+
clientSecret: "[APP-CLIENT-SECRET]"
50+
```
51+
52+
And deploy your Chainloop Control Plane with the update values to take effect.
53+
54+
Finally give it a try by running `chainloop auth login` and that's all! Your Chainloop users are now authenticated against your Active Directory tenant.
55+
56+
94 KB
Loading

0 commit comments

Comments
 (0)