为指定的集群安装组件。

使用说明

• 调用该接口前，请先调用 ListSupportedAddons 接口，获取您待安装组件的安装模式（DeployMode），对应的版本（Version）等参数值，以减少不必要的安装失败。
• 此接口为异步接口，当此接口返回成功时，组件将进入{Creating, [Progressing]}状态，直到安装成功，进入{Running, [Ok]}状态。请调用 ListAddons 接口获取该组件当前的状态，查看组件是否安装成功。

请求说明

• 请求方式：POST
• 请求地址：https://open.volcengineapi.com/?Action=CreateAddon&Version=2022-05-12

调试

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见 公共参数。

组件配置信息

metrics-collector

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  AccessKeyId	String	否	AK************	当DeployNodeType=VirtualNode时必须传入该参数，否则，可不填。 表示使用火山引擎 AK/SK 的方式，授权 VCI 部署该组件。AccessKey ID（AK）的获取方式，请参见 获取访问密钥。
  AccessKeySecret	String	否	SK**********	当DeployNodeType=VirtualNode时必须传入该参数，否则，可不填。 表示使用火山引擎 AK/SK 的方式，授权 VCI 部署该组件。Secret Access Key（SK）的获取方式，请参见 获取访问密钥。

• Config 示例

  {
    "AccessKeyId": "AK************",
    "AccessKeySecret": "SK**********"
  }
  

cr-credential-controller

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  CrConfigmapData	Object	是	-	镜像仓库免密组件配置信息。
  CrConfigmapData.Namespace	String	是	*	当前集群下可以免密拉取私有镜像的命名空间。默认值为*，表示所有命名空间都可以免密拉取私有镜像；您也可以输入具体的命名空间名称，指定多个命名空间，多个名称之间以英文逗号（,）分隔。
  CrConfigmapData.ServiceAccount	String	是	*	能够使用免密组件的 Kubernetes 中的服务账号。默认值为*，表示已配置命名空间下的所有 ServiceAccount，都可以免密拉取私有镜像；您也可以输入具体的 ServiceAccount，可以指定多个 ServiceAccount，多个名称之间以英文逗号（,）分隔。
  CrConfigmapData.Registries	Array	是	-	镜像仓库实例配置信息。
  CrConfigmapData.Registries.0.Instance	String	是	cr-basic	可以免密拉取私有镜像的目标镜像仓库实例名称。 可以调用 ListRegistries 接口，获取镜像仓库名称。 说明 可选同一个地域中的一个或多个镜像仓库实例。 该镜像仓库实例中，后续新推送的私有镜像也能被免密拉取。
  CrConfigmapData.Registries.0.Region	String	是	cn-beijing	目标镜像仓库实例所在的地域。

• Config 示例

  {
    "CrConfigmapData": {
      "Namespace": "*",
      "ServiceAccount": "*",
      "Registries": [
        {
          "Instance": "cr-basic",
          "Region": "cn-beijing"
        }
      ]
    }
  }
  

