update ovn eip dnat snat api (#145)

Signed-off-by: bobz965 <zhangbingbing2_yewu@cmss.chinamobile.com>
kubeovn · Dec 21, 2023 · 2bb3c0f · 2bb3c0f
1 parent 4d4ae7e
commit 2bb3c0f
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 9 deletions.
diff --git a/docs/reference/kube-ovn-api.en.md b/docs/reference/kube-ovn-api.en.md
@@ -552,16 +552,20 @@ For detailed configuration information of SwitchLBRule, you can refer to [Custom
 | Property Name | Type | Description |
 | --- | --- | --- |
 | externalSubnet | String | OvnEip's subnet name |
-| v4ip | String | OvnEip IP address |
+| v4Ip | String | OvnEip IPv4 address |
+| v6Ip | String | OvnEip IPv6 address |
 | macAddress | String | OvnEip Mac address |
-| type | String | OvnEip use type, the value can be `fip`, `snat` or `lrp` |
+| type | String | OvnEip use type, the value can be `lrp`, `lsp` or `nat` |
 
 #### OvnEipStatus
 
 | Property Name | Type | Description |
 | --- | --- | --- |
 | conditions | []OvnEipCondition | OvnEip status change information, refer to the beginning of the documentation for the definition of Condition |
-| v4ip | String | The IPv4 ip address used by ovnEip |
+| type | String | OvnEip use type, the value can be `lrp`, `lsp` or `nat` |
+| nat | String | dnat snat fip |
+| v4Ip | String | The IPv4 ip address used by ovnEip |
+| v6Ip | String | The IPv4 ip address used by ovnEip |
 | macAddress | String | Mac address used by ovnEip |
 
 ### OvnFip
@@ -579,7 +583,10 @@ For detailed configuration information of SwitchLBRule, you can refer to [Custom
 | Property Name | Type | Description |
 | --- | --- | --- |
 | ovnEip | String | Name of the bound ovnEip |
+| ipType | String | vip crd or ip crd ("" means ip crd) |
 | ipName | String | The IP crd name corresponding to the bound Pod |
+| vpc | String | The vpc crd name corresponding to the bound Pod |
+| V4Ip | String | The IPv4 ip addresss corresponding to vip or the bound Pod |
 
 #### OvnFipStatus
 
@@ -588,7 +595,6 @@ For detailed configuration information of SwitchLBRule, you can refer to [Custom
 | ready | Bool | OvnFip is ready or not |
 | v4Eip | String | Name of the ovnEip to which ovnFip is bound |
 | v4Ip | String | The ovnEip address currently in use |
-| macAddress | String | OvnFip's configured mac address |
 | vpc | String | The name of the vpc where ovnFip is located |
 | conditions | []OvnFipCondition | OvnFip status change information, refer to the beginning of the document for the definition of Condition |
 
@@ -607,8 +613,10 @@ For detailed configuration information of SwitchLBRule, you can refer to [Custom
 | Property Name | Type | Description |
 | --- | --- | --- |
 | ovnEip | String | Name of the ovnEip to which ovnSnatRule is bound |
-| vpcSubnet | String | The name of the subnet configured by ovnSnatRule |
+| vpcSubnet | String | The name of the subnet of the vpc configured by ovnSnatRule |
+| vpc | String | The vpc crd name corresponding to the ovnSnatRule bound Pod |
 | ipName | String | The IP crd name corresponding to the ovnSnatRule bound Pod |
+| v4IpCidr | String | The IPv4 cidr of the vpc subnet |
 
 #### OvnSnatRuleStatus
 

diff --git a/docs/reference/kube-ovn-api.md b/docs/reference/kube-ovn-api.md
@@ -552,16 +552,20 @@ SwitchLBRule 的详细配置信息，可以参考 [自定义 VPC 内部负载均
 | 属性名称 | 类型 | 描述 |
 | --- | --- | --- |
 | externalSubnet | String | OvnEip 所在的子网名称 |
-| v4ip | String | OvnEip IP 地址 |
+| v4Ip | String | OvnEip IPv4 地址 |
+| v6Ip | String | OvnEip IPv6 地址 |
 | macAddress | String | OvnEip Mac 地址 |
-| type | String | OvnEip 使用类型，取值有 `fip`、`snat` 或者 `lrp` |
+| type | String | OvnEip 使用类型，取值有 `lrp`、`lsp` 或者 `nat` |
 
 #### OvnEipStatus
 
 | 属性名称 | 类型 | 描述 |
 | --- | --- | --- |
 | conditions | []OvnEipCondition | 默认 Vpc OvnEip 状态变化信息，具体字段参考文档开头 Condition 定义 |
-| v4ip | String | OvnEip 使用的 v4 IP 地址 |
+| type | String | OvnEip 使用类型, 可以是 `lrp`, `lsp` or `nat` |
+| nat | String | dnat snat fip |
+| v4Ip | String | OvnEip 使用的 v4 IP 地址 |
+| v6Ip | String | OvnEip 使用的 v6 IP 地址 |
 | macAddress | String | OvnEip 使用的 Mac 地址 |
 
 ### OvnFip
@@ -579,7 +583,10 @@ SwitchLBRule 的详细配置信息，可以参考 [自定义 VPC 内部负载均
 | 属性名称 | 类型 | 描述 |
 | --- | --- | --- |
 | ovnEip | String | OvnFip 绑定的 OvnEip 名称 |
+| ipType | String | vip 或者 ip crd ("" 表示 ip crd) |
 | ipName | String | OvnFip 绑定 Pod 对应的 IP crd 名称 |
+| vpc | String | Pod 所在的 VPC 的名字 |
+| V4Ip | String |IP 或者 VIP 的 IPv4 地址 |
 
 #### OvnFipStatus
 
@@ -588,7 +595,6 @@ SwitchLBRule 的详细配置信息，可以参考 [自定义 VPC 内部负载均
 | ready | Bool | OvnFip 是否配置完成 |
 | v4Eip | String | OvnFip 绑定的 OvnEip 名称 |
 | v4Ip | String | OvnFip 当前使用的 OvnEip 地址 |
-| macAddress | String | OvnFip 配置的 Mac 地址 |
 | vpc | String | OvnFip 所在的 Vpc 名称 |
 | conditions | []OvnFipCondition | OvnFip 状态变化信息，具体字段参考文档开头 Condition 定义 |
 
@@ -608,7 +614,9 @@ SwitchLBRule 的详细配置信息，可以参考 [自定义 VPC 内部负载均
 | --- | --- | --- |
 | ovnEip | String | OvnSnatRule 绑定的 OvnEip 名称 |
 | vpcSubnet | String | OvnSnatRule 配置的子网名称 |
+| vpc | String | Pod 所在的 VPC |
 | ipName | String | OvnSnatRule 绑定 Pod 对应的 IP crd 名称 |
+| v4IpCidr | String | vpc subnet 的 IPv4 cidr  |
 
 #### OvnSnatRuleStatus