From b782127a0d023b7e54ec85018b9e0a64c1481087 Mon Sep 17 00:00:00 2001 From: ci-bot Date: Fri, 16 Aug 2024 04:39:36 +0000 Subject: [PATCH] Deployed e51106b2 to v1.13.x with MkDocs 1.6.0 and mike 2.1.2 --- v1.13.x/en/guide/networkpolicy-log/index.html | 17 +- v1.13.x/en/reference/annotations/index.html | 2 +- v1.13.x/guide/networkpolicy-log/index.html | 19 +- v1.13.x/reference/annotations/index.html | 2 +- v1.13.x/search/search_index.json | 2 +- v1.13.x/sitemap.xml | 312 +++++++++--------- v1.13.x/sitemap.xml.gz | Bin 2830 -> 2831 bytes versions.json | 4 +- 8 files changed, 192 insertions(+), 166 deletions(-) diff --git a/v1.13.x/en/guide/networkpolicy-log/index.html b/v1.13.x/en/guide/networkpolicy-log/index.html index 3b3e6efdf..a51c4c556 100644 --- a/v1.13.x/en/guide/networkpolicy-log/index.html +++ b/v1.13.x/en/guide/networkpolicy-log/index.html @@ -1,4 +1,4 @@ - NetworkPolicy Logging - Kube-OVN Document
Skip to content

Annotation Usage

Kube-OVN uses a large number of Pod and Node Annotations for configuring functionality and transferring information. Users can refer to this document to understand the usage of each Annotation, to better troubleshooting and information retrieval.

Note: Some Annotations may change as the code is adjusted.

Pod Annotation

Key Value Description
ovn.kubernetes.io/allocated true or false If the Pod primary interface has already been allocated an address
ovn.kubernetes.io/routed true or false If the Pod primary interface has already been allocated a route
ovn.kubernetes.io/mac_address String MAC address allocated to Pod primary interface，when creating a Pod, you can set a fixed MAC address by this Annotation
ovn.kubernetes.io/ip_address String IP address allocated to Pod primary interface，when creating a Pod, you can set a fixed IP address by this Annotation
ovn.kubernetes.io/cidr String Subnet CIDR that the Pod primary interface belongs to
ovn.kubernetes.io/gateway String Subnet Gateway address that the Pod primary interface belongs to
ovn.kubernetes.io/ip_pool IP list, separated by comma Pod primary interface will choose address from this list, used for workload fix address
ovn.kubernetes.io/bgp true, cluster, local Enable Pod address BGP advertisement
ovn.kubernetes.io/snat String SNAT address for accessing external address
ovn.kubernetes.io/eip String EIP address that Pod accesses external clusters and is accessed from external.
ovn.kubernetes.io/vip String VIP allocated to Pod primary interface
ovn.kubernetes.io/virtualmachine String The VirtualMachineInstance that the Pod primary interface belongs to
ovn.kubernetes.io/logical_router String The VPC that the Pod primary interface belongs to
ovn.kubernetes.io/layer2_forward true or false Enable add unknown address to Pod primary interface in OVN NorthboundDB LSP
ovn.kubernetes.io/port_security true or false Enable Pod primary interface port security
ovn.kubernetes.io/logical_switch String The Subnet that the Pod primary interface belongs to
ovn.kubernetes.io/vlan_id Int The VlanID that the Pod primary interface belongs to
ovn.kubernetes.io/ingress_rate Int Pod primary interface ingress rate limit, measured in Mbits/s
ovn.kubernetes.io/egress_rate Int Pod primary interface egress rate limit, measured in Mbits/s
ovn.kubernetes.io/security_groups String list, separated by comma The SecurityGroup that the Pod primary interface belongs to
ovn.kubernetes.io/allow_live_migration true or false Allow live migration for Pod primary interface, used by KubeVirt
ovn.kubernetes.io/default_route true or false Set the default route to the Pod primary interface.
ovn.kubernetes.io/provider_network String The ProviderNetwork that the Pod primary interface belongs to
ovn.kubernetes.io/mirror true or false Enable Pod primary interface traffic mirror
ovn.kubernetes.io/latency Int The delay injected to the Pod primary interface card, measured in milliseconds
ovn.kubernetes.io/limit Int Maximum number of packets that the qdisc queue of the primary interface of the Pod
ovn.kubernetes.io/loss Float The probability of packet loss on the Pod primary interface
ovn.kubernetes.io/jitter Int The jitter of packet latency on the Pod primary interface, measured in milliseconds

