Backport of [NET-11256] Add gateway list command to consul-k8s CLI into release/1.6.x

.changelog/4433.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+cli: Introduce `gateway list` for collecting multiple components of all gateways' configuration by running a single command.
+```

cli/cmd/gateway/list/command.go

@@ -0,0 +1,312 @@
+package read
+
+import (
+	"archive/zip"
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+	"strings"
+	"sync"
+
+	helmcli "helm.sh/helm/v3/pkg/cli"
+	"k8s.io/client-go/rest"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	gwv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
+	gwv1beta1 "sigs.k8s.io/gateway-api/apis/v1beta1"
+	"sigs.k8s.io/yaml"
+
+	"github.com/hashicorp/consul-k8s/cli/common"
+	"github.com/hashicorp/consul-k8s/cli/common/flag"
+	"github.com/hashicorp/consul-k8s/cli/common/terminal"
+)
+
+type Command struct {
+	*common.BaseCommand
+
+	kubernetes client.Client
+	restConfig *rest.Config
+
+	set *flag.Sets
+
+	flagAllNamespaces    bool
+	flagGatewayKind      string
+	flagGatewayNamespace string
+	flagKubeConfig       string
+	flagKubeContext      string
+	flagOutput           string
+
+	initOnce sync.Once
+	help     string
+}
+
+func (c *Command) Help() string {
+	c.initOnce.Do(c.init)
+	return fmt.Sprintf("%s\n\nUsage: consul-k8s gateway list [flags]\n\n%s", c.Synopsis(), c.help)
+}
+
+func (c *Command) Synopsis() string {
+	return "Inspect the configuration for all Gateways in the Kubernetes cluster or a given Kubernetes namespace."
+}
+
+// init establishes the flags for Command
+func (c *Command) init() {
+	c.set = flag.NewSets()
+
+	f := c.set.NewSet("Command Options")
+	f.StringVar(&flag.StringVar{
+		Name:    "namespace",
+		Target:  &c.flagGatewayNamespace,
+		Usage:   "The Kubernetes namespace to list Gateways in.",
+		Aliases: []string{"n"},
+	})
+	f.BoolVar(&flag.BoolVar{
+		Name:    "all-namespaces",
+		Target:  &c.flagAllNamespaces,
+		Default: false,
+		Usage:   "List Gateways in all Kubernetes namespaces.",
+		Aliases: []string{"A"},
+	})
+	f.StringVar(&flag.StringVar{
+		Name:    "output",
+		Target:  &c.flagOutput,
+		Usage:   "Output the Gateway configuration as 'json' in the terminal or 'archive' as a zip archive named 'gateways.zip' in the current directory.",
+		Default: "archive",
+		Aliases: []string{"o"},
+	})
+
+	f = c.set.NewSet("Global Options")
+	f.StringVar(&flag.StringVar{
+		Name:    "kubeconfig",
+		Aliases: []string{"c"},
+		Target:  &c.flagKubeConfig,
+		Usage:   "Set the path to a kubeconfig file.",
+	})
+	f.StringVar(&flag.StringVar{
+		Name:   "context",
+		Target: &c.flagKubeContext,
+		Usage:  "Set the Kubernetes context to use.",
+	})
+
+	c.help = c.set.Help()
+}
+
+// Run runs the command
+func (c *Command) Run(args []string) int {
+	c.initOnce.Do(c.init)
+	c.Log.ResetNamed("read")
+	defer common.CloseWithError(c.BaseCommand)
+
+	if err := c.set.Parse(args); err != nil {
+		c.UI.Output(err.Error(), terminal.WithErrorStyle())
+		return 1
+	}
+
+	if err := c.initKubernetes(); err != nil {
+		c.UI.Output(err.Error(), terminal.WithErrorStyle())
+		return 1
+	}
+
+	if err := c.fetchCRDs(); err != nil {
+		c.UI.Output(err.Error(), terminal.WithErrorStyle())
+		return 1
+	}
+
+	return 0
+}
+
+type gatewayWithRoutes struct {
+	Gateway      gwv1beta1.Gateway      `json:"gateway"`
+	GatewayClass gwv1beta1.GatewayClass `json:"gatewayClass"`
+	HTTPRoutes   []gwv1beta1.HTTPRoute  `json:"httpRoutes"`
+	TCPRoutes    []gwv1alpha2.TCPRoute  `json:"tcpRoutes"`
+}
+
+func (c *Command) fetchCRDs() error {
+	// Fetch Gateways
+	var gateways gwv1beta1.GatewayList
+	if err := c.kubernetes.List(context.Background(), &gateways, client.InNamespace(c.flagGatewayNamespace)); err != nil {
+		return fmt.Errorf("error fetching Gateway CRD: %w", err)
+	}
+
+	// Fetch all HTTPRoutes in all namespaces
+	var httpRoutes gwv1beta1.HTTPRouteList
+	if err := c.kubernetes.List(context.Background(), &httpRoutes); err != nil {
+		return fmt.Errorf("error fetching HTTPRoute CRDs: %w", err)
+	}
+
+	// Fetch all TCPRoutes in all namespaces
+	var tcpRoutes gwv1alpha2.TCPRouteList
+	if err := c.kubernetes.List(context.Background(), &tcpRoutes); err != nil {
+		return fmt.Errorf("error fetching TCPRoute CRDs: %w", err)
+	}
+
+	var gws []gatewayWithRoutes
+
+	for _, gateway := range gateways.Items {
+		// Fetch GatewayClass referenced by Gateway
+		var gatewayClass gwv1beta1.GatewayClass
+		if err := c.kubernetes.Get(context.Background(), client.ObjectKey{Namespace: "", Name: string(gateway.Spec.GatewayClassName)}, &gatewayClass); err != nil {
+			return fmt.Errorf("error fetching GatewayClass CRD: %w", err)
+		}
+
+		// FUTURE Fetch GatewayClassConfig referenced by GatewayClass
+		// This import requires resolving hairy dependency discrepancies between modules in this repo
+		//var gatewayClassConfig v1alpha1.GatewayClassConfig
+		//if err := c.kubernetes.Get(context.Background(), client.ObjectKey{Namespace: "", Name: gatewayClass.Spec.ParametersRef.Name}, &gatewayClassConfig); err != nil {
+		//	return fmt.Errorf("error fetching GatewayClassConfig CRD: %w", err)
+		//}
+
+		// FUTURE Fetch MeshServices referenced by HTTPRoutes or TCPRoutes
+		// This import requires resolving hairy dependency discrepancies between modules in this repo
+		// var meshServices v1alpha1.MeshServiceList
+		// if err := c.kubernetes.List(context.Background(), &meshServices); err != nil {
+		//   return fmt.Errorf("error fetching MeshService CRDs: %w", err)
+		// }
+
+		gw := gatewayWithRoutes{
+			Gateway:      gateway,
+			GatewayClass: gatewayClass,
+			HTTPRoutes:   make([]gwv1beta1.HTTPRoute, 0, len(httpRoutes.Items)),
+			TCPRoutes:    make([]gwv1alpha2.TCPRoute, 0, len(tcpRoutes.Items)),
+		}
+
+		for _, route := range httpRoutes.Items {
+			for _, ref := range route.Spec.ParentRefs {
+				switch {
+				case string(ref.Name) != gateway.Name:
+					// Route parent references gateway with different name
+					continue
+				case ref.Namespace != nil && string(*ref.Namespace) == gateway.Namespace:
+					// Route parent explicitly references gateway with same name and namespace
+					gw.HTTPRoutes = append(gw.HTTPRoutes, route)
+				case ref.Namespace == nil && route.Namespace == gateway.Namespace:
+					// Route parent implicitly references gateway with same name in local namespace
+					gw.HTTPRoutes = append(gw.HTTPRoutes, route)
+				}
+			}
+		}
+
+		for _, route := range tcpRoutes.Items {
+			for _, ref := range route.Spec.ParentRefs {
+				switch {
+				case string(ref.Name) != gateway.Name:
+					// Route parent references gateway with different name
+					continue
+				case ref.Namespace != nil && string(*ref.Namespace) == gateway.Namespace:
+					// Route parent explicitly references gateway with same name and namespace
+					gw.TCPRoutes = append(gw.TCPRoutes, route)
+				case ref.Namespace == nil && route.Namespace == gateway.Namespace:
+					// Route parent implicitly references gateway with same name in local namespace
+					gw.TCPRoutes = append(gw.TCPRoutes, route)
+				}
+			}
+		}
+
+		gws = append(gws, gw)
+	}
+
+	switch strings.ToLower(c.flagOutput) {
+	case "json":
+		if err := c.writeJSONOutput(gws); err != nil {
+			return fmt.Errorf("error writing CRDs as JSON: %w", err)
+		}
+	default:
+		file, err := os.Create("./gateways.zip")
+		if err != nil {
+			return fmt.Errorf("error creating output file: %w", err)
+		}
+
+		zipw := zip.NewWriter(file)
+		defer zipw.Close()
+
+		if err := c.writeArchive(zipw, gws); err != nil {
+			return fmt.Errorf("error writing CRDs to zip archive: %w", err)
+		}
+		c.UI.Output("Wrote to zip archive " + file.Name())
+		return zipw.Close()
+	}
+
+	return nil
+}
+
+func (c *Command) writeJSONOutput(obj interface{}) error {
+	output, err := json.MarshalIndent(obj, "", "\t")
+	if err != nil {
+		return err
+	}
+
+	c.UI.Output(string(output))
+	return nil
+}
+
+// writeArchive writes one file to the zip archive for each Gateway in the list.
+// The files have name `<namespace>-<name>.yaml`.
+func (c *Command) writeArchive(zipw *zip.Writer, gws []gatewayWithRoutes) error {
+	for _, gw := range gws {
+		name := fmt.Sprintf("%s-%s.yaml", gw.Gateway.Namespace, gw.Gateway.Name)
+
+		w, err := zipw.Create(name)
+		if err != nil {
+			return fmt.Errorf("error creating zip entry for %s: %w", name, err)
+		}
+
+		objYaml, err := yaml.Marshal(gw)
+		if err != nil {
+			return fmt.Errorf("error marshalling %s: %w", name, err)
+		}
+
+		_, err = w.Write(objYaml)
+		if err != nil {
+			return fmt.Errorf("error writing %s to zip archive: %w", name, err)
+		}
+	}
+
+	return nil
+}
+
+// initKubernetes initializes the REST config and uses it to initialize the k8s client.
+func (c *Command) initKubernetes() (err error) {
+	settings := helmcli.New()
+
+	// If a kubeconfig was specified, use it
+	if c.flagKubeConfig != "" {
+		settings.KubeConfig = c.flagKubeConfig
+	}
+
+	// If a kube context was specified, use it
+	if c.flagKubeContext != "" {
+		settings.KubeContext = c.flagKubeContext
+	}
+
+	// Create a REST config from the settings for our Kubernetes client
+	if c.restConfig == nil {
+		if c.restConfig, err = settings.RESTClientGetter().ToRESTConfig(); err != nil {
+			return fmt.Errorf("error creating Kubernetes REST config: %w", err)
+		}
+	}
+
+	// Create a controller-runtime client from c.restConfig
+	if c.kubernetes == nil {
+		if c.kubernetes, err = client.New(c.restConfig, client.Options{}); err != nil {
+			return fmt.Errorf("error creating controller-runtime client: %w", err)
+		}
+		// FUTURE Fix dependency discrepancies between modules in this repo so that this scheme can be added (see above)
+		//_ = v1alpha1.AddToScheme(c.kubernetes.Scheme())
+		_ = gwv1alpha2.AddToScheme(c.kubernetes.Scheme())
+		_ = gwv1beta1.AddToScheme(c.kubernetes.Scheme())
+	}
+
+	// If all namespaces specified, use empty namespace; otherwise, if
+	// no namespace was specified, use the one from the kube context.
+	if c.flagAllNamespaces {
+		c.flagGatewayNamespace = ""
+	} else if c.flagGatewayNamespace == "" {
+		if c.flagOutput != "json" {
+			c.UI.Output("No namespace specified, using current kube context namespace: %s", settings.Namespace())
+		}
+		c.flagGatewayNamespace = settings.Namespace()
+	}
+
+	return nil
+}