使用Terraform Gitlab Provider创建项目时遇分支保护状态错误

错误信息 #

╷
│ Error: error while waiting for branch  to reach 'protected' status, json: cannot unmarshal array into Go value of type gitlab.Branch
│ 
│   with gitlab_project.peters_repo,
│   on main.tf line 11, in resource "gitlab_project" "peters_repo":
│   11: resource "gitlab_project" "peters_repo" {
│ 
╵

现有配置文件 #

variables.tf #

variable "gitlab_token" {
  default = "*my token*"
}
variable "gitlab_url" {
  default = "*my gitlab url*"
}

variable "default_branch" {
  default = "master"
}

main.tf #

resource "gitlab_group" "example" {
  name        = "Example Group"
  path        = "example_group"
  description = "An example group"
}

resource "gitlab_project" "peters_repo" {
  name         = "test-repo"
  description  = "This is a description"
  namespace_id = gitlab_group.example.id

  default_branch = var.default_branch

  provisioner "local-exec" {
    command = "curl --request DELETE '${var.gitlab_url}/api/v4/projects/${gitlab_project.peters_repo.id}/protected_branches/${var.default_branch}' --header 'PRIVATE-TOKEN: ${var.gitlab_token}'"
  }
}

resource "gitlab_branch_protection" "example_protection" {
  project = gitlab_project.peters_repo.id
  branch  = var.default_branch

  push_access_level  = "maintainer"
  merge_access_level = "maintainer"
}

providers.tf #

terraform {
  required_version = "~> 1.4"

  required_providers {
    gitlab = {
      source  = "gitlabhq/gitlab"
      version = "15.10.0"
    }
  }
}

provider "gitlab" {
  token = var.gitlab_token
  base_url = "var.gitlab_url"
}

问题分析与修复方案 #

1. 修正Provider的base_url配置 #

providers.tf中base_url错误地用字符串包裹变量，导致Provider无法正确连接到自托管GitLab，返回异常的JSON结构。修改为直接引用变量：

provider "gitlab" {
  token    = var.gitlab_token
  base_url = var.gitlab_url # 移除引号，直接使用变量
}

2. 避免分支保护冲突并确保默认分支存在 #

• gitlab_project资源默认会自动保护默认分支，同时使用gitlab_branch_protection资源会引发冲突，需要禁用默认保护。
• 如果仓库未初始化，默认分支可能不存在，添加初始化配置确保分支存在。
• 移除不必要的local-exec，Terraform资源可自动管理分支保护。

修改后的gitlab_project资源：

resource "gitlab_project" "peters_repo" {
  name                   = "test-repo"
  description            = "This is a description"
  namespace_id           = gitlab_group.example.id
  default_branch         = var.default_branch
  protect_default_branch = false # 禁用默认分支保护，交由gitlab_branch_protection管理
  initialize_with_readme = true  # 初始化仓库，确保默认分支存在
}

3. 验证版本兼容性 #

确保自托管GitLab版本与使用的Provider版本（15.10.0）兼容，建议使用GitLab 15.x版本。

执行步骤 #

1. 保存所有修改后的配置文件
2. 重新初始化Terraform：terraform init
3. 查看执行计划：terraform plan
4. 应用配置：terraform apply

内容的提问来源于stack exchange，提问作者Kyrylo