Node Annotation

Key Value Description
ovn.kubernetes.io/allocated true or false If the ovn0 interface has already been allocated an address
ovn.kubernetes.io/ip_address String IP address allocated to ovn0 interface
ovn.kubernetes.io/mac_address String MAC address allocated to ovn0 interface
ovn.kubernetes.io/cidr String Subnet CIDR that the node ovn0 interface belongs to
ovn.kubernetes.io/gateway String Subnet gateway that the node ovn0 interface belongs to
ovn.kubernetes.io/chassis String The Chassis ID in OVN-SouthBoundDB that the node belongs to
ovn.kubernetes.io/port_name String The LSP name in OVN-NorthboundDB that the node ovn0 interface belongs to
ovn.kubernetes.io/logical_switch String Subnet that the node ovn0 interface belongs to
ovn.kubernetes.io/tunnel_interface String Network interface used for tunnel encapsulation

Namespace Annotation

Key Value Description
ovn.kubernetes.io/cidr CIDR list, separated by comma The CIDRs of subnets bound by this Namespace
ovn.kubernetes.io/exclude_ips excludeIPs list, separated by semicolon The excludeIPs of subnets bound by this Namespace

Subnet Annotation

Key Value Description
ovn.kubernetes.io/bgp true, cluster, local Enable Subnet address BGP advertisement

Service Annotation

Key Value Description
ovn.kubernetes.io/bgp true or false Enable Service address BGP advertisement
ovn.kubernetes.io/switch_lb_vip String Additional VIP addresses assigned to Service in Kube-OVN.
ovn.kubernetes.io/vpc String The VPC that the Service belongs to

Networkpolicy Annotation

Key Value Description
ovn.kubernetes.io/enable_log true or false Enable NetworkPolicy log

微信群 Slack Twitter Support Meeting

Comments

Annotation Usage

Kube-OVN uses a large number of Pod and Node Annotations for configuring functionality and transferring information. Users can refer to this document to understand the usage of each Annotation, to better troubleshooting and information retrieval.

Note: Some Annotations may change as the code is adjusted.

Pod Annotation

Key Value Description
ovn.kubernetes.io/allocated true or false If the Pod primary interface has already been allocated an address
ovn.kubernetes.io/routed true or false If the Pod primary interface has already been allocated a route
ovn.kubernetes.io/mac_address String MAC address allocated to Pod primary interface，when creating a Pod, you can set a fixed MAC address by this Annotation
ovn.kubernetes.io/ip_address String IP address allocated to Pod primary interface，when creating a Pod, you can set a fixed IP address by this Annotation
ovn.kubernetes.io/cidr String Subnet CIDR that the Pod primary interface belongs to
ovn.kubernetes.io/gateway String Subnet Gateway address that the Pod primary interface belongs to
ovn.kubernetes.io/ip_pool IP list, separated by comma Pod primary interface will choose address from this list, used for workload fix address
ovn.kubernetes.io/bgp true, cluster, local Enable Pod address BGP advertisement
ovn.kubernetes.io/snat String SNAT address for accessing external address
ovn.kubernetes.io/eip String EIP address that Pod accesses external clusters and is accessed from external.
ovn.kubernetes.io/vip String VIP allocated to Pod primary interface
ovn.kubernetes.io/virtualmachine String The VirtualMachineInstance that the Pod primary interface belongs to
ovn.kubernetes.io/logical_router String The VPC that the Pod primary interface belongs to
ovn.kubernetes.io/layer2_forward true or false Enable add unknown address to Pod primary interface in OVN NorthboundDB LSP
ovn.kubernetes.io/port_security true or false Enable Pod primary interface port security
ovn.kubernetes.io/logical_switch String The Subnet that the Pod primary interface belongs to
ovn.kubernetes.io/vlan_id Int The VlanID that the Pod primary interface belongs to
ovn.kubernetes.io/ingress_rate Int Pod primary interface ingress rate limit, measured in Mbits/s
ovn.kubernetes.io/egress_rate Int Pod primary interface egress rate limit, measured in Mbits/s
ovn.kubernetes.io/security_groups String list, separated by comma The SecurityGroup that the Pod primary interface belongs to
ovn.kubernetes.io/allow_live_migration true or false Allow live migration for Pod primary interface, used by KubeVirt
ovn.kubernetes.io/default_route true or false Set the default route to the Pod primary interface.
ovn.kubernetes.io/provider_network String The ProviderNetwork that the Pod primary interface belongs to
ovn.kubernetes.io/mirror true or false Enable Pod primary interface traffic mirror
ovn.kubernetes.io/latency Int The delay injected to the Pod primary interface card, measured in milliseconds
ovn.kubernetes.io/limit Int Maximum number of packets that the qdisc queue of the primary interface of the Pod
ovn.kubernetes.io/loss Float The probability of packet loss on the Pod primary interface
ovn.kubernetes.io/jitter Int The jitter of packet latency on the Pod primary interface, measured in milliseconds

