8000 Flags package refactoring: from "flag" to "pflag" by cheina97 · Pull Request #2725 · liqotech/liqo · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Flags package refactoring: from "flag" to "pflag" #2725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 9, 2024
Merged

Flags package refactoring: from "flag" to "pflag" #2725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions cmd/crd-replicator/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
package main

import (
"flag"
"os"
"time"

"github.com/spf13/pflag"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/kubernetes"
Expand All @@ -34,6 +34,7 @@ import (
identitymanager "github.com/liqotech/liqo/pkg/identityManager"
tenantnamespace "github.com/liqotech/liqo/pkg/tenantNamespace"
"github.com/liqotech/liqo/pkg/utils/args"
flagsutils "github.com/liqotech/liqo/pkg/utils/flags"
"github.com/liqotech/liqo/pkg/utils/mapper"
"github.com/liqotech/liqo/pkg/utils/restcfg"
)
Expand All @@ -47,13 +48,13 @@ func init() {

func main() {
clusterFlags := args.NewClusterIDFlags(true, nil)
resyncPeriod := flag.Duration("resync-period", 10*time.Hour, "The resync period for the informers")
workers := flag.Uint("workers", 1, "The number of workers managing the reflection of each remote cluster")
resyncPeriod := pflag.Duration("resync-period", 10*time.Hour, "The resync period for the informers")
workers := pflag.Uint("workers", 1, "The number of workers managing the reflection of each remote cluster")

restcfg.InitFlags(nil)
klog.InitFlags(nil)
flagsutils.InitKlogFlags(nil)

flag.Parse()
pflag.Parse()

log.SetLogger(klog.NewKlogr())

Expand Down
9 changes: 3 additions & 6 deletions cmd/fabric/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
package main

import (
"flag"
"fmt"
"os"

Expand Down Expand Up @@ -64,12 +63,10 @@ func main() {
RunE: run,
}

legacyflags := flag.NewFlagSet("legacy", flag.ExitOnError)
restcfg.InitFlags(legacyflags)
klog.InitFlags(legacyflags)
flagsutils.FromFlagToPflag(legacyflags, cmd.Flags())

flagsutils.InitKlogFlags(cmd.Flags())
restcfg.InitFlags(cmd.Flags())
fabric.InitFlags(cmd.Flags(), options)

if err := fabric.MarkFlagsRequired(&cmd); err != nil {
klog.Error(err)
os.Exit(1)
Expand Down
8 changes: 2 additions & 6 deletions cmd/gateway/geneve/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
package main

import (
"flag"
"fmt"
"os"

Expand Down Expand Up @@ -58,11 +57,8 @@ func main() {
RunE: run,
}

legacyflags := flag.NewFlagSet("legacy", flag.ExitOnError)
restcfg.InitFlags(legacyflags)
klog.InitFlags(legacyflags)
flagsutils.FromFlagToPflag(legacyflags, cmd.Flags())

flagsutils.InitKlogFlags(cmd.Flags())
restcfg.InitFlags(cmd.Flags())
fabric.InitFlags(cmd.Flags(), options)

gateway.InitFlags(cmd.Flags(), options.GwOptions)
Expand Down
7 changes: 2 additions & 5 deletions cmd/gateway/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
package main

import (
"flag"
"fmt"
"os"

Expand Down Expand Up @@ -62,10 +61,8 @@ func main() {
RunE: run,
}

legacyflags := flag.NewFlagSet("legacy", flag.ExitOnError)
restcfg.InitFlags(legacyflags)
klog.InitFlags(legacyflags)
flagsutils.FromFlagToPflag(legacyflags, cmd.Flags())
flagsutils.InitKlogFlags(cmd.Flags())
restcfg.InitFlags(cmd.Flags())

gwoptions := gateway.NewOptions()
connoptions = connection.NewOptions(
Expand Down
7 changes: 2 additions & 5 deletions cmd/gateway/wireguard/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
package main

import (
"flag"
"fmt"
"net"
"os"
Expand Down Expand Up @@ -66,10 +65,8 @@ func main() {
RunE: run,
}

legacyflags := flag.NewFlagSet("legacy", flag.ExitOnError)
restcfg.InitFlags(legacyflags)
klog.InitFlags(legacyflags)
flagsutils.FromFlagToPflag(legacyflags, cmd.Flags())
flagsutils.InitKlogFlags(cmd.Flags())
restcfg.InitFlags(cmd.Flags())

gateway.InitFlags(cmd.Flags(), options.GwOptions)
wireguard.InitFlags(cmd.Flags(), options)
Expand Down
7 changes: 2 additions & 5 deletions cmd/ipam/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
package main

import (
"flag"
"fmt"
"os"

Expand Down Expand Up @@ -66,10 +65,8 @@ func main() {
RunE: run,
}

legacyflags := flag.NewFlagSet("legacy", flag.ExitOnError)
restcfg.InitFlags(legacyflags)
klog.InitFlags(legacyflags)
flagsutils.FromFlagToPflag(legacyflags, cmd.Flags())
flagsutils.InitKlogFlags(cmd.Flags())
restcfg.InitFlags(cmd.Flags())

liqoipam.InitFlags(cmd.Flags(), options)
if err := liqoipam.MarkFlagsRequired(&cmd, options); err != nil {
Expand Down
88 changes: 45 additions & 43 deletions cmd/liqo-controller-manager/main.go
View file
Open in desktop
F438
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ package main

import (
"context"
"flag"
"os"
"time"

monitoringv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
"github.com/spf13/pflag"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
corev1 "k8s.io/api/core/v1"
Expand Down Expand Up @@ -58,6 +58,7 @@ import (
argsutils "github.com/liqotech/liqo/pkg/utils/args"
dynamicutils "github.com/liqotech/liqo/pkg/utils/dynamic"
liqoerrors "github.com/liqotech/liqo/pkg/utils/errors"
flagsutils "github.com/liqotech/liqo/pkg/utils/flags"
"github.com/liqotech/liqo/pkg/utils/indexer"
ipamips "github.com/liqotech/liqo/pkg/utils/ipam/mapping"
"github.com/liqotech/liqo/pkg/utils/mapper"
Expand Down Expand Up @@ -93,78 +94,79 @@ func main() {
var awsConfig identitymanager.LocalAwsConfig

// Cluster-wide modules enable/disable flags.
networkingEnabled := flag.Bool("networking-enabled", true, "Enable/disable the networking module")
authenticationEnabled := flag.Bool("authentication-enabled", true, "Enable/disable the authentication module")
offloadingEnabled := flag.Bool("offloading-enabled", true, "Enable/disable the offloading module")
networkingEnabled := pflag.Bool("networking-enabled", true, "Enable/disable the networking module")
authenticationEnabled := pflag.Bool("authentication-enabled", true, "Enable/disable the authentication module")
offloadingEnabled := pflag.Bool("offloading-enabled", true, "Enable/disable the offloading module")

// Manager flags
webhookPort := flag.Uint("webhook-port", 9443, "The port the webhook server binds to")
metricsAddr := flag.String("metrics-address", ":8080", "The address the metric endpoint binds to")
probeAddr := flag.String("health-probe-address", ":8081", "The address the health probe endpoint binds to")
leaderElection := flag.Bool("enable-leader-election", false, "Enable leader election for controller manager")
webhookPort := pflag.Uint("webhook-port", 9443, "The port the webhook server binds to")
metricsAddr := pflag.String("metrics-address", ":8080", "The address the metric endpoint binds to")
probeAddr := pflag.String("health-probe-address", ":8081", "The address the health probe endpoint binds to")
leaderElection := pflag.Bool("enable-leader-election", false, "Enable leader election for controller manager")

// Global parameters
resyncPeriod := flag.Duration("resync-period", 10*time.Hour, "The resync period for the informers")
resyncPeriod := pflag.Duration("resync-period", 10*time.Hour, "The resync period for the informers")
clusterIDFlags := argsutils.NewClusterIDFlags(true, nil)
liqoNamespace := flag.String("liqo-namespace", consts.DefaultLiqoNamespace,
liqoNamespace := pflag.String("liqo-namespace", consts.DefaultLiqoNamespace,
"Name of the namespace where the liqo components are running")
foreignClusterWorkers := flag.Int("foreign-cluster-workers", 1, "The number of workers used to reconcile ForeignCluster resources.")
foreignClusterPingInterval := flag.Duration("foreign-cluster-ping-interval", 15*time.Second,
foreignClusterWorkers := pflag.Int("foreign-cluster-workers", 1, "The number of workers used to reconcile ForeignCluster resources.")
foreignClusterPingInterval := pflag.Duration("foreign-cluster-ping-interval", 15*time.Second,
"The frequency of the ForeignCluster API server readiness check. Set 0 to disable the check")
foreignClusterPingTimeout := flag.Duration("foreign-cluster-ping-timeout", 5*time.Second,
foreignClusterPingTimeout := pflag.Duration("foreign-cluster-ping-timeout", 5*time.Second,
"The timeout of the ForeignCluster API server readiness check")
defaultLimitsEnforcement := flag.String("default-limits-enforcement", string(offloadingv1beta1.NoLimitsEnforcement),
defaultLimitsEnforcement := pflag.String("default-limits-enforcement", string(offloadingv1beta1.NoLimitsEnforcement),
"The default limits enforcement policy for the offloading module")

// NETWORKING MODULE
ipamServer := flag.String("ipam-server", "", "The address of the IPAM server (set to empty string to disable IPAM)")
flag.Var(&gatewayServerResources, "gateway-server-resources",
ipamServer := pflag.String("ipam-server", "", "The address of the IPAM server (set to empty string to disable IPAM)")
pflag.Var(&gatewayServerResources, "gateway-server-resources",
"The list of resource types that implements the gateway server. They must be in the form <group>/<version>/<resource>")
flag.Var(&gatewayClientResources, "gateway-client-resources",
pflag.Var(&gatewayClientResources, "gateway-client-resources",
"The list of resource types that implements the gateway client. They must be in the form <group>/<version>/<resource>")
wgGatewayServerClusterRoleName := flag.String("wg-gateway-server-cluster-role-name", "liqo-gateway",
wgGatewayServerClusterRoleName := pflag.String("wg-gateway-server-cluster-role-name", "liqo-gateway",
"The name of the cluster role used by the wireguard gateway servers")
wgGatewayClientClusterRoleName := flag.String("wg-gateway-client-cluster-role-name", "liqo-gateway",
wgGatewayClientClusterRoleName := pflag.String("wg-gateway-client-cluster-role-name", "liqo-gateway",
"The name of the cluster role used by the wireguard gateway clients")
fabricFullMasqueradeEnabled := flag.Bool("fabric-full-masquerade-enabled", false, "Enable the full masquerade on the fabric network")
gwmasqbypassEnabled := flag.Bool("gateway-masquerade-bypass-enabled", false, "Enable the gateway masquerade bypass")
networkWorkers := flag.Int("network-ctrl-workers", 1, "The number of workers used to reconcile Network resources.")
ipWorkers := flag.Int("ip-ctrl-workers", 1, "The number of workers used to reconcile IP resources.")
fabricFullMasqueradeEnabled := pflag.Bool("fabric-full-masquerade-enabled", false, "Enable the full masquerade on the fabric network")
gwmasqbypassEnabled := pflag.Bool("gateway-masquerade-bypass-enabled", false, "Enable the gateway masquerade bypass")
networkWorkers := pflag.Int("network-ctrl-workers", 1, "The number of workers used to reconcile Network resources.")
ipWorkers := pflag.Int("ip-ctrl-workers", 1, "The number of workers used to reconcile IP resources.")

// AUTHENTICATION MODULE
flag.StringVar(&apiServerAddressOverride,
pflag.StringVar(&apiServerAddressOverride,
"api-server-address-override", "", "Override the API server address where the Kuberentes APIServer is exposed")
flag.StringVar(&caOverride, "ca-override", "", "Override the CA certificate used by Kubernetes to sign certificates (base64 encoded)")
flag.BoolVar(&trustedCA, "trusted-ca", false, "Whether the Kubernetes APIServer certificate is issue by a trusted CA")
pflag.StringVar(&caOverride, "ca-override", "", "Override the CA certificate used by Kubernetes to sign certificates (base64 encoded)")
pflag.BoolVar(&trustedCA, "trusted-ca", false, "Whether the Kubernetes APIServer certificate is issue by a trusted CA")
// AWS configurations
flag.StringVar(&awsConfig.AwsAccessKeyID, "aws-access-key-id", "", "AWS IAM AccessKeyID for the Liqo User")
flag.StringVar(&awsConfig.AwsSecretAccessKey, "aws-secret-access-key", "", "AWS IAM SecretAccessKey for the Liqo User")
flag.StringVar(&awsConfig.AwsRegion, "aws-region", "", "AWS region where the local cluster is running")
flag.StringVar(&awsConfig.AwsClusterName, "aws-cluster-name", "", "Name of the local EKS cluster")
pflag.StringVar(&awsConfig.AwsAccessKeyID, "aws-access-key-id", "", "AWS IAM AccessKeyID for the Liqo User")
pflag.StringVar(&awsConfig.AwsSecretAccessKey, "aws-secret-access-key", "", "AWS IAM SecretAccessKey for the Liqo User")
pflag.StringVar(&awsConfig.AwsRegion, "aws-region", "", "AWS region where the local cluster is running")
pflag.StringVar(&awsConfig.AwsClusterName, "aws-cluster-name", "", "Name of the local EKS cluster")
// Resource sharing parameters
flag.Var(&clusterLabels, consts.ClusterLabelsParameter,
pflag.Var(&clusterLabels, consts.ClusterLabelsParameter,
"The set of labels which characterizes the local cluster when exposed remotely as a virtual node")
flag.Var(&ingressClasses, "ingress-classes", "List of ingress classes offered by the cluster. Example: \"nginx;default,traefik\"")
flag.Var(&loadBalancerClasses, "load-balancer-classes", "List of load balancer classes offered by the cluster. Example:\"metallb;default\"")
flag.Var(&defaultNodeResources, "default-node-resources", "Default resources assigned to the Virtual Node Pod")
pflag.Var(&ingressClasses, "ingress-classes", "List of ingress classes offered by the cluster. Example: \"nginx;default,traefik\"")
pflag.Var(&loadBalancerClasses, "load-balancer-classes", "List of load balancer classes offered by the cluster. Example:\"metallb;default\"")
pflag.Var(&defaultNodeResources, "default-node-resources", "Default resources assigned to the Virtual Node Pod")

// OFFLOADING MODULE
// Storage Provisioner parameters
enableStorage := flag.Bool("enable-storage", false, "enable the liqo virtual storage class")
virtualStorageClassName := flag.String("virtual-storage-class-name", "liqo", "Name of the virtual storage class")
realStorageClassName := flag.String("real-storage-class-name", "", "Name of the real storage class to use for the actual volumes")
storageNamespace := flag.String("storage-namespace", "liqo-storage", "Namespace where the liqo storage-related resources are stored")
enableStorage := pflag.Bool("enable-storage", false, "enable the liqo virtual storage class")
virtualStorageClassName := pflag.String("virtual-storage-class-name", "liqo", "Name of the virtual storage class")
realStorageClassName := pflag.String("real-storage-class-name", "", "Name of the real storage class to use for the actual volumes")
storageNamespace := pflag.String("storage-namespace", "liqo-storage", "Namespace where the liqo storage-related resources are stored")
// Service continuity
enableNodeFailureController := flag.Bool("enable-node-failure-controller", false, "Enable the node failure controller")
enableNodeFailureController := pflag.Bool("enable-node-failure-controller", false, "Enable the node failure controller")
// Controllers workers
shadowPodWorkers := flag.Int("shadow-pod-ctrl-workers", 10, "The number of workers used to reconcile ShadowPod resources.")
shadowEndpointSliceWorkers := flag.Int("shadow-endpointslice-ctrl-workers", 10,
shadowPodWorkers := pflag.Int("shadow-pod-ctrl-workers", 10, "The number of workers used to reconcile ShadowPod resources.")
shadowEndpointSliceWorkers := pflag.Int("shadow-endpointslice-ctrl-workers", 10,
"The number of workers used to reconcile ShadowEndpointSlice resources.")

liqoerrors.InitFlags(nil)
restcfg.InitFlags(nil)
klog.InitFlags(nil)
flag.Parse()
flagsutils.InitKlogFlags(nil)

pflag.Parse()

log.SetLogger(klog.NewKlogr())

Expand Down
13 changes: 0 additions & 13 deletions cmd/liqoctl/cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ package cmd
import (
"bytes"
"context"
"flag"
"fmt"
"html/template"
"os"
Expand All @@ -26,8 +25,6 @@ import (
"strings"

"github.com/spf13/cobra"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/klog/v2"
"k8s.io/kubectl/pkg/cmd/util"

"github.com/liqotech/liqo/pkg/liqoctl/create"
Expand Down Expand Up @@ -110,16 +107,6 @@ func NewRootCommand(ctx context.Context) *cobra.Command {
},
}

// Since we cannot access internal klog configuration, we create a new flagset, let klog to install
// its flags, and we only set the ones we are intrested in.
klogFlagset := flag.NewFlagSet("klog", flag.PanicOnError)
klog.InitFlags(klogFlagset)
// These settings is required to silence the Helm library messages.
utilruntime.Must(klogFlagset.Set("stderrthreshold", "FATAL"))
klog.LogToStderr(false)
buffer := &bytes.Buffer{}
klog.SetOutput(buffer)

// In case liqoctl is used as a kubectl plugin, let's set a custom usage template with kubectl
// hardcoded in it, since Cobra does not allow to specify a two word command (i.e., "kubectl liqo")
if strings.HasPrefix(liqoctl, "kubectl ") {
Expand Down
20 changes: 11 additions & 9 deletions cmd/metric-agent/main.go
View file
Open in desktop
D812
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ package main

import (
"context"
"flag"
"fmt"
"net/http"
"os"

"github.com/spf13/pflag"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
Expand All @@ -36,6 +36,7 @@ import (
"github.com/liqotech/liqo/pkg/consts"
"github.com/liqotech/liqo/pkg/remotemetrics"
clientutils "github.com/liqotech/liqo/pkg/utils/clients"
flagsutils "github.com/liqotech/liqo/pkg/utils/flags"
"github.com/liqotech/liqo/pkg/utils/mapper"
"github.com/liqotech/liqo/pkg/utils/restcfg"
)
Expand All @@ -47,15 +48,16 @@ import (
func main() {
ctx := context.Background()

keyPath := flag.String("key-path", "server.key", "Path to the key file")
certPath := flag.String("cert-path", "server.crt", "Path to the certificate file")
readTimeout := flag.Duration("read-timeout", 0, "Read timeout")
writeTimeout := flag.Duration("write-timeout", 0, "Write timeout")
port := flag.Int("port", 8443, "Port to listen on")
keyPath := pflag.String("key-path", "server.key", "Path to the key file")
certPath := pflag.String("cert-path", "server.crt", "Path to the certificate file")
readTimeout := pflag.Duration("read-timeout", 0, "Read timeout")
writeTimeout := pflag.Duration("write-timeout", 0, "Write timeout")
port := pflag.Int("port", 8443, "Port to listen on")

klog.InitFlags(nil)
restcfg.InitFlags(nil)
flag.Parse()
flagsutils.InitKlogFlags(pflag.CommandLine)
restcfg.InitFlags(pflag.CommandLine)

pflag.Parse()

log.SetLogger(klog.NewKlogr())

Expand Down
Loading
0