Baetyl 配置文件释义

大小
- b：字节（byte）
- k：千字节（kilobyte）
- m：兆字节（megabyte）
- g：吉字节（gigabyte）
时间
- s：秒
- m：分
- h：小时配置示例可参考baeyle项目中目录下的例子。

version: 应用版本
services: 应用的服务列表
  - name: [必须]服务名称，在服务列表中必须唯一
    image: [必须]服务入口。Docker 容器模式下表示服务镜像；Native 进程模式下表示服务运行包所在位置
    replica: 默认为0，服务副本数，表示启动的服务实例数。通常服务只需启动一个。函数运行时服务一般设置为0，不由主程序启动，而是由函数管理服务来动态启动实例
    mounts: 存储卷映射列表
      - name: [必须]存储卷名称，对应存储卷列表中的一个
        path: [必须]存储卷映射到容器中的路径
        readonly: 默认值：false，存储卷是否只读
    ports: Docker 容器模式下暴露的端口，例如：
      - 0.0.0.0:1883:1883
      - 0.0.0.0:1884:1884/tcp
      - 8080:8080/tcp
      - 9884:8884
    devices: Docker 容器模式下的设备映射，例如：
      - /dev/video0
      - /dev/sda:/dev/xvdc:r
    args: 服务实例启动参数，例如：
      - '-c'
      - 'conf/conf.yml'
    env: 服务实例环境变量，例如：
      version: v1
    restart: 服务实例重启策略配置项
      retry:
        max: 默认为空，表示总是重试，服务重启最大次数
      policy: 默认值：always，重启策略。no：不重启；always：总是重启；on-failure：服务异常退出就重启
      backoff:
        min: 默认值：1s，重启最小间隔时间
        max: 默认值：5m，重启最大间隔时间
        factor: 默认值：2，重启间隔增大倍数
    resources: Docker 容器模式下的服务实例资源限制配置项
      cpu:
        cpus: 服务实例可用的 CPU 比例，例如：1.5，表示可以用1.5个 CPU 内核
        setcpus: 服务实例可用的 CPU 内核，例如：0-2，表示可以使用第0到2个 CPU 内核；0，表示可以使用第0个 CPU 内核；1，表示可以使用第1个 CPU 内核
      memory:
        limit: 服务实例可用的内存，例如：500m，表示可以用500兆内存
        swap: 服务实例可用的交换空间，例如：1g，表示可以用1G内存
      pids:
        limit: 服务实例可创建的进程数
volumes: 存储卷列表
  - name: [必须]存储卷名称，在存储卷列表中唯一
    path: [必须]存储卷在宿主机上的路径，相对于主程序的工作目录而言

remote: Agent 模块对接 BIE 云端管理套件的配置项
  mqtt: BIE 云端 MQTT 通道配置
    clientid: [必须]连接云端 MQTT 通道的 Client ID，必须是云端核心设备的 ID
    address: [必须]云端 MQTT 通道的的地址，必须使用 SSL Endpoint
    username: [必须]云端 MQTT 通道连接的用户名，必须是云端核心设备的用户名
    ca: [必须]云端 MQTT 通道连接的CA证书路径
    key: [必须]云端 MQTT 通道连接的客户端私钥路径
    cert: [必须]云端 MQTT 通道连接的客户端公钥路径
    timeout: 默认值：30s，云端 MQTT 通道连接超时时间
    interval: 默认值：1m，云端 MQTT 通道重连的最大间隔时间，从500微秒翻倍增加到最大值
    keepalive: 默认值：10m，云端 MQTT 通道连接的保持时间
    cleansession: 默认值：false，云端 MQTT 通道连接的的是否保持 Session
    validatesubs: 默认值：false，云端 MQTT 通道连接是否检查订阅结果。 如果为 true 发现订阅失败报错退出
    buffersize: 默认值：10，发送消息内存队列大小，异常退出会导致消息丢失
  http: BIE 云端 HTTP 通道配置
    address: 会自动根据 MQTT 通道的地址推断云端 HTTPS 通道地址，无需配置
    timeout: 默认值：30s，云端HTTPS通道连接超时时间
  report: Agent 上报云端配置
    url: 上报的URL，无需配置
    topic: 上报主题模板，无需配置
    interval: 默认值：20s，上报间隔时间
  desire: Agent 接收云端下发配置
    topic: 下发主题模板，无需配置

