dashboard.md

普通用户操作

1. 首次登陆

用户手册登陆时没有任何权限，需要找小组leader或者系统管理员添加权限。

权限添加好之后，刷新当前页面，在左侧的__项目发布__的二级导航下就可以看到你的项目了。

2. Build项目

点击左侧__项目发布__二级导航下的一个项目，即可进入项目操作页面，默认进入的Tab就是__Build__页面

在输入框中输入你需要Build的Branch、Tag或者Commit，然后点击Build按钮。

如下图所示(非管理员/项目管理者用户无法看到左边四个中文的Tab):

3. Deploy项目

点击Deploy Tab进入Deploy页面

第一选择框：

• 按机器分组发布，一般一个分组代表一个机柜
• 按环境发布, 按“测试环境”，“开发环境”，“线上环境”等环境分类发布，一般一个环境下有多个机器分组
• 按机器发布, 用于当某台机器发布出错，或者需要特别指定一台机器的时候，需要输入机器名

第二个输入框： 可能是选择框，也可能输入框，代表发布的目标机器（分组）

第三个选择框： 选择需要发布的commit。每个commit的格式如“[checkout] commit”，checkout代表branch，tag或者就是commit本身。

4. PR Build

无需手动Build，只需配置好项目在github上的hooks就可以。

5. PR Deploy

同3。需要注意的是，PR也代码可以发布到线上，请谨慎操作。

项目管理员操作（对系统管理员也适用）

1. 项目配置

在项目配置Tab下进行项目的基本配置。需要注意的是Pull Key，当刚创建项目的时候必须要配置。

配置方法：先在本地生成ssh key；进入github的项目管理页面，将生成的publick key 添加到项目的deploy key 中；在再讲private key填入Deploy系统项目配置下的Pull Key。

2. 发布配置

发布配置主要是一些发布的时候需要用到的东西，如ssh login key（发布登陆用的key），远程目录，远程操作用户等等。

3. 机器分组

分组配置非常简单，输入分组名，选择分组所属的环境即可。

4. 机器配置

添加机器有两种方式，添加单个机器和批量添加机器。 批量添加的方法如下图所示：

系统管理员操作

1. 添加角色

• 添加角色
• 删除角色
• 设置角色权限

2. 用户管理

• 删除用户
• 为用户添加角色
• 删除用户的角色

3. 项目管理

• 添加项目
• 删除项目

4. 发布环境配置

• 添加发布环境
• 删除发布环境