You need to enable JavaScript to run this app.
导航
私有节点使用指南
最近更新时间:2024.01.03 20:53:13首次发布时间:2024.01.03 20:53:13

本文介绍私有节点的创建、安装、升级和卸载操作。

创建私有节点

通过创建私有节点,完成节点属性和基本信息配置,生成安装私有节点所需的配置文件。

操作步骤

  1. 登录云拨测控制台

  2. 在左侧菜单栏选择 系统管理 > 节点管理

  3. 私有节点管理 标签页,单击 创建私有节点

  4. 创建私有节点 面板,参考下表,完成 节点属性 配置。

    配置项

    说明

    节点名称

    设置私有节点名称。

    说明

    长度为1~256个字符,可包含中文、英文字母、数字、中划线(-)或下划线(_)。

    Access Key

    选择Access Key。
    AccessKey(简称AK)和SecretAccessKey(简称SK)表示一组密钥对,用来对私有节点和云拨测服务端的通信进行鉴权。

    说明

    如果没有可用的Access Key,需要前往密钥管理页面去创建,具体操作可以参考创建AK和SK

    地域

    设置私有节点所在地理位置,支持设置国家、省份和城市。

    运营商ISP

    输入私有节点接入的网络所属的互联网服务提供商。

    标签

    单击 添加,在弹框中为私有节点选择所需标签(支持通过搜索快速查找所需标签),然后单击 确定

    说明

    如果没有可用的标签,单击 创建标签,输入 keyvalue 后单击即可创建新的标签。

  5. 完成 节点属性 配置后,单击 下一步:配置安装,并完成以下配置和操作。

    配置项

    说明

    安装平台

    目前仅支持通过 Docker 安装私有节点。

    Access Key

    节点属性 配置中选择的Access Key。AK/SK的密钥对,用于数据上报鉴权。

    密钥

    由系统自动生成,仅在创建私有节点时展示一次,用于生成配置文件内容。
    在私有节点上报拨测数据结果时,使用密钥进行数字签名,保证信息的完整性和安全性。

    警告

    每个节点的密钥是唯一的,云拨测不会保存该密钥,请您妥善保管,避免因密钥泄露产生异常数据。

    功能

    如果需要使用私有节点执行Web页面访问的拨测任务,请选中 在此节点执行Web页面加载测试任务

    配置文件代理

    为了确保私有节点可以将执行拨测任务的数据上传到云拨测平台,请确保私有节点部署的环境可以正常访问公网。

    • 如果私有节点部署的环境能够访问公网,可以选择 不使用代理
    • 如果私有节点部署的环境无法访问公网,需要通过代理实现私有节点访问公网,将执行拨测任务的数据发送到云拨测。支持设置以下两种代理服务:
      • HTTP Proxy
      • Socks Proxy

    HTTP Proxy

    配置文件代理 选择 HTTP Proxy 时,需要配置以下参数:

    • 代理服务器地址:输入HTTP代理服务器的地址。
    • 代理服务器端口:输入HTTP代理服务器的端口。
    • 用户名/密码:如果您的HTTP代理服务器需要用户名和密码才能访问,需要选中 用户名/密码 后,输入 用户名密码

    Socks Proxy

    配置文件代理 选择 Socks Proxy 时,需要配置以下参数:

    • 代理服务器地址:输入Socks代理服务器的地址。
    • 代理服务器端口:输入Socks代理服务器的端口。
    • 用户名/密码:如果您的Socks代理服务器需要用户名和密码才能访问,需要选中 用户名/密码 后,输入 用户名密码

    IP黑名单

    如果需要禁止向某些IP地址发送拨测请求,可以将其加入IP黑名单中。

  6. 完成 节点属性基本配置 后,对应的配置信息会自动保存到下方的 配置文件 中。关于配置文件的说明请参见私有节点配置文件说明
    单击 下载复制 按钮,保存配置文件。
    图片

  7. 配置文件 下方,云拨测提供了安装私有节点的命令,单击右上角的 复制 按钮,保存备用。
    图片

  8. 完成以上配置后,单击 确定
    在私有节点列表,可以看到新创建的私有节点。此时,私有节点为 离线 状态(表示该私有节点尚未与云拨测建立连接),运行状态为 已启用(表示可以执行拨测任务)。
    图片

安装私有节点

前提条件

在您的业务系统中安装执行拨测任务的程序需要通过Docker完成,请确保您的环境中已经安装了Docker。如未安装,请参考安装Docker

操作步骤

  1. 登录您的设备或服务所在的环境中,复制并执行在创建私有节点中获取的配置文件内容。
    图片
    成功执行后,在当前目录下会创建一个名为cloud-detect的目录,该目录下有一个名为cloud-detect-runner-xxxxxxxxxxxxxxxxxxx.toml的文件。其中xxxxxxxxxxxxxxxxxxx为私有节点ID。
    图片
  2. 复制并执行在创建私有节点中获取的 安装命令
    图片
    该命令会创建并运行一个Docker容器。您可以执行以下命令查看容器相关信息:
    • 执行docker ps 查询运行中的容器和相关信息。
      您可以看到容器ID、使用的镜像、启动容器时运行的命令、容器的创建时间、容器状态、容器的端口信息和使用的连接类型以及容器名称(在安装命令中设置的容器名称)。
      图片
    • 执行docker logs 容器ID或容器名称获取容器日志。
      图片
  3. 容器成功运行后,表示私有节点已创建成功。
    私有节点管理 页面,可以看到当前私有节点为 在线 状态。
    图片

