GitLab Source Plugin Configuration Reference

Example #

kind: source
# Common source-plugin configuration
spec:
  name: gitlab
  path: cloudquery/gitlab
  registry: cloudquery
  version: "v7.6.4"
  tables: ["gitlab_users"]
  destinations: ["postgresql"]

  # Gitlab specific configuration
  # Learn more about the configuration options at https://cql.ink/gitlab_source
  spec:
    # required
    access_token: "${GITLAB_ACCESS_TOKEN}"
    # optional, leave empty for GitLab SaaS
    # base_url: "<INSTANCE_URL>"

GitLab Spec #

• auth_method (string) (optional, default: api_key)

  This plugin supports different authentication methods when communicating with the GitLab API. Depending on the chosen authentication method, additional configuration parameters are required.

  Supported values are api_key and bearer_token. If the api_key method is selected, the following additional configuration parameters will be used. If the bearer_token method is selected, the following additional configuration parameters will be used.
• base_url (string, optional): URL for your self hosted GitLab server. Leave empty for GitLab SaaS. Not all tables are supported for GitLab SaaS.
• concurrency (integer, optional, default: 10000) A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
• scheduler (string, optional, default: dfs) The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.

  For more information about this, see performance tuning.

API Key Configuration Reference #

• access_token (string, required): An access token for your GitLab server. For instructions on how to generate an access token visit the GitLab docs.

Bearer Token Configuration Reference #

• bearer_token (string) (required)

  The OAuth 2.0 Bearer Token to authenticate with (recommendation: Use environment variable instead of hardcoded the token in the config).