Skip to content

Latest commit

 

History

History
226 lines (112 loc) · 7.9 KB

api.md

File metadata and controls

226 lines (112 loc) · 7.9 KB
Raw

API Reference

Packages

networking.cloud.tencent.com/v1alpha1

Resource Types

AllocatableCLBInfo

Appears in:

Field Description Default Validation
lbId string CLB 实例的 ID。
currentPort integer CLB 当前已被分配的端口。
autoCreate boolean 是否是自动创建的 CLB。如果是，删除 DedicatedCLBService 时，CLB 也会被清理。

AllocatedCLBInfo

Appears in:

Field Description Default Validation
lbId string CLB 实例的 ID。
autoCreate boolean 是否是自动创建的 CLB。如果是，删除 DedicatedCLBService 时，CLB 也会被清理。

DedicatedCLBListener

DedicatedCLBListener is the Schema for the dedicatedclblisteners API

Field Description Default Validation
apiVersion string networking.cloud.tencent.com/v1alpha1
kind string DedicatedCLBListener
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec DedicatedCLBListenerSpec
status DedicatedCLBListenerStatus

DedicatedCLBListenerSpec

DedicatedCLBListenerSpec defines the desired state of DedicatedCLBListener

Appears in:

Field Description Default Validation
lbId string CLB 实例的 ID。
lbRegion string CLB 所在地域，不填则使用 TKE 集群所在的地域。
lbPort integer CLB 监听器的端口号。
protocol string CLB 监听器的协议。 Enum: [TCP UDP]
extensiveParameters string 创建监听器的参数，JSON 格式，详细参数请参考 CreateListener 接口：https://cloud.tencent.com/document/api/214/30693
targetPod TargetPod CLB 监听器绑定的目标 Pod。

DedicatedCLBListenerStatus

DedicatedCLBListenerStatus defines the observed state of DedicatedCLBListener

Appears in:

Field Description Default Validation
listenerId string CLB 监听器的 ID。
state string CLB 监听器的状态。 Enum: [Bound Available Pending Failed Deleting]
message string 记录 CLB 监听器的失败信息。
address string CLB 监听器的外部地址。

DedicatedCLBService

DedicatedCLBService is the Schema for the dedicatedclbservices API

Field Description Default Validation
apiVersion string networking.cloud.tencent.com/v1alpha1
kind string DedicatedCLBService
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec DedicatedCLBServiceSpec
status DedicatedCLBServiceStatus

DedicatedCLBServicePort

Appears in:

Field Description Default Validation
protocol string 端口协议，支持 TCP、UDP。
targetPort integer 目标端口。
addressPodAnnotation string Pod 外部地址的注解，如果设置，Pod 被映射的外部 CLB 地址将会被自动写到 Pod 的该注解中，Pod 内部可通过 Downward API 感知到自身的外部地址。

DedicatedCLBServiceSpec

DedicatedCLBServiceSpec defines the desired state of DedicatedCLBService

Appears in:

Field Description Default Validation
lbRegion string CLB 所在地域，不填则使用 TKE 集群所在的地域。
vpcId string CLB 所在 VPC ID，不填则使用 TKE 集群所在的 VPC 的 ID。
minPort integer CLB 端口范围的最小端口号。 500
maxPort integer CLB 端口范围的最大端口号。 50000
maxPod integer 限制单个 CLB 的 Pod/监听器 的最大数量。
selector object (keys:string, values:string) Pod 的标签选择器，被选中的 Pod 会被绑定到 CLB 监听器下。
ports DedicatedCLBServicePort array Pod 监听的端口。
listenerExtensiveParameters string 创建监听器的参数，JSON 格式，详细参数请参考 CreateListener 接口：https://cloud.tencent.com/document/api/214/30693
existedLbIds string array 复用的已有的 CLB ID，可动态追加。
lbAutoCreate LbAutoCreate 启用自动创建 CLB 的功能。

DedicatedCLBServiceStatus

DedicatedCLBServiceStatus defines the observed state of DedicatedCLBService

Appears in:

Field Description Default Validation
allocatableLb AllocatableCLBInfo array 可分配端口的 CLB 列表
allocatedLb AllocatedCLBInfo array 已分配完端口的 CLB 列表

LbAutoCreate

Appears in:

Field Description Default Validation
enable boolean 是否启用自动创建 CLB 的功能，如果启用，当 CLB 不足时，会自动创建新的 CLB。
extensiveParameters string 创建 CLB 时的参数，JSON 格式，详细参数请参考 CreateLoadBalancer 接口：https://cloud.tencent.com/document/api/214/30692

TargetPod

Appears in:

Field Description Default Validation
podName string Pod 的名称。
targetPort integer Pod 监听的端口。