|
# 配置 Runners[](#configuring-CODECHINA-runners "Permalink")
|
|
# 配置 Runners[](#configuring-CODECHINA-runners "Permalink")
|
|
|
|
|
|
在 CODECHINA CI/CD 中,runners 运行[`.codechina-ci.yml`](/docs/ci/yaml.md)定义的代码。Runner 是一种轻量级,高度可扩展的代理,它通过 CI/CD 的协调器 API 提取 CI 流水线任务,运行该流水线任务,并将结果发送回 CODECHINA 实例。
|
|
在 CODECHINA CI/CD 中,runners 运行[`.codechina-ci.yml`](/docs/ci/yaml)定义的代码。Runner 是一种轻量级,高度可扩展的代理,它通过 CI/CD 的协调器 API 提取 CI 流水线任务,运行该流水线任务,并将结果发送回 CODECHINA 实例。
|
|
|
|
|
|
Runners 由管理员创建,并在 CODECHINA UI 中可见。
|
|
Runners 由管理员创建,并在 CODECHINA UI 中可见。
|
|
|
|
|
... | @@ -86,7 +86,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -86,7 +86,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
要启用共享 runners:
|
|
要启用共享 runners:
|
|
|
|
|
|
1. 转到项目的 **设置> CI/CD**,然后展开 **Runners**部分。
|
|
1. 转到项目的 **设置> DevOps**,然后展开 **Runners**部分。
|
|
2. 点击 **为此项目启用共享 runners**。
|
|
2. 点击 **为此项目启用共享 runners**。
|
|
|
|
|
|
#### 禁用共享 Runners[](#disable-shared-runners "Permalink")
|
|
#### 禁用共享 Runners[](#disable-shared-runners "Permalink")
|
... | @@ -95,7 +95,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -95,7 +95,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
要为项目禁用共享 runners:
|
|
要为项目禁用共享 runners:
|
|
|
|
|
|
1. 转到项目的 **设置> CI/CD**, 然后展开 **Runners**部分。
|
|
1. 转到项目的 **设置> DevOps**, 然后展开 **Runners**部分。
|
|
2. 在 **共享 runners**区域中,单击 **为此项目启用共享 runners** 使开关变灰。
|
|
2. 在 **共享 runners**区域中,单击 **为此项目启用共享 runners** 使开关变灰。
|
|
|
|
|
|
### 组织 Runners[](#group-runners "Permalink")
|
|
### 组织 Runners[](#group-runners "Permalink")
|
... | @@ -106,22 +106,22 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -106,22 +106,22 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
#### 创建组 Runner[](#create-a-group-runner "Permalink")
|
|
#### 创建组 Runner[](#create-a-group-runner "Permalink")
|
|
|
|
|
|
你可以为自己管理的 CODECHINA 实例或 CODECHINA.com 创建一个组 Runner。 你必须具有该组的[所有者权限](/docs/user/permissions.md#group-members-permissions) 。
|
|
你可以为自己管理的 CODECHINA 实例或 CODECHINA.com 创建一个组 Runner。 你必须具有该组的[所有者权限](/docs/user/permissions#group-members-permissions) 。
|
|
|
|
|
|
创建组 runner:
|
|
创建组 runner:
|
|
|
|
|
|
1. 安装 Runner。
|
|
1. 安装 Runner。
|
|
2. 转到你要使 Runner 运行的组。
|
|
2. 转到你要使 Runner 运行的组。
|
|
3. 去 **设置> CI/CD**,然后展开 **Runners**部分。
|
|
3. 去 **设置> DevOps**,然后展开 **Runners**部分。
|
|
4. 记下 URL 和令牌。
|
|
4. 记下 URL 和令牌。
|
|
5. 注册 Runner。
|
|
5. 注册 Runner。
|
|
|
|
|
|
#### 查看和管理组 Runners[](#view-and-manage-group-runners "Permalink")
|
|
#### 查看和管理组 Runners[](#view-and-manage-group-runners "Permalink")
|
|
|
|
|
|
你可以查看和管理组,其子组和项目的所有 runners。 你可以为自己管理的 CODECHINA 实例或 codechina.csdn.net 执行此操作。 你必须具有该组的[所有者权限](/docs/user/permissions.md#group-members-permissions) 。
|
|
你可以查看和管理组,其子组和项目的所有 runners。 你可以为自己管理的 CODECHINA 实例或 codechina.csdn.net 执行此操作。 你必须具有该组的[所有者权限](/docs/user/permissions#group-members-permissions) 。
|
|
|
|
|
|
1. 转到要查看 runners 的组。
|
|
1. 转到要查看 runners 的组。
|
|
2. 去 **设置> CI/CD**,然后展开"**Runners**部分。
|
|
2. 去 **设置> DevOps**,然后展开"**Runners**部分。
|
|
3. 显示以下字段。
|
|
3. 显示以下字段。
|
|
|
|
|
|
| Attribute | Description |
|
|
| Attribute | Description |
|
... | @@ -140,7 +140,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -140,7 +140,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
#### 暂停或移除组 runner[](#pause-or-remove-a-group-runner "Permalink")
|
|
#### 暂停或移除组 runner[](#pause-or-remove-a-group-runner "Permalink")
|
|
|
|
|
|
你可以为自己管理的 CODECHINA 实例或 codechina.csdn.net 暂停或删除组 runner。 你必须具有该组的[所有者权限](/docs/user/permissions.md#group-members-permissions) 。
|
|
你可以为自己管理的 CODECHINA 实例或 codechina.csdn.net 暂停或删除组 runner。 你必须具有该组的[所有者权限](/docs/user/permissions#group-members-permissions) 。
|
|
|
|
|
|
1. 转到你要删除或暂停 Runner 的组。
|
|
1. 转到你要删除或暂停 Runner 的组。
|
|
2. 去 **设置> CI/ CD**,然后展开 **Runners**部分。
|
|
2. 去 **设置> CI/ CD**,然后展开 **Runners**部分。
|
... | @@ -164,12 +164,12 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -164,12 +164,12 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
#### 创建一个特定的 Runner[](#create-a-specific-runner "Permalink")
|
|
#### 创建一个特定的 Runner[](#create-a-specific-runner "Permalink")
|
|
|
|
|
|
你可以为自己管理的 CODECHINA 实例或 codechina.csdn.net 创建特定的 Runner。 你必须具有项目的[所有者权限](/docs/user/permissions.md#project-members-permissions) 。
|
|
你可以为自己管理的 CODECHINA 实例或 codechina.csdn.net 创建特定的 Runner。 你必须具有项目的[所有者权限](/docs/user/permissions#project-members-permissions) 。
|
|
|
|
|
|
要创建特定的 runner:
|
|
要创建特定的 runner:
|
|
|
|
|
|
1. 安装 Runner。
|
|
1. 安装 Runner。
|
|
2. 转到项目的 **设置> CI/CD**,然后展开**Runners**部分。
|
|
2. 转到项目的 **设置> DevOps**,然后展开**Runners**部分。
|
|
3. 记下 URL 和令牌。
|
|
3. 记下 URL 和令牌。
|
|
4. 注册 Runner。
|
|
4. 注册 Runner。
|
|
|
|
|
... | @@ -182,7 +182,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -182,7 +182,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
要为项目启用或禁用特定的 runners:
|
|
要为项目启用或禁用特定的 runners:
|
|
|
|
|
|
1. 转到项目的 **设置> CI/CD**,然后展开 **Runners**部分。
|
|
1. 转到项目的 **设置> DevOps**,然后展开 **Runners**部分。
|
|
2. 点击 **为此项目启用** 或 **为此项目禁用**。
|
|
2. 点击 **为此项目启用** 或 **为此项目禁用**。
|
|
|
|
|
|
#### 防止为其他项目启用特定 Runner [](#prevent-a-specific-runner-from-being-enabled-for-other-projects "Permalink")
|
|
#### 防止为其他项目启用特定 Runner [](#prevent-a-specific-runner-from-being-enabled-for-other-projects "Permalink")
|
... | @@ -191,7 +191,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -191,7 +191,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
锁定或解锁 runner:
|
|
锁定或解锁 runner:
|
|
|
|
|
|
1. 转到项目的 **设置> CI/CD**,然后展开 **Runners**部分。
|
|
1. 转到项目的 **设置> DevOps**,然后展开 **Runners**部分。
|
|
2. 找到你想要锁定或解锁的 runner。 确保已启用。
|
|
2. 找到你想要锁定或解锁的 runner。 确保已启用。
|
|
3. 单击铅笔按钮。
|
|
3. 单击铅笔按钮。
|
|
4. 选中 **锁定到当前项目**选项。
|
|
4. 选中 **锁定到当前项目**选项。
|
... | @@ -199,7 +199,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -199,7 +199,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
## 为 Runner 设置最大流水线任务超时[](#set-maximum-job-timeout-for-a-runner "Permalink")
|
|
## 为 Runner 设置最大流水线任务超时[](#set-maximum-job-timeout-for-a-runner "Permalink")
|
|
|
|
|
|
对于每个 runner,你可以指定*最大流水线任务超时时间* 。 如果此超时时间小于[项目定义的超时时间](/docs/ci/pipelines/settings.md#timeout) ,则优先。
|
|
对于每个 runner,你可以指定*最大流水线任务超时时间* 。 如果此超时时间小于[项目定义的超时时间](/docs/ci/pipelines/settings#timeout) ,则优先。
|
|
|
|
|
|
此功能可用于防止共享的 Runner 被具有较长超时(例如,一个星期)的工作的项目淹没。
|
|
此功能可用于防止共享的 Runner 被具有较长超时(例如,一个星期)的工作的项目淹没。
|
|
|
|
|
... | @@ -238,7 +238,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -238,7 +238,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
### 防止 Runners 泄露敏感信息[](#prevent-runners-from-revealing-sensitive-information "Permalink")
|
|
### 防止 Runners 泄露敏感信息[](#prevent-runners-from-revealing-sensitive-information "Permalink")
|
|
|
|
|
|
你可以保护 runners ,使他们不会泄露敏感信息。 当 runner 受到保护时,runner 仅选择在[受保护分支](/docs/user/project/protected_branches.md)或[受保护标签](/docs/user/project/protected_tags.md)上创建的流水线任务,而忽略其他流水线任务。
|
|
你可以保护 runners ,使他们不会泄露敏感信息。 当 runner 受到保护时,runner 仅选择在[受保护分支](/docs/user/project/protected_branches)或[受保护标签](/docs/user/project/protected_tags)上创建的流水线任务,而忽略其他流水线任务。
|
|
|
|
|
|
保护或取消保护跑步者:
|
|
保护或取消保护跑步者:
|
|
|
|
|
... | @@ -264,7 +264,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -264,7 +264,7 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
重置令牌:
|
|
重置令牌:
|
|
|
|
|
|
1. 转到项目的 **设置> CI/CD** 。
|
|
1. 转到项目的 **设置> DevOps** 。
|
|
2. 展开**流水线通用设置**部分。
|
|
2. 展开**流水线通用设置**部分。
|
|
3. 找到 **Runner 令牌**表单字段,然后单击 **显示值**按钮。
|
|
3. 找到 **Runner 令牌**表单字段,然后单击 **显示值**按钮。
|
|
4. 删除值并保存表单。
|
|
4. 删除值并保存表单。
|
... | @@ -289,9 +289,9 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -289,9 +289,9 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
### 确定特定 Runner 的 IP 地址[](#determine-the-ip-address-of-a-specific-runner "Permalink")
|
|
### 确定特定 Runner 的 IP 地址[](#determine-the-ip-address-of-a-specific-runner "Permalink")
|
|
|
|
|
|
若要查找特定项目的 runner 的 IP 地址,你必须具有该项目的所有者[权限](/docs/user/permissions.md#project-members-permissions) 。
|
|
若要查找特定项目的 runner 的 IP 地址,你必须具有该项目的所有者[权限](/docs/user/permissions#project-members-permissions) 。
|
|
|
|
|
|
1. 转到项目的 **设置> CI/CD**,然后展开 **Runners**部分。
|
|
1. 转到项目的 **设置> DevOps**,然后展开 **Runners**部分。
|
|
2. 在详细信息页面上,你应该看到**IP 地址**行。
|
|
2. 在详细信息页面上,你应该看到**IP 地址**行。
|
|
|
|
|
|
[![specific Runner IP address](img/b6c59d6785a7941658315a7e8e148751.png)](img/specific_runner_ip_address.png)
|
|
[![specific Runner IP address](img/b6c59d6785a7941658315a7e8e148751.png)](img/specific_runner_ip_address.png)
|
... | @@ -300,15 +300,15 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
... | @@ -300,15 +300,15 @@ CODECHINA 实例中的每个项目都可以使用*共享 Runners* 。 |
|
|
|
|
|
你必须设置一个 Runner 才能运行它在共享项目上可能遇到的所有不同类型的流水线任务。 如果不是标签,这对于大量项目将是有问题的。
|
|
你必须设置一个 Runner 才能运行它在共享项目上可能遇到的所有不同类型的流水线任务。 如果不是标签,这对于大量项目将是有问题的。
|
|
|
|
|
|
通过将 Runner 标记为它可以处理的流水线任务类型,可以确保共享的 Runners [仅运行其能够运行的流水线任务](/docs/ci/yaml.md#tags) 。
|
|
通过将 Runner 标记为它可以处理的流水线任务类型,可以确保共享的 Runners [仅运行其能够运行的流水线任务](/docs/ci/yaml#tags) 。
|
|
|
|
|
|
例如,在 CODECHINA 上,如果 Runners 包含运行 Rails 测试套件的适当依赖项,我们会将它们标记为`rails` 。
|
|
例如,在 CODECHINA 上,如果 Runners 包含运行 Rails 测试套件的适当依赖项,我们会将它们标记为`rails` 。
|
|
|
|
|
|
注册 Runner 时 ,其默认行为是**仅选择带** [标签的流水线任务](/docs/ci/yaml.md#tags) 。 要更改此设置,你必须具有项目的所有者[权限](/docs/user/permissions.md#project-members-permissions) 。
|
|
注册 Runner 时 ,其默认行为是**仅选择带** [标签的流水线任务](/docs/ci/yaml#tags) 。 要更改此设置,你必须具有项目的所有者[权限](/docs/user/permissions#project-members-permissions) 。
|
|
|
|
|
|
要使 runner 选择无标签的工作,请执行以下操作:
|
|
要使 runner 选择无标签的工作,请执行以下操作:
|
|
|
|
|
|
1. 转到项目的 **设置> CI/CD**,然后展开 **Runners**部分。
|
|
1. 转到项目的 **设置> DevOps**,然后展开 **Runners**部分。
|
|
2. 找到你要选择未加标签的流水线任务的 Runner,并确保已启用它。
|
|
2. 找到你要选择未加标签的流水线任务的 Runner,并确保已启用它。
|
|
3. 单击铅笔按钮。
|
|
3. 单击铅笔按钮。
|
|
4. 选中**运行未加标签的流水线任务**选项。
|
|
4. 选中**运行未加标签的流水线任务**选项。
|
... | | ... | |