baetyl-hub 模块

hub:
  clientid: Client 连接 Hub 的 Client ID。cleansession 为 false 则不允许为空
  address: [必须] Client 连接Hub的地址
  username: [必须] Client 连接Hub的用户名
  password: 如果采用账号密码，必须填 Client 连接Hub的密码，否者不用填写
  ca: 如果采用证书双向认证，必须填 Client 连接Hub的CA证书路径
  key: 如果采用证书双向认证，必须填 Client 连接Hub的客户端私钥路径
  timeout: 默认值：30s，Client 连接 Hub 的超时时间
  interval: 默认值：1m，Client 连接 Hub 的重连最大间隔时间，从500微秒翻倍增加到最大值
  keepalive: 默认值：10m，Client 连接Hub的保持连接时间
  cleansession: 默认值：false，Client 连接 Hub 的是否保持 Session
  validatesubs: 默认值：false，Client 是否检查 Hub 订阅结果，如果是发现订阅失败报错退出
  buffersize: 默认值：10，Client 发送消息给 Hub 的内存队列大小，异常退出会导致消息丢失，恢复后 QoS 为1的消息依赖 Hub 重发
rules: 路由规则配置项
  - clientid: Client 连接 Hub 的 Client ID
    subscribe:
      topic: [必须] Client 向 Hub 订阅的消息主题
      qos: 默认值：0，Client向 Hub 订阅的消息 QoS
    function:
      name: [必须]处理消息的函数名
    publish:
      topic: [必须]计算结果发布到 Hub 的主题
      qos: 默认值：0，计算结果发布 Hub 的 QoS
    retry:
      max: 默认值：3，最大重试次数
functions: 函数列表
  - name: [必须]函数名称，列表内唯一
    service: [必须]提供函数实例的服务名称
    instance: 实例配置项
      min: 默认值：0，最小值：0，最大值：100，最少实例数
      max: 默认值：1，最小值：1，最大值：100，最大实例数
      idletime: 默认值：10m，实例最大空闲时间
      evicttime: 默认值：1m，实例检查周期，如果发现实例空闲超过就销毁
    message:
      length:
        max: 默认值：4m， 函数实例允许接收和发送的最大消息长度
    backoff:
      max: 默认值：1m，Client 连接函数实例最大重连间隔
    timeout: 默认值：30s，Client 连接函数实例超时时间
logger: 日志配置项
  path: 默认为空，即不打印到文件；如果指定文件则输出到文件
  level: 默认值：info，日志等级，支持debug、info、warn 和 error
  format: 默认值：text，日志打印格式，支持 text 和 json
  age:
    max: 默认值：15，日志文件保留的最大天数
  size:
    max: 默认值：50，日志文件大小限制，单位MB
  backup:
    max: 默认值：15，日志文件保留的最大数量

# 两个模块的配置方式相同，可参考下面一份配置
server: 作为 GRPC Server 独立启动时配置；托管给 baetyl-function-manager 无需配置
  address: GRPC Server 监听的地址，<host>:<port>
  workers:
    max: 默认 CPU 核数乘以5，线程池最大容量
  concurrent:
    max: 默认不限制，最大并发连接数
  message:
    length:
      max: 默认值：4m， 函数实例允许接收和发送的最大消息长度
  ca: Server 的 CA 证书路径
  key: Server 的服务端私钥路径
  cert: Server 的服务端公钥路径
functions: 函数列表
  - name: [必须] 函数名称，列表内唯一
    handler: [必须] 函数包和处理函数名，比如：'sayhi.handler'
    codedir: [必须] Python 代码所在路径
logger: 日志配置项
  path: 默认为空，即不打印到文件；如果指定文件则输出到文件
  level: 默认值：info，日志等级，支持 debug、info、warn 和 error
  age:
    max: 默认值：15，日志文件保留的最大天数
  backup:
        max: 默认值：15，日志文件保留的最大数量

baetyl-function-node 模块

