Type: Component
Name: fc-deploy
Provider:
  - 阿里云
Version: 0.0.120
Description: 阿里云函数计算基础组件
HomePage: https://github.com/devsapp/fc-base
Tags:
  - 函数计算
Category: 基础云产品
Commands:
  deploy: 部署函数
  remove: 移除函数
Service:
  函数计算:
    Authorities:
      - 函数计算全部权限
Properties:
  region:
    Description: 地域
    Required: true
    Type:
      - Enum:
          - cn-beijing
          - cn-hangzhou
          - cn-shanghai
          - cn-qingdao
          - cn-zhangjiakou
          - cn-huhehaote
          - cn-shenzhen
          - cn-chengdu
          - cn-hongkong
          - ap-southeast-1
          - ap-southeast-2
          - ap-southeast-3
          - ap-southeast-5
          - ap-northeast-1
          - eu-central-1
          - eu-west-1
          - us-west-1
          - us-east-1
          - ap-south-1
  service:
    Description: 服务
    Required: true
    Type:
      - Struct:
          name:
            Required: true
            Description: service名称
            Type:
              - String
          description:
            Required: true
            Description: Service的简短描述
            Type:
              - String
          internetAccess:
            Required: false
            Description: 设为true让function可以访问公网
            Type:
              - Boolean
          role:
            Required: false
            Description: 授予函数计算所需权限的RAM role, 使用场景包含 1. 把 function产生的 log 发送到用户的 logstore 中 2. 为function 在执行中访问其它云资源生成 token
            Type:
              - String
          nasConfig:
            Required: false
            Description: NAS配置, 配置后function可以访问指定NAS
            Type:
              - Struct:
                  userId:
                    Required: false
                    Description: userID
                    Default: 10003
                    Type:
                      - String
                  groupId:
                    Required: false
                    Description: groupID
                    Default: 10003
                    Type:
                      - String
                  mountPoints:
                    Required: false
                    Description: 挂载点
                    Type:
                      - List<Struct>:
                          serverAddr:
                            Required: false
                            Description: server地址
                            Type:
                              - String
                          nasDir:
                            Required: false
                            Description: nas目录
                            Type:
                              - String
                          fcDir:
                            Required: false
                            Description: fc目录, 只能以/mnt，或者/home开始
                            Type:
                              - String
          vpcConfig:
            Required: false
            Description: VPC配置, 配置后function可以访问指定VPC
            Type:
              - Struct:
                  securityGroupId:
                    Required: false
                    Description: 安全组ID
                    Type:
                      - String
                  vSwitchIds:
                    Required: false
                    Description: 一个或多个VSwitch ID
                    Type:
                      - List<String>
                  vpcId:
                    Required: false
                    Description: VPC ID
                    Type:
                      - String
          logConfig:
            Required: false
            Description: log配置，function产生的log会写入这里配置的logstore
            Type:
              - Struct:
                  logStore:
                    Required: false
                    Description: loghub中的logstore名称
                    Type:
                      - String
                  project:
                    Required: false
                    Description: loghub中的project名称
                    Type:
                      - String
  function:
    Description: 函数
    Required: true
    Type:
      - Struct:
          name:
            Required: true
            Description: function名称
            Type:
              - String
          description:
            Required: false
            Description: function的简短描述
            Type:
              - String
          service:
            Required: false
            Description: function所属服务
            Type:
              - String
          ossBucket:
            Required: false
            Description: function code包的bucket name
            Type:
              - String
          ossKey:
            Required: false
            Description: function code包的在bucket中的key
            Type:
              - String
          handler:
            Required: false
            Default: index.handler
            Description: function执行的入口，具体格式和语言相关
            Type:
              - String
          memorySize:
            Required: false
            Default: 512
            Description: function的内存规格
            Type:
              - Number
          gpuMemorySize:
            Required: false
            Default: 8192
            Description: function的显存规格
            Type:
              - Number
          runtime:
            Required: false
            Default: Nodejs10
            Description: 运行时
            Type:
              - String
          timeout:
            Required: false
            Default: 60
            Description: function运行的超时时间
            Type:
              - Number
          caPort:
            Required: false
            Description: CustomContainer/Runtime指定端口
            Type:
              - Number
          customContainerConfig:
            Required: false
            Description: 自定义镜像配置
            Type:
              - Struct:
                  image:
                    Required: false
                    Description: 仓库地址
                    Type:
                      - String
                  command:
                    Required: false
                    Description: 指令
                    Type:
                      - String
                  args:
                    Required: false
                    Description: 参数
                    Type:
                      - String
          environmentVariables:
            Required: false
            Description: 环境变量
            Type:
              - List<Struct>
          initializationTimeout:
            Required: false
            Description: 初始化超时时间
            Type:
              - Number
          initializer:
            Required: false
            Description: 初始化入口
            Type:
              - String
          instanceConcurrency:
            Required: false
            Description: 单实例多并发
            Type:
              - Number
          instanceType:
            Required: false
            Description: 实例类型
            Type:
              - String

  triggers:
    Required: false
    Description: 触发器
    Type:
      - List<Struct>:
          name:
            Required: true
            Description: 触发器名称
            Type:
              - String
          type:
            Required: true
            Description: 触发器类型
            Type:
              - Enum:
                  - OSS
                  - Timer
                  - HTTP
                  - Log
                  - RDS
                  - mns_topic
                  - TableStore
                  - CDN
          function:
            Required: true
            Description: 所属函数
            Type:
              - String
          service:
            Required: true
            Description: 所属服务
            Type:
              - String
          role:
            Required: false
            Description: 角色
            Type:
              - String
          config:
            Required: true
            Description: 参数
            Type:
              - Struct[OSS触发器]:
                  bucketName:
                    Required: true
                    Description: 为 OSS 中对应的 bucket 名称
                    Type:
                      - String
                  events:
                    Required: true
                    Description: 为 OSS 端触发函数执行的事件
                    Type:
                      - List
                  filter:
                    Required: true
                    Description: 筛选条件
                    Type:
                      - Struct:
                          Key:
                            Required: false
                            Description: 筛选Key
                            Type:
                              - Struct:
                                  prefix:
                                    Required: false
                                    Description: 前缀
                                    Type:
                                      - String
                                  suffix:
                                    Required: false
                                    Description: 后缀
                                    Type:
                                      - String
              - Struct[时间触发器]:
                  cronExpression:
                    Required: false
                    Description: 时间触发器表达式
                    Type:
                      - String
                  enable:
                    Required: false
                    Default: true
                    Description: 表示是否启用该触发器
                    Type:
                      - Boolean
                  payload:
                    Required: false
                    Description: 传入参数
                    Type:
                      - String
              - Struct[CDN触发器/CDN Trigger]:
                  eventName:
                    Required: true
                    Description: 为 CDN 端触发函数执行的事件，一经创建不能更改
                    Type:
                      - String
                  eventVersion:
                    Required: true
                    Description: 为 CDN 端触发函数执行事件的版本，一经创建不能更改
                    Type:
                      - String
                  notes:
                    Required: true
                    Description: 备注信息
                    Type:
                      - String
                  filter:
                    Required: true
                    Description: 过滤器（至少需要一个过滤器）
                    Type:
                      - Struct:
                          fomain:
                            Required: false
                            Description: 网址
                            Type:
                              - List<String>
              - Struct[表格存储触发器]:
                  nnstanceName:
                    Required: true
                    Description: 表格存储实例的名字
                    Type:
                      - String
                  tableName:
                    Required: true
                    Description: 实例中的表名
                    Type:
                      - String
              - Struct[MNS触发器]:
                  topicName:
                    Required: true
                    Description: mns topic的名字
                    Type:
                      - String
                  region:
                    Required: false
                    Description: mns topic 所在的 region，如果不填，默认为和函数一样的 region
                    Type:
                      - String
                  notifyContentFormat:
                    Required: false
                    Description: 推送给函数入参 event 的格式，可选值：STREAM, JSON
                    Default: STREAM
                    Type:
                      - Enum:
                          - STREAM
                          - JSON
                  notifyStrategy:
                    Required: false
                    Description: 调用函数的重试策略，可选值：BACKOFF_RETRY, EXPONENTIAL_DECAY_RETRY
                    Deafult: BACKOFF_RETRY
                    Type:
                      - Enum:
                          - BACKOFF_RETRY
                          - EXPONENTIAL_DECAY_RETRY
              - Struct[RDS触发器]:
                  instanceId:
                    Required: true
                    Description: RDS 实例 ID
                    Type:
                      - String
                  subscriptionObjects:
                    Required: false
                    Description: 订阅对象，当前支持到表级别，只有这些表的更新才会触发函数执行
                    Type:
                      - List<String>
                  retry:
                    Required: false
                    Description: 重试次数，可选值：[0,3], 默认值为3
                    Type:
                      - Number
                  concurrency:
                    Required: false
                    Description: 调用并发量，可选值：[1，5], 默认值为1
                    Deafult: 1
                    Type:
                      - Enum:
                          - 1
                          - 2
                          - 3
                          - 4
                          - 5
                  eventFormat:
                    Required: false
                    Description: event格式，可选值：json, protobuf
                    Default: protobuf
                    Type:
                      - Enum:
                          - json
                          - protobuf
              - Struct[LOG日志触发器]:
                  sourceConfig:
                    Required: true
                    Description: 日志源配置
                    Type:
                      - Struct:
                          logstore:
                            Required: true
                            Description: 数据源的 Logstore 名称。触发器会定时从该 Logstore 订阅数据到函数计算
                            Type:
                              - String
                  jobConfig:
                    Required: false
                    Description: 包含两个可配置属性
                    Type:
                      - Struct:
                          maxRetryTime:
                            Required: false
                            Description: 表示日志服务触发函数执行时，如果遇到错误，所允许的最大尝试次数
                            Type:
                              - String
                          triggerInterval:
                            Required: false
                            Description: 表示日志服务触发函数执行的间隔
                            Type:
                              - String
                  logConfig:
                    Required: false
                    Description: 包含三个可配置属性
                    Type:
                      - Struct:
                          project:
                            Required: false
                            Description: 表示日志服务 Project 名称
                            Type:
                              - String
                          logStore:
                            Required: false
                            Description: 表示触发函数执行时，产生的日志会记录到该 Logstore
                            Type:
                              - String
                  functionParameter:
                    Required: false
                    Description: 日志服务将该配置内容作为函数 event, 当事件触发时，会连同它的内容一起发送给函数
                    Deafult: {}
                    Type:
                      - Struct
                  enable:
                    Required: false
                    Description: 表示是否启用该触发器
                    Default: true
                    Type:
                      - Boolean
              - Struct[HTTP触发器]:
                  authType:
                    Required: true
                    Description: 鉴权类型，可选值：ANONYMOUS、FUNCTION
                    Type:
                      - Enum:
                          - ANONYMOUS
                          - FUNCTION
                  methods:
                    Required: true
                    Description: HTTP 触发器支持的访问方法
                    Type:
                      - List<Enum>:
                          - GET
                          - POST
                          - PUT
                          - DELETE
                          - HEAD
                          - PATCH
  customDomains:
    Required: false
    Description: 自定义域名
    Type:
      - List<Struct>:
          domainName:
            Required: true
            Description: 域名
            Type:
              - String
          protocol:
            Required: true
            Description: 协议
            Type:
              - Enum:
                  - HTTP
                  - HTTPS
                  - HTTP&HTTPS
          routeConfigs:
            Required: true
            Description: 触发器类型
            Type:
              - List<Struct>:
                  path:
                    Required: true
                    Description: 路径
                    Type:
                      - String
                  serviceName:
                    Required: true
                    Description: 服务名
                    Type:
                      - String
                  functionName:
                    Required: true
                    Description: 函数名
                    Type:
                      - String
                  methods:
                    Required: true
                    Description: 请求方法
                    Type:
                      - List<Enum>:
                          - POST
                          - GET
                          - HEAD
                          - DELETE
                          - PUT
          certConfig:
            Required: true
            Description: 触发器类型
            Type:
              - Struct:
                  certName:
                    Required: true
                    Description: 证书名
                    Type:
                      - String
                  certificate:
                    Required: true
                    Description: 证书certificate
                    Type:
                      - String
                  privateKey:
                    Required: true
                    Description: 证书privateKey
                    Type:
                      - String