将 Semaphore 配置作为代码管理

将受支持的项目、仓库和任务模板定义为代码。在变更自动化平台之前，先审查 Terraform 计划。

免费安装提供程序文档
main.tf
resource "semaphoreui_project" "production_ops" {  name = "Production operations"  alert = true  max_parallel_tasks = 10}

还在手动配置 Semaphore？

在多个项目中反复配置很耗时，手动变更也很容易失去追踪。

通过 Terraform 提供程序在 Git 中定义受支持的 Semaphore 资源，并在应用之前审查变更。

使用 Terraform 创建第一个 Semaphore 项目

Terraform 配置通过 API 管理 Semaphore 项目、仓库和任务模板
  1. 01

    将提供程序连接到 Semaphore

    设置 Semaphore 地址，并使用 API 令牌认证。

  2. 02

    在 Git 中定义资源

    声明项目、仓库和任务模板。与基础设施配置一起，在同一个拉取请求中审查变更。

  3. 03

    先审查计划，再应用变更

    应用前先查看拟议变更。将配置保存在 Git 中，以供下次更新。

获取 Terraform 提供程序

管理作业依赖的平台

管理团队执行的作业

将可重用的执行配置保存在受支持的提供程序资源中。

任务模板

通过 API 连接配置

提供程序通过相同的平台 API 配置 Semaphore。

API 与 Webhook

提供程序的边界与 Semaphore 的职责

配置执行作业的平台

提供程序 README 列出了项目、环境、清单、密钥、仓库、计划、模板、用户和视图。资源覆盖范围取决于提供程序版本。请使用注册表文档确认具体字段和生命周期行为，不要假定每个 UI 设置都有相应资源表示。

应用平台变更之前先审查

执行计划让团队了解受管资源的拟议变更。修改模板可能改变未来的运维执行，因此审查这些差异时应像审查可执行源代码一样谨慎。Terraform 状态和提供程序凭据也需要适当的访问控制与后端策略。

了解当前维护模式

提供程序仓库目前说明，其采用 AI 辅助的尽力维护方式，并注明没有积极维护。这是采用时的重要考虑因素。在将其作为关键资源配置依赖之前，请测试所需资源、固定版本并阅读未解决的问题。

文档与相关功能

FAQ

Semaphore Terraform 提供程序管理哪些内容？

提供程序通过 Semaphore API 管理受支持的 Semaphore 资源，例如项目、仓库、模板和文档所列的其他资源类别。它配置的是平台本身，不同于通过 Semaphore 执行管理云基础设施的 Terraform 代码。请查看所固定提供程序版本的资源和参数文档，因为 Web UI 中存在某个设置，并不能证明提供程序也支持它。

必须在 Semaphore 内运行 Terraform 才能使用提供程序吗？

不需要。只要运行环境能够访问 Semaphore API，并以所需权限认证，就可以在任何运行 Terraform 的地方使用提供程序。您可以使用工作站或现有配置流水线。请明确提供程序的执行环境、API 凭据和状态后端。如果之后通过 Semaphore 自身运行它，应仔细评估这项依赖，确保平台配置及其执行能力都可恢复。

能将 Semaphore Terraform 提供程序与 OpenTofu 一起使用吗？

提供程序使用 Terraform 提供程序协议。本地测试在 OpenTofu 中固定 semaphoreui/semaphore 0.3.9，并连接隔离的 Semaphore 2.19.12 实例。测试读取了现有项目、创建了可丢弃项目，并在后续计划中确认没有漂移。该测试未覆盖 Terraform CLI 或每一种提供程序资源。采用之前，请固定自己的版本，并验证团队需要的资源和生命周期操作。

能将现有 UI 创建的资源导入 Terraform 吗？

请在所锁定的提供程序版本文档中确认每种资源的导入支持和所需标识符。不要假定所有资源的导入行为相同。在应用计划之前，先确定如何表示现有配置，以及后续变更由哪个系统管理。从非生产资源开始，检查生成的状态和拟议变更，避免意外替换正在使用的共享配置。

能将 Semaphore 配置保存在 Git 中吗？

可以。将受支持 Semaphore 资源的 Terraform 配置保存在版本控制仓库中，按常规拉取请求流程审查变更。提供程序通过 Semaphore API 应用配置。API 凭据应与代码分开存储，并根据团队管理的配置选择合适的状态后端。

提供程序能管理任务模板吗？

任务模板属于提供程序文档中记录的资源类别。请通过注册表参考确认所锁定版本支持的具体参数。模板变更可能影响后续自动化运行，因此在团队使用更新后的作业之前，应审查计划，并在 Semaphore 中确认生成的配置。

使用提供程序与在 Semaphore 中运行 Terraform 是一回事吗？

两者用途不同。提供程序通过 API 管理 Semaphore 配置，Terraform 任务模板则从 Semaphore 执行基础设施配置。可以独立使用任一方式：在现有 Terraform 环境中配置自动化平台，再使用其模板运行团队已有的基础设施作业。

提供程序 API 令牌和 Terraform 状态应保存在哪里？

通过受支持的提供程序配置提供 API 令牌，不要提交到 Git。为 Terraform 状态后端配置适合团队的访问与备份控制。执行提供程序的环境需要能够连接 Semaphore，并使用有权管理配置中声明资源的身份。