hub:
  clientid: Client 连接 Hub 的 Client ID。cleansession 为 false 则不允许为空
  address: [必须] Client 连接Hub的地址
  username: [必须] Client 连接Hub的用户名
  password: 如果采用账号密码，必须填 Client 连接Hub的密码，否者不用填写
  ca: 如果采用证书双向认证，必须填 Client 连接Hub的CA证书路径
  key: 如果采用证书双向认证，必须填 Client 连接Hub的客户端私钥路径
  cert: 如果采用证书双向认证，必须填 Client 连接Hub的客户端公钥路径
  timeout: 默认值：30s，Client 连接 Hub 的超时时间
  interval: 默认值：1m，Client 连接 Hub 的重连最大间隔时间，从500微秒翻倍增加到最大值
  keepalive: 默认值：10m，Client 连接Hub的保持连接时间
  cleansession: 默认值：false，Client 连接 Hub 的是否保持 Session
  validatesubs: 默认值：false，Client 是否检查 Hub 订阅结果，如果是发现订阅失败报错退出
  buffersize: 默认值：10，Client 发送消息给 Hub 的内存队列大小，异常退出会导致消息丢失，恢复后 QoS 为1的消息依赖 Hub 重发
video:
  uri: [必须] 摄像头地址或视频文件路径，摄像头可支持 IP 网络摄像头和 USB 摄像头
    # 对于 IP 网络摄像头，通用配置方式为：`rtsp://<username>:<password>@<ip>:<port>/Streaming/channels/<stream_number>/`
      # `<username>` 和 `<password>` 代表摄像头登录、认证口令
      # `<ip>` 代表 IP 网络摄像头的 IP 地址
      # `<port>` 代表 RTSP 协议的端口，默认为 554
      # `<stream_number>` 代表码流通道编号。如果为 1，则表示抓取的是主码流；如果为 2，则表示抓取的是次码流
    # 对于 USB 摄像头，其配置内容为挂载的 USB 编号，如 "0" 代表设备 `/dev/video0`，另外还需要将设备 `/dev/video0` 映射进容器
    # 对于视频文件，其配置内容为视频文件的路径，需要将视频文件以（自定义）存储卷方式挂载到 video infer 服务
  limit:
    fps: [必须] 表示每秒能够处理的最大帧量。如果摄像头帧率为 N，每秒最多能够处理的帧量为 M，则 Ceil(N/M) - 1 帧将会被跳过
infer:
  config: [必须] 模型文件的配置文件路径。需要了解更多内容可参考：https://docs.opencv.org/4.1.1/d6/d0f/group__dnn.html#ga3b34fe7a29494a6a4295c169a7d32422.
  backend: [可选] 模型推断后处理加速配置项，可支持的配置项为：halide，openvino，opencv，vulkan，default。需要了解更多内容可参考：https://docs.opencv.org/4.1.1/d6/d0f/group__dnn.html#ga186f7d9bfacac8b0ff2e26e2eab02625
  device: [可选] 表示用何种硬件对模型进行推断，可选择的配置项为 cpu（默认），fp32，fp16，vpu，vulkan，fpga。需要了解更多内容可参考：https://docs.opencv.org/4.1.1/d6/d0f/group__dnn.html#ga709af7692ba29788182cf573531b0ff5
process: 
  before: 从图像创建 4 维 blob。（可选）从中心调整大小和裁剪图像，减去平均值，按比例因子缩放值，交换蓝色和红色通道。需要了解更多内容可参考：https://docs.opencv.org/4.1.1/d6/d0f/group__dnn.html#ga29f34df9376379a603acd8df581ac8d7
    scale: multiplier for image values.
    swaprb: 标志位，用于转换图像的第 1、3 通道，即将常用的 RGB 顺序调整为 BGR
    width: 输出图像的宽度
    hight: 输出图像的高度
    mean: 从通道中减去平均值的标量。如果图像具有 BGR 排序并且 swaprb 为 true，则值的排列顺序应为（均值 R，均值 G，均值 B）
      v1: 代表 RGB 中的蓝色分量，与下面的 v2，v3，v4 一起常被用于传递像素值
      v2: 代表 RGB 中的绿色分量
      v3: 代表 RGB 中的红色分量
      v4: 代表 Alpha 透明色分量
    crop: 标志位，表明图像在进行 resize 操作后是否会被裁剪
  after:
    function: 
      name: [必须] 处理模型推断结果的函数名称
