Documentation
¶
Index ¶
- type AddonConfig
- type AddonConfigSpec
- type CAConfig
- type CAConfigSpec
- type Cluster
- type ClusterNetwork
- type ClusterNetworkSpec
- type ClusterNetworkSubnet
- type ClusterSpec
- type ClusterSubnet
- type CustomizedNodeGroupSpec
- type DiskSpec
- type Label
- type LabelSpec
- type MaintenanceWindow
- type MaintenanceWindowSpec
- type MasterAuth
- type MasterImage
- type MasterProgress
- type MasterVersion
- type NatGateway
- type NatGatewaySpec
- type NodeConfig
- type NodeConfigSpec
- type NodeGroup
- type NodeGroupNetworkSpec
- type NodeGroupProgress
- type NodeGroupSpec
- type NodeImage
- type NodeNetwork
- type NodeVersion
- type Quota
- type ServerConfig
- type Tag
- type TagFilter
- type UpgradePlan
- type ValidNodeConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddonConfig ¶ added in v1.12.0
type AddonConfigSpec ¶ added in v1.12.0
type CAConfigSpec ¶ added in v1.15.0
type Cluster ¶
type Cluster struct {
/* 集群id (Optional) */
ClusterId string `json:"clusterId"`
/* 名称 (Optional) */
Name string `json:"name"`
/* 描述 (Optional) */
Description string `json:"description"`
/* kubernetes的版本 (Optional) */
Version string `json:"version"`
/* 集群所在的az (Optional) */
Azs []string `json:"azs"`
/* 节点组列表 (Optional) */
NodeGroups []NodeGroup `json:"nodeGroups"`
/* k8s的cluster的cidr (Optional) */
ClusterCidr string `json:"clusterCidr"`
/* 认证信息 (Optional) */
MasterAuth MasterAuth `json:"masterAuth"`
/* 状态 [pending,running,reconciling(升级时的状态), deleting, deleted, error] (Optional) */
ClusterState string `json:"clusterState"`
/* 状态变更原因 (Optional) */
StateMessage string `json:"stateMessage"`
/* 更新时间 (Optional) */
UpdateTime string `json:"updateTime"`
/* 创建时间 (Optional) */
CreateTime string `json:"createTime"`
/* 用户的AccessKey,插件调用open-api时的认证凭证 (Optional) */
AccessKey string `json:"accessKey"`
/* 基本验证方式 (Optional) */
BasicAuth bool `json:"basicAuth"`
/* 证书验证方式 (Optional) */
ClientCertificate bool `json:"clientCertificate"`
/* 用户访问的ip (Optional) */
Endpoint string `json:"endpoint"`
/* endpoint的port (Optional) */
EndpointPort string `json:"endpointPort"`
/* endpoint的dashboard port (Optional) */
DashboardPort string `json:"dashboardPort"`
/* deprecated 优先以addonsConfig中的配置为准 <br>用户是否启用集群自定义监控,true 表示开启用,false 表示未开启用 (Optional) */
UserMetrics bool `json:"userMetrics"`
/* 集群组件配置信息 (Optional) */
AddonsConfig []AddonConfig `json:"addonsConfig"`
/* 是否开启集群自动升级,true 表示开启,false 表示未开启 (Optional) */
AutoUpgrade bool `json:"autoUpgrade"`
/* 配置集群维护策略 (Optional) */
MaintenanceWindow MaintenanceWindow `json:"maintenanceWindow"`
/* 集群升级计划信息, 仅展示最新一条升级计划信息 (Optional) */
UpgradePlan UpgradePlan `json:"upgradePlan"`
/* 控制节点操作进度 (Optional) */
MasterProgress MaintenanceWindow `json:"masterProgress"`
/* 网络配置信息 (Optional) */
ClusterNetwork ClusterNetwork `json:"clusterNetwork"`
/* 集群网络类型,可取值为auto和customized (Optional) */
NetworkMode string `json:"networkMode"`
}
type ClusterNetwork ¶ added in v1.21.0
type ClusterNetwork struct {
/* kube-apiserver是否可公网访问,false则kube-apiserver不绑定公网地址,true绑定公网地址 (Optional) */
PublicApiServer bool `json:"publicApiServer"`
/* master网络的cidr (Optional) */
MasterCidr string `json:"masterCidr"`
/* service网络的cidr (Optional) */
ServiceCidr string `json:"serviceCidr"`
/* 用户侧承载node和pod的vpc id (Optional) */
VpcId string `json:"vpcId"`
/* 集群子网信息 (Optional) */
ClusterSubnets []ClusterNetworkSubnet `json:"clusterSubnets"`
/* nat网关配置 (Optional) */
NatGateway []NatGateway `json:"natGateway"`
}
type ClusterNetworkSpec ¶ added in v1.21.0
type ClusterNetworkSpec struct {
/* kube-apiserver是否可公网访问,false则kube-apiserver不绑定公网地址,true绑定公网地址 */
PublicApiServer bool `json:"publicApiServer"`
/* master网络的cidr */
MasterCidr string `json:"masterCidr"`
/* service网络的cidr */
ServiceCidr string `json:"serviceCidr"`
/* 用户侧承载node和pod的vpc id */
VpcId string `json:"vpcId"`
/* 初始pod的子网id */
PodSubnetId string `json:"podSubnetId"`
/* 初始loadbalancer类型的service所创建的lb所在的subnet */
LbSubnetId string `json:"lbSubnetId"`
/* 初始的node子网ID */
NodeSubnetId string `json:"nodeSubnetId"`
/* nat网关配置 */
NatGateway NatGatewaySpec `json:"natGateway"`
}
type ClusterNetworkSubnet ¶ added in v1.21.0
type ClusterSpec ¶
type ClusterSpec struct {
/* 名称(同一用户的 cluster 允许重名) */
Name string `json:"name"`
/* 描述 (Optional) */
Description string `json:"description"`
/* 默认开启 basicAuth与clientCertificate最少选择一个 (Optional) */
BasicAuth bool `json:"basicAuth"`
/* 默认开启 basicAuth与clientCertificate最少选择一个 (Optional) */
ClientCertificate bool `json:"clientCertificate"`
/* kubernetes的版本,默认1.8 (Optional) */
Version string `json:"version"`
/* 集群所在的az */
Azs []string `json:"azs"`
/* 实例组 (Optional) */
NodeGroup NodeGroupSpec `json:"nodeGroup"`
/* k8s的master的cidr */
MasterCIDR string `json:"masterCIDR"`
/* 用户的AccessKey,插件调用open-api时的认证凭证 */
AccessKey string `json:"accessKey"`
/* 用户的SecretKey,插件调用open-api时的认证凭证 */
SecretKey string `json:"secretKey"`
}
type ClusterSubnet ¶ added in v1.21.0
type ClusterSubnet struct {
/* 子网 ID (Optional) */
SubnetId string `json:"subnetId"`
/* 子网类型,可取值为:pod_subnet/lb_subnet/node_subnet (Optional) */
SubnetType string `json:"subnetType"`
/* 子网是否启用,仅pod子网可用。 (Optional) */
Enabled bool `json:"enabled"`
/* 子网CIDR (Optional) */
Cidr string `json:"cidr"`
/* 子网中可用的IP数量 (Optional) */
AvailableIpNum int `json:"availableIpNum"`
/* 子网名称 (Optional) */
SubnetName string `json:"subnetName"`
}
type CustomizedNodeGroupSpec ¶ added in v1.21.0
type CustomizedNodeGroupSpec struct {
/* 名称 */
Name string `json:"name"`
/* (Optional) */
Description string `json:"description"`
/* 工作节点组的信息 */
NodeConfig NodeConfigSpec `json:"nodeConfig"`
/* 工作节点组的 az,必须为集群az的子集,默认为集群az (Optional) */
Azs []string `json:"azs"`
/* 工作节点组初始化大小,至少为1个 */
InitialNodeCount int `json:"initialNodeCount"`
/* 是否开启自动修复,默认不开启。 (Optional) */
AutoRepair bool `json:"autoRepair"`
/* 自动伸缩配置 (Optional) */
CaConfig CAConfigSpec `json:"caConfig"`
}
type DiskSpec ¶ added in v1.13.0
type DiskSpec struct {
/* 磁盘类型,取值为cloud、local,默认为cloud (Optional) */
SystemDiskCategory *string `json:"systemDiskCategory"`
/* 云盘系统盘的大小 单位(GB) (Optional) */
SystemDiskSize *int `json:"systemDiskSize"`
/* 云盘系统盘的类型,支持 hdd.std1,ssd.gp1,ssd.io1 (Optional) */
SystemDiskType *string `json:"systemDiskType"`
/* 云盘 iops,仅限 ssd.io1 类型云盘有效 (Optional) */
SystemDiskIops *int `json:"systemDiskIops"`
}
type LabelSpec ¶
type LabelSpec struct {
/* key包含两个部分:prefix与name,name是必须的,prefix是可选的。prefix与name分隔用"/"。
name 可以是字母,数字,[-_.]。长度小于63。prefix:遵循DNS标准(例如:kubernetes.io/),长度不超过253
[参照](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)
*/
Key string `json:"key"`
/* 字母,数字,[-_.],长度不超过63 (Optional) */
Value *string `json:"value"`
}
type MaintenanceWindow ¶ added in v1.12.0
type MaintenanceWindow struct {
/* daily, weekly, monthly, 默认 weekly (Optional) */
PeriodType string `json:"periodType"`
/* 维护操作开始具体日期, 仅对 periodType 取值为 weekly 或 monthly 时有效, periodType 为 weekly 时可以取 1-7, periodType 为 monthly 时可取 1-28
(Optional) */
StartDay int `json:"startDay"`
/* 维护操作开始具体时间. 时间格式符合RFC3339,并使用 UTC 时间,精确到分钟,例如 23:27 (Optional) */
StartTime string `json:"startTime"`
/* 维护运行时长: 4-24 小时,步长 1 小时, 默认为: 4小时 (Optional) */
Duration int `json:"duration"`
}
type MaintenanceWindowSpec ¶ added in v1.8.0
type MaintenanceWindowSpec struct {
/* daily, weekly, monthly, 默认 weekly (Optional) */
PeriodType *string `json:"periodType"`
/* 维护操作开始具体日期, 仅对 periodType 取值为 weekly 或 monthly 时有效, periodType 为 weekly 时可以取 1-7, periodType 为 monthly 时可取 1-28
(Optional) */
StartDay *int `json:"startDay"`
/* 维护操作开始具体时间. 时间格式符合RFC3339,并使用 UTC 时间,精确到分钟,例如 23:27 */
StartTime string `json:"startTime"`
/* 时区,使用 IANA 数据格式,例如:"Asia/Shanghai" 或 "America/Los_Angeles",默认 "UTC" (Optional) */
TimeZone *string `json:"timeZone"`
/* 维护运行时长: 4-24 小时,步长 1 小时, 默认为: 4小时 (Optional) */
Duration *int `json:"duration"`
}
type MasterAuth ¶
type MasterAuth struct {
/* base64编码,集群的根的public certificate (Optional) */
ClusterCaCertificate string `json:"clusterCaCertificate"`
/* base64编码,客户端连接集群的public certificate (Optional) */
ClientCertificate string `json:"clientCertificate"`
/* base64编码, client的私钥 (Optional) */
ClientKey string `json:"clientKey"`
/* basic auth的user (Optional) */
User string `json:"user"`
/* basic auth的password (Optional) */
Password string `json:"password"`
}
type MasterImage ¶
type MasterImage struct {
/* 镜像编码 (Optional) */
Code string `json:"code"`
/* 虚机镜像id (Optional) */
ImageId string `json:"imageId"`
/* 主版本号 (Optional) */
MainVersion string `json:"mainVersion"`
/* 内部版本号 (Optional) */
InnerVersion string `json:"innerVersion"`
/* 是否默认镜像 (Optional) */
IsDefault bool `json:"isDefault"`
/* 可见度:0:所有人可见;1:授权用户可见;2:只有白名单用户可见 (Optional) */
Visibility int `json:"visibility"`
/* 默认节点镜像编码 (Optional) */
DefaultNodeImageCode string `json:"defaultNodeImageCode"`
/* 工作节点镜像 (Optional) */
NodeImages []NodeImage `json:"nodeImages"`
}
type MasterProgress ¶ added in v1.8.0
type MasterVersion ¶
type MasterVersion struct {
/* 集群版本号 (Optional) */
Version string `json:"version"`
/* 是否默认版本 (Optional) */
IsDefault bool `json:"isDefault"`
/* 默认工作节点版本号 (Optional) */
DefaultNodeVersion string `json:"defaultNodeVersion"`
/* 版本状态 (Optional) */
VersionStatus string `json:"versionStatus"`
/* node 节点的配置 (Optional) */
NodeVersions []NodeVersion `json:"nodeVersions"`
/* node节点操作系统类型列表,以 "," 分割,目前支持 CentOS|Windows (Optional) */
NodeOsTypes string `json:"nodeOsTypes"`
}
type NatGateway ¶ added in v1.21.0
type NatGatewaySpec ¶ added in v1.21.0
type NodeConfig ¶
type NodeConfig struct {
/* 实例类型 (Optional) */
InstanceType string `json:"instanceType"`
/* 镜像信息 (Optional) */
ImageId string `json:"imageId"`
/* 云主机SSH密钥对名称 (Optional) */
KeyNames []string `json:"keyNames"`
/* 云主机磁盘类型 (Optional) */
SystemDiskCategory string `json:"systemDiskCategory"`
/* 云主机云盘系统盘大小 单位(GB) (Optional) */
SystemDiskSize int `json:"systemDiskSize"`
/* 云主机云盘系统盘类型 (Optional) */
SystemDiskType string `json:"systemDiskType"`
/* 云主机云盘 iops,仅限 ssd 类型云盘有效 (Optional) */
SystemDiskIops int `json:"systemDiskIops"`
/* 工作节点组标签 (Optional) */
Labels []LabelSpec `json:"labels"`
}
type NodeConfigSpec ¶
type NodeConfigSpec struct {
/* 实例类型 */
InstanceType string `json:"instanceType"`
/* 工作节点版本,不指定则使用默认版本 (Optional) */
Version *string `json:"version"`
/* 云主机密码,默认为集群密码,密码规范参考:[公共参数规范](https://docs.jdcloud.com/cn/virtual-machines/api/general_parameters) (Optional) */
Password *string `json:"password"`
/* 云主机SSH密钥对名称,当前仅支持一个。使用中的SSH密钥请勿删除。 (Optional) */
KeyNames []string `json:"keyNames"`
/* 云主机系统盘配置信息 (Optional) */
SystemDisk *DiskSpec `json:"systemDisk"`
/* 工作节点组标签,最多支持 10 个 (Optional) */
Labels []LabelSpec `json:"labels"`
}
type NodeGroup ¶
type NodeGroup struct {
/* 集群 id (Optional) */
ClusterId string `json:"clusterId"`
/* 工作节点组 id (Optional) */
NodeGroupId string `json:"nodeGroupId"`
/* 工作节点组名称 (Optional) */
Name string `json:"name"`
/* 工作节点组描述 (Optional) */
Description string `json:"description"`
/* 工作节点组配置信息 (Optional) */
NodeConfig NodeConfig `json:"nodeConfig"`
/* 工作节点版本 (Optional) */
Version string `json:"version"`
/* 工作节点所属的网络信息 (Optional) */
NodeNetwork NodeNetwork `json:"nodeNetwork"`
/* 当前工作节点数量 (Optional) */
CurrentCount int `json:"currentCount"`
/* 期望的工作节点数量 (Optional) */
ExpectCount int `json:"expectCount"`
/* 工作节点组的ag id ,通过agid可以查询该工作节点组下的实例 (Optional) */
AgId string `json:"agId"`
/* 工作节点组所在的 az (Optional) */
Azs []string `json:"azs"`
/* 工作节点组的 ag 对应的实例模板 (Optional) */
InstanceTemplateId string `json:"instanceTemplateId"`
/* 状态 [pending,running,resizing,reconciling,deleting,deleted,error,running_with_error(部分节点有问题)] (Optional) */
State string `json:"state"`
/* (Optional) */
Tags []Tag `json:"tags"`
/* 更新时间 (Optional) */
UpdateTime string `json:"updateTime"`
/* 状态变更原因 (Optional) */
StateMessage string `json:"stateMessage"`
/* 是否开启自动修复 (Optional) */
AutoRepair bool `json:"autoRepair"`
/* 控制节点操作进度 (Optional) */
Progress NodeGroupProgress `json:"progress"`
/* 自动伸缩配置 (Optional) */
CaConfig CAConfig `json:"caConfig"`
/* 创建时间 (Optional) */
CreatedTime string `json:"createdTime"`
}
type NodeGroupNetworkSpec ¶ added in v1.21.0
type NodeGroupNetworkSpec struct {
/* node所在子网id (Optional) */
SubnetId *string `json:"subnetId"`
}
type NodeGroupProgress ¶ added in v1.8.0
type NodeGroupProgress struct {
/* 工作节点组 id (Optional) */
NodeGroupId string `json:"nodeGroupId"`
/* 操作类型, upgrade, downgrade, rollback (Optional) */
Action string `json:"action"`
/* 总工作节点个数 (Optional) */
TotalCount int `json:"totalCount"`
/* 升级完成工作节点个数 (Optional) */
UpdatedCount int `json:"updatedCount"`
}
type NodeGroupSpec ¶
type NodeGroupSpec struct {
/* 名称 */
Name string `json:"name"`
/* (Optional) */
Description *string `json:"description"`
/* 工作节点组的信息 */
NodeConfig *NodeConfigSpec `json:"nodeConfig"`
/* 工作节点组的 az,必须为集群az的子集,默认为集群az (Optional) */
Azs []string `json:"azs"`
/* 工作节点组初始化大小,至少为1个 */
InitialNodeCount int `json:"initialNodeCount"`
/* 工作节点组运行的vpc */
VpcId string `json:"vpcId"`
/* 工作节点组的cidr (Optional) */
NodeCidr *string `json:"nodeCidr"`
/* 是否开启自动修复,默认不开启。 (Optional) */
AutoRepair *bool `json:"autoRepair"`
/* 自动伸缩配置 (Optional) */
CaConfig *CAConfigSpec `json:"caConfig"`
}
type NodeImage ¶
type NodeImage struct {
/* 镜像编码 (Optional) */
Code string `json:"code"`
/* 虚机镜像id (Optional) */
ImageId string `json:"imageId"`
/* 镜像操作系统 (Optional) */
ImageOs string `json:"imageOs"`
/* 主版本号 (Optional) */
MainVersion string `json:"mainVersion"`
/* 内部版本号 (Optional) */
InnerVersion string `json:"innerVersion"`
/* 可见度 (Optional) */
Visibility int `json:"visibility"`
}
type NodeNetwork ¶
type NodeNetwork struct {
/* pod子网的id (Optional) */
PodSubnetId string `json:"podSubnetId"`
/* node子网的id (Optional) */
NodeSubnetId string `json:"nodeSubnetId"`
/* service子网的id (Optional) */
ServiceSubnetId string `json:"serviceSubnetId"`
/* service关联LB的具有公网访问能力的子网id (Optional) */
ServicePublicSubnetId string `json:"servicePublicSubnetId"`
/* node的cidr (Optional) */
NodeNetworkCidr string `json:"nodeNetworkCidr"`
/* vpc id (Optional) */
VpcId string `json:"vpcId"`
}
type NodeVersion ¶
type ServerConfig ¶
type ServerConfig struct {
/* kubernetes master 的支持版本 (Optional) */
ValidMasterVersions []string `json:"validMasterVersions"`
/* kubernetes master 的默认版本 (Optional) */
DefaultMasterVersion string `json:"defaultMasterVersion"`
/* node 节点的配置 (Optional) */
ValidNodeConfig []ValidNodeConfig `json:"validNodeConfig"`
}
type UpgradePlan ¶ added in v1.12.0
type UpgradePlan struct {
/* 升级方式 auto, manual (Optional) */
Mode string `json:"mode"`
/* 升级范围 cluster, master, nodegroup (Optional) */
Scope string `json:"scope"`
/* 升级计划状态 waiting, upgrading (Optional) */
State string `json:"state"`
/* master 期望版本 (Optional) */
MasterExpectedVersion string `json:"masterExpectedVersion"`
/* node 期望版本 (Optional) */
NodeExpectedVersion string `json:"nodeExpectedVersion"`
/* 升级启动时间 (Optional) */
StartTime string `json:"startTime"`
/* 持续时长 (Optional) */
Duration int `json:"duration"`
}
type ValidNodeConfig ¶
Source Files
¶
- AddonConfig.go
- AddonConfigSpec.go
- CAConfig.go
- CAConfigSpec.go
- Cluster.go
- ClusterNetwork.go
- ClusterNetworkSpec.go
- ClusterNetworkSubnet.go
- ClusterSpec.go
- ClusterSubnet.go
- CustomizedNodeGroupSpec.go
- DiskSpec.go
- Label.go
- LabelSpec.go
- MaintenanceWindow.go
- MaintenanceWindowSpec.go
- MasterAuth.go
- MasterImage.go
- MasterProgress.go
- MasterVersion.go
- NatGateway.go
- NatGatewaySpec.go
- NodeConfig.go
- NodeConfigSpec.go
- NodeGroup.go
- NodeGroupNetworkSpec.go
- NodeGroupProgress.go
- NodeGroupSpec.go
- NodeImage.go
- NodeNetwork.go
- NodeVersion.go
- Quota.go
- ServerConfig.go
- Tag.go
- TagFilter.go
- UpgradePlan.go
- ValidNodeConfig.go
Click to show internal directories.
Click to hide internal directories.