fix: change kube_vip to kube-vip (#3118)

redscholar · web-flow · commit 32da7506382c · 2026-05-28T10:12:12.000Z
Signed-off-by: redscholar &lt;blacktiledhouse@gmail.com&gt;
diff --git a/builtin/capkk/roles/precheck/env_check/tasks/kubernetes.yaml b/builtin/capkk/roles/precheck/env_check/tasks/kubernetes.yaml
@@ -20,7 +20,7 @@
         {{ not $existIP }}
     fail_msg: >-
       "kubernetes.control_plane_endpoint.kube_vip.address" should be a un-used ip address.
-  when: .kubernetes.control_plane_endpoint.type | eq "kube_vip"
+  when: .kubernetes.control_plane_endpoint.type | eq "kube-vip"
 
 - name: Stop if unsupported version of Kubernetes
   run_once: true
diff --git a/builtin/capkk/roles/uninstall/kubernetes/tasks/network.yaml b/builtin/capkk/roles/uninstall/kubernetes/tasks/network.yaml
@@ -33,7 +33,7 @@
     {{- end }}
 
 - name: Delete arp by kube-vip
-  when: eq .kubernetes.control_plane_endpoint.type "kube_vip"
+  when: eq .kubernetes.control_plane_endpoint.type "kube-vip"
   command: |
     ip neigh show | grep {{ .kubernetes.control_plane_endpoint.kube_vip.address }} | awk '{print $1 " dev " $3}' | xargs -r -L1 ip neigh delete
     ip -o addr show | grep {{ .kubernetes.control_plane_endpoint.kube_vip.address }} | awk '{system("ip addr del "$4" dev "$2)}'
diff --git a/builtin/core/defaults/config/v1.23.yaml b/builtin/core/defaults/config/v1.23.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.6"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.24.yaml b/builtin/core/defaults/config/v1.24.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.7"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.25.yaml b/builtin/core/defaults/config/v1.25.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.8"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.26.yaml b/builtin/core/defaults/config/v1.26.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.9"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.27.yaml b/builtin/core/defaults/config/v1.27.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.9"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.28.yaml b/builtin/core/defaults/config/v1.28.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.9"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.29.yaml b/builtin/core/defaults/config/v1.29.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.9"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.30.yaml b/builtin/core/defaults/config/v1.30.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.9"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.31.yaml b/builtin/core/defaults/config/v1.31.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.10"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.32.yaml b/builtin/core/defaults/config/v1.32.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.10"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.33.yaml b/builtin/core/defaults/config/v1.33.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.10"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/defaults/config/v1.34.yaml b/builtin/core/defaults/config/v1.34.yaml
@@ -12,12 +12,12 @@ spec:
     sandbox_image:
       tag: "3.10.1"
     control_plane_endpoint:
-      # Supported HA types: local, kube_vip, haproxy.
+      # Supported HA types: local, kube-vip, haproxy.
       # If set to local, configure local hostname resolution as follows:
       #   - Control-plane nodes: 127.0.0.1  .kubernetes.control_plane_endpoint.host
       #   - Worker nodes:  .init_kubernetes_node  .kubernetes.control_plane_endpoint.host
       type: local
-      # Kube-vip image tag used for static pod deployment (when type is kube_vip).
+      # Kube-vip image tag used for static pod deployment (when type is kube-vip).
       kube_vip:
         image:
           tag: v0.7.2
diff --git a/builtin/core/roles/defaults/defaults/main/03-kubernetes.yaml b/builtin/core/roles/defaults/defaults/main/03-kubernetes.yaml
@@ -85,7 +85,7 @@ kubernetes:
   control_plane_endpoint:
     host: lb.kubesphere.local
     port: "{{ .kubernetes.apiserver.port }}"
-    # Supported types: local, kube_vip, haproxy
+    # Supported types: local, kube-vip, haproxy
     # When type is local, configure as follows:
     #   - On control-plane nodes: 127.0.0.1 {{ .kubernetes.control_plane_endpoint.host }}
     #   - On worker nodes: {{ .init_kubernetes_node }} {{ .kubernetes.control_plane_endpoint.host }}
diff --git a/builtin/core/roles/kubernetes/init-kubernetes/tasks/init_kubernetes.yaml b/builtin/core/roles/kubernetes/init-kubernetes/tasks/init_kubernetes.yaml
@@ -14,7 +14,7 @@
     - name: Init | Pre-initialization for kube-vip
       when: 
         - .kubernetes.kube_version | semverCompare ">=v1.29.0"
-        - eq .kubernetes.control_plane_endpoint.type "kube_vip"
+        - eq .kubernetes.control_plane_endpoint.type "kube-vip"
       command: |
         sed -i 's#path: /etc/kubernetes/admin.conf#path: /etc/kubernetes/super-admin.conf#' \
           /etc/kubernetes/manifests/kube-vip.yaml
@@ -26,7 +26,7 @@
     - name: Init | Post-initialization for kube-vip
       when: 
         - .kubernetes.kube_version | semverCompare ">=v1.29.0"
-        - eq .kubernetes.control_plane_endpoint.type "kube_vip"
+        - eq .kubernetes.control_plane_endpoint.type "kube-vip"
       command: |
         sed -i 's#path: /etc/kubernetes/super-admin.conf#path: /etc/kubernetes/admin.conf#' \
           /etc/kubernetes/manifests/kube-vip.yaml
diff --git a/builtin/core/roles/kubernetes/pre-kubernetes/tasks/high-availability/main.yaml b/builtin/core/roles/kubernetes/pre-kubernetes/tasks/high-availability/main.yaml
@@ -2,7 +2,7 @@
 - name: HighAvailability | Include kube-vip static pod tasks
   include_tasks: high-availability/kube_vip.yaml
   when:
-    - .kubernetes.control_plane_endpoint.type | eq "kube_vip"
+    - .kubernetes.control_plane_endpoint.type | eq "kube-vip"
     - .groups.kube_control_plane | default list | has .inventory_hostname
 
 # HighAvailability: Deploy HAProxy only on worker nodes. Control plane nodes use the local static pod for kube-apiserver.
diff --git a/builtin/core/roles/native/dns/tasks/main.yaml b/builtin/core/roles/native/dns/tasks/main.yaml
@@ -145,7 +145,7 @@
     # Write the current control plane endpoint DNS configuration
     cat >> {{ .item }} <<EOF
     # kubekey kubernetes control_plane_endpoint BEGIN
-    {{- if .kubernetes.control_plane_endpoint.type | eq "kube_vip" }}
+    {{- if .kubernetes.control_plane_endpoint.type | eq "kube-vip" }}
     {{ .kubernetes.control_plane_endpoint.kube_vip.address }} {{ .kubernetes.control_plane_endpoint.host }}
     {{- else if and (.kubernetes.control_plane_endpoint.type | eq "local") (.kubernetes.control_plane_endpoint.local.address | empty | not) }}
     {{ .kubernetes.control_plane_endpoint.local.address }} {{ .kubernetes.control_plane_endpoint.host }}
diff --git a/builtin/core/roles/precheck/kubernetes/tasks/main.yaml b/builtin/core/roles/precheck/kubernetes/tasks/main.yaml
@@ -1,6 +1,6 @@
 - name: Kubernetes | Validate kube-vip address
   run_once: true
-  when: .kubernetes.control_plane_endpoint.type | eq "kube_vip"
+  when: .kubernetes.control_plane_endpoint.type | eq "kube-vip"
   assert:
     that:
       - .kubernetes.control_plane_endpoint.kube_vip.address | empty | not
diff --git a/builtin/core/roles/uninstall/kubernetes/tasks/network.yaml b/builtin/core/roles/uninstall/kubernetes/tasks/network.yaml
@@ -37,7 +37,7 @@
     {{- end }}
 
 - name: Network | Remove ARP and IP address entries for kube-vip
-  when: eq .kubernetes.control_plane_endpoint.type "kube_vip"
+  when: eq .kubernetes.control_plane_endpoint.type "kube-vip"
   command: |
     ip neigh show | grep {{ .kubernetes.control_plane_endpoint.kube_vip.address }} | awk '{print $1 " dev " $3}' | xargs -r -L1 ip neigh delete
     ip -o addr show | grep {{ .kubernetes.control_plane_endpoint.kube_vip.address }} | awk '{system("ip addr del "$4" dev "$2)}'
diff --git a/docs/en/reference/config.md b/docs/en/reference/config.md
@@ -526,7 +526,7 @@ kubernetes:
     host: lb.kubesphere.local
     # Control plane endpoint port, defaults to the apiserver port
     port: "{{ .kubernetes.apiserver.port }}"
-    # Load balancing type: local, kube_vip, haproxy
+    # Load balancing type: local, kube-vip, haproxy
     # When type is local, configure as follows:
     #   - On control-plane nodes: 127.0.0.1 {{ .kubernetes.control_plane_endpoint.host }}
     #   - On worker nodes: {{ .init_kubernetes_node }} {{ .kubernetes.control_plane_endpoint.host }}
@@ -636,7 +636,7 @@ kubernetes:
 | `kubernetes.kubelet.container_log_max_files` | Number of old container log files to retain. |
 | `kubernetes.control_plane_endpoint.host` | Stable access address (IP or DNS) for the control plane. |
 | `kubernetes.control_plane_endpoint.port` | Control plane endpoint port. |
-| `kubernetes.control_plane_endpoint.type` | Load balancing implementation type: `local` (local resolution), `kube_vip` (VIP-based), `haproxy`. |
+| `kubernetes.control_plane_endpoint.type` | Load balancing implementation type: `local` (local resolution), `kube-vip` (VIP-based), `haproxy`. |
 | `kubernetes.control_plane_endpoint.local.address` | When using `local` mode, an external load balancer address can be specified for resolution only. |
 | `kubernetes.control_plane_endpoint.kube_vip.address` | Network interface name or IP bound by kube-vip. |
 | `kubernetes.control_plane_endpoint.kube_vip.mode` | kube-vip working mode: `ARP` or `BGP`. |
diff --git a/docs/en/reference/playbooks/create_cluster.md b/docs/en/reference/playbooks/create_cluster.md
@@ -28,7 +28,7 @@ The `precheck` phase verifies that cluster nodes meet the installation requireme
 - **Kernel version check**: Verify that the kernel version meets the minimum requirement
 **kubernetes_precheck**: Kubernetes-related checks, including:
 - **IP address check**: Verify that the node defines either `internal_ipv4` or `internal_ipv6` (both cannot be empty)
-- **KubeVIP check**: When using `kube_vip` type for the control plane endpoint, verify that the kube_vip address is valid and not already in use
+- **KubeVIP check**: When using `kube-vip` type for the control plane endpoint, verify that the kube-vip address is valid and not already in use
 - **Kubernetes version check**: Verify that the Kubernetes version meets the minimum version requirement
 - **Existing Kubernetes check**: Verify whether Kubernetes is already installed on the node; if so, check whether the version matches the configured `kube_version`
 **network_precheck**: Network connectivity checks, including:
diff --git a/docs/zh/installation/architecture.md b/docs/zh/installation/architecture.md
@@ -29,7 +29,7 @@ precheck 阶段验证集群节点是否满足安装要求。
 
 **kubernetes_precheck**：Kubernetes 相关检查，包括：
 - **IP 地址检查**：验证节点是否定义了 internal_ipv4 或 internal_ipv6，两者不能同时为空
-- **KubeVIP 检查**：当使用 kube_vip 作为控制平面端点时，验证 kube_vip 地址是否有效且未被使用
+- **KubeVIP 检查**：当使用 kube-vip 作为控制平面端点时，验证 kube-vip 地址是否有效且未被使用
 - **Kubernetes 版本检查**：验证 Kubernetes 版本是否满足最低版本要求
 - **已安装 Kubernetes 检查**：验证节点上是否已安装 Kubernetes，如果已安装则检查版本是否与配置的 kube_version 匹配
 
diff --git a/docs/zh/reference/config.md b/docs/zh/reference/config.md
@@ -524,7 +524,7 @@ kubernetes:
     host: lb.kubesphere.local
     # 控制平面端点端口，默认继承 apiserver 端口
     port: "{{ .kubernetes.apiserver.port }}"
-    # 负载均衡类型：local, kube_vip, haproxy
+    # 负载均衡类型：local, kube-vip, haproxy
     # 当 type 为 local 时，配置如下：
     #   - 控制平面节点：127.0.0.1 {{ .kubernetes.control_plane_endpoint.host }}
     #   - 工作节点：{{ .init_kubernetes_node }} {{ .kubernetes.control_plane_endpoint.host }}
@@ -634,7 +634,7 @@ kubernetes:
 | `kubernetes.kubelet.container_log_max_files` | 保留的旧容器日志文件数量。 |
 | `kubernetes.control_plane_endpoint.host` | 控制平面的稳定访问地址（IP 或 DNS）。 |
 | `kubernetes.control_plane_endpoint.port` | 控制平面端点端口。 |
-| `kubernetes.control_plane_endpoint.type` | 负载均衡实现方式：`local`（本地解析）、`kube_vip`（基于 VIP）、`haproxy`。 |
+| `kubernetes.control_plane_endpoint.type` | 负载均衡实现方式：`local`（本地解析）、`kube-vip`（基于 VIP）、`haproxy`。 |
 | `kubernetes.control_plane_endpoint.local.address` | 使用 `local` 模式时，可指定外部负载均衡器地址仅用于解析。 |
 | `kubernetes.control_plane_endpoint.kube_vip.address` | kube-vip 绑定的网卡名称或 IP。 |
 | `kubernetes.control_plane_endpoint.kube_vip.mode` | kube-vip 的工作模式：`ARP` 或 `BGP`。 |
diff --git a/docs/zh/reference/playbooks/create_cluster.md b/docs/zh/reference/playbooks/create_cluster.md
@@ -28,7 +28,7 @@ precheck 集群安装前，对集群节点进行检查是否满足集群安装
 - **内核版本检查**: 验证内核版本是否满足最低版本要求
 **kubernetes_precheck**: Kubernetes 相关检查，包括：
 - **IP地址检查**: 验证节点是否定义了 internal_ipv4 或 internal_ipv6，两者不能同时为空
-- **KubeVIP检查**: 当使用 kube_vip 类型的控制平面端点时，验证 kube_vip 地址是否有效且未被使用
+- **KubeVIP检查**: 当使用 kube-vip 类型的控制平面端点时，验证 kube-vip 地址是否有效且未被使用
 - **Kubernetes版本检查**: 验证 Kubernetes 版本是否满足最低版本要求
 - **已安装Kubernetes检查**: 验证节点上是否已安装 Kubernetes，如果已安装则检查版本是否与配置的 kube_version 匹配
 **network_precheck**: 网络连通性检查，包括：
diff --git a/skills/kubekey/references/config.md b/skills/kubekey/references/config.md
@@ -159,7 +159,7 @@ spec:
     control_plane_endpoint:
       host: lb.kubesphere.local
       port: 6443
-      type: local  # local, kube_vip, haproxy
+      type: local  # local, kube-vip, haproxy
       local:
         address: ""
       kube_vip:
@@ -612,7 +612,7 @@ spec:
     control_plane_endpoint:
       host: lb.kubesphere.local
       port: 6443
-      type: kube_vip
+      type: kube-vip
       kube_vip:
         address: 192.168.1.100
         mode: ARP
