用户指南
本节面向已经拥有 Semaphore 项目访问权限的人。这里的所有操作都在 Web 界面中或通过 项目 API 完成。服务器的安装、配置以及接入身份提供方请参阅管理员指南。
Semaphore 中的工作遵循同一条链路。项目承载其他一切。在项目内部,你要注册一次 运行所需的资源:存放 playbook 或脚本的仓库、用于访问仓库和主机的密钥、目标 机器的清单,以及包含取值和机密的变量组。任务模板把这些组合成对运行内容 的定义,而该模板的每一次运行就是一个任务。计划任务、工作流和传入的 Webhook 会 替你启动模板。
搭建项目
请按此顺序进行,因为每一步都依赖上一步。
| 页面 | 涵盖内容 |
|---|---|
| 项目 | 创建项目、侧边栏中的各个区域,以及备份与恢复。 |
| 团队 | 四种内置角色,以及 Enterprise 版的自定义角色。 |
| 密钥库 | SSH 密钥、登录凭据和外部机密存储。 |
| 仓库 | 存放自动化代码的 Git 仓库和本地路径。 |
| 清单 | Ansible 的主机与连接设置,Terraform 的工作区。 |
| 变量组 | 传入任务、可复用的变量和机密。 |
定义并运行工作
| 页面 | 涵盖内容 |
|---|---|
| 任务模板 | 模板表单的每个字段,以及模板类型。 |
| 应用 | 每种应用运行什么:Ansible、Terraform、OpenTofu、Terragrunt 和脚本。 |
| 任务 | 启动任务、任务状态、日志、停止和重新运行。 |
| 计划任务 | 按 cron 计划运行模板。 |
| 工作流 | 通过审批和分支把模板串联起来。 |
| 集成 | 通过传入的 Webhook 启动任务。 |
| 项目运行器 | 把项目的任务发送到你自己的运行器。 |
| 您的账户 | 个人设置和 API 令牌。 |
从哪里开始
如果有人刚把你加入一个项目,请先阅读项目熟悉界面,然后阅读 任务运行一个任务并查看它的日志。如果你要从零搭建一个项目, 请按上面表格的顺序进行。
完全没用过 Semaphore?请从快速入门开始。