rename

Signed-off-by: bobz965 <zhangbingbing2_yewu@cmss.chinamobile.com>
kubeovn · Oct 24, 2023 · d4f394a · d4f394a
1 parent 558c0d5
commit d4f394a
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 32 deletions.
diff --git a/docs/advance/vpc-dns.en.md → docs/advance/vpc-internal-dns.en.md b/docs/advance/vpc-dns.en.md → docs/advance/vpc-internal-dns.en.md
@@ -1,4 +1,4 @@
-# Custom VPC DNS
+# Custom VPC Internal DNS
 
 Due to the isolation of the user-defined VPC and the default VPC network, the coredns deployed in the default VPC cannot be accessed from within the custom VPC. If you wish to use the intra-cluster domain name resolution capability provided by Kubernetes within your custom VPC, you can refer to this document and utilize the vpc-dns CRD to do so.
 

diff --git a/docs/advance/vpc-dns.md → docs/advance/vpc-internal-dns.md b/docs/advance/vpc-dns.md → docs/advance/vpc-internal-dns.md
@@ -1,4 +1,4 @@
-# 自定义 VPC DNS
+# 自定义 VPC 内部 DNS
 
 由于用户自定义 VPC 和 默认 VPC 网络相互隔离，自定 VPC 内无法访问到部署在默认 VPC 内的 coredns。
 如果用户希望在自定义 VPC 内使用 Kubernetes 提供的集群内域名解析能力，可以参考本文档，利用 `vpc-dns` CRD 来实现。

diff --git a/docs/advance/vpc-internal-lb.en.md b/docs/advance/vpc-internal-lb.en.md
@@ -37,12 +37,10 @@ spec:
   ```
 
 - usage of `selector`, `sessionAffinity`, and `port` is the same as Kubernetes Service.
-
 - `vip`：customize load balancing IP address.
-
 - `namespace`：namespace of the `pod` selected by `selector`.
 
-    Kube OVN will determine the VPC of the selected `pod` based on the `SwitchLBRule` definition and set the corresponding L2 LB.
+Kube OVN will determine the VPC of the selected `pod` based on the `SwitchLBRule` definition and set the corresponding L2 LB.
 
 ## Manually Defined Load Balancing Rules by `Endpoints`
 
@@ -70,15 +68,13 @@ spec:
     protocol: TCP
 ```
 
-- usage of `sessionAffinity`, and `port` is the same as Kubernetes Service.
+usage of `sessionAffinity`, and `port` is the same as Kubernetes Service.
 
 - `vip`：customize load balancing IP address.
-
 - `namespace`：namespace of the `pod` selected by `selector`.
-
 - `endpoints`：load balancing backend IP list.
 
-> **attention：**If both `selector` and `endpoints` are configured, the `selector` configuration will be automatically ignored.
+If both `selector` and `endpoints` are configured, the `selector` configuration will be automatically ignored.
 
 ## Health Check
 
@@ -121,6 +117,7 @@ spec:
     targetPort: 80
     protocol: TCP
 END
+
 root@server:~# kubectl apply -f slr.yaml
 root@server:~# kubectl get slr
 NAME              VIP       PORT(S)    SERVICE                       AGE
@@ -183,6 +180,7 @@ protocol            : tcp
 src_ip              : "10.16.0.2"
 src_mac             : "c6:d4:b8:08:54:e7"
 status              : online
+
 ```
 
 At this point, the service response can be successfully obtained through load balancer `vip`.
@@ -193,22 +191,6 @@ root@server:~# kubectl exec -it -n vulpecula nginx-78d9578975-t8tm5 -- curl 1.1.
 <html>
 <head>
 <title>Welcome to nginx!</title>
-<style>
-html { color-scheme: light dark; }
-body { width: 35em; margin: 0 auto;
-font-family: Tahoma, Verdana, Arial, sans-serif; }
-</style>
-</head>
-<body>
-<h1>Welcome to nginx!</h1>
-<p>If you see this page, the nginx web server is successfully installed and
-working. Further configuration is required.</p>
-
-<p>For online documentation and support please refer to
-<a href="http://nginx.org/">nginx.org</a>.<br/>
-Commercial support is available at
-<a href="http://nginx.com/">nginx.com</a>.</p>
-
 <p><em>Thank you for using nginx.</em></p>
 </body>
 </html>
@@ -225,6 +207,7 @@ kubectl get po -o wide -n vulpecula
 NAME                     READY   STATUS    RESTARTS   AGE     IP          NODE     NOMINATED NODE   READINESS GATES
 nginx-78d9578975-lxmvh   1/1     Running   0          31s     10.16.0.8   worker   <none>           <none>
 nginx-78d9578975-t8tm5   1/1     Running   3          4d16h   10.16.0.6   worker   <none>           <none>
+
 ```
 
 Query the `Load_Balancer_Health_Check` and `Service_Monitor` by commands, the results have undergone corresponding changes.
