tetra: move the dump command to a debug sub command

Also creates a hidden alias to not break compatibility with dump being a top command. But now we have the debug command to host those kind of sub commands. Signed-off-by: Mahe Tardy <[email protected]>
cilium · Sep 27, 2024 · c9abfca · c9abfca
1 parent 4d81e96
commit c9abfca
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 9 deletions.
diff --git a/cmd/tetra/commands_linux.go b/cmd/tetra/commands_linux.go
@@ -7,7 +7,6 @@ import (
 	"github.com/cilium/tetragon/cmd/tetra/bugtool"
 	"github.com/cilium/tetragon/cmd/tetra/cri"
 	"github.com/cilium/tetragon/cmd/tetra/debug"
-	"github.com/cilium/tetragon/cmd/tetra/dump"
 	"github.com/cilium/tetragon/cmd/tetra/loglevel"
 	"github.com/cilium/tetragon/cmd/tetra/policyfilter"
 	"github.com/cilium/tetragon/cmd/tetra/probe"
@@ -19,8 +18,8 @@ func addCommands(rootCmd *cobra.Command) {
 	addBaseCommands(rootCmd)
 	rootCmd.AddCommand(bugtool.New())
 	rootCmd.AddCommand(tracingpolicy.New())
-	rootCmd.AddCommand(dump.New())
 	rootCmd.AddCommand(debug.New())
+	rootCmd.AddCommand(debug.NewDumpAlias())
 	rootCmd.AddCommand(policyfilter.New())
 	rootCmd.AddCommand(probe.New())
 	rootCmd.AddCommand(loglevel.New())

diff --git a/cmd/tetra/debug/debug.go b/cmd/tetra/debug/debug.go
@@ -11,5 +11,6 @@ func New() *cobra.Command {
 		Hidden: true,
 	}
 	cmd.AddCommand(NewMapCmd())
+	cmd.AddCommand(NewDumpCommand())
 	return &cmd
 }
diff --git a/cmd/tetra/dump/dump.go → cmd/tetra/debug/dump.go b/cmd/tetra/dump/dump.go → cmd/tetra/debug/dump.go
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // Copyright Authors of Tetragon
 
-package dump
+package debug
 
 import (
 	"fmt"
@@ -21,11 +21,18 @@ import (
 	"google.golang.org/grpc"
 )
 
-func New() *cobra.Command {
+// NewDumpAlias return a hidden alias of the dump subcommand, dump used to be a
+// top level commands and was moved under debug, this avoids a breaking change.
+func NewDumpAlias() *cobra.Command {
+	legacyDump := NewDumpCommand()
+	legacyDump.Hidden = true
+	return legacyDump
+}
+
+func NewDumpCommand() *cobra.Command {
 	ret := &cobra.Command{
 		Use:          "dump",
-		Short:        "dump information",
-		Hidden:       true,
+		Short:        "Dump information from tetragon maps and caches",
 		SilenceUsage: true,
 	}
 

diff --git a/cmd/tetra/policyfilter/policyfilter.go b/cmd/tetra/policyfilter/policyfilter.go
@@ -8,7 +8,7 @@ import (
 	"path/filepath"
 	"strconv"
 
-	"github.com/cilium/tetragon/cmd/tetra/dump"
+	"github.com/cilium/tetragon/cmd/tetra/debug"
 	"github.com/cilium/tetragon/pkg/cgroups"
 	"github.com/cilium/tetragon/pkg/defaults"
 	"github.com/cilium/tetragon/pkg/logger"
@@ -41,7 +41,7 @@ func dumpDebugCmd() *cobra.Command {
 		Short: "dump cgroup ID to namespace state",
 		Args:  cobra.ExactArgs(0),
 		Run: func(_ *cobra.Command, _ []string) {
-			dump.NamespaceState(mapFname)
+			debug.NamespaceState(mapFname)
 		},
 	}
 
@@ -77,7 +77,7 @@ func dumpCmd() *cobra.Command {
 		Short: "dump policyfilter state",
 		Args:  cobra.ExactArgs(0),
 		Run: func(_ *cobra.Command, _ []string) {
-			dump.PolicyfilterState(mapFname)
+			debug.PolicyfilterState(mapFname)
 		},
 	}