ghcr.io/flannel-io/flannel-cni-plugin:v1.6.2-flannel1

概述

此插件旨在与容器网络 fabric flannel 配合使用。当 flannel 守护进程启动时，它会生成一个 /run/flannel/subnet.env 文件，内容如下：

/run/flannel/subnet.env
FLANNEL_NETWORK=10.1.0.0/16
FLANNEL_SUBNET=10.1.17.1/24
FLANNEL_MTU=1472
FLANNEL_IPMASQ=true

这些信息反映了主机上 flannel 网络的属性。flannel CNI 插件使用这些信息来配置其他 CNI 插件，例如 bridge 插件。

构建

运行 go mod vendor，然后执行 make。生成的 flannel 二进制文件将位于 bin/ 目录下

go mod vendor
make
flannel

操作

给定以下网络配置文件和上述 /run/flannel/subnet.env 的内容，

/run/flannel/subnet.env
{
"name": "mynet",
"type": "flannel"
}

flannel 插件将生成另一个网络配置文件：

{
"name": "mynet",
"type": "bridge",
"mtu": 1472,
"ipMasq": false,
"isGateway": true,
"ipam": {
"type": "host-local",
"subnet": "10.1.17.0/24"
}
}

然后它将调用 bridge 插件，并将生成的配置传递给该插件。

从上面可以看出，flannel 插件默认会委托给 bridge 插件。如果需要向 bridge 插件传递额外的配置值，可以通过 delegate 字段实现：

delegate
{
"name": "mynet",
"type": "flannel",
"delegate": {
"bridge": "mynet0",
"mtu": 1400
}
}

这会向 bridge 插件提供一个配置参数——创建的网桥现在将命名为 mynet0。注意，这里还指定了 mtu，此值不会被 flannel 插件覆盖。

mynet0
mtu

此外，delegate 字段还可用于选择完全不同类型的插件。要使用 ipvlan 而非 bridge，可指定以下配置：

delegate
ipvlan
bridge
{
"name": "mynet",
"type": "flannel",
"delegate": {
"type": "ipvlan",
"master": "eth0"
}
}

为委托插件生成的网络配置中的 ipam 部分，也可通过在输入的 flannel 网络配置中添加基础 ipam 部分来自定义。此 ipam 元素会先更新为包含 flannel 子网、到 flannel 网络的路由，以及（除非已提供）设置为 host-local 的 ipam 类型，然后再提供给委托插件。

ipam
ipam
ipam
ipam
type
host-local

网络配置参考

• name（字符串，必填）：网络的名称 name
• type（字符串，必填）："flannel" type
• subnetFile（字符串，可选）：flanneld 生成的子网文件的完整路径。默认为 /run/flannel/subnet.env subnetFile
• dataDir（字符串，可选）：插件存储生成的网络配置文件的目录路径。默认为 /var/lib/cni/flannel dataDir /var/lib/cni/flannel
• delegate（字典，可选）：指定委托插件的配置选项。 delegate
• ipam（字典，可选，仅 Linux）：指定时，用作构建委托插件配置中 ipam 部分的基础。 ipam ipam

flannel 插件将始终在委托插件配置中设置以下字段：

• name：其 "name" 字段的值。 name
• ipam：基于接收到的 ipam 部分（如果存在），类型默认为 host-local，子网设置为 $FLANNEL_SUBNET，并且（仅 Linux）路由元素由接收到的 ipam 元素中列出的路由和到 flannel 网络的路由组合而成。输入 ipam 部分中的其他字段将透明地提供给委托插件。 ipam ipam type host-local subnet $FLANNEL_SUBNET routes ipam ipam

flannel 插件将在委托插件配置中设置以下字段（如果它们不存在）：

• ipMasq：$FLANNEL_IPMASQ 的取反值 ipMasq $FLANNEL_IPMASQ
• mtu：$FLANNEL_MTU mtu $FLANNEL_MTU

此外，对于 bridge 插件，如果 isGateway 不存在，将被设置为 true。

isGateway true

bridge 插件包含 isDefaultGateway，当该值为 false 时，允许添加回指向集群服务和/或主机的路由。在这种情况下，bridge 插件不会安装默认路由，因此仅 pod 间连接可用。

isDefaultGateway

Windows 支持（实验性）

