fix some comments (#9688)

Signed-off-by: cui fliter <imcusg@gmail.com>
This commit is contained in:
cui fliter 2023-03-06 03:00:57 +08:00 committed by GitHub
parent 640bdac76d
commit 82e836fbe8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 10 additions and 9 deletions

View file

@ -104,7 +104,7 @@ Describe here `kubectl plugin`, `dbg`, `waitshutdown` and cover the hack scripts
### kubectl plugin ### kubectl plugin
It containes kubectl plugin for inspecting your ingress-nginx deployments. It contains kubectl plugin for inspecting your ingress-nginx deployments.
This part of code can be found in [cmd/plugin](https://github.com/kubernetes/ingress-nginx/tree/main/cmd/plugin) directory This part of code can be found in [cmd/plugin](https://github.com/kubernetes/ingress-nginx/tree/main/cmd/plugin) directory
Detail functions flow and available flow can be found in [kubectl-plugin](https://github.com/kubernetes/ingress-nginx/blob/main/docs/kubectl-plugin.md) Detail functions flow and available flow can be found in [kubectl-plugin](https://github.com/kubernetes/ingress-nginx/blob/main/docs/kubectl-plugin.md)

View file

@ -105,7 +105,7 @@ func (k8s *k8s) patchAPIService(ctx context.Context, objectName string, ca []byt
return nil return nil
} }
// PatchWebhookConfigurations will patch validatingWebhook and mutatingWebhook clientConfig configurations with // patchWebhookConfigurations will patch validatingWebhook and mutatingWebhook clientConfig configurations with
// the provided ca data. If failurePolicy is provided, patch all webhooks with this value // the provided ca data. If failurePolicy is provided, patch all webhooks with this value
func (k8s *k8s) patchWebhookConfigurations( func (k8s *k8s) patchWebhookConfigurations(
ctx context.Context, ctx context.Context,

View file

@ -34,7 +34,7 @@ import (
"k8s.io/ingress-nginx/pkg/apis/ingress" "k8s.io/ingress-nginx/pkg/apis/ingress"
) )
// getEndpoints returns a list of Endpoint structs for a given service/target port combination. // getEndpointsFromSlices returns a list of Endpoint structs for a given service/target port combination.
func getEndpointsFromSlices(s *corev1.Service, port *corev1.ServicePort, proto corev1.Protocol, zoneForHints string, func getEndpointsFromSlices(s *corev1.Service, port *corev1.ServicePort, proto corev1.Protocol, zoneForHints string,
getServiceEndpointsSlices func(string) ([]*discoveryv1.EndpointSlice, error)) []ingress.Endpoint { getServiceEndpointsSlices func(string) ([]*discoveryv1.EndpointSlice, error)) []ingress.Endpoint {

View file

@ -1732,7 +1732,7 @@ func buildServerName(hostname string) string {
return `~^(?<subdomain>[\w-]+)\.` + strings.Join(parts, "\\.") + `$` return `~^(?<subdomain>[\w-]+)\.` + strings.Join(parts, "\\.") + `$`
} }
// parseComplexNGINXVar parses things like "$my${complex}ngx\$var" into // parseComplexNginxVarIntoLuaTable parses things like "$my${complex}ngx\$var" into
// [["$var", "complex", "my", "ngx"]]. In other words, 2nd and 3rd elements // [["$var", "complex", "my", "ngx"]]. In other words, 2nd and 3rd elements
// in the result are actual NGINX variable names, whereas first and 4th elements // in the result are actual NGINX variable names, whereas first and 4th elements
// are string literals. // are string literals.

View file

@ -20,14 +20,15 @@ package main
import ( import (
"fmt" "fmt"
"os"
"strings"
semver "github.com/blang/semver/v4" semver "github.com/blang/semver/v4"
"github.com/helm/helm/pkg/chartutil" "github.com/helm/helm/pkg/chartutil"
"github.com/magefile/mage/mg" "github.com/magefile/mage/mg"
"github.com/magefile/mage/sh" "github.com/magefile/mage/sh"
yamlpath "github.com/vmware-labs/yaml-jsonpath/pkg/yamlpath" yamlpath "github.com/vmware-labs/yaml-jsonpath/pkg/yamlpath"
"gopkg.in/yaml.v3" "gopkg.in/yaml.v3"
"os"
"strings"
) )
const HelmChartPath = "charts/ingress-nginx/Chart.yaml" const HelmChartPath = "charts/ingress-nginx/Chart.yaml"
@ -114,7 +115,7 @@ func UpdateChartChangelog() {
} }
// UpdateAppVersion Updates the Helm App Version of Ingress Nginx Controller // UpdateChartValue Updates the Helm ChartValue
func (Helm) UpdateChartValue(key, value string) { func (Helm) UpdateChartValue(key, value string) {
updateChartValue(key, value) updateChartValue(key, value)
} }

View file

@ -46,7 +46,7 @@ func GetRemovedHosts(rucfg, newcfg *ingress.Configuration) []string {
return oldSet.Difference(newSet).List() return oldSet.Difference(newSet).List()
} }
// GetRemovedCertificateSerialNumber extracts the difference of certificates between two configurations // GetRemovedCertificateSerialNumbers extracts the difference of certificates between two configurations
func GetRemovedCertificateSerialNumbers(rucfg, newcfg *ingress.Configuration) []string { func GetRemovedCertificateSerialNumbers(rucfg, newcfg *ingress.Configuration) []string {
oldCertificates := sets.NewString() oldCertificates := sets.NewString()
newCertificates := sets.NewString() newCertificates := sets.NewString()

View file

@ -81,7 +81,7 @@ var _ = framework.IngressNginxDescribe("[Flag] enable-ssl-passthrough", func() {
host := "testpassthrough.com" host := "testpassthrough.com"
echoName := "echopass" echoName := "echopass"
/* Even with enable-ssl-passthrough enabled, only annotated ingresses may receive the trafic */ /* Even with enable-ssl-passthrough enabled, only annotated ingresses may receive the traffic */
annotations := map[string]string{ annotations := map[string]string{
"nginx.ingress.kubernetes.io/ssl-passthrough": "true", "nginx.ingress.kubernetes.io/ssl-passthrough": "true",
} }