Skip to content

Commit

Permalink
fix typo
Browse files Browse the repository at this point in the history
Signed-off-by: Mengxin Liu <[email protected]>
  • Loading branch information
oilbeater committed Jan 15, 2025
1 parent b9a27c4 commit 4b8356e
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/guide/eip-snat.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ data:
```
- `enable-external-gw`: Whether to enable SNAT and EIP functions.
- `type`: `centrailized` or `distributed`, Default is `centralized` If `distributed` is used, all nodes of the cluster need to have the same name NIC to perform the gateway function.
- `external-gw-nodes`: In `centralized` modeThe names of the node performing the gateway role, comma separated.
- `type`: `centralized` or `distributed`, Default is `centralized` If `distributed` is used, all nodes of the cluster need to have the same name NIC to perform the gateway function.
- `external-gw-nodes`: In `centralized`mode, The names of the node performing the gateway role, comma separated..
- `external-gw-nic`: The name of the NIC that performs the role of a gateway on the node.
- `external-gw-addr`: The IP and mask of the physical network gateway.
- `nic-ip`,`nic-mac`: The IP and Mac assigned to the logical gateway port needs to be an unoccupied IP and Mac for the physical subnet.
Expand Down
10 changes: 5 additions & 5 deletions docs/guide/eip-snat.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> 该配置针对默认 VPC 下的网络,用户自定义 VPC 请参考 [VPC 网关](./vpc.md#vpc_2)
Kube-OVN 支持利用 OVN 中的 L3 Gateway 功能来实现 Pod 级别的 SNAT 和 EIP 功能。
通过使用 SNAT,一组 Pod 可以共享一个 IP 地址对外进行访问。 通过 EIP 的功能,一个 Pod 可以直接和一个外部 IP 关联,
通过使用 SNAT,一组 Pod 可以共享一个 IP 地址对外进行访问。通过 EIP 的功能,一个 Pod 可以直接和一个外部 IP 关联,
外部服务可以通过 EIP 直接访问 Pod,Pod 也将通过这个 EIP 访问外部服务。

![](../static/eip-snat.png)
Expand Down Expand Up @@ -35,15 +35,15 @@ data:
```
- `enable-external-gw`: 是否开启 SNAT 和 EIP 功能。
- `type`: `centrailized` 或 `distributed`, 默认为 `centralized` 如果使用 `distributed`,则集群所有节点都需要有同名网卡来承担网关功能。
- `type`: `centralized` 或 `distributed`,默认为 `centralized` 如果使用 `distributed`,则集群所有节点都需要有同名网卡来承担网关功能。
- `external-gw-nodes`: `centralized` 模式下,承担网关作用的节点名,逗号分隔。
- `external-gw-nic`: 节点上承担网关作用的网卡名。
- `external-gw-addr`: 物理网络网关的 IP 和掩码。
- `nic-ip`,`nic-mac`: 分配给逻辑网关端口的 IP 和 Mac,需为物理段未被占用的 IP 和 Mac。

## 观察 OVN 和 OVS 状态确认配置生效

检查 OVN-NB 状态, 确认 `ovn-external` 逻辑交换机存在,并且 `ovn-cluster-ovn-external`
检查 OVN-NB 状态确认 `ovn-external` 逻辑交换机存在,并且 `ovn-cluster-ovn-external`
逻辑路由器端口上 绑定了正确的地址和 chassis。

```bash
Expand Down Expand Up @@ -121,6 +121,6 @@ kubectl annotate pod pod-gw ovn.kubernetes.io/routed-

`kube-ovn-controller` 的部分启动参数可对 SNAT 和 EIP 功能进行高阶配置:

- `--external-gateway-config-ns`: Configmap `ovn-external-gw-config` 所属 Namespace, 默认为 `kube-system`。
- `--external-gateway-config-ns`: Configmap `ovn-external-gw-config`所属 Namespace,默认为为 `kube-system`。
- `--external-gateway-net`: 物理网卡所桥接的网桥名,默认为 `external`。
- `--external-gateway-vlanid`: 物理网络 Vlan Tag 号,默认为 0, 即不使用 Vlan。
- `--external-gateway-vlanid`: 物理网络 Vlan Tag 号,默认为 0,即不使用 Vlan。
2 changes: 1 addition & 1 deletion docs/guide/vpc.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ spec:

### Modify the Provider of the ovn-default Logical Switch

Modify the provider of ovn-default to the provider `ovn-nad.default.ovn` configured above in nad
Modify the provider of ovn-default to the provider `ovn-nad.default.ovn`configured above in nad:

```yaml
apiVersion: kubeovn.io/v1
Expand Down
10 changes: 5 additions & 5 deletions docs/guide/vpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ data:
```

- `image`: 网关 Pod 所使用的镜像。
- `enable-vpc-nat-gw` 控制是否启用 VPC 网关功能。
- `enable-vpc-nat-gw`:控制是否启用 VPC 网关功能。

### 创建 VPC 网关并配置默认路由

Expand All @@ -214,7 +214,7 @@ spec:
- `subnet`:为 VPC 内某个 Subnet 名,VPC 网关 Pod 会在该子网下用 `lanIp` 来连接租户网络。
- `lanIp`:`subnet` 内某个未被使用的 IP,VPC 网关 Pod 最终会使用该 IP。当 VPC 配置路由需要指向当前 VpcNatGateway 时 `nextHopIP` 需要设置为这个 `lanIp`。
- `selector`:VpcNatGateway Pod 的节点选择器,格式和 Kubernetes 中的 NodeSelector 格式相同。
- `externalSubnets` VPC 网关使用的外部网络,如果不配置则默认使用 `ovn-vpc-external-network`,当前版本只支持配置一个外部网络。
- `externalSubnets`:VPC 网关使用的外部网络,如果不配置则默认使用 `ovn-vpc-external-network`,当前版本只支持配置一个外部网络。

其他可配参数:

Expand Down Expand Up @@ -265,7 +265,7 @@ spec:
externalSubnet: ovn-vpc-external-network
```

- `externalSubnet` EIP 所在外部网络名称,如果不指定则默认为 `ovn-vpc-external-network`,如果指定则必须为所在 VPC 网关的 `externalSubnets` 中的一个。
- `externalSubnet`:EIP 所在外部网络名称,如果不指定则默认为 `ovn-vpc-external-network`,如果指定则必须为所在 VPC 网关的 `externalSubnets` 中的一个。

### 创建 DNAT 规则

Expand Down Expand Up @@ -502,7 +502,7 @@ data:
- `coredns-vip`:为 coredns 提供 lb 服务的 vip。
- `nad-name`:配置的 `network-attachment-definitions` 资源名称。
- `nad-provider`:使用的 provider 名称。
- `k8s-service-host`:(可缺省) 用于 coredns 访问 k8s apiserver 服务的 ip。
- `k8s-service-host`:(可缺省)用于 coredns 访问 k8s apiserver 服务的 ip。
- `k8s-service-port`:(可缺省)用于 coredns 访问 k8s apiserver 服务的 port。

### 部署 vpc-dns 依赖资源
Expand Down Expand Up @@ -596,7 +596,7 @@ spec:
subnet: cjh-subnet-1
```

- `vpc` 用于部署 dns 组件的 vpc 名称。
- `vpc`:用于部署 dns 组件的 vpc 名称。
- `subnet`:用于部署 dns 组件的子名称。

查看资源信息:
Expand Down

0 comments on commit 4b8356e

Please sign in to comment.