Node Annotation

Key Value Description
ovn.kubernetes.io/allocated true or false If the ovn0 interface has already been allocated an address
ovn.kubernetes.io/ip_address String IP address allocated to ovn0 interface
ovn.kubernetes.io/mac_address String MAC address allocated to ovn0 interface
ovn.kubernetes.io/cidr String Subnet CIDR that the node ovn0 interface belongs to
ovn.kubernetes.io/gateway String Subnet gateway that the node ovn0 interface belongs to
ovn.kubernetes.io/chassis String The Chassis ID in OVN-SouthBoundDB that the node belongs to
ovn.kubernetes.io/port_name String The LSP name in OVN-NorthboundDB that the node ovn0 interface belongs to
ovn.kubernetes.io/logical_switch String Subnet that the node ovn0 interface belongs to
ovn.kubernetes.io/tunnel_interface String Network interface used for tunnel encapsulation

Namespace Annotation

Key Value Description
ovn.kubernetes.io/cidr CIDR list, separated by comma The CIDRs of subnets bound by this Namespace
ovn.kubernetes.io/exclude_ips excludeIPs list, separated by semicolon The excludeIPs of subnets bound by this Namespace

Subnet Annotation

Key Value Description
ovn.kubernetes.io/bgp true, cluster, local Enable Subnet address BGP advertisement

Service Annotation

Key Value Description
ovn.kubernetes.io/bgp true or false Enable Service address BGP advertisement
ovn.kubernetes.io/switch_lb_vip String Additional VIP addresses assigned to Service in Kube-OVN.
ovn.kubernetes.io/vpc String The VPC that the Service belongs to

Networkpolicy Annotation

Key Value Description
ovn.kubernetes.io/enable_log true or false Enable NetworkPolicy log
ovn.kubernetes.io/log_acl_actions One or more combinations of "allow,drop,pass" Print ACL logs that match ACL action

微信群 Slack Twitter Support Meeting

Comments

Annotation 使用说明

Kube-OVN 使用了大量的 Pod 和 Node Annotation 进行功能设置和信息传递，用户可以通过本文档了解各个 Annotation 的使用，方便问题排查和信息获取。

注意：部分 Annotation 可能会随着代码调整而进行变化。

Pod Annotation

Key Value Description
ovn.kubernetes.io/allocated true or false Pod 主网卡是否已被分配地址
ovn.kubernetes.io/routed true or false Pod 主网卡在 OVN 内的路由是否设置完成
ovn.kubernetes.io/mac_address String Pod 主网卡所分配到的 Mac 地址，创建 Pod 时可通过该 Annotation 设置固定 Mac 地址
ovn.kubernetes.io/ip_address String Pod 主网卡所分配到的 IP 地址，创建 Pod 时可通过该 Annotation 设置固定 IP 地址
ovn.kubernetes.io/cidr String Pod 主网卡所属子网的 CIDR
ovn.kubernetes.io/gateway String Pod 主网卡所属子网的 Gateway 地址
ovn.kubernetes.io/ip_pool IP 列表，逗号间隔 Pod 主网卡地址将从列表中选择，适用于 Workload 固定 IP 场景
ovn.kubernetes.io/bgp true, cluster, local 是否对外通过 BGP 发布 Pod 地址
ovn.kubernetes.io/snat String Pod 访问集群外使用的 SNAT 地址
ovn.kubernetes.io/eip String Pod 访问集群外部和被集群外部访问所使用的 EIP 地址
ovn.kubernetes.io/vip String Pod 主网卡使用的预留 VIP，可通过该 Annotation 使用预先创建的 VIP 资源
ovn.kubernetes.io/virtualmachine String Pod 主网卡所属的 VirtualMachineInstance
ovn.kubernetes.io/logical_router String Pod 主网卡所属的 VPC
ovn.kubernetes.io/layer2_forward true or false Pod 主网卡在 OVN LSP 中是否增加 unknown 地址
ovn.kubernetes.io/port_security true or false Pod 主网卡对应端口是否开启 Port Security
ovn.kubernetes.io/logical_switch String Pod 主网卡所属的 Subnet
ovn.kubernetes.io/vlan_id Int Pod 主网卡所属 Subnet 的 Vlan ID
ovn.kubernetes.io/ingress_rate Int Pod 主网卡流入方向限速，单位为 Mbits/s
ovn.kubernetes.io/egress_rate Int Pod 主网卡流出方向限速，单位为 Mbits/s
ovn.kubernetes.io/security_groups String 列表，使用逗号分隔 Pod 主网卡所属的 Security Group
ovn.kubernetes.io/allow_live_migration true or false Pod 主网卡是否允许 live migration，用于 kubevirt 场景
ovn.kubernetes.io/default_route true or false 是否将主网卡设置为默认路由网卡
ovn.kubernetes.io/provider_network String Pod 主网卡所属的 ProviderNetwork
ovn.kubernetes.io/mirror true or false Pod 主网卡是否做流量镜像
ovn.kubernetes.io/logical_switch String Pod 主网卡所属 Subnet
ovn.kubernetes.io/latency Int Pod 主网卡注入的延迟，单位为 ms
ovn.kubernetes.io/limit Int Pod 主网卡 qdisc 队列可容纳的最大数据包数
ovn.kubernetes.io/loss Float Pod 主网卡报文丢包概率
ovn.kubernetes.io/jitter Int Pod 主网卡注入抖动延迟，单位为 ms