@@ -270,6 +253,7 @@ protocol            : tcp
 src_ip              : "10.16.0.2"
 src_mac             : "c6:d4:b8:08:54:e7"
 status              : online
+
 ```
 
 Delete `SwitchLBRule` and confirm the resource status, `Load_Balancer_Health_Check` adn `Service_Monitor` has been deleted, and the corresponding `vip` has also been deleted.

diff --git a/docs/advance/vpc-internal-lb.md b/docs/advance/vpc-internal-lb.md
diff --git a/docs/reference/feature-stage.md b/docs/reference/feature-stage.md
@@ -75,6 +75,5 @@
 | [StatefulSet 固定 IP](../guide/static-ip-mac.md) | true  | GA    | 1.8       |           |
 | [VM 固定 IP](../guide/static-ip-mac.md) | false | Beta  | 1.9       |           |
 | [默认 VPC Load Balancer 类型 Service](../guide/loadbalancer-service.md) | false | Alpha | 1.11      |           |
-| [自定义 VPC 内部负载均衡](../guide/loadbalancer-service.md) | false | Alpha | 1.11      |           |
-| [自定义 VPC DNS](../guide/loadbalancer-service.md) | false | Alpha | 1.11      |           |
+| [自定义 VPC 内部 DNS](../advance/vpc-internal-dns.md) | false | Alpha | 1.11      |           |
 | [Underlay 和 Overlay 互通](../start/underlay.md) | false | Alpha | 1.11      |           |
diff --git a/docs/reference/kube-ovn-api.en.md b/docs/reference/kube-ovn-api.en.md
@@ -414,7 +414,7 @@ The meaning of the above tolerance fields can be found in the official Kubernete
 | conditions | []VpcDnsCondition | VpcDns status change information, refer to the beginning of the document for the definition of Condition |
 | active | Bool | Whether VpcDns is in use |
 
-For detailed documentation on the use of VpcDns, see [Customizing VPC DNS](../advance/vpc-dns.md).
+For detailed documentation on the use of VpcDns, see [Customizing VPC DNS](../advance/vpc-internal-dns.md).
 
 ### SwitchLBRule
 
@@ -436,7 +436,7 @@ For detailed documentation on the use of VpcDns, see [Customizing VPC DNS](../ad
 | sessionAffinity | String | Standard Kubernetes service sessionAffinity value |
 | ports | []SlrPort | List of SwitchLBRule ports |
 
-For detailed configuration information of SwitchLBRule, you can refer to [Customizing VPC Internal Load Balancing](../advance/vpc-internal-lb.md).
+For detailed configuration information of SwitchLBRule, you can refer to [Customizing VPC Internal Load Balancing health check](../advance/vpc-internal-lb.md).
 
 ##### SlrPort
 

diff --git a/docs/reference/kube-ovn-api.md b/docs/reference/kube-ovn-api.md
@@ -414,7 +414,7 @@
 | conditions | []VpcDnsCondition | VpcDns 状态变化信息，具体字段参考文档开头 Condition 定义 |
 | active | Bool | VpcDns 是否正在使用 |
 
-VpcDns 的详细使用文档，可以参考 [自定义 VPC DNS](../advance/vpc-dns.md)。
+VpcDns 的详细使用文档，可以参考 [自定义 VPC 内部 DNS](../advance/vpc-internal-dns.md)。
 
 ### SwitchLBRule
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -53,7 +53,7 @@ nav:
       - DHCP 设置: 'advance/dhcp.md'
       - VPC 互联: 'advance/vpc-peering.md'
       - 自定义 VPC 内部负载均衡: 'advance/vpc-internal-lb.md'
-      - 自定义 VPC DNS: 'advance/vpc-dns.md'
+      - 自定义 VPC 内部 DNS: 'advance/vpc-internal-dns.md'
       - 外部网关设置: 'advance/external-gateway.md'
       - VIP 预留设置: 'advance/vip.md'
       - Mellanox 网卡 Offload 支持: 'advance/offload-mellanox.md'
@@ -204,7 +204,7 @@ plugins:
           Iptables 规则: Iptables Rules
           kube-ovn-pinger 参数描述: kube-ovn-pinger args description
           自定义 VPC 内部负载均衡: VPC Internal Load Balancer
-          自定义 VPC DNS: VPC DNS
+          自定义 VPC 内部 DNS: VPC Internal DNS
           Kube-OVN 接口规范: Kube-OVN API Reference
           SecurityGroup 使用: SecurityGroup Usage
           OVN IPsec 支持: OVN IPsec Support