Skip to content
This repository has been archived by the owner on Oct 8, 2024. It is now read-only.

Commit

Permalink
GitLab IDAM documentation (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael-Kruggel authored Sep 14, 2023
1 parent 9119d72 commit 7453f3b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,7 @@ set -o history
```bash
make build/uds-capability-gitlab
```

## Documentation

[Identity and Access Management](docs/idam.md)
19 changes: 19 additions & 0 deletions docs/idam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# IDAM integration with uds-capability-gitlab

This gitlab capability is preconfigured to work with an IDAM solution, but IDAM is disabled by default.

## IDAM Variables

These Zarf variables are mapped to gitlab helm chart values that are documented [here.](https://docs.gitlab.com/charts/charts/globals#omniauth)

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| IDAM_ENABLED | bool | `false` | Enables/disables IDAM |
| IDAM_ALLOWED_SSOS | list | `[]` | Enables auto creation of accounts when signing in with OmniAuth |
| IDAM_BLOCK_AUTO_USERS | bool | `false` | Enables/disables auto created users being blocked by default |
| IDAM_AUTO_LINK_USER | string | `""` | Allows users authenticating via an OmniAuth provider to be automatically linked to a current GitLab user |
| IDAM_AUTO_SIGNIN | string | `""` | Single provider name allowed to automatically sign in |
| IDAM_EXTERNAL_PROVIDERS | list | `[]` | Define which OmniAuth providers you want to be external |
| IDAM_PROVIDERS | multi-line list | `[]` | [See documentation](https://docs.gitlab.com/charts/charts/globals#providers) |
| IDAM_SYNC_ATTRIBUTES | list | `[]` | List of profile attributes to sync from the provider upon login |
| IDAM_SYNC_PROVIDERS | list | `[]` | List of provider names that GitLab should automatically sync profile information from |

0 comments on commit 7453f3b

Please sign in to comment.