Skip to content

Latest commit

 

History

History
204 lines (194 loc) · 11 KB

parameters-zh_CN.md

File metadata and controls

204 lines (194 loc) · 11 KB

CCE Operator Parameter

创建集群

创建集群时填写的大部分字段与华为云文档相对应:https://support.huaweicloud.com/api-cce/cce_02_0236.html#section4

{
    "huaweiCredentialSecret": "cattle-global-data:cc-xxxxx", // secret ID
    "category": "CCE", //  集群类型,CCE 或 Turbo
    "regionID": "cn-north-1", // CCE 集群的 Region
    "clusterID": "", // 创建集群时,此参数为空字符串,仅导入集群时需要此字段
    "imported": false, // 非导入集群
    "name": "cce-create-1", // CCE 集群名称,由用户填写
    "labels": { // 集群标签,由华为云自动生成,用于升级时前端识别集群支持的特性开关,用户指定无效。
        "key": "value"
    },
    "type": "VirtualMachine", // 目前只支持 VirtualMachine:Master节点为x86架构服务器,后续支持 ARM64 鲲鹏
    "flavor": "cce.s1.small", // s1:单控制节点CCE集群。
                              // s2:多控制节点CCE集群 (高可用)。
                              // small (最大 50 节点), medium (200 节点), large (1k 节点), xlarge (2k 节点)
    "version": "v1.23", // v1.21, v1.23, v1.25, v1.27, v1.28
    "description": "example description", // 集群描述
    "ipv6Enable": false, // 保留参数,永远为 False
    "hostNetwork": {
        "vpcID": "VPC-ID", // VPCID,若为空字符串,Operator 将新建一个 VPC
        "subnetID": "SUBNET-ID", // SubnetID,若为空字符串,Operator 将新建一个 Subnet
        "securityGroup": "SECURITY-GROUP-ID" // 安全组,若为空字符串,华为云在创建集群时会自动新建一个安全组
    },
    "containerNetwork": {
        // 容器网络类型:
        // overlay_l2: 容器隧道网络
        // vpc-router: VPC网络,使用ipvlan和自定义VPC路由为容器构建的Underlay的l2网络
        // eni: 云原生网络2.0,仅限 CCE Turbo集群时指定,且 Turbo 集群只能选择 eni 网络类型
        "mode": "overlay_l2", 
        "cidr": "172.16.123.0/24" // 容器网络网段
        // "cidrs": ["172.16.123.0/24"] // 后续华为云 API 升级可能会启用 cidr 字段改为 "cidrs" 字段
    },
    "eniNetwork": { // 云原生网络2.0网络配置,仅限创建 CCE Turbo 集群时指定。
        "subnets": [] // IPv4 子网 ID 列表,Subnet 的 IPv4 子网ID。
    },
    "authentication": { // 集群认证方式相关配置。
        "mode": "rbac", // 集群认证模式。
        "authenticatingProxy": { // 当集群认证模式为 authenticating_proxy 时,此项必须填写。
            "ca": "",
            "cert": "",
            "privateKey": ""
        }
    },
    "kubernetesSvcIPRange": "10.3.4.0/24", // 服务网段参数,kubernetes clusterIP取值范围
    "tags": {
        "cluster-key": "cluster-value" // 集群资源标签
    },
    "kubeProxyMode": "iptables", // 服务转发模式, iptables 或 ipvs (默认 iptables)
    "publicAccess": true, // 为 Operator 独有的参数
                          // 是否公开访问,若为 true,则创建集群时需提供已有的 ClusterExternalIP 或配置 PublicIP
                          // 若为 false,则创建集群时不配置公网 IP
    "publicIP": { // 为 Operator 独有的参数
        "createEIP": true, // 若为 true,Operator 在创建集群之前会先创建 EIP,之后在创建集群时将 EIP 绑定至集群
        "eip": { // Operator 创建 EIP 的参数
            "ipType": "5_sbgp", // 弹性IP类型 5_telcom(电信),5_union(联通),5_bgp(全动态BGP),5_sbgp(静态BGP)
            "bandwidth": {
                "chargeMode": "traffic", // 计费模式: bandwidth,traffic
                "size": 1, // 带宽大小 1-300Mbit/s
                "shareType": "PER", // 保留参数,Operator 目前只支持 PER,后续可考虑支持 WHOLE 共享宽带
            }
        }
    },
    "natGateway": { // NAT 网关,为节点池中的节点提供公网访问能力(从 Docker Hub 拉取 Agent 镜像)
                    // 若不配置 NAT 网关,节点将无法访问公网,无法从 DockerHub 等 Public Registry 中拉取镜像
        "enabled": true, // 是否启用 NAT 网关
        "existingEIPID": "", // NAT 网关的 SNAT Rule 使用已有的 EIP ID(若提供已有 EIP ID,将忽略下方 snatRuleEIP 参数)
        "snatRuleEIP": { // 若未提供已有 EIP ID,则按照以下参数创建 EIP 并配置 SNAT Rule
            "ipType": "5_sbgp", // 弹性IP类型 5_telcom(电信),5_union(联通),5_bgp(全动态BGP),5_sbgp(静态BGP)
            "bandwidth": {
                "chargeMode": "traffic", // 计费模式: bandwidth,traffic
                "shareType": "PER", // 保留参数,Operator 目前只支持 PER,后续可考虑支持 WHOLE 共享宽带
                "size": "5," // 带宽大小 1-300Mbit/s
            }
        }
    },
    "extendParam": { // 集群拓展参数
        "clusterAZ": "cn-north-1a", // 保留参数,可为空字符串,集群 master 节点的地区
        "clusterExternalIP": "114.113.112.111", // 当 publicAccess 为 true 时,创建集群时为绑定至已有的 EIP 地址(此字段填写 IP 地址,而不是 EIP ID)
        "periodType": "", // month:月, year:年; billingMode 为 1(包周期)时生效,且为必选。
        "periodNum": 0, // 订购周期数
        "isAutoRenew": "false", // 字符串类型的 true/false, 是否自动续订
        "isAutoPay": "false", // 字符串类型的 true/false, 是否自动扣款
    },
    "nodePools": [
        // 集群节点池的参数配置,与华为云文档相对应:https://support.huaweicloud.com/api-cce/cce_02_0242.html#section4
        {
            "name": "nodepool-1", // 节点池名称,由用户输入
            "type": "vm", // 节点池类型:vm, ElasticBMS, pm (default: vm)
            "nodePoolID": "NODE_ID-aaa-bbb-ccc", // 节点池 ID,仅查询时返回结果
            "nodeTemplate": { // 该节点池的每个节点的配置模板
                "flavor": "t6.large.2",  // 节点池规格
                "availableZone": "cn-north-1a", // 可用区, 可为 random
                "operatingSystem": "EulerOS 2.9",
                "sshKey": "SSH_KEY", // SSH 密钥,处于安全考虑,帐号密码登录的方式不被 Operator 支持
                "rootVolume": { // 节点系统盘
                    "size": 40,
                    "type": "SSD"
                },
                "dataVolumes": [ // 节点数据盘数组
                    {
                        "size": 100,
                        "type": "SSD"
                    }
                ],
                "publicIP": { // 节点公网IP配置 (保留字段,节点池不支持配置节点公网IP)
                //     "count": 1,
                //     "eip": {
                //         "ipType": "5_bgp",
                //         "bandwidth": {
                //             "chargeMode": "traffic",
                //             "size": 1,
                //             "shareType": "PER"
                //         }
                //     }
                },
                "billingMode": 0, // 节点计费模式
                "runtime": "containerd", // 容器运行时
                "extendParam": { // 节点扩展参数
                    "periodType": "month",
                    "periodNum": 1,
                    "isAutoRenew": "false"
                }
            },
            "initialNodeCount": 1, // 节点池中节点的数量
            "autoscaling": {
                "enable": false, // 是否开启自动扩缩容(若启用 autoscaling,需要在华为云控制台手动安装 autoscaler 插件)
                "minNodeCount": 0, // 最小能缩容的节点个数
                "maxNodeCount": 1, // 最大能扩容的节点个数
                "scaleDownCooldownTime": 0, // 节点保留时间,单位为分钟
                "priority": 0 // 节点池权重,数值越大节点池优先级越高
            },
            "podSecurityGroups": [],
            "customSecurityGroups": [
                // 节点池自定义安全组相关配置,未指定安全组ID,新建节点将添加 Node 节点默认安全组。
                "SECURITY_GROUP_ID"
            ]
        }
    ]
}