Node Annotation

Key Value Description
ovn.kubernetes.io/allocated true or false 节点的 ovn0 网卡是否已被分配 join 子网地址
ovn.kubernetes.io/mac_address String Node ovn0 网卡分配到的 Mac 地址
ovn.kubernetes.io/ip_address String Node ovn0 网卡所分配到的 IP 地址
ovn.kubernetes.io/cidr String Node ovn0 网卡所属 join 子网的 CIDR
ovn.kubernetes.io/gateway String Node ovn0 网卡所属 join 子网的 Gateway 地址
ovn.kubernetes.io/chassis String Node 在 OVN-SouthBoundDB 中的 Chassis ID
ovn.kubernetes.io/port_name String Node ovn0 网卡在 OVN-NorthboundDB 中 LSP 的名称
ovn.kubernetes.io/logical_switch String Node ovn0 网卡所属 Subnet
ovn.kubernetes.io/tunnel_interface String 隧道封装使用的网卡

Namespace Annotation

Key Value Description
ovn.kubernetes.io/cidr CIDR 列表，逗号分隔 该 Namespace 所绑定子网的 CIDR
ovn.kubernetes.io/exclude_ips excludeIPs 列表，分号分割 该 Namespace 所绑定子网的 excludeIPs

Subnet Annotation

Key Value Description
ovn.kubernetes.io/bgp true, cluster, local 是否对外通过 BGP 发布子网地址

Service Annotation

Key Value Description
ovn.kubernetes.io/bgp true or false 是否对外通过 BGP 发布 Service 地址
ovn.kubernetes.io/switch_lb_vip String Service 在 Kube-OVN 中额外分配的 VIP 地址
ovn.kubernetes.io/vpc String Service 所属的 VPC

Networkpolicy Annotation

Key Value Description
ovn.kubernetes.io/enable_log true or false 是否开启 NetworkPolicy 日志

微信群 Slack Twitter Support Meeting

评论

Annotation 使用说明

Kube-OVN 使用了大量的 Pod 和 Node Annotation 进行功能设置和信息传递，用户可以通过本文档了解各个 Annotation 的使用，方便问题排查和信息获取。

注意：部分 Annotation 可能会随着代码调整而进行变化。

Pod Annotation