升级私有节点

当用于创建私有节点容器的镜像更新后,您可以拉取新镜像,重新部署容器实例,从而实现私有节点的升级。

  1. 执行docker ps,查询容器名称并记录备用。
    图片
    当前容器名称为cloud-detect-runner-xxxxxxxxxxxxxxxxxxx

  2. 执行以下命令,停止并删除当前容器。

    docker stop cloud-detect-runner-xxxxxxxxxxxxxxxxxxx
    docker rm cloud-detect-runner-xxxxxxxxxxxxxxxxxxx
    
  3. 执行以下命令,拉取最新的容器镜像。

    docker pull cloud-detect-bj-cn-beijing.cr.volces.com/public/private-runner:latest
    

    如果您在创建私有节点时选择了在此节点执行Web页面加载测试任务的功能,则需要拉取以下镜像:

    docker pull cloud-detect-bj-cn-beijing.cr.volces.com/public/private-runner-web:latest
    
  4. 执行以下命令,基于新镜像创建并运行一个新的容器实例,该容器实例需要以步骤1中记录的容器实例名称命名。

    说明

    如果您在创建私有节点时勾选了在此节点执行Web页面加载测试任务,注意将下述命令中最后一行的镜像地址替换为:cloud-detect-bj-cn-beijing.cr.volces.com/public/private-runner-web:latest

    docker run -d -it \
    --name cloud-detect-runner-xxxxxxxxxxxxxxxxxxx \
    -v ${CLOUD_DETECT_CONFIG_PATH}/cloud-detect-runner-xxxxxxxxxxxxxxxxxxx.toml:/opt/config.toml \
    -e RUNTIME_IDC_NAME=boe \
    --cap-add NET_ADMIN \
    --restart unless-stopped \
    cloud-detect-bj-cn-beijing.cr.volces.com/public/private-runner:latest
    
  5. 容器创建成功后,可以看到私有节点已重新变为 在线 状态。
    图片

卸载私有节点

如果您不再需要私有节点执行拨测任务,可以将其卸载并删除。

  1. 执行docker ps,查询容器名称。
    图片
    当前容器名称为cloud-detect-runner-xxxxxxxxxxxxxxxxxxx

  2. 执行以下命令,停止并删除当前容器。

    docker stop cloud-detect-runner-xxxxxxxxxxxxxxxxxxx
    docker rm cloud-detect-runner-xxxxxxxxxxxxxxxxxxx
    
  3. (可选)执行以下命令,删除配置文件。

    rm $(pwd)/cloud-detect/cloud-detect-runner-xxxxxxxxxxxxxxxxxxx.toml
    
  4. (可选)执行以下命令,删除容器镜像。

    docker rmi cloud-detect-bj-cn-beijing.cr.volces.com/public/private-runner:latest
    # 如果在创建私有节点时选择了在此节点执行Web页面加载测试任务的功能,则需要删除以下镜像:
    docker rmi cloud-detect-bj-cn-beijing.cr.volces.com/public/private-runner-web:latest
    
  5. 私有节点管理 页面找到当前节点,单击 操作 列下的 删除,即可删除该节点。

私有节点配置文件说明

在创建私有节点时,完成节点属性和基本配置后,系统会自动生成TOML格式的配置文件。关于TOML的更多内容请参考TOML

version = "1.0.0" # TOML版本

[server] 
endpoints = [ "https://detect.zijieapi.com" ] # 私有节点访问的服务器地址,请勿修改。

[log]
level = "info"  # 日志等级,可选值debug,info,warn,error,默认为error。

[metadata]
id = "xxxxxxxxxxxxxxxxxxx" # 拨测点ID,由云拨测平台产生,不可修改。
account_id = "xxxxxxxxxx" # 主账号ID,由云拨测平台产生,不可修改。

[authorization]
access_key = "xxxxxxxxxxxxxxxx" # AccessKey,可以在云拨测控制台系统管理 > 密钥管理中查看。
secret_access_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" # SecretAccessKey,可以在云拨测控制台系统管理 > 密钥管理中查看。
# 节点私钥,由云拨测平台产生,仅在实例创建时展示一次,每个节点有唯一的私钥,平台未记录该数据,请妥善保管。
private_key = """
-----BEGIN RSA PRIVATE KEY-----
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=
-----END RSA PRIVATE KEY-----
"""

[network]
proxy = "xxxxxxxxxxxxxxxxxxxxxxxxxxxx" # 如果私有节点所在的环境无法访问公网,需要设置代理将私有节点数据发送到云拨测。
  [network.ipv4]
  block_list = [ "192.168.1.1/32" ] # 设置IPv4地址防火墙,仅支持CIDR格式。

  [network.ipv6]
  block_list = [ "fe80::1/128" ] # 设置IPv6地址防火墙,仅支持CIDR格式。