1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2024-12-14 11:57:48 +00:00

Set the UserAgent in client-go based calls to kube-apiserver (#11569)

Signed-off-by: Davanum Srinivas <davanum@gmail.com>
This commit is contained in:
Davanum Srinivas 2024-11-12 04:34:32 -05:00 committed by GitHub
parent e64a5ff647
commit d76107c2c9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -3,12 +3,23 @@ package config
import ( import (
"fmt" "fmt"
"math" "math"
"runtime"
"k8s.io/cli-runtime/pkg/genericclioptions" "k8s.io/cli-runtime/pkg/genericclioptions"
rest "k8s.io/client-go/rest" rest "k8s.io/client-go/rest"
clientcmd "k8s.io/client-go/tools/clientcmd" clientcmd "k8s.io/client-go/tools/clientcmd"
"sigs.k8s.io/release-utils/version"
) )
// withUserAgent explicitly sets the UserAgent field in rest.Config which is
// then used by client-go for calls to the API server, helps with debugging issues
func withUserAgent(restConfig *rest.Config, err error) (*rest.Config, error) {
if err != nil && restConfig != nil {
restConfig.UserAgent = fmt.Sprintf("Kyverno/%s (%s; %s)", version.GetVersionInfo().GitVersion, runtime.GOOS, runtime.GOARCH)
}
return restConfig, err
}
// CreateClientConfig creates client config and applies rate limit QPS and burst // CreateClientConfig creates client config and applies rate limit QPS and burst
func CreateClientConfig(kubeconfig string, qps float64, burst int) (*rest.Config, error) { func CreateClientConfig(kubeconfig string, qps float64, burst int) (*rest.Config, error) {
clientConfig, err := createClientConfig(kubeconfig) clientConfig, err := createClientConfig(kubeconfig)
@ -20,15 +31,15 @@ func CreateClientConfig(kubeconfig string, qps float64, burst int) (*rest.Config
} }
clientConfig.Burst = burst clientConfig.Burst = burst
clientConfig.QPS = float32(qps) clientConfig.QPS = float32(qps)
return clientConfig, nil return withUserAgent(clientConfig, nil)
} }
// createClientConfig creates client config // createClientConfig creates client config
func createClientConfig(kubeconfig string) (*rest.Config, error) { func createClientConfig(kubeconfig string) (*rest.Config, error) {
if kubeconfig == "" { if kubeconfig == "" {
return rest.InClusterConfig() return withUserAgent(rest.InClusterConfig())
} }
return clientcmd.BuildConfigFromFlags("", kubeconfig) return withUserAgent(clientcmd.BuildConfigFromFlags("", kubeconfig))
} }
// CreateClientConfigWithContext creates client config from custom kubeconfig file and context // CreateClientConfigWithContext creates client config from custom kubeconfig file and context
@ -37,5 +48,5 @@ func CreateClientConfigWithContext(kubeconfig string, context string) (*rest.Con
kubernetesConfig := genericclioptions.NewConfigFlags(true) kubernetesConfig := genericclioptions.NewConfigFlags(true)
kubernetesConfig.KubeConfig = &kubeconfig kubernetesConfig.KubeConfig = &kubeconfig
kubernetesConfig.Context = &context kubernetesConfig.Context = &context
return kubernetesConfig.ToRESTConfig() return withUserAgent(kubernetesConfig.ToRESTConfig())
} }