此插件支持委托给 Windows CNI 插件（overlay.exe、l2bridge.exe），以与 Windows 上的 Flannel 配合使用。Flannel 为 host-gw 模式在 L2Bridge 模式下设置 HNS 网络，为 vxlan 模式在 Overlay 模式下设置 HNS 网络。

委托插件配置中必须设置以下字段：

• name（字符串，必填）：网络的名称（必须与 Flannel 配置中的名称/HNS 网络名称匹配） name
• type（字符串，可选）：默认为 win-l2bridge。可设置为 win-overlay 或其他自定义 Windows CNI type win-l2bridge win-overlay
• ipMasq：$FLANNEL_IPMASQ 的取反值 ipMasq $FLANNEL_IPMASQ
• endpointMacPrefix（字符串，可选）：win-overlay 模式必填，设置为 Flannel 配置的 MAC 前缀 endpointMacPrefix win-overlay
• clusterNetworkPrefix（字符串，可选）：win-l2bridge 模式必填，当 ipMasq 设置为 true 时设置 NAT clusterNetworkPrefix win-l2bridge ipMasq

对于 win-l2bridge，Flannel CNI 插件将设置：

win-l2bridge

• ipam：使用 "host-local" 类型，"subnet" 设置为 $FLANNEL_SUBNET，网关为 $FLANNEL_NETWORK 中的 .2 地址 ipam $FLANNEL_SUBNET $FLANNEL_NETWORK

对于 win-overlay，Flannel CNI 插件将设置：

win-overlay

• ipam：使用 "host-local" 类型，"subnet" 设置为 $FLANNEL_SUBNET，网关为 $FLANNEL_NETWORK 中的 .1 地址 ipam $FLANNEL_SUBNET $FLANNEL_NETWORK

如果 IPMASQ 为 true，Flannel CNI 插件将设置 OutBoundNAT 策略，并将 FLANNEL_SUBNET 添加到任何现有排除项中。

所有其他委托配置（例如 AdditionalArgs 中的其他 HNS 端点策略）将按原样传递给 WINCNI。

示例 VXLAN Flannel CNI 配置

{
"name": "mynet",
"type": "flannel",
"delegate": {
"type": "win-overlay",
"endpointMacPrefix": "0E-2A"
}
}

对于此示例，当 FLANNEL_NETWORK=10.244.0.0/16、FLANNEL_SUBNET=10.244.1.0/24 且 IPMASQ=true 时，Flannel CNI 将生成以下配置以委托给 Windows CNI

{
"name": "mynet",
"type": "win-overlay",
"endpointMacPrefix": "0E-2A",
"ipMasq": true,
"ipam": {
"subnet": "10.244.1.0/24",
"type": "host-local"
}
}

---

项目仓库 README（补充）

概述

此插件旨在与 https://github.com/coreos/flannel%EF%BC%88%E4%B8%80%E7%A7%8D%E5%AE%B9%E5%99%A8%E7%BD%91%E7%BB%9C fabric）配合使用。 当 flannel 守护进程启动时，它会生成一个 /run/flannel/subnet.env 文件，内容如下：

FLANNEL_NETWORK=10.1.0.0/16
FLANNEL_SUBNET=10.1.17.1/24
FLANNEL_MTU=1472
FLANNEL_IPMASQ=true

这些信息反映了主机上 flannel 网络的属性。 flannel CNI 插件使用这些信息来配置其他 CNI 插件，例如 bridge 插件。

构建

运行 go mod vendor，然后运行 make。生成的 flannel 二进制文件将位于 bin/ 目录下

操作

给定以下网络配置文件和上文的 /run/flannel/subnet.env 内容：

{
"name": "mynet",
"type": "flannel"
}

flannel 插件将生成另一个网络配置文件：

{
"name": "mynet",
"type": "bridge",
"mtu": 1472,
"ipMasq": false,
"isGateway": true,
"ipam": {
"type": "host-local",
"subnet": "10.1.17.0/24"
}
}

然后它将调用 bridge 插件，并将生成的配置传递给它。

从上面可以看出，flannel 插件默认会委托给 bridge 插件。如果需要向 bridge 插件传递额外的配置值，可以通过 delegate 字段实现：

{
"name": "mynet",
"type": "flannel",
"delegate": {
"bridge": "mynet0",
"mtu": 1400
}
}

这会向 bridge 插件提供一个配置参数——创建的网桥现在将命名为 mynet0。注意，mtu 也已指定，此值不会被 flannel 插件覆盖。

