Skip to content
This repository was archived by the owner on Jan 19, 2026. It is now read-only.

Latest commit

 

History

History
250 lines (249 loc) · 11.1 KB

File metadata and controls

250 lines (249 loc) · 11.1 KB

gitlab module options

  • gitlab.groups
    type: attribute set of submodules
    default: {}
    example: null
    defined: module/groups.nix
    description: Definition of a GitLab group
  • gitlab.groups.<name>.description
    type: string
    default: ""
    example: null
    defined: module/groups.nix
    description: The description of the group
  • gitlab.groups.<name>.id
    type: string
    default: "${gitlab_group.‹name›.id}"
    example: null
    defined: module/groups.nix
    description: Terraform reference to the id of the group. Used for convienience when referencing the group in other resources. Should not be overriden, the default value should be fine.
  • gitlab.groups.<name>.membership
    type: attribute set of submodules
    default: {}
    example: null
    defined: module/groups.nix
    description: Manage membership of the group
  • gitlab.groups.<name>.membership.<name>.accessLevel
    type: one of "no one", "minimal", "guest", "reporter", "developer", "maintainer", "owner", "master"
    default: null
    example: null
    defined: module/groups.nix
    description: Access level of the user
  • gitlab.groups.<name>.membership.<name>.userId
    type: string
    default: null
    example: null
    defined: module/groups.nix
    description: ID of the user to add to the group
  • gitlab.groups.<name>.name
    type: string
    default: "‹name›"
    example: null
    defined: module/groups.nix
    description: The name of the group
  • gitlab.groups.<name>.parentId
    type: string
    default: null
    example: null
    defined: module/groups.nix
    description: ID of the parent group
  • gitlab.groups.<name>.path
    type: string
    default: "‹name›"
    example: null
    defined: module/groups.nix
    description: The path of the group
  • gitlab.groups.<name>.settings
    type: anything
    default: {}
    example: null
    defined: module/groups.nix
    description: Any additional settings you may want to set. See the [gitlab_group resource](https://registry.terraform.io/providers/gitlabhq/gitlab/latest/docs/resources/group) documentation for a list of possible values.
  • gitlab.projects
    type: attribute set of submodules
    default: {}
    example: null
    defined: module/projects.nix
    description: Definition of a GitLab project
  • gitlab.projects.<name>.defaultBranch
    type: string
    default: "main"
    example: null
    defined: module/projects.nix
    description: Name of the default branch
  • gitlab.projects.<name>.description
    type: string
    default: ""
    example: null
    defined: module/projects.nix
    description: Description of the project
  • gitlab.projects.<name>.fileCreator.email
    type: string
    default: ""
    example: null
    defined: module/projects.nix
    description: Email of the user that will be visible in commits used to update repository files
  • gitlab.projects.<name>.fileCreator.name
    type: string
    default: "terraform"
    example: null
    defined: module/projects.nix
    description: Name of the user that will be visible in commits used to update repository files
  • gitlab.projects.<name>.files
    type: attribute set of submodules
    default: {}
    example: null
    defined: module/projects.nix
    description: Manage files that should be present in the repository
  • gitlab.projects.<name>.files.<name>.content
    type: string
    default: null
    example: null
    defined: module/projects.nix
    description: Content of the file
  • gitlab.projects.<name>.files.<name>.filePath
    type: string
    default: null
    example: null
    defined: module/projects.nix
    description: Path of the created file inside the repository
  • gitlab.projects.<name>.id
    type: string
    default: "${gitlab_project.‹name›.id}"
    example: null
    defined: module/projects.nix
    description: Terraform reference to the id of the group. Used for convienience when referencing the group in other resources. Should not be overriden, the default value should be fine.
  • gitlab.projects.<name>.name
    type: string
    default: "‹name›"
    example: null
    defined: module/projects.nix
    description: Name of the project
  • gitlab.projects.<name>.namespaceId
    type: string
    default: null
    example: null
    defined: module/projects.nix
    description: ID of the namespace (user or group) this project should be in.
  • gitlab.projects.<name>.settings
    type: anything
    default: {}
    example: null
    defined: module/projects.nix
    description: Any additional settings you may want to set. See the [gitlab_project resource](https://registry.terraform.io/providers/gitlabhq/gitlab/latest/docs/resources/project) documentation for a list of possible values.
  • gitlab.provider.enable
    type: boolean
    default: false
    example: true
    defined: module/provider.nix
    description: Whether to enable GitLab provider.
  • gitlab.rootGroup.groupId
    type: null or signed integer
    default: null
    example: null
    defined: module/root_group.nix
    description: ID of the root group.
  • gitlab.rootGroup.id
    type: string
    default: "${data.gitlab_group.root.id}"
    example: null
    defined: module/root_group.nix
    description: Terraform reference to the id of the group. Used for convienience when referencing the group in other resources. Should not be overriden, the default value should be fine.
  • gitlab.users
    type: attribute set of submodules
    default: {}
    example: null
    defined: module/users.nix
    description: Creates data objects for the given users. You can then get a terraform reference to the id of that user (for use in group or project options) using the .id option.
  • gitlab.users.<name>.id
    type: string
    default: "${data.gitlab_user.‹name›.id}"
    example: null
    defined: module/users.nix
    description: Terraform reference to the id of the user. Used for convienience when referencing the user in other resources. Should not be overriden, the default value should be fine.
  • gitlab.users.<name>.username
    type: string
    default: "‹name›"
    example: null
    defined: module/users.nix
    description: Username of the given user