Skip to content

Commit f335ab8

Browse files
imrocimroc
committed
doc: make generate-docs
Signed-off-by: roc <[email protected]>
1 parent 11ea576 commit f335ab8

File tree

1 file changed

+13
-222
lines changed

1 file changed

+13
-222
lines changed

‎docs/api.md‎

Lines changed: 13 additions & 222 deletions
Original file line numberDiff line numberDiff line change
@@ -11,46 +11,9 @@
1111
- [CLBNodeBinding](#clbnodebinding)
1212
- [CLBPodBinding](#clbpodbinding)
1313
- [CLBPortPool](#clbportpool)
14-
- [DedicatedCLBListener](#dedicatedclblistener)
15-
- [DedicatedCLBService](#dedicatedclbservice)
1614

1715

1816

19-
#### AllocatableCLBInfo
20-
21-
22-
23-
24-
25-
26-
27-
_Appears in:_
28-
- [DedicatedCLBServiceStatus](#dedicatedclbservicestatus)
29-
30-
| Field | Description | Default | Validation |
31-
| --- | --- | --- | --- |
32-
| `lbId` _string_ | CLB 实例的 ID。 | | |
33-
| `currentPort` _integer_ | CLB 当前已被分配的端口。 | | |
34-
| `autoCreate` _boolean_ | 是否是自动创建的 CLB。如果是，删除 DedicatedCLBService 时，CLB 也会被清理。 | | |
35-
36-
37-
#### AllocatedCLBInfo
38-
39-
40-
41-
42-
43-
44-
45-
_Appears in:_
46-
- [DedicatedCLBServiceStatus](#dedicatedclbservicestatus)
47-
48-
| Field | Description | Default | Validation |
49-
| --- | --- | --- | --- |
50-
| `lbId` _string_ | CLB 实例的 ID。 | | |
51-
| `autoCreate` _boolean_ | 是否是自动创建的 CLB。如果是，删除 DedicatedCLBService 时，CLB 也会被清理。 | | |
52-
53-
5417
#### AutoCreateConfig
5518

5619

@@ -110,6 +73,8 @@ _Appears in:_
11073
| `PortPoolNotFound` | |
11174
| `NoPortAvailable` | |
11275
| `Deleting` | |
76+
| `PortPoolNotAllocatable` | |
77+
| `Allocated` | |
11378

11479

11580
#### CLBBindingStatus
@@ -126,7 +91,7 @@ _Appears in:_
12691

12792
| Field | Description | Default | Validation |
12893
| --- | --- | --- | --- |
129-
| `state` _[CLBBindingState](#clbbindingstate)_ | 绑定状态 | | |
94+
| `state` _[CLBBindingState](#clbbindingstate)_ | 绑定状态 | Pending | |
13095
| `message` _string_ | 状态信息 | | |
13196
| `portBindings` _[PortBindingStatus](#portbindingstatus) array_ | 端口绑定详情 | | |
13297

@@ -211,6 +176,7 @@ _Appears in:_
211176
| --- | --- | --- | --- |
212177
| `startPort` _integer_ | 端口池的起始端口号 | | |
213178
| `endPort` _integer_ | 端口池的结束端口号 | | |
179+
| `listenerQuota` _integer_ | 监听器数量配额。仅用在单独调整了指定 CLB 实例监听器数量配额的场景（TOTAL_LISTENER_QUOTA），<br />控制器默认会获取账号维度的监听器数量配额作为端口分配的依据，如果 listenerQuota 不为空，<br />将以它的值作为该端口池中所有 CLB 监听器数量配额覆盖账号维度的监听器数量配额。<br /><br />注意：如果指定了 listenerQuota，不支持启用 CLB 自动创建，且需自行保证该端口池中所有 CLB<br />实例的监听器数量配额均等于 listenerQuota 的值。 | | |
214180
| `segmentLength` _integer_ | 端口段的长度 | | |
215181
| `region` _string_ | 地域代码，如ap-chengdu | | |
216182
| `exsistedLoadBalancerIDs` _string array_ | 已有负载均衡器ID列表 | | |
@@ -249,8 +215,9 @@ _Appears in:_
249215

250216
| Field | Description | Default | Validation |
251217
| --- | --- | --- | --- |
252-
| `state` _[CLBPortPoolState](#clbportpoolstate)_ | 状态: Pending/Active/Scaling | | |
218+
| `state` _[CLBPortPoolState](#clbportpoolstate)_ | 状态: Pending/Active/Scaling | Pending | |
253219
| `message` _string_ | 状态信息 | | |
220+
| `quota` _integer_ | 监听器数量的 Quota | | |
254221
| `loadbalancerStatuses` _[LoadBalancerStatus](#loadbalancerstatus) array_ | 负载均衡器状态列表 | | |
255222

256223

@@ -286,149 +253,6 @@ _Appears in:_
286253
| `internetAccessible` _[InternetAccessible](#internetaccessible)_ | 仅适用于公网负载均衡。负载均衡的网络计费模式。 | | |
287254

288255

289-
#### DedicatedCLBListener
290-
291-
292-
293-
DedicatedCLBListener is the Schema for the dedicatedclblisteners API
294-
295-
296-
297-
298-
299-
| Field | Description | Default | Validation |
300-
| --- | --- | --- | --- |
301-
| `apiVersion` _string_ | `networking.cloud.tencent.com/v1alpha1` | | |
302-
| `kind` _string_ | `DedicatedCLBListener` | | |
303-
| `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | |
304-
| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | |
305-
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
306-
| `spec` _[DedicatedCLBListenerSpec](#dedicatedclblistenerspec)_ | | | |
307-
| `status` _[DedicatedCLBListenerStatus](#dedicatedclblistenerstatus)_ | | | |
308-
309-
310-
#### DedicatedCLBListenerSpec
311-
312-
313-
314-
DedicatedCLBListenerSpec defines the desired state of DedicatedCLBListener
315-
316-
317-
318-
_Appears in:_
319-
- [DedicatedCLBListener](#dedicatedclblistener)
320-
321-
| Field | Description | Default | Validation |
322-
| --- | --- | --- | --- |
323-
| `lbId` _string_ | CLB 实例的 ID。 | | |
324-
| `lbRegion` _string_ | CLB 所在地域，不填则使用 TKE 集群所在的地域。 | | |
325-
| `lbPort` _integer_ | CLB 监听器的端口号。 | | |
326-
| `lbEndPort` _integer_ | CLB 端口段监听器的结束端口号。 | | |
327-
| `protocol` _string_ | CLB 监听器的协议。 | | Enum: [TCP UDP] <br /> |
328-
| `extensiveParameters` _string_ | 创建监听器的参数，JSON 格式，详细参数请参考 CreateListener 接口：https://cloud.tencent.com/document/api/214/30693 | | |
329-
| `targetPod` _[TargetPod](#targetpod)_ | CLB 监听器绑定的目标 Pod。 | | |
330-
331-
332-
#### DedicatedCLBListenerStatus
333-
334-
335-
336-
DedicatedCLBListenerStatus defines the observed state of DedicatedCLBListener
337-
338-
339-
340-
_Appears in:_
341-
- [DedicatedCLBListener](#dedicatedclblistener)
342-
343-
| Field | Description | Default | Validation |
344-
| --- | --- | --- | --- |
345-
| `listenerId` _string_ | CLB 监听器的 ID。 | | |
346-
| `state` _string_ | CLB 监听器的状态。 | | Enum: [Bound Available Pending Failed Deleting] <br /> |
347-
| `message` _string_ | 记录 CLB 监听器的失败信息。 | | |
348-
| `address` _string_ | CLB 监听器的外部地址。 | | |
349-
350-
351-
#### DedicatedCLBService
352-
353-
354-
355-
DedicatedCLBService is the Schema for the dedicatedclbservices API
356-
357-
358-
359-
360-
361-
| Field | Description | Default | Validation |
362-
| --- | --- | --- | --- |
363-
| `apiVersion` _string_ | `networking.cloud.tencent.com/v1alpha1` | | |
364-
| `kind` _string_ | `DedicatedCLBService` | | |
365-
| `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | |
366-
| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | |
367-
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
368-
| `spec` _[DedicatedCLBServiceSpec](#dedicatedclbservicespec)_ | | | |
369-
| `status` _[DedicatedCLBServiceStatus](#dedicatedclbservicestatus)_ | | | |
370-
371-
372-
#### DedicatedCLBServicePort
373-
374-
375-
376-
377-
378-
379-
380-
_Appears in:_
381-
- [DedicatedCLBServiceSpec](#dedicatedclbservicespec)
382-
383-
| Field | Description | Default | Validation |
384-
| --- | --- | --- | --- |
385-
| `protocol` _string_ | 端口协议，支持 TCP、UDP。 | | |
386-
| `targetPort` _integer_ | 目标端口。 | | |
387-
| `addressPodAnnotation` _string_ | Pod 外部地址的注解，如果设置，Pod 被映射的外部 CLB 地址将会被自动写到 Pod 的该注解中，Pod 内部可通过 Downward API 感知到自身的外部地址。 | | |
388-
389-
390-
#### DedicatedCLBServiceSpec
391-
392-
393-
394-
DedicatedCLBServiceSpec defines the desired state of DedicatedCLBService
395-
396-
397-
398-
_Appears in:_
399-
- [DedicatedCLBService](#dedicatedclbservice)
400-
401-
| Field | Description | Default | Validation |
402-
| --- | --- | --- | --- |
403-
| `lbRegion` _string_ | CLB 所在地域，不填则使用 TKE 集群所在的地域。 | | |
404-
| `vpcId` _string_ | CLB 所在 VPC ID，不填则使用 TKE 集群所在的 VPC 的 ID。 | | |
405-
| `minPort` _integer_ | CLB 端口范围的最小端口号。 | 500 | |
406-
| `maxPort` _integer_ | CLB 端口范围的最大端口号。 | 50000 | |
407-
| `maxPod` _integer_ | 限制单个 CLB 的 Pod/监听器 的最大数量。 | | |
408-
| `selector` _object (keys:string, values:string)_ | Pod 的标签选择器，被选中的 Pod 会被绑定到 CLB 监听器下。 | | |
409-
| `ports` _[DedicatedCLBServicePort](#dedicatedclbserviceport) array_ | Pod 监听的端口。 | | |
410-
| `listenerExtensiveParameters` _string_ | 创建监听器的参数，JSON 格式，详细参数请参考 CreateListener 接口：https://cloud.tencent.com/document/api/214/30693 | | |
411-
| `existedLbIds` _string array_ | 复用的已有的 CLB ID，可动态追加。 | | |
412-
| `lbAutoCreate` _[LbAutoCreate](#lbautocreate)_ | 启用自动创建 CLB 的功能。 | | |
413-
414-
415-
#### DedicatedCLBServiceStatus
416-
417-
418-
419-
DedicatedCLBServiceStatus defines the observed state of DedicatedCLBService
420-
421-
422-
423-
_Appears in:_
424-
- [DedicatedCLBService](#dedicatedclbservice)
425-
426-
| Field | Description | Default | Validation |
427-
| --- | --- | --- | --- |
428-
| `allocatableLb` _[AllocatableCLBInfo](#allocatableclbinfo) array_ | 可分配端口的 CLB 列表 | | |
429-
| `allocatedLb` _[AllocatedCLBInfo](#allocatedclbinfo) array_ | 已分配完端口的 CLB 列表 | | |
430-
431-
432256
#### InternetAccessible
433257

434258

@@ -447,23 +271,6 @@ _Appears in:_
447271
| `bandwidthpkgSubType` _string_ | 带宽包的类型，如 SINGLEISP（单线）、BGP（多线）。 | | Enum: [SINGLEISP BGP] <br /> |
448272

449273

450-
#### LbAutoCreate
451-
452-
453-
454-
455-
456-
457-
458-
_Appears in:_
459-
- [DedicatedCLBServiceSpec](#dedicatedclbservicespec)
460-
461-
| Field | Description | Default | Validation |
462-
| --- | --- | --- | --- |
463-
| `enable` _boolean_ | 是否启用自动创建 CLB 的功能，如果启用，当 CLB 不足时，会自动创建新的 CLB。 | | |
464-
| `extensiveParameters` _string_ | 创建 CLB 时的参数，JSON 格式，详细参数请参考 CreateLoadBalancer 接口：https://cloud.tencent.com/document/api/214/30692 | | |
465-
466-
467274
#### LoadBalancerState
468275

469276
_Underlying type:_ _string_
@@ -494,12 +301,13 @@ _Appears in:_
494301

495302
| Field | Description | Default | Validation |
496303
| --- | --- | --- | --- |
497-
| `autoCreated` _boolean_ | | | |
498-
| `state` _[LoadBalancerState](#loadbalancerstate)_ | | | |
499-
| `loadbalancerID` _string_ | | | |
500-
| `loadbalancerName` _string_ | | | |
501-
| `ips` _string array_ | | | |
502-
| `hostname` _string_ | | | |
304+
| `autoCreated` _boolean_ | 是否自动创建 | | |
305+
| `state` _[LoadBalancerState](#loadbalancerstate)_ | CLB 状态（Running/NotFound） | | |
306+
| `loadbalancerID` _string_ | CLB 实例 ID | | |
307+
| `loadbalancerName` _string_ | CLB 实例名称 | | |
308+
| `ips` _string array_ | CLB 实例的 IP 地址 | | |
309+
| `hostname` _string_ | CLB 实例的域名 (域名化 CLB) | | |
310+
| `allocated` _integer_ | 已分配的监听器数量 | | |
503311

504312

505313
#### PortBindingStatus
@@ -564,20 +372,3 @@ _Appears in:_
564372
| `tagValue` _string_ | 标签的值 | | |
565373

566374

567-
#### TargetPod
568-
569-
570-
571-
572-
573-
574-
575-
_Appears in:_
576-
- [DedicatedCLBListenerSpec](#dedicatedclblistenerspec)
577-
578-
| Field | Description | Default | Validation |
579-
| --- | --- | --- | --- |
580-
| `podName` _string_ | Pod 的名称。 | | |
581-
| `targetPort` _integer_ | Pod 监听的端口。 | | |
582-
583-

0 commit comments

Comments
 (0)