21d1bcd6b8
It wasn't documented that InitLogs already uses the log flush frequency, so some commands have called it before parsing (for example, kubectl in the original code for logs.go). The flag never had an effect in such commands. Fixing this turned into a major refactoring of how commands set up flags and run their Cobra command: - component-base/logs: implicitely registering flags during package init is an anti-pattern that makes it impossible to use the package in commands which want full control over their command line. Logging flags must be added explicitly now, something that the new cli.Run does automatically. - component-base/logs: AddFlags would have crashed in kubectl-convert if it had been called because it relied on the global pflag.CommandLine. This has been fixed and kubectl-convert now has the same --log-flush-frequency flag as other commands. - component-base/logs/testinit: an exception are tests where flag.CommandLine has to be used. This new package can be imported to add flags to that once per test program. - Normalization of the klog command line flags was inconsistent. Some commands unintentionally didn't normalize to the recommended format with hyphens. This gets fixed for sample programs, but not for production programs because it would be a breaking change. This refactoring has the following user-visible effects: - The validation error for `go run ./cmd/kube-apiserver --logging-format=json --add-dir-header` now references `add-dir-header` instead of `add_dir_header`. - `staging/src/k8s.io/cloud-provider/sample` uses flags with hyphen instead of underscore. - `--log-flush-frequency` is not listed anymore in the --logging-format flag's `non-default formats don't honor these flags` usage text because it will also work for non-default formats once it is needed. - `cmd/kubelet`: the description of `--logging-format` uses hyphens instead of underscores for the flags, which now matches what the command is using. - `staging/src/k8s.io/component-base/logs/example/cmd`: added logging flags. - `apiextensions-apiserver` no longer prints a useless stack trace for `main` when command line parsing raises an error.
89 lines
3.0 KiB
Go
89 lines
3.0 KiB
Go
/*
|
|
Copyright 2018 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package options
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/spf13/pflag"
|
|
|
|
// libs that provide registration functions
|
|
"k8s.io/component-base/logs"
|
|
"k8s.io/component-base/version/verflag"
|
|
|
|
// ensure libs have a chance to globally register their flags
|
|
_ "k8s.io/kubernetes/pkg/credentialprovider/azure"
|
|
_ "k8s.io/kubernetes/pkg/credentialprovider/gcp"
|
|
)
|
|
|
|
// AddGlobalFlags explicitly registers flags that libraries (glog, verflag, etc.) register
|
|
// against the global flagsets from "flag" and "github.com/spf13/pflag".
|
|
// We do this in order to prevent unwanted flags from leaking into the Kubelet's flagset.
|
|
func AddGlobalFlags(fs *pflag.FlagSet) {
|
|
addCadvisorFlags(fs)
|
|
addCredentialProviderFlags(fs)
|
|
verflag.AddFlags(fs)
|
|
logs.AddFlags(fs)
|
|
}
|
|
|
|
// normalize replaces underscores with hyphens
|
|
// we should always use hyphens instead of underscores when registering kubelet flags
|
|
func normalize(s string) string {
|
|
return strings.Replace(s, "_", "-", -1)
|
|
}
|
|
|
|
// register adds a flag to local that targets the Value associated with the Flag named globalName in global
|
|
func register(global *flag.FlagSet, local *pflag.FlagSet, globalName string) {
|
|
if f := global.Lookup(globalName); f != nil {
|
|
pflagFlag := pflag.PFlagFromGoFlag(f)
|
|
pflagFlag.Name = normalize(pflagFlag.Name)
|
|
local.AddFlag(pflagFlag)
|
|
} else {
|
|
panic(fmt.Sprintf("failed to find flag in global flagset (flag): %s", globalName))
|
|
}
|
|
}
|
|
|
|
// pflagRegister adds a flag to local that targets the Value associated with the Flag named globalName in global
|
|
func pflagRegister(global, local *pflag.FlagSet, globalName string) {
|
|
if f := global.Lookup(globalName); f != nil {
|
|
f.Name = normalize(f.Name)
|
|
local.AddFlag(f)
|
|
} else {
|
|
panic(fmt.Sprintf("failed to find flag in global flagset (pflag): %s", globalName))
|
|
}
|
|
}
|
|
|
|
// registerDeprecated registers the flag with register, and then marks it deprecated
|
|
func registerDeprecated(global *flag.FlagSet, local *pflag.FlagSet, globalName, deprecated string) {
|
|
register(global, local, globalName)
|
|
local.Lookup(normalize(globalName)).Deprecated = deprecated
|
|
}
|
|
|
|
// addCredentialProviderFlags adds flags from k8s.io/kubernetes/pkg/credentialprovider
|
|
func addCredentialProviderFlags(fs *pflag.FlagSet) {
|
|
// lookup flags in global flag set and re-register the values with our flagset
|
|
global := pflag.CommandLine
|
|
local := pflag.NewFlagSet(os.Args[0], pflag.ExitOnError)
|
|
|
|
addLegacyCloudProviderCredentialProviderFlags(global, local)
|
|
|
|
fs.AddFlagSet(local)
|
|
}
|