prometheus-agent

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  NodeExporterDisabled	Boolean	否	false	是否禁用 node-exporter 插件。取值： false：（默认值）不禁用，即安装插件。node-exporter 插件用于通过 Linux 操作系统感知虚拟机各项指标。 true：禁用插件，即不安装插件。
  AutoScalingEnabled	Boolean	否	false	是否开启 vm-agent 采集器和 kube-state-metrics 组件的自动扩缩容功能。取值： false：（默认值）不开启自动扩容，即组件的分片数为配置的初始分片数，不会随着资源占用率的提升而自动扩容。 true：开启自动扩容。
  VmAgent.InitShards	Integer	否	1	vm-agent 初始（最小）分片数。 默认值：1 取值范围：[1, 20] 注意 安装完成 prometheus-agent 组件后不支持更新该参数配置。 不同规模集群中的推荐初始（最小）分片数不同，详情请参见 推荐规格。
  VmAgent.MaxShards	Integer	否	5	vm-agent 扩容最大分片数。 默认值：5 取值范围：[VmAgent.InitShards的值, 20] 仅AutoScalingEnabled=true时生效。
  VmAgent.Requests.Cpu	String	否	2	vm-agent 资源 CPU 请求。 单位为核。若使用毫核为单位，则格式为：CPU 请求+m，例如100m表示 CPU 资源请求为 100 毫核。 默认值：2
  VmAgent.Requests.Memory	String	否	2Gi	vm-agent 资源内存请求。 单位为 MiB 或 GiB，格式为：内存请求+单位，例如90Mi表示内存资源请求为 90 MiB；2Gi表示内存资源请求为 2 GiB。 默认值：2Gi
  VmAgent.Limits.Cpu	String	否	4	vm-agent 资源 CPU 上限。 单位为核。若使用毫核为单位，则格式为：CPU 请求+m，例如100m表示 CPU 资源上限为 100 毫核。 默认值：4
  VmAgent.Limits.Memory	String	否	4Gi	vm-agent 资源内存上限。 单位为 MiB 或 GiB，格式为：内存请求+单位，例如90Mi表示内存资源上限为 90 MiB；2Gi表示内存资源上限为 2 GiB。 默认值：4Gi
  KubeStateMetrics.InitShards	Integer	否	1	kube-state-metrics 初始分片数及缩容最小分片数。 默认值：1 取值范围：[1, 20] 注意 安装完成 prometheus-agent 组件后不支持更新该参数配置。 不同规模集群中的推荐初始（最小）分片数不同，详情请参见 推荐规格。
  KubeStateMetrics.MaxShards	Integer	否	5	kube-state-metrics 扩容最大分片数。 默认值：5 取值范围：[KubeStateMetrics.InitShards的值, 20] 仅AutoScalingEnabled=true时生效。
  KubeStateMetrics.Requests.Cpu	String	否	200m	kube-state-metrics 资源 CPU 请求。 单位为核。若使用毫核为单位，则格式为：CPU 请求+m，例如100m表示 CPU 资源请求为 100 毫核。 默认值：200m
  KubeStateMetrics.Requests.Memory	String	否	512Mi	kube-state-metrics 资源内存请求。 单位为 MiB 或 GiB，格式为：内存请求+单位，例如90Mi表示内存资源请求为 90 MiB；2Gi表示内存资源请求为 2 GiB。 默认值：512Mi
  KubeStateMetrics.Limits.Cpu	String	否	800m	kube-state-metrics 资源 CPU 上限。 单位为核。若使用毫核为单位，则格式为：CPU 请求+m，例如100m表示 CPU 资源上限为 100 毫核。 默认值：800m
  KubeStateMetrics.Limits.Memory	String	否	2Gi	kube-state-metrics 资源内存上限。 单位为 MiB 或 GiB，格式为：内存请求+单位，例如90Mi表示内存资源请求为 90 MiB；2Gi表示内存资源上限为 2 GiB。 默认值：2Gi

• Config 示例

  {
  	    "NodeExporterDisabled": false,
  	    "VmAgent": {
  	        "InitShards": 2,
  	        "Requests": {
  	            "Cpu": "500m",
  	            "Memory": "512Mi"
  	        }
  	    }
  	}
  

apmplus-opentelemetry-collector

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  promReplicas	Integer	是	1	PrometheusScraper 实例个数。单实例支持 10 万条数据/分钟，所需资源为 1 核 CPU 2GB 内存。一般情况下实例数为 1 可满足需求。如果集群每分钟产生 30 万条数据，请将实例数设置为 3。 说明 PrometheusScraper 默认以 Deployment 方式部署。
  otelReplicas	Integer	是	1	OpenTelemetryCollector 实例个数。单实例支持 1 万条 trace/秒，所需资源为 1 核 CPU 2GB 内存。一般情况下实例数为 1 可满足需求。如果集群每秒产生 3 万条 trace，请将实例数设置为 3。 说明 OpenTelemetryCollector 默认以 Statefulset 方式部署。

