From 74e998bb9e71503a3b1368e68aa18be40d8c1ddb Mon Sep 17 00:00:00 2001 From: Solvik Blum Date: Wed, 7 Aug 2024 11:01:49 +0200 Subject: [PATCH] add new variables to README.md --- README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2d3a608..9dbe64e 100644 --- a/README.md +++ b/README.md @@ -219,18 +219,20 @@ Any admin on GitLab is an admin of the Kubernetes cluster. ## Advanced configuration `gitlab2rbac` supports multiple environment variables for advanced configuration: -| Flag | Description | Default | -|:------------------------------------|:----------------------------------------------------------------------------|:-----------| -|`GITLAB2RBAC_FREQUENCY` |Update interval in seconds. |60 | -|`GITLAB_ADMINS_GROUP` |Base your k8s admins on GitLab namespace (None means GitLab administrators). |None | -|`GITLAB_GROUPS_SEARCH` |Limit to those groups (separated by commas, empty means all groups). |gitlab2rbac | -|`GITLAB_NAMESPACE_GRANULARITY` |Whether to get permissions from GitLab projects or groups. |project | -|`GITLAB_PRIVATE_TOKEN` |Configure gitlab API token. | | -|`GITLAB_TIMEOUT` |Timeout for GitLab operations, in seconds. |10 | -|`GITLAB_URL` |Configure gitlab API target. | | -|`KUBERNETES_AUTO_CREATE` |Replicate GitLab groups/projects as Kubernetes namespaces. |False | -|`KUBERNETES_LOAD_INCLUSTER_CONFIG` |Load configuration inside Kubernetes when gitlab2rbac runs as a pod. |False | -|`KUBERNETES_TIMEOUT` |Timeout for Kubernetes operations, in seconds. |10 | +| Flag | Description | Default | +|:------------------------------------|:----------------------------------------------------------------------------|:------------------| +|`GITLAB2RBAC_FREQUENCY` |Update interval in seconds. |60 | +|`GITLAB_ADMINS_GROUP` |Base your k8s admins on GitLab namespace (None means GitLab administrators). |None | +|`GITLAB_GROUPS_IGNORE_LIST` |Groups to ignore (separated by commas, default value is "lost-and-found" |lost-and-found | +|`GITLAB_GROUPS_SEARCH` |Limit to those groups (separated by commas, empty means all groups). |gitlab2rbac | +|`GITLAB_NAMESPACE_GRANULARITY` |Whether to get permissions from GitLab projects or groups. |project | +|`GITLAB_PRIVATE_TOKEN` |Configure gitlab API token. | | +|`GITLAB_USERNAME_IGNORE_LIST` |Gitlab users to ignore for the synchronisation | | +|`GITLAB_TIMEOUT` |Timeout for GitLab operations, in seconds. |10 | +|`GITLAB_URL` |Configure gitlab API target. | | +|`KUBERNETES_AUTO_CREATE` |Replicate GitLab groups/projects as Kubernetes namespaces. |False | +|`KUBERNETES_LOAD_INCLUSTER_CONFIG` |Load configuration inside Kubernetes when gitlab2rbac runs as a pod. |False | +|`KUBERNETES_TIMEOUT` |Timeout for Kubernetes operations, in seconds. |10 | ## License MIT