导入集群

{
    "clusterID": "aaa-bbb-ccc",
    "huaweiCredentialSecret": "cattle-global-data:cc-xxxxx",
    "imported": true,
    "name": "import-example",
    "regionID": "cn-north-1"
}

编辑已创建的集群

以下字段为可编辑字段,用于更新集群 / 节点池信息。

{
    "name": "example-update", // 集群名称
    "huaweiCredentialSecret": "cattle-global-data:cc-xxxxx", // 更新云凭证
    "description": "", // 更新集群描述
    // 集群升级,直接改动集群版本即可升级。例如将 1.25 改为 1.27,即升级至 1.27 版本。
    // 需要注意集群升级前需要手动检查所有插件必须运行正常(没有未就绪的工作负载),否则会造成升级失败。
    "version": "v1.25",
    "hostNetwork": {
        "securityGroup": "SECURITY-GROUP-ID" // 修改节点默认安全组
    },
    // 变更集群 (Resize) 存在约束限制:https://support.huaweicloud.com/usermanual-cce/cce_10_0403.html
    // 需要额外注意以下几点:
    // 1. 变更集群规格不支持修改控制节点数量。例如无法将 s1 修改为 s2
    // 2. 不支持降低集群规格。例如不能将 medium 降为 small
    // 3. 单控制节点的集群不允许变更到 1000 节点及以上。例如 s1.small (50 节点) 只能升级到 s1.medium (200 节点)。
    // Resize 请求可能遇到规格不足:Insufficient resources under expected master specifications 错误。
    "flavor": "cce.s1.medium", // s1:单控制节点CCE集群。
                              // s2:多控制节点CCE集群 (高可用)。
                              // small (最大 50 节点), medium (200 节点), large (1k 节点), xlarge (2k 节点)
    "nodePools": [ // 可编辑节点池数组,用于增加/删除节点池
        {
            "name": "nodepool-1", // 节点池名称,可编辑
            "nodePoolID": "NODE_ID-aaa-bbb-ccc", // 节点池 ID(若创建新的节点池,此字段留空,若修改已有节点池,需要提供此参数)
            // "nodeTemplate": {}, // 节点模板在创建节点池后不支持修改
            "initialNodeCount": 1, // 节点池中节点的数量,可编辑
            "autoscaling": {
                "enable": false, // 是否开启自动扩缩容(若启用 autoscaling,需要在华为云控制台手动安装 autoscaler 插件)
                "minNodeCount": 0, // 最小能缩容的节点个数
                "maxNodeCount": 1, // 最大能扩容的节点个数
                "scaleDownCooldownTime": 0, // 节点保留时间,单位为分钟
                "priority": 0 // 节点池权重
            },
        }
    ]
}

编辑已导入的集群

已导入的集群仅支持编辑 huaweiCredentialSecret 云凭证。