[shell-operator] add default option funcs, break import cycle in app (#828)

Signed-off-by: Pavel Okhlopkov <[email protected]>

Author: ldmonster

pkg/app/kube-client.go

@@ -7,25 +7,32 @@ import (
 )
 
 var (
-	KubeContext = ""
-	KubeConfig  = ""
-	KubeServer  = ""
+	KubeContext            = ""
+	KubeConfig             = ""
+	KubeServer             = ""
+	KubeClientFieldManager = ""
 )
 
 var (
-	KubeClientQpsDefault   = "5" // DefaultQPS from k8s.io/client-go/rest/config.go
-	KubeClientQps          float32
+	KubeClientQps   float32
+	KubeClientBurst int
+)
+
+const (
+	KubeClientQpsDefault   = "5"  // DefaultQPS from k8s.io/client-go/rest/config.go
 	KubeClientBurstDefault = "10" // DefaultBurst from k8s.io/client-go/rest/config.go
-	KubeClientBurst        int
 )
 
 var (
-	ObjectPatcherKubeClientQpsDefault     = "5" // DefaultQPS from k8s.io/client-go/rest/config.go
-	ObjectPatcherKubeClientQps            float32
+	ObjectPatcherKubeClientQps     float32
+	ObjectPatcherKubeClientBurst   int
+	ObjectPatcherKubeClientTimeout time.Duration
+)
+
+const (
+	ObjectPatcherKubeClientQpsDefault     = "5"  // DefaultQPS from k8s.io/client-go/rest/config.go
 	ObjectPatcherKubeClientBurstDefault   = "10" // DefaultBurst from k8s.io/client-go/rest/config.go
-	ObjectPatcherKubeClientBurst          int
 	ObjectPatcherKubeClientTimeoutDefault = "10s"
-	ObjectPatcherKubeClientTimeout        time.Duration
 )
 
 func DefineKubeClientFlags(cmd *kingpin.CmdClause) {

pkg/app/log.go

@@ -8,8 +8,6 @@ import (
 
 	"github.com/deckhouse/deckhouse/pkg/log"
 	"gopkg.in/alecthomas/kingpin.v2"
-
-	"github.com/flant/shell-operator/pkg/config"
 )
 
 // Use info level with timestamps and a text output by default
@@ -44,8 +42,14 @@ func DefineLoggingFlags(cmd *kingpin.CmdClause) {
 		BoolVar(&LogProxyHookJSON)
 }
 
+type Registerer interface {
+	Register(key string, help string, defaultValue string,
+		setter func(key string, newValue string) error,
+		expirer func(key string, newValue string) time.Duration)
+}
+
 // SetupLogging sets logger formatter and level.
-func SetupLogging(runtimeConfig *config.Config, logger *log.Logger) {
+func SetupLogging(runtimeConfig Registerer, logger *log.Logger) {
 	// TODO: if we need formatters - add to logger
 	// jsonFormatter := log.JSONFormatter{DisableTimestamp: LogNoTime}
 	// textFormatter := log.TextFormatter{DisableTimestamp: LogNoTime, DisableColors: true}

pkg/app/webhook.go

@@ -2,112 +2,132 @@ package app
 
 import (
 	"gopkg.in/alecthomas/kingpin.v2"
+)
+
+// Note: ValidatingWebhookSettings and ConversionWebhookSettings are defined in
+// their respective packages (pkg/webhook/admission and pkg/webhook/conversion).
+// Default values are centralized in pkg/webhook/defaults package.
 
-	"github.com/flant/shell-operator/pkg/webhook/admission"
-	"github.com/flant/shell-operator/pkg/webhook/conversion"
-	"github.com/flant/shell-operator/pkg/webhook/server"
+// Validating webhook flag variables - exported so they can be used after parsing
+var (
+	ValidatingWebhookConfigurationName string
+	ValidatingWebhookServiceName       string
+	ValidatingWebhookServerCert        string
+	ValidatingWebhookServerKey         string
+	ValidatingWebhookCA                string
+	ValidatingWebhookClientCA          []string
+	ValidatingWebhookFailurePolicy     string
+	ValidatingWebhookListenPort        string
+	ValidatingWebhookListenAddress     string
 )
 
-var ValidatingWebhookSettings = &admission.WebhookSettings{
-	Settings: server.Settings{
-		ServerCertPath: "/validating-certs/tls.crt",
-		ServerKeyPath:  "/validating-certs/tls.key",
-		ClientCAPaths:  nil,
-		ServiceName:    "shell-operator-validating-svc",
-		ListenAddr:     "0.0.0.0",
-		ListenPort:     "9680",
-	},
-	CAPath:               "/validating-certs/ca.crt",
-	ConfigurationName:    "shell-operator-hooks",
-	DefaultFailurePolicy: "Fail",
-}
+// Conversion webhook flag variables - exported so they can be used after parsing
+var (
+	ConversionWebhookServiceName   string
+	ConversionWebhookServerCert    string
+	ConversionWebhookServerKey     string
+	ConversionWebhookCA            string
+	ConversionWebhookClientCA      []string
+	ConversionWebhookListenPort    string
+	ConversionWebhookListenAddress string
+)
 
-var ConversionWebhookSettings = &conversion.WebhookSettings{
-	Settings: server.Settings{
-		ServerCertPath: "/conversion-certs/tls.crt",
-		ServerKeyPath:  "/conversion-certs/tls.key",
-		ClientCAPaths:  nil,
-		ServiceName:    "shell-operator-conversion-svc",
-		ListenAddr:     "0.0.0.0",
-		ListenPort:     "9681",
-	},
-	CAPath: "/conversion-certs/ca.crt",
-}
+// Default values for validating webhook configuration
+const (
+	ValidatingServerCertPathDefault    = "/validating-certs/tls.crt"
+	ValidatingServerKeyPathDefault     = "/validating-certs/tls.key"
+	ValidatingServiceNameDefault       = "shell-operator-validating-svc"
+	ValidatingListenAddrDefault        = "0.0.0.0"
+	ValidatingListenPortDefault        = "9680"
+	ValidatingCAPathDefault            = "/validating-certs/ca.crt"
+	ValidatingConfigurationNameDefault = "shell-operator-hooks"
+	ValidatingFailurePolicyTypeDefault = "Fail"
+)
+
+// Default values for conversion webhook configuration
+const (
+	ConversionServerCertPathDefault = "/conversion-certs/tls.crt"
+	ConversionServerKeyPathDefault  = "/conversion-certs/tls.key"
+	ConversionServiceNameDefault    = "shell-operator-conversion-svc"
+	ConversionListenAddrDefault     = "0.0.0.0"
+	ConversionListenPortDefault     = "9681"
+	ConversionCAPathDefault         = "/conversion-certs/ca.crt"
+)
 
 // DefineValidatingWebhookFlags defines flags for ValidatingWebhook server.
 func DefineValidatingWebhookFlags(cmd *kingpin.CmdClause) {
 	cmd.Flag("validating-webhook-configuration-name", "A name of a ValidatingWebhookConfiguration resource. Can be set with $VALIDATING_WEBHOOK_CONFIGURATION_NAME.").
 		Envar("VALIDATING_WEBHOOK_CONFIGURATION_NAME").
-		Default(ValidatingWebhookSettings.ConfigurationName).
-		StringVar(&ValidatingWebhookSettings.ConfigurationName)
+		Default(ValidatingConfigurationNameDefault).
+		StringVar(&ValidatingWebhookConfigurationName)
 	cmd.Flag("validating-webhook-service-name", "A name of a service used in ValidatingWebhookConfiguration. Can be set with $VALIDATING_WEBHOOK_SERVICE_NAME.").
 		Envar("VALIDATING_WEBHOOK_SERVICE_NAME").
-		Default(ValidatingWebhookSettings.ServiceName).
-		StringVar(&ValidatingWebhookSettings.ServiceName)
+		Default(ValidatingServiceNameDefault).
+		StringVar(&ValidatingWebhookServiceName)
 	cmd.Flag("validating-webhook-server-cert", "A path to a server certificate for service used in ValidatingWebhookConfiguration. Can be set with $VALIDATING_WEBHOOK_SERVER_CERT.").
 		Envar("VALIDATING_WEBHOOK_SERVER_CERT").
-		Default(ValidatingWebhookSettings.ServerCertPath).
-		StringVar(&ValidatingWebhookSettings.ServerCertPath)
+		Default(ValidatingServerCertPathDefault).
+		StringVar(&ValidatingWebhookServerCert)
 	cmd.Flag("validating-webhook-server-key", "A path to a server private key for service used in ValidatingWebhookConfiguration. Can be set with $VALIDATING_WEBHOOK_SERVER_KEY.").
 		Envar("VALIDATING_WEBHOOK_SERVER_KEY").
-		Default(ValidatingWebhookSettings.ServerKeyPath).
-		StringVar(&ValidatingWebhookSettings.ServerKeyPath)
+		Default(ValidatingServerKeyPathDefault).
+		StringVar(&ValidatingWebhookServerKey)
 	cmd.Flag("validating-webhook-ca", "A path to a ca certificate for ValidatingWebhookConfiguration. Can be set with $VALIDATING_WEBHOOK_CA.").
 		Envar("VALIDATING_WEBHOOK_CA").
-		Default(ValidatingWebhookSettings.CAPath).
-		StringVar(&ValidatingWebhookSettings.CAPath)
+		Default(ValidatingCAPathDefault).
+		StringVar(&ValidatingWebhookCA)
 	cmd.Flag("validating-webhook-client-ca", "A path to a server certificate for ValidatingWebhookConfiguration. Can be set with $VALIDATING_WEBHOOK_CLIENT_CA.").
 		Envar("VALIDATING_WEBHOOK_CLIENT_CA").
-		StringsVar(&ValidatingWebhookSettings.ClientCAPaths)
+		StringsVar(&ValidatingWebhookClientCA)
 	cmd.Flag("validating-webhook-failure-policy", "Defines default FailurePolicy for ValidatingWebhookConfiguration.").
-		Default("Fail").
+		Default(ValidatingFailurePolicyTypeDefault).
 		Envar("VALIDATING_WEBHOOK_FAILURE_POLICY").
-		EnumVar(&ValidatingWebhookSettings.DefaultFailurePolicy, "Fail", "Ignore")
+		EnumVar(&ValidatingWebhookFailurePolicy, "Fail", "Ignore")
 	cmd.Flag("validating-webhook-listen-port",
 		"Defines default ListenPort for ValidatingWebhookConfiguration. "+
 			"Can be set with $VALIDATING_WEBHOOK_LISTEN_PORT.").
-		Default(ValidatingWebhookSettings.ListenPort).
+		Default(ValidatingListenPortDefault).
 		Envar("VALIDATING_WEBHOOK_LISTEN_PORT").
-		StringVar(&ValidatingWebhookSettings.ListenPort)
+		StringVar(&ValidatingWebhookListenPort)
 	cmd.Flag("validating-webhook-listen-address",
 		"Defines default ListenAddr for ValidatingWebhookConfiguration. "+
 			"Can be set with $VALIDATING_WEBHOOK_LISTEN_ADDRESS.").
-		Default(ValidatingWebhookSettings.ListenAddr).
+		Default(ValidatingListenAddrDefault).
 		Envar("VALIDATING_WEBHOOK_LISTEN_ADDRESS").
-		StringVar(&ValidatingWebhookSettings.ListenAddr)
+		StringVar(&ValidatingWebhookListenAddress)
 }
 
 // DefineConversionWebhookFlags defines flags for ConversionWebhook server.
 func DefineConversionWebhookFlags(cmd *kingpin.CmdClause) {
 	cmd.Flag("conversion-webhook-service-name", "A name of a service for clientConfig in CRD. Can be set with $CONVERSION_WEBHOOK_SERVICE_NAME.").
 		Envar("CONVERSION_WEBHOOK_SERVICE_NAME").
-		Default(ConversionWebhookSettings.ServiceName).
-		StringVar(&ConversionWebhookSettings.ServiceName)
+		Default(ConversionServiceNameDefault).
+		StringVar(&ConversionWebhookServiceName)
 	cmd.Flag("conversion-webhook-server-cert", "A path to a server certificate for clientConfig in CRD. Can be set with $CONVERSION_WEBHOOK_SERVER_CERT.").
 		Envar("CONVERSION_WEBHOOK_SERVER_CERT").
-		Default(ConversionWebhookSettings.ServerCertPath).
-		StringVar(&ConversionWebhookSettings.ServerCertPath)
+		Default(ConversionServerCertPathDefault).
+		StringVar(&ConversionWebhookServerCert)
 	cmd.Flag("conversion-webhook-server-key", "A path to a server private key for clientConfig in CRD. Can be set with $CONVERSION_WEBHOOK_SERVER_KEY.").
 		Envar("CONVERSION_WEBHOOK_SERVER_KEY").
-		Default(ConversionWebhookSettings.ServerKeyPath).
-		StringVar(&ConversionWebhookSettings.ServerKeyPath)
+		Default(ConversionServerKeyPathDefault).
+		StringVar(&ConversionWebhookServerKey)
 	cmd.Flag("conversion-webhook-ca", "A path to a ca certificate for clientConfig in CRD. Can be set with $CONVERSION_WEBHOOK_CA.").
 		Envar("CONVERSION_WEBHOOK_CA").
-		Default(ConversionWebhookSettings.CAPath).
-		StringVar(&ConversionWebhookSettings.CAPath)
+		Default(ConversionCAPathDefault).
+		StringVar(&ConversionWebhookCA)
 	cmd.Flag("conversion-webhook-client-ca", "A path to a server certificate for CRD.spec.conversion.webhook. Can be set with $CONVERSION_WEBHOOK_CLIENT_CA.").
 		Envar("CONVERSION_WEBHOOK_CLIENT_CA").
-		StringsVar(&ConversionWebhookSettings.ClientCAPaths)
+		StringsVar(&ConversionWebhookClientCA)
 	cmd.Flag("conversion-webhook-listen-port",
 		"Defines default ListenPort for ConversionWebhookConfiguration. "+
 			"Can be set with $CONVERSION_WEBHOOK_LISTEN_PORT.").
 		Envar("CONVERSION_WEBHOOK_LISTEN_PORT").
-		Default(ConversionWebhookSettings.ListenPort).
-		StringVar(&ConversionWebhookSettings.ListenPort)
+		Default(ConversionListenPortDefault).
+		StringVar(&ConversionWebhookListenPort)
 	cmd.Flag("conversion-webhook-listen-address",
 		"Defines default ListenAddr for ConversionWebhookConfiguration. "+
 			"Can be set with $CONVERSION_WEBHOOK_LISTEN_ADDRESS.").
-		Default(ConversionWebhookSettings.ListenAddr).
+		Default(ConversionListenAddrDefault).
 		Envar("CONVERSION_WEBHOOK_LISTEN_ADDRESS").
-		StringVar(&ConversionWebhookSettings.ListenAddr)
+		StringVar(&ConversionWebhookListenAddress)
 }

pkg/hook/config/config_v1.go

@@ -11,7 +11,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 
-	"github.com/flant/shell-operator/pkg/app"
 	htypes "github.com/flant/shell-operator/pkg/hook/types"
 	kubeeventsmanager "github.com/flant/shell-operator/pkg/kube_events_manager"
 	kemtypes "github.com/flant/shell-operator/pkg/kube_events_manager/types"
@@ -441,7 +440,7 @@ func convertValidating(cfgV1 KubernetesAdmissionConfigV1) htypes.ValidatingConfi
 	if cfgV1.FailurePolicy != nil {
 		webhook.FailurePolicy = cfgV1.FailurePolicy
 	} else {
-		defaultFailurePolicy := v1.FailurePolicyType(app.ValidatingWebhookSettings.DefaultFailurePolicy)
+		defaultFailurePolicy := v1.FailurePolicyType(admission.DefaultSettings.DefaultFailurePolicy)
 		webhook.FailurePolicy = &defaultFailurePolicy
 	}
 

pkg/hook/hook_manager_test.go

@@ -9,7 +9,6 @@ import (
 	"github.com/deckhouse/deckhouse/pkg/log"
 	. "github.com/onsi/gomega"
 
-	"github.com/flant/shell-operator/pkg/app"
 	"github.com/flant/shell-operator/pkg/hook/controller"
 	"github.com/flant/shell-operator/pkg/hook/types"
 	"github.com/flant/shell-operator/pkg/webhook/admission"
@@ -20,10 +19,10 @@ func newHookManager(t *testing.T, testdataDir string) *Manager {
 	hooksDir, _ := filepath.Abs(testdataDir)
 
 	conversionManager := conversion.NewWebhookManager()
-	conversionManager.Settings = app.ConversionWebhookSettings
+	conversionManager.Settings = conversion.DefaultSettings
 
 	admissionManager := admission.NewWebhookManager(nil)
-	admissionManager.Settings = app.ValidatingWebhookSettings
+	admissionManager.Settings = admission.DefaultSettings
 
 	cfg := &ManagerConfig{
 		WorkingDir: hooksDir,

pkg/kube/object_patch/patch.go

@@ -21,6 +21,8 @@ import (
 	"k8s.io/client-go/dynamic"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/util/retry"
+
+	"github.com/flant/shell-operator/pkg"
 )
 
 type ObjectPatcher struct {
@@ -106,7 +108,7 @@ func (o *ObjectPatcher) executeCreateOperation(op *createOperation) error {
 	_, err = o.kubeClient.Dynamic().
 		Resource(gvk).
 		Namespace(object.GetNamespace()).
-		Create(context.TODO(), object, metav1.CreateOptions{}, generateSubresources(op.subresource)...)
+		Create(context.TODO(), object, pkg.DefaultCreateOptions(), generateSubresources(op.subresource)...)
 	log.Debug("Finished Create API call")
 
 	objectExists := errors.IsAlreadyExists(err)
@@ -137,7 +139,7 @@ func (o *ObjectPatcher) executeCreateOperation(op *createOperation) error {
 			_, err = o.kubeClient.Dynamic().
 				Resource(gvk).
 				Namespace(objCopy.GetNamespace()).
-				Update(context.TODO(), objCopy, metav1.UpdateOptions{}, generateSubresources(op.subresource)...)
+				Update(context.TODO(), objCopy, pkg.DefaultUpdateOptions(), generateSubresources(op.subresource)...)
 			log.Debug("Finished Update API call")
 			return wrapErr(err)
 		})
@@ -184,7 +186,7 @@ func (o *ObjectPatcher) executePatchOperation(op *patchOperation) error {
 	_, err = o.kubeClient.Dynamic().
 		Resource(gvk).
 		Namespace(op.namespace).
-		Patch(context.TODO(), op.name, op.patchType, patchBytes, metav1.PatchOptions{}, generateSubresources(op.subresource)...)
+		Patch(context.TODO(), op.name, op.patchType, patchBytes, pkg.DefaultPatchOptions(), generateSubresources(op.subresource)...)
 	log.Debug("Finished Patch API call")
 
 	if op.ignoreMissingObject && errors.IsNotFound(err) {
@@ -247,7 +249,7 @@ func (o *ObjectPatcher) executeFilterOperation(op *patchOperation) error {
 		_, err = o.kubeClient.Dynamic().
 			Resource(gvk).
 			Namespace(op.namespace).
-			Update(context.TODO(), filteredObj, metav1.UpdateOptions{}, generateSubresources(op.subresource)...)
+			Update(context.TODO(), filteredObj, pkg.DefaultUpdateOptions(), generateSubresources(op.subresource)...)
 		log.Debug("Finished Update API call")
 		if err != nil {
 			return err