Update flag and field naming

hashicorp · Feb 6, 2020 · 896e430 · 896e430
1 parent 9facc11
commit 896e430
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 47 deletions.
diff --git a/catalog/to-consul/resource.go b/catalog/to-consul/resource.go
@@ -95,21 +95,21 @@ type ServiceResource struct {
 	// k8s namespaces.
 	EnableNamespaces bool
 
-	// ConsulNamespaceName is the name of the Consul namespace to register all
+	// ConsulDestinationNamespace is the name of the Consul namespace to register all
 	// synced services into if Consul namespaces are enabled and mirroring
 	// is disabled. This will not be used if mirroring is enabled.
-	ConsulNamespaceName string
+	ConsulDestinationNamespace string
 
-	// EnableNSMirroring causes Consul namespaces to be created to match the
+	// EnableK8SNSMirroring causes Consul namespaces to be created to match the
 	// organization within k8s. Services are registered into the Consul
 	// namespace that mirrors their k8s namespace.
-	EnableNSMirroring bool
+	EnableK8SNSMirroring bool
 
-	// MirroringPrefix is an optional prefix that can be added to the Consul
+	// K8SNSMirroringPrefix is an optional prefix that can be added to the Consul
 	// namespaces created while mirroring. For example, if it is set to "k8s-",
 	// then the k8s `default` namespace will be mirrored in Consul's
 	// `k8s-default` namespace.
-	MirroringPrefix string
+	K8SNSMirroringPrefix string
 
 	// serviceLock must be held for any read/write to these maps.
 	serviceLock sync.RWMutex
@@ -352,10 +352,10 @@ func (t *ServiceResource) generateRegistrations(key string) {
 		var ns string
 
 		// Mirroring takes precedence
-		if t.EnableNSMirroring {
-			ns = fmt.Sprintf("%s%s", t.MirroringPrefix, svc.Namespace)
+		if t.EnableK8SNSMirroring {
+			ns = fmt.Sprintf("%s%s", t.K8SNSMirroringPrefix, svc.Namespace)
 		} else {
-			ns = t.ConsulNamespaceName
+			ns = t.ConsulDestinationNamespace
 		}
 		t.Log.Debug("[generateRegistrations] namespace being used", "key", key, "namespace", ns)
 

diff --git a/subcommand/sync-catalog/command.go b/subcommand/sync-catalog/command.go
@@ -25,13 +25,6 @@ import (
 	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
 )
 
-type arrayFlags []string
-
-func (i *arrayFlags) Set(value string) error {
-	*i = append(*i, value)
-	return nil
-}
-
 // Command is the command for syncing the K8S and Consul service
 // catalogs (one or both directions).
 type Command struct {
@@ -57,12 +50,12 @@ type Command struct {
 	flagLogLevel              string
 
 	// Flags to support namespaces
-	flagEnableNamespaces       bool     // Use namespacing on all components
-	flagConsulNamespace        string   // Consul namespace to register everything if not mirroring
-	flagAllowK8sNamespacesList []string // K8s namespaces to explicitly inject
-	flagDenyK8sNamespacesList  []string // K8s namespaces to deny injection (has precedence)
-	flagEnableNSMirroring      bool     // Enables mirroring of k8s namespaces into Consul
-	flagMirroringPrefix        string   // Prefix added to Consul namespaces created when mirroring
+	flagEnableNamespaces           bool     // Use namespacing on all components
+	flagConsulDestinationNamespace string   // Consul namespace to register everything if not mirroring
+	flagAllowK8sNamespacesList     []string // K8s namespaces to explicitly inject
+	flagDenyK8sNamespacesList      []string // K8s namespaces to deny injection (has precedence)
+	flagEnableK8SNSMirroring       bool     // Enables mirroring of k8s namespaces into Consul
+	flagK8SNSMirroringPrefix       string   // Prefix added to Consul namespaces created when mirroring
 
 	consulClient *api.Client
 	clientset    kubernetes.Interface
@@ -117,18 +110,19 @@ func (c *Command) init() {
 	c.flags.StringVar(&c.flagLogLevel, "log-level", "info",
 		"Log verbosity level. Supported values (in order of detail) are \"trace\", "+
 			"\"debug\", \"info\", \"warn\", and \"error\".")
-	c.flags.BoolVar(&c.flagEnableNamespaces, "enable-namespaces", false,
-		"Enables namespaces, in either a single Consul namespace or mirrored [Enterprise only feature]")
-	c.flags.StringVar(&c.flagConsulNamespace, "consul-namespace", "default",
-		"Defines which Consul namespace to register all synced services into. If `enable-namespace-mirroring` "+
-			"is true, this is not used.")
-	c.flags.Var((*flags.AppendSliceValue)(&c.flagAllowK8sNamespacesList), "allow-namespace",
+	c.flags.Var((*flags.AppendSliceValue)(&c.flagAllowK8sNamespacesList), "allow-k8s-namespace",
 		"K8s namespaces to explicitly allow. May be specified multiple times.")
-	c.flags.Var((*flags.AppendSliceValue)(&c.flagDenyK8sNamespacesList), "deny-namespace",
+	c.flags.Var((*flags.AppendSliceValue)(&c.flagDenyK8sNamespacesList), "deny-k8s-namespace",
 		"K8s namespaces to explicitly deny. Takes precedence over allow. May be specified multiple times.")
-	c.flags.BoolVar(&c.flagEnableNSMirroring, "enable-namespace-mirroring", false, "Enables namespace mirroring")
-	c.flags.StringVar(&c.flagMirroringPrefix, "mirroring-prefix", "",
-		"Prefix that will be added to all k8s namespaces mirrored into Consul if mirroring is enabled.")
+	c.flags.BoolVar(&c.flagEnableNamespaces, "enable-namespaces", false,
+		"[Enterprise Only] Enables namespaces, in either a single Consul namespace or mirrored")
+	c.flags.StringVar(&c.flagConsulDestinationNamespace, "consul-destination-namespace", "default",
+		"[Enterprise Only] Defines which Consul namespace to register all synced services into. If 'enable-namespace-mirroring' "+
+			"is true, this is not used.")
+	c.flags.BoolVar(&c.flagEnableK8SNSMirroring, "enable-k8s-namespace-mirroring", false, "[Enterprise Only] Enables "+
+		"namespace mirroring")
+	c.flags.StringVar(&c.flagK8SNSMirroringPrefix, "k8s-namespace-mirroring-prefix", "",
+		"[Enterprise Only] Prefix that will be added to all k8s namespaces mirrored into Consul if mirroring is enabled.")
 
 	c.http = &flags.HTTPFlags{}
 	c.k8s = &k8sflags.K8SFlags{}
@@ -230,21 +224,21 @@ func (c *Command) Run(args []string) int {
 		ctl := &controller.Controller{
 			Log: logger.Named("to-consul/controller"),
 			Resource: &catalogtoconsul.ServiceResource{
-				Log:                   logger.Named("to-consul/source"),
-				Client:                c.clientset,
-				Syncer:                syncer,
-				AllowK8sNamespacesSet: allowSet,
-				DenyK8sNamespacesSet:  denySet,
-				ExplicitEnable:        !c.flagK8SDefault,
-				ClusterIPSync:         c.flagSyncClusterIPServices,
-				NodePortSync:          catalogtoconsul.NodePortSyncType(c.flagNodePortSyncType),
-				ConsulK8STag:          c.flagConsulK8STag,
-				ConsulServicePrefix:   c.flagConsulServicePrefix,
-				AddK8SNamespaceSuffix: c.flagAddK8SNamespaceSuffix,
-				EnableNamespaces:      c.flagEnableNamespaces,
-				ConsulNamespaceName:   c.flagConsulNamespace,
-				EnableNSMirroring:     c.flagEnableNSMirroring,
-				MirroringPrefix:       c.flagMirroringPrefix,
+				Log:                        logger.Named("to-consul/source"),
+				Client:                     c.clientset,
+				Syncer:                     syncer,
+				AllowK8sNamespacesSet:      allowSet,
+				DenyK8sNamespacesSet:       denySet,
+				ExplicitEnable:             !c.flagK8SDefault,
+				ClusterIPSync:              c.flagSyncClusterIPServices,
+				NodePortSync:               catalogtoconsul.NodePortSyncType(c.flagNodePortSyncType),
+				ConsulK8STag:               c.flagConsulK8STag,
+				ConsulServicePrefix:        c.flagConsulServicePrefix,
+				AddK8SNamespaceSuffix:      c.flagAddK8SNamespaceSuffix,
+				EnableNamespaces:           c.flagEnableNamespaces,
+				ConsulDestinationNamespace: c.flagConsulDestinationNamespace,
+				EnableK8SNSMirroring:       c.flagEnableK8SNSMirroring,
+				K8SNSMirroringPrefix:       c.flagK8SNSMirroringPrefix,
 			},
 		}