feat(kubernetes): add kubernetes nodegroup show command (#242)

Author: kangasta

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Add `kubernetes nodegroup show` for displaying node-group details. This also adds _Nodes_ table and _Anti-affinity_ field that were not available in previous `kubernetes show` output.
+
+### Changed
+- In human readable output of `kubernetes show` command, show node-groups as table. Node-group datails are available with `kubernetes nodegroup show` command.
+
 ## [2.10.0] - 2023-07-17
 ### Added
 - Add `--disable-utility-network-access` for `kubernetes nodegroup create` command

README.md

@@ -28,11 +28,12 @@ completion   Generate the autocompletion script for the specified shell
 database     Manage databases
 help         Help about any command
 ip-address   Manage IP addresses
-kubernetes   Manage Kubernetes clusters (EXPERIMENTAL)
+kubernetes   Manage Kubernetes clusters
 loadbalancer Manage load balancers
 network      Manage networks
 router       Manage routers
 server       Manage servers
+servergroup  Manage server groups
 storage      Manage storages
 version      Display software information
 zone         Display zone information

internal/commands/all/all.go

@@ -163,6 +163,7 @@ func BuildCommands(rootCmd *cobra.Command, conf *config.Config) {
 	nodeGroupCommand := commands.BuildCommand(nodegroup.BaseNodeGroupCommand(), kubernetesCommand.Cobra(), conf)
 	commands.BuildCommand(nodegroup.CreateCommand(), nodeGroupCommand.Cobra(), conf)
 	commands.BuildCommand(nodegroup.ScaleCommand(), nodeGroupCommand.Cobra(), conf)
+	commands.BuildCommand(nodegroup.ShowCommand(), nodeGroupCommand.Cobra(), conf)
 	commands.BuildCommand(nodegroup.DeleteCommand(), nodeGroupCommand.Cobra(), conf)
 
 	// Server group operations

internal/commands/kubernetes/kubernetes.go

@@ -7,7 +7,7 @@ import (
 // BaseKubernetesCommand creates the base "kubernetes" command
 func BaseKubernetesCommand() commands.Command {
 	return &kubernetesCommand{
-		commands.New("kubernetes", "Manage Kubernetes clusters (EXPERIMENTAL)"),
+		commands.New("kubernetes", "Manage Kubernetes clusters"),
 	}
 }
 

internal/commands/kubernetes/nodegroup/delete.go

@@ -38,8 +38,8 @@ func (s *deleteCommand) InitCommand() {
 	_ = s.Cobra().MarkFlagRequired("name")
 }
 
-// Execute implements commands.MultipleArgumentCommand
-func (s *deleteCommand) Execute(exec commands.Executor, arg string) (output.Output, error) {
+// ExecuteSingleArgument implements commands.SingleArgumentCommand
+func (s *deleteCommand) ExecuteSingleArgument(exec commands.Executor, arg string) (output.Output, error) {
 	msg := fmt.Sprintf("Deleting node group %s from cluster %v", s.name, arg)
 	exec.PushProgressStarted(msg)
 

internal/commands/kubernetes/nodegroup/nodegroup.go

@@ -7,7 +7,7 @@ import (
 // BaseNodeGroupCommand creates the base "kubernetes nodegroups" command
 func BaseNodeGroupCommand() commands.Command {
 	return &nodegroupCommand{
-		commands.New("nodegroup", "Manage cluster node-groups (EXPERIMENTAL)"),
+		commands.New("nodegroup", "Manage cluster node-groups"),
 	}
 }
 

internal/commands/kubernetes/nodegroup/scale.go

@@ -41,8 +41,8 @@ func (s *scaleCommand) InitCommand() {
 	_ = s.Cobra().MarkFlagRequired("count")
 }
 
-// Execute implements commands.MultipleArgumentCommand
-func (s *scaleCommand) Execute(exec commands.Executor, arg string) (output.Output, error) {
+// ExecuteSingleArgument implements commands.SingleArgumentCommand
+func (s *scaleCommand) ExecuteSingleArgument(exec commands.Executor, arg string) (output.Output, error) {
 	msg := fmt.Sprintf("Scaling node group %s of cluster %v", s.name, arg)
 	exec.PushProgressStarted(msg)
 

internal/commands/kubernetes/nodegroup/show.go

@@ -0,0 +1,151 @@
+package nodegroup
+
+import (
+	"github.com/UpCloudLtd/upcloud-cli/v2/internal/commands"
+	"github.com/UpCloudLtd/upcloud-cli/v2/internal/completion"
+	"github.com/UpCloudLtd/upcloud-cli/v2/internal/format"
+	"github.com/UpCloudLtd/upcloud-cli/v2/internal/labels"
+	"github.com/UpCloudLtd/upcloud-cli/v2/internal/output"
+	"github.com/UpCloudLtd/upcloud-cli/v2/internal/resolver"
+	"github.com/UpCloudLtd/upcloud-cli/v2/internal/ui"
+	"github.com/spf13/pflag"
+
+	"github.com/UpCloudLtd/upcloud-go-api/v6/upcloud/request"
+)
+
+// ShowCommand creates the "kubernetes nodegroup show" command
+func ShowCommand() commands.Command {
+	return &showCommand{
+		BaseCommand: commands.New(
+			"show",
+			"Show node group details",
+			"upctl kubernetes nodegroup show 55199a44-4751-4e27-9394-7c7661910be3 --name default",
+		),
+	}
+}
+
+type showCommand struct {
+	*commands.BaseCommand
+	name string
+	resolver.CachingKubernetes
+	completion.Kubernetes
+}
+
+// InitCommand implements Command.InitCommand
+func (s *showCommand) InitCommand() {
+	flagSet := &pflag.FlagSet{}
+	flagSet.StringVar(&s.name, "name", "", "Node group name")
+	s.AddFlags(flagSet)
+
+	_ = s.Cobra().MarkFlagRequired("name")
+}
+
+// ExecuteSingleArgument implements commands.SingleArgumentCommand
+func (s *showCommand) ExecuteSingleArgument(exec commands.Executor, uuid string) (output.Output, error) {
+	svc := exec.All()
+	nodeGroup, err := svc.GetKubernetesNodeGroup(exec.Context(), &request.GetKubernetesNodeGroupRequest{ClusterUUID: uuid, Name: s.name})
+	if err != nil {
+		return nil, err
+	}
+
+	taintColumns := []output.TableColumn{
+		{Key: "key", Header: "Key"},
+		{Key: "value", Header: "Value"},
+		{Key: "effect", Header: "Effect"},
+	}
+
+	taintRows := []output.TableRow{}
+	for _, taint := range nodeGroup.Taints {
+		taintRows = append(taintRows, output.TableRow{
+			taint.Key,
+			taint.Value,
+			taint.Effect,
+		})
+	}
+
+	kubeletArgColumns := taintColumns[0:2]
+
+	kubeletArgRows := []output.TableRow{}
+	for _, kubeletArg := range nodeGroup.KubeletArgs {
+		kubeletArgRows = append(kubeletArgRows, output.TableRow{
+			kubeletArg.Key,
+			kubeletArg.Value,
+		})
+	}
+
+	nodeRows := []output.TableRow{}
+	for _, node := range nodeGroup.Nodes {
+		nodeRows = append(nodeRows, output.TableRow{
+			node.UUID,
+			node.Name,
+			node.State,
+		})
+	}
+
+	nodeColumns := []output.TableColumn{
+		{Key: "uuid", Header: "UUID", Colour: ui.DefaultUUUIDColours},
+		{Key: "name", Header: "Name"},
+		{Key: "state", Header: "State", Format: format.KubernetesNodeState},
+	}
+
+	var storageName string
+	if storage, err := svc.GetStorageDetails(exec.Context(), &request.GetStorageDetailsRequest{UUID: nodeGroup.Storage}); err != nil {
+		storageName = ""
+	} else {
+		storageName = storage.Title
+	}
+
+	// For JSON and YAML output, passthrough API response
+	return output.MarshaledWithHumanOutput{
+		Value: nodeGroup,
+		Output: output.Combined{
+			output.CombinedSection{
+				Contents: output.Details{
+					Sections: []output.DetailSection{
+						{
+							Title: "Overview",
+							Rows: []output.DetailRow{
+								{Title: "Name:", Value: nodeGroup.Name},
+								{Title: "Count:", Value: nodeGroup.Count},
+								{Title: "Plan:", Value: nodeGroup.Plan},
+								{Title: "State:", Value: nodeGroup.State, Format: format.KubernetesNodeGroupState},
+								{Title: "Storage UUID:", Value: nodeGroup.Storage, Colour: ui.DefaultUUUIDColours},
+								{Title: "Storage name:", Value: storageName, Format: format.PossiblyUnknownString},
+								{Title: "Anti-affinity:", Value: nodeGroup.AntiAffinity, Format: format.Boolean},
+								{Title: "Utility network access:", Value: nodeGroup.UtilityNetworkAccess, Format: format.Boolean},
+							},
+						},
+					},
+				},
+			},
+			labels.GetLabelsSectionWithResourceType(nodeGroup.Labels, "node group"),
+			output.CombinedSection{
+				Key:   "taints",
+				Title: "Taints:",
+				Contents: output.Table{
+					Columns:      taintColumns,
+					Rows:         taintRows,
+					EmptyMessage: "No taints defined for this node group.",
+				},
+			},
+			output.CombinedSection{
+				Key:   "kubelet_args",
+				Title: "Kubelet arguments:",
+				Contents: output.Table{
+					Columns:      kubeletArgColumns,
+					Rows:         kubeletArgRows,
+					EmptyMessage: "No kubelet arguments defined for this node group.",
+				},
+			},
+			output.CombinedSection{
+				Key:   "nodes",
+				Title: "Nodes:",
+				Contents: output.Table{
+					Columns:      nodeColumns,
+					Rows:         nodeRows,
+					EmptyMessage: "No nodes found for this node group.",
+				},
+			},
+		},
+	}, nil
+}