新建代理

概述

通过在代理机上安装Agent并接入注册到CodeArts，可以实现自定义的执行资源接入。

建议一台代理机上只安装一个Agent，如果安装多个Agent可能在执行任务时导致Agent下线。

前提条件

• 使用代理机功能，需要配备1台4U8G或以上规格、磁盘>80GB的主机。
• 安装代理的主机必须安装Java 8、Git，如果选择的资源池类型为容器，在代理机还须安装Docker。
  

  • 使用为Linux操作系统主机作为代理机，则页面中提供自动安装功能。您也可以选择手动安装，请使用root账号执行安装命令。
  • 如果使用Windows或MAC操作系统主机作为代理机，请手动在服务器中安装。
• （页面中对容器、虚拟机类型资源池提供自动安装，如果选择手动安装请使用root账号执行安装命令）。
• 安装代理的主机必须有公网访问权限，并且开通以下域名的防火墙白名单、暴露相应端口号。

  表1 区域域名对应关系

  区域名称	域名
  北京一（cn-north-1）	cloudoctopus-agent.cn-north-1.myhuaweicloud.com
  北京四（cn-north-4）	cloudoctopus-agent.cn-north-4.myhuaweicloud.com
  上海一（cn-east-3）	cloudoctopus-agent.cn-east-3.myhuaweicloud.com
  上海二（cn-east-2）	cloudoctopus-agent.cn-east-2.myhuaweicloud.com
  广州（cn-south-1）	cloudoctopus-agent.cn-south-1.myhuaweicloud.com
  深圳（cn-south-2）	cloudoctopus-agent.cn-south-2.myhuaweicloud.com
  大连（cn-northeast-1）	cloudoctopus-agent.cn-northeast-1.myhuaweicloud.com
  贵阳一（cn-southwest-2 ）	cloudoctopus-agent.cn-southwest-2.myhuaweicloud.com

  通过代理机接入服务所需要暴露的端口号范围如下：

  表2 服务端口号映射关系

  服务名称	端口号范围
  代码检查（CodeArts Check）	1200~1299
  编译构建（CodeArts Build）	1300~1399
  部署（CodeArts Deploy）	1400~1499
  测试计划（CodeArts TestPlan）	1500~1599

  可以通过如下命令检查是否已经加入白名单，如：

  telnet cloudoctopus-agent.cn-north-1.myhuaweicloud.com 1211
  telnet cloudoctopus-agent.cn-north-1.myhuaweicloud.com 1420

新建代理

1. 完成新建资源池后，在资源池列表中找到目标资源池，单击资源池名称，进入“代理列表”页面。
2. 单击“新建代理”，页面弹出对话框。
3. 根据需要完成参数配置。
   1. 配置主机所需的网络环境。

      表3 步骤一配置

      配置项	配置说明
      自动安装JDK	主机需要具备Java 8环境。 开启此开关后，将为主机自动安装JDK至“/usr/local”目录中。 如果关闭此开关，则需手动安装。如何安装Java 8？ 说明： 仅资源池类型为“LINUX”或“LINUX_DOCKER”时显示此配置项。
      自动安装Git	主机需要具备Git环境。 开启此开关后，将为主机自动安装Git。 如果关闭此开关，则需手动安装。如何安装Git？ 说明： 仅资源池类型为“LINUX”或“LINUX_DOCKER”时显示此配置项。
      自动安装Docker	主机需要具备Docker环境。 开启此开关后，将为主机自动安装Docker至“/usr/bin”目录中。安装完成后将自动注册服务并启动docker服务。 如果关闭此开关，则需手动安装。如何安装Docker？ 说明： 仅资源池类型为“LINUX”或“LINUX_DOCKER”时显示此配置项。

   2. 配置身份认证信息。

      表4 步骤二配置

      配置项	配置说明
      AK	Access Key Id。 在通过获取AK/SK下载的访问密钥文件中获取。
      SK	Secret Access Key。 在通过获取AK/SK下载的访问密钥文件中获取。
      代理名称	代理（Agent）的名称，同一台主机不可以安装相同名称的代理。 请根据实际情况填写。为了方便管理，命名建议清晰，建议关联代理机IP，如：10.10.10.10-agent-01。
      代理工作空间	代理在主机上运行的工作目录，任务执行的工作空间，同一台主机的不同代理不可以使用同样的代理工作空间。 请根据实际情况填写。为了方便管理，建议关联数据盘，例如： Linux：/opt/cloud/agent01。 Windows：C:/opt/cloud/agent01。 MAC：/opt/cloud/agent01。

   3. 生成命令。

      完成参数配置，勾选“我已阅读并同意”，单击“生成命令”，命令框中自动生成安装代理命令。

      单击“复制命令”，复制此命令。

4. 登录主机，执行上一步复制的安装命令。
   • Linux主机：使用root账号登录主机，执行安装命令。
   • Windows主机：使用管理员身份登录主机，打开Git Bash，执行安装命令。
   • MAC主机：使用root账号登录主机，执行安装命令。
   当命令终端显示如下提示时，表示安装结束。

   图1 安装成功回显
   

5. 返回“代理列表”页面，关闭弹窗。

   等待10-30秒，刷新页面，在列表中可查看到已经安装的代理实例状态为“空闲中”，表示安装成功。

后续操作

• 查看代理列表

  在资源池列表中找到目标资源池，单击资源池名称，进入“代理列表”页面。

  代理列表可显示代理机状态、内存使用率、可用硬盘等信息。

  代理机有以下五种状态：

  表5 代理机状态说明

  代理机状态	说明
  运行中	代理机正在执行任务。
  空闲中	代理机处于连接状态，未运行任务。
  停用	代理机处于连接状态，但被停用无法执行任务。
  下线	代理机处于掉线断开状态，如需上线请登录代理机重新注册，否则删除即可。
  删除中	代理机正在被删除中。

• 删除代理
  在“代理列表”页面，单击操作列，可以删除指定的代理机。

  

  “运行中”状态的代理机无法删除。

• 启动/停用代理

  在“代理列表”页面，单击操作列，可停用对应代理，停用后，状态列显示为“停用”；单击，可以重新启用代理，状态列恢复为“空闲中”。

• 查看资源池详情

  在“代理列表”页面，单击“资源池详情”页签，可以查看资源池的详细信息（资源池所有者、资源池类型、资源池创建时间以及描述信息）。