Key Value Description
ovn.kubernetes.io/allocated true or false Pod 主网卡是否已被分配地址
ovn.kubernetes.io/routed true or false Pod 主网卡在 OVN 内的路由是否设置完成
ovn.kubernetes.io/mac_address String Pod 主网卡所分配到的 Mac 地址，创建 Pod 时可通过该 Annotation 设置固定 Mac 地址
ovn.kubernetes.io/ip_address String Pod 主网卡所分配到的 IP 地址，创建 Pod 时可通过该 Annotation 设置固定 IP 地址
ovn.kubernetes.io/cidr String Pod 主网卡所属子网的 CIDR
ovn.kubernetes.io/gateway String Pod 主网卡所属子网的 Gateway 地址
ovn.kubernetes.io/ip_pool IP 列表，逗号间隔 Pod 主网卡地址将从列表中选择，适用于 Workload 固定 IP 场景
ovn.kubernetes.io/bgp true, cluster, local 是否对外通过 BGP 发布 Pod 地址
ovn.kubernetes.io/snat String Pod 访问集群外使用的 SNAT 地址
ovn.kubernetes.io/eip String Pod 访问集群外部和被集群外部访问所使用的 EIP 地址
ovn.kubernetes.io/vip String Pod 主网卡使用的预留 VIP，可通过该 Annotation 使用预先创建的 VIP 资源
ovn.kubernetes.io/virtualmachine String Pod 主网卡所属的 VirtualMachineInstance
ovn.kubernetes.io/logical_router String Pod 主网卡所属的 VPC
ovn.kubernetes.io/layer2_forward true or false Pod 主网卡在 OVN LSP 中是否增加 unknown 地址
ovn.kubernetes.io/port_security true or false Pod 主网卡对应端口是否开启 Port Security
ovn.kubernetes.io/logical_switch String Pod 主网卡所属的 Subnet
ovn.kubernetes.io/vlan_id Int Pod 主网卡所属 Subnet 的 Vlan ID
ovn.kubernetes.io/ingress_rate Int Pod 主网卡流入方向限速，单位为 Mbits/s
ovn.kubernetes.io/egress_rate Int Pod 主网卡流出方向限速，单位为 Mbits/s
ovn.kubernetes.io/security_groups String 列表，使用逗号分隔 Pod 主网卡所属的 Security Group
ovn.kubernetes.io/allow_live_migration true or false Pod 主网卡是否允许 live migration，用于 kubevirt 场景
ovn.kubernetes.io/default_route true or false 是否将主网卡设置为默认路由网卡
ovn.kubernetes.io/provider_network String Pod 主网卡所属的 ProviderNetwork
ovn.kubernetes.io/mirror true or false Pod 主网卡是否做流量镜像
ovn.kubernetes.io/logical_switch String Pod 主网卡所属 Subnet
ovn.kubernetes.io/latency Int Pod 主网卡注入的延迟，单位为 ms
ovn.kubernetes.io/limit Int Pod 主网卡 qdisc 队列可容纳的最大数据包数
ovn.kubernetes.io/loss Float Pod 主网卡报文丢包概率
ovn.kubernetes.io/jitter Int Pod 主网卡注入抖动延迟，单位为 ms

Node Annotation

Key Value Description
ovn.kubernetes.io/allocated true or false 节点的 ovn0 网卡是否已被分配 join 子网地址
ovn.kubernetes.io/mac_address String Node ovn0 网卡分配到的 Mac 地址
ovn.kubernetes.io/ip_address String Node ovn0 网卡所分配到的 IP 地址
ovn.kubernetes.io/cidr String Node ovn0 网卡所属 join 子网的 CIDR
ovn.kubernetes.io/gateway String Node ovn0 网卡所属 join 子网的 Gateway 地址
ovn.kubernetes.io/chassis String Node 在 OVN-SouthBoundDB 中的 Chassis ID
ovn.kubernetes.io/port_name String Node ovn0 网卡在 OVN-NorthboundDB 中 LSP 的名称
ovn.kubernetes.io/logical_switch String Node ovn0 网卡所属 Subnet
ovn.kubernetes.io/tunnel_interface String 隧道封装使用的网卡

Namespace Annotation

Key Value Description
ovn.kubernetes.io/cidr CIDR 列表，逗号分隔 该 Namespace 所绑定子网的 CIDR
ovn.kubernetes.io/exclude_ips excludeIPs 列表，分号分割 该 Namespace 所绑定子网的 excludeIPs

Subnet Annotation

Key Value Description
ovn.kubernetes.io/bgp true, cluster, local 是否对外通过 BGP 发布子网地址

Service Annotation

Key Value Description
ovn.kubernetes.io/bgp true or false 是否对外通过 BGP 发布 Service 地址
ovn.kubernetes.io/switch_lb_vip String Service 在 Kube-OVN 中额外分配的 VIP 地址
ovn.kubernetes.io/vpc String Service 所属的 VPC

Networkpolicy Annotation

Key Value Description
ovn.kubernetes.io/enable_log true or false 是否开启 NetworkPolicy 日志
ovn.kubernetes.io/log_acl_actions "allow,drop,pass"其中一个或多个组合 打印匹配 Action ACL 的日志

微信群 Slack Twitter Support Meeting

评论