functions:
  - name: [必须] 函数名称，列表内唯一
    address: function manager 服务地址，通用配置方式是 <host>:<port>，如 `function-manager:50051`
    message:
      length:
        max: 默认值：4m， 函数实例允许接收和发送的最大消息长度
    backoff:
      max: 默认值：1m，Client 连接函数实例最大重连间隔
    timeout: 默认值：30s，Client 连接函数实例超时时间
logger: 日志配置项
  path: 默认为空，即不打印到文件；如果指定文件则输出到文件
  level: 默认值：info，日志等级，支持 debug、info、warn 和 error
  format: 默认值：text，日志打印格式，支持 text 和 json
  age:
    max: 默认值：15，日志文件保留的最大天数
  size:
    max: 默认值：50，日志文件大小限制，单位 MB
  backup:
    max: 默认值：15，日志文件保留的最大数量

baetyl-remote-mqtt 模块

hub:
  clientid: Client 连接 Hub 的 Client ID。cleansession 为 false 则不允许为空
  address: [必须] Client 连接 Hub 的地址
  username: [必须] Client 连接 Hub 的用户名
  password: 如果采用账号密码，必须填 Client 连接 Hub 的密码，否者不用填写
  ca: 如果采用证书双向认证，必须填 Client 连接 Hub 的 CA 证书路径
  key: 如果采用证书双向认证，必须填 Client 连接 Hub 的客户端私钥路径
  cert: 如果采用证书双向认证，必须填 Client 连接 Hub 的客户端公钥路径
  timeout: 默认值：30s，Client 连接 Hub 的超时时间
  interval: 默认值：1m，Client 连接 Hub 的重连最大间隔时间，从500微秒翻倍增加到最大值
  keepalive: 默认值：10m，Client 连接 Hub 的保持连接时间
  cleansession: 默认值：false，Client 连接 Hub 的是否保持 Session
  validatesubs: 默认值：false，Client 是否检查 Hub 订阅结果，如果是发现订阅失败报错退出
  buffersize: 默认值：10，Client 发送消息给 Hub 的内存队列大小，异常退出会导致消息丢失，恢复后 QoS 为1的消息依赖 Hub 重发
rules: 路由规则列表，向 Hub 订阅消息发送给 Remote，或反之
  - hub:
      clientid: Client 连接 Hub 的 Client ID
      subscriptions: Client 向 Hub 订阅的消息，例如
        - topic: say
          qos: 1
        - topic: hi
          qos: 0
    remote:
      name: [必须]指定Remote名称，必须是Remote列表中的一个
      clientid: Client 连接 Remote 的 Client ID
      subscriptions: Client 向 Remote 订阅的消息，例如
        - topic: remote/say
          qos: 0
        - topic: remote/hi
          qos: 0
remotes: Remote列表
  - name: [必须] Remote名称，列表内必须唯一
    clientid: Client 连接 Remote 的 Client ID
    address: [必须] Client 连接 Remote的地址
    username: Client 连接Remote的用户名
    password: 如果采用账号密码，必须填 Client 连接 Remote 的密码，否者不用填写
    ca: 如果采用证书双向认证，必须填 Client 连接 Remote 的 CA 证书路径
    key: 如果采用证书双向认证，必须填 Client 连接 Remote 的客户端私钥路径
    cert: 如果采用证书双向认证，必须填 Client 连接 Remote 的客户端公钥路径
    timeout: 默认值：30s，Client 连接 Remote 的超时时间
    interval: 默认值：1m，Client 连接 Remote 的重连最大间隔时间，从500微秒翻倍增加到最大值
    keepalive: 默认值：10m，Client 连接 Remote 的保持连接时间
    cleansession: 默认值：false，Client 连接 Remote 的是否保持 Session
    validatesubs: 默认值：false，Client 是否检查Remote订阅结果，如果是发现订阅失败报错退出
    buffersize: 默认值：10，Client 发送消息给 Remote 的内存队列大小，异常退出会导致消息丢失，恢复后 QoS 为1的消息依赖 Remote 重发
logger: 日志配置项
  path: 默认为空，即不打印到文件；如果指定文件则输出到文件
  level: 默认值：info，日志等级，支持 debug、info、warn 和 error
  format: 默认值：text，日志打印格式，支持 text 和 json
  age:
    max: 默认值：15，日志文件保留的最大天数
  size:
    max: 默认值：50，日志文件大小限制，单位 MB
  backup:
    max: 默认值：15，日志文件保留的最大数量