此外，delegate 字段还可用于选择完全不同类型的插件。要使用 ipvlan 而非 bridge，可指定以下配置：

{
"name": "mynet",
"type": "flannel",
"delegate": {
"type": "ipvlan",
"master": "eth0"
}
}

为委托插件生成的网络配置中的 ipam 部分，也可以通过在输入的 flannel 网络配置中添加基础 ipam 部分来自定义。然后，此 ipam 元素会更新为包含 flannel 子网、到 flannel 网络的路由，并且（除非已提供）ipam 的 type 会设置为 host-local，之后再提供给委托插件。

网络配置参考

• name（字符串，必填）：网络名称
• type（字符串，必填）："flannel"
• subnetFile（字符串，可选）：flanneld 写出的子网文件的完整路径。默认为 /run/flannel/subnet.env
• dataDir（字符串，可选）：插件存储生成的网络配置文件的目录路径。默认为 /var/lib/cni/flannel
• delegate（字典，可选）：指定委托插件的配置选项。
• ipam（字典，可选，仅 Linux）：指定时，用作构建委托插件配置的 ipam 部分的基础。

flannel 插件将始终在委托插件配置中设置以下字段：

• name：其“name”字段的值。
• ipam：基于接收到的 ipam 部分（如果存在），type 默认为 host-local，subnet 设置为 $FLANNEL_SUBNET，并且（仅 Linux）routes 元素由接收到的 ipam 元素中列出的路由和到 flannel 网络的路由组合而成。输入 ipam 部分中存在的其他字段将透明地提供给委托插件。

flannel 插件将在委托插件配置中设置以下字段（如果它们不存在）：

• ipMasq：$FLANNEL_IPMASQ 的取反值
• mtu：$FLANNEL_MTU

此外，对于 bridge 插件，如果 isGateway 不存在，将被设置为 true。

bridge 插件包含 isDefaultGateway，当该值为 false 时，允许添加回指向集群服务和/或主机的路由。在这种情况下，bridge 插件不会安装默认路由，因此仅 pod 到 pod 的连接可用。

Windows 支持（实验性）

此插件支持委托给 Windows CNI 插件（overlay.exe、l2bridge.exe），以与 https://github.com/coreos/flannel/issues/833 配合使用。Flannel 为 host-gw 模式设置 L2Bridge 模式的 HNS 网络，为 vxlan 模式设置 Overlay 模式的 HNS 网络。

委托插件配置中必须设置以下字段：

• name（字符串，必填）：网络名称（必须与 Flannel 配置中的名称/HNS 网络的名称匹配）
• type（字符串，可选）：默认设置为 win-l2bridge。可设置为 win-overlay 或其他自定义 Windows CNI
• ipMasq：$FLANNEL_IPMASQ 的取反值
• endpointMacPrefix（字符串，可选）：win-overlay 模式下必填，设置为 Flannel 配置的 MAC 前缀
• clusterNetworkPrefix（字符串，可选）：win-l2bridge 模式下必填，如果 ipMasq 设置为 true，则设置 NAT

对于 win-l2bridge，Flannel CNI 插件将设置：

• ipam：将使用 "host-local" 类型，"subnet" 设置为 $FLANNEL_SUBNET，网关为 $FLANNEL_NETWORK 中的 .2 地址

对于 win-overlay，Flannel CNI 插件将设置：

• ipam：将使用 "host-local" 类型，"subnet" 设置为 $FLANNEL_SUBNET，网关为 $FLANNEL_NETWORK 中的 .1 地址

如果 IPMASQ 为 true，Flannel CNI 插件将设置 OutBoundNAT 策略，并将 FLANNEL_SUBNET 添加到任何现有排除项中。

所有其他委托配置（例如 AdditionalArgs 中的其他 HNS 端点策略）将原样传递给 WINCNI。

VXLAN Flannel CNI 配置示例

{
"name": "mynet",
"type": "flannel",
"delegate": {
"type": "win-overlay",
"endpointMacPrefix": "0E-2A"
}
}

对于此示例，当 FLANNEL_NETWORK=10.244.0.0/16、FLANNEL_SUBNET=10.244.1.0/24 且 IPMASQ=true 时，Flannel CNI 将生成以下配置以委托给 Windows CNI：

{
"name": "mynet",
"type": "win-overlay",
"endpointMacPrefix": "OE-2A",
"ipMasq": true,
"ipam": {
"subnet": "10.244.1.0/24",
"type": "host-local"
}
}