• Config 示例

  {
    "promReplicas": 1,
    "otelReplicas": 1
  }
  

cluster-autoscaler

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  ScanInterval	String	否	10s	弹性伸缩的间隔时间：取值为：10s、15s、30s、60s、120s、180s、300s，单位为：秒。
  ScaleDown.Enabled	Boolean	是	false	是否自动缩容，取值： true：开启自动缩容。开启后，集群中有较多空闲节点资源时会触发缩容。仅对 按量计费 节点资源生效。 false：（默认值）不开启自动缩容。
  ScaleDown.UtilizationThreshold	Float	否	0.5	非 GPU 节点缩容阈值，取值范围：[0,1]。 当ScaleDown.Enabled=true时必须传入。
  ScaleDown.GpuUtilizationThreshold	Float	否	0.5	GPU 节点缩容阈值，取值范围：[0,1]。 当ScaleDown.Enabled=true时必须传入。
  ScaleDown.UnneededTime	Integer	否	1	缩容触发时延，取值范围：[1,60]，单位：分钟。 当ScaleDown.Enabled=true时必须传入。
  ScaleDown.DelayAfterAdded	Integer	否	1	扩容后缩容冷却时间，取值范围：[1,60]，单位：分钟。 当ScaleDown.Enabled=true时必须传入。
  ScaleDown.DelayAfterFailure	Integer	否	1	缩容失败冷却时间，取值范围：[1,60]，单位：分钟。 当ScaleDown.Enabled=true时必须传入。
  ScaleDown.SkipNodesWithLocalStorageDisabled	Boolean	否	false	触发缩容时不跳过包含本地存储 Pod 的节点。取值： true：是，不跳过。 false：（默认值）否，跳过。 当ScaleDown.Enabled=true时必须传入。
  ScaleDown.SkipNodesWithSystemPodsDisabled	Boolean	否	false	触发缩容时不跳过包含 kube-system 命名空间下非 DaemonSet 管理的 Pod 节点。取值： true：是，不跳过。 false：（默认值）否，跳过。 当ScaleDown.Enabled=true时必须传入。
  ScaleDown.MaxEmptyBulkDeleteNumber	Integer	否	5	最大并发缩容数，取值范围：[1,15]，单位：分钟。 当ScaleDown.Enabled=true时必须传入。
  ScaleDown.MinReplicas	Integer	否	0	节点排水时允许工作负载存在的最小 Pod 数量。
  ScaleDown.MaxGracefulTermination	Integer	否	600	节点排水时等待 Pod 终止的最大秒数。
  ScaleDown.DaemonSetEvictionForNodesDisabled	Boolean	否	false	节点缩容时不对节点上 DaemonSet 类型的 Pod 排水。 true：是，不对节点上 DaemonSet 类型的 Pod 进行排水。 false：（默认值）否，对节点上 DaemonSet 类型的 Pod 进行排水。
  ScaleUp.Expander	String	是	random	节点自动扩容时所采用的扩容策略类型。取值： random：（默认值）随机选择一个节点池进行扩容。 most-pods：选择能够调度最多 Pods 的节点池进行扩容。 least-waste：选择 CPU 资源最少的空闲节点池进行扩容。 priority：选择所设优先级最高的节点池进行扩容。

• Config 示例

  {
      "ScanInterval": "15s",
      "ScaleDown": {
          "Enabled": false,
          "UtilizationThreshold": 0.5,
          "GpuUtilizationThreshold": 0.5,
          "UnneededTime": 10,
          "DelayAfterAdded": 10,
          "DelayAfterFailure": 3,
          "SkipNodesWithLocalStorageDisabled": true,
          "SkipNodesWithSystemPodsDisabled": true,
          "MaxEmptyBulkDeleteNumber": 5,
          "MinReplicas": 0,
          "MaxGracefulTermination": 600,
          "DaemonSetEvictionForNodesDisabled": false
      },
      "ScaleUp": {
          "Expander": "random"
      }
  }