From d1525ec808c2c2ac6987f12cc68acf0b5a776650 Mon Sep 17 00:00:00 2001 From: liuhongyu Date: Mon, 26 Oct 2020 23:13:50 +0800 Subject: [PATCH] Fix the kube-proxy comment so that the document can be generated correctly --- pkg/proxy/apis/config/types.go | 7 ++++--- staging/src/k8s.io/kube-proxy/config/v1alpha1/types.go | 4 +++- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/pkg/proxy/apis/config/types.go b/pkg/proxy/apis/config/types.go index 40a0ce5999a..7fedb69261b 100644 --- a/pkg/proxy/apis/config/types.go +++ b/pkg/proxy/apis/config/types.go @@ -170,8 +170,9 @@ type KubeProxyConfiguration struct { DetectLocalMode LocalMode } -// Currently, three modes of proxy are available in Linux platform: 'userspace' (older, going to be EOL), 'iptables' -// (newer, faster), 'ipvs'(newest, better in performance and scalability). +// ProxyMode represents modes used by the Kubernetes proxy server. Currently, three modes of proxy are available in +// Linux platform: 'userspace' (older, going to be EOL), 'iptables' (newer, faster), 'ipvs'(newest, better in performance +// and scalability). // // Two modes of proxy are available in Windows platform: 'userspace'(older, stable) and 'kernelspace' (newer, faster). // @@ -179,7 +180,7 @@ type KubeProxyConfiguration struct { // future). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are // insufficient, this always falls back to the userspace proxy. IPVS mode will be enabled when proxy mode is set to 'ipvs', // and the fall back path is firstly iptables and then userspace. - +// // In Windows platform, if proxy mode is blank, use the best-available proxy (currently userspace, but may change in the // future). If winkernel proxy is selected, regardless of how, but the Windows kernel can't support this mode of proxy, // this always falls back to the userspace proxy. diff --git a/staging/src/k8s.io/kube-proxy/config/v1alpha1/types.go b/staging/src/k8s.io/kube-proxy/config/v1alpha1/types.go index 53991571dc0..36dafe0c199 100644 --- a/staging/src/k8s.io/kube-proxy/config/v1alpha1/types.go +++ b/staging/src/k8s.io/kube-proxy/config/v1alpha1/types.go @@ -166,6 +166,8 @@ type KubeProxyConfiguration struct { DetectLocalMode LocalMode `json:"detectLocalMode"` } +// ProxyMode represents modes used by the Kubernetes proxy server. +// // Currently, three modes of proxy are available in Linux platform: 'userspace' (older, going to be EOL), 'iptables' // (newer, faster), 'ipvs'(newest, better in performance and scalability). // @@ -175,7 +177,7 @@ type KubeProxyConfiguration struct { // future). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are // insufficient, this always falls back to the userspace proxy. IPVS mode will be enabled when proxy mode is set to 'ipvs', // and the fall back path is firstly iptables and then userspace. - +// // In Windows platform, if proxy mode is blank, use the best-available proxy (currently userspace, but may change in the // future). If winkernel proxy is selected, regardless of how, but the Windows kernel can't support this mode of proxy, // this always falls back to the userspace proxy.