Deprecation of etcd-snapshot command in v1.26 (#6575)

* Consolidate etcd snapshot commands * Consolidate secrets encryption commands * Move etcd-snapshot to fatal error stage. Signed-off-by: Derek Nola <derek.nola@suse.com>
k3s-io · Dec 5, 2022 · b5d39df · b5d39df
1 parent d723775
commit b5d39df
Show file tree

Hide file tree

Showing 9 changed files with 177 additions and 200 deletions.
diff --git a/cmd/encrypt/main.go b/cmd/encrypt/main.go
@@ -15,14 +15,13 @@ import (
 func main() {
 	app := cmds.NewApp()
 	app.Commands = []cli.Command{
-		cmds.NewSecretsEncryptCommand(cli.ShowAppHelp,
-			cmds.NewSecretsEncryptSubcommands(
-				secretsencrypt.Status,
-				secretsencrypt.Enable,
-				secretsencrypt.Disable,
-				secretsencrypt.Prepare,
-				secretsencrypt.Rotate,
-				secretsencrypt.Reencrypt),
+		cmds.NewSecretsEncryptCommands(
+			secretsencrypt.Status,
+			secretsencrypt.Enable,
+			secretsencrypt.Disable,
+			secretsencrypt.Prepare,
+			secretsencrypt.Rotate,
+			secretsencrypt.Reencrypt,
 		),
 	}
 

diff --git a/cmd/etcdsnapshot/main.go b/cmd/etcdsnapshot/main.go
@@ -15,12 +15,12 @@ import (
 func main() {
 	app := cmds.NewApp()
 	app.Commands = []cli.Command{
-		cmds.NewEtcdSnapshotCommand(etcdsnapshot.Save,
-			cmds.NewEtcdSnapshotSubcommands(
-				etcdsnapshot.Delete,
-				etcdsnapshot.List,
-				etcdsnapshot.Prune,
-				etcdsnapshot.Save),
+		cmds.NewEtcdSnapshotCommands(
+			etcdsnapshot.Run,
+			etcdsnapshot.Delete,
+			etcdsnapshot.List,
+			etcdsnapshot.Prune,
+			etcdsnapshot.Save,
 		),
 	}
 

diff --git a/cmd/k3s/main.go b/cmd/k3s/main.go
@@ -51,21 +51,20 @@ func main() {
 		cmds.NewCRICTL(externalCLIAction("crictl", dataDir)),
 		cmds.NewCtrCommand(externalCLIAction("ctr", dataDir)),
 		cmds.NewCheckConfigCommand(externalCLIAction("check-config", dataDir)),
-		cmds.NewEtcdSnapshotCommand(etcdsnapshotCommand,
-			cmds.NewEtcdSnapshotSubcommands(
-				etcdsnapshotCommand,
-				etcdsnapshotCommand,
-				etcdsnapshotCommand,
-				etcdsnapshotCommand),
+		cmds.NewEtcdSnapshotCommands(
+			etcdsnapshotCommand,
+			etcdsnapshotCommand,
+			etcdsnapshotCommand,
+			etcdsnapshotCommand,
+			etcdsnapshotCommand,
 		),
-		cmds.NewSecretsEncryptCommand(secretsencryptCommand,
-			cmds.NewSecretsEncryptSubcommands(
-				secretsencryptCommand,
-				secretsencryptCommand,
-				secretsencryptCommand,
-				secretsencryptCommand,
-				secretsencryptCommand,
-				secretsencryptCommand),
+		cmds.NewSecretsEncryptCommands(
+			secretsencryptCommand,
+			secretsencryptCommand,
+			secretsencryptCommand,
+			secretsencryptCommand,
+			secretsencryptCommand,
+			secretsencryptCommand,
 		),
 		cmds.NewCertCommand(
 			cmds.NewCertSubcommands(

diff --git a/cmd/server/main.go b/cmd/server/main.go
@@ -48,21 +48,20 @@ func main() {
 		cmds.NewKubectlCommand(kubectl.Run),
 		cmds.NewCRICTL(crictl.Run),
 		cmds.NewCtrCommand(ctr.Run),
-		cmds.NewEtcdSnapshotCommand(etcdsnapshot.Save,
-			cmds.NewEtcdSnapshotSubcommands(
-				etcdsnapshot.Delete,
-				etcdsnapshot.List,
-				etcdsnapshot.Prune,
-				etcdsnapshot.Save),
+		cmds.NewEtcdSnapshotCommands(
+			etcdsnapshot.Run,
+			etcdsnapshot.Delete,
+			etcdsnapshot.List,
+			etcdsnapshot.Prune,
+			etcdsnapshot.Save,
 		),
-		cmds.NewSecretsEncryptCommand(cli.ShowAppHelp,
-			cmds.NewSecretsEncryptSubcommands(
-				secretsencrypt.Status,
-				secretsencrypt.Enable,
-				secretsencrypt.Disable,
-				secretsencrypt.Prepare,
-				secretsencrypt.Rotate,
-				secretsencrypt.Reencrypt),
+		cmds.NewSecretsEncryptCommands(
+			secretsencrypt.Status,
+			secretsencrypt.Enable,
+			secretsencrypt.Disable,
+			secretsencrypt.Prepare,
+			secretsencrypt.Rotate,
+			secretsencrypt.Reencrypt,
 		),
 		cmds.NewCertCommand(
 			cmds.NewCertSubcommands(

diff --git a/main.go b/main.go
@@ -32,21 +32,20 @@ func main() {
 		cmds.NewAgentCommand(agent.Run),
 		cmds.NewKubectlCommand(kubectl.Run),
 		cmds.NewCRICTL(crictl.Run),
-		cmds.NewEtcdSnapshotCommand(etcdsnapshot.Save,
-			cmds.NewEtcdSnapshotSubcommands(
-				etcdsnapshot.Delete,
-				etcdsnapshot.List,
-				etcdsnapshot.Prune,
-				etcdsnapshot.Save),
+		cmds.NewEtcdSnapshotCommands(
+			etcdsnapshot.Run,
+			etcdsnapshot.Delete,
+			etcdsnapshot.List,
+			etcdsnapshot.Prune,
+			etcdsnapshot.Save,
 		),
-		cmds.NewSecretsEncryptCommand(cli.ShowAppHelp,
-			cmds.NewSecretsEncryptSubcommands(
-				secretsencrypt.Status,
-				secretsencrypt.Enable,
-				secretsencrypt.Disable,
-				secretsencrypt.Prepare,
-				secretsencrypt.Rotate,
-				secretsencrypt.Reencrypt),
+		cmds.NewSecretsEncryptCommands(
+			secretsencrypt.Status,
+			secretsencrypt.Enable,
+			secretsencrypt.Disable,
+			secretsencrypt.Prepare,
+			secretsencrypt.Rotate,
+			secretsencrypt.Reencrypt,
 		),
 		cmds.NewCertCommand(
 			cmds.NewCertSubcommands(

diff --git a/pkg/cli/cmds/etcd_snapshot.go b/pkg/cli/cmds/etcd_snapshot.go
@@ -99,61 +99,57 @@ var EtcdSnapshotFlags = []cli.Flag{
 	},
 }
 
-func NewEtcdSnapshotCommand(action func(*cli.Context) error, subcommands []cli.Command) cli.Command {
+func NewEtcdSnapshotCommands(run, delete, list, prune, save func(ctx *cli.Context) error) cli.Command {
 	return cli.Command{
 		Name:            EtcdSnapshotCommand,
 		Usage:           "Trigger an immediate etcd snapshot",
 		SkipFlagParsing: false,
 		SkipArgReorder:  true,
-		Action:          action,
-		Subcommands:     subcommands,
-		Flags:           EtcdSnapshotFlags,
-	}
-}
-
-func NewEtcdSnapshotSubcommands(delete, list, prune, save func(ctx *cli.Context) error) []cli.Command {
-	return []cli.Command{
-		{
-			Name:            "delete",
-			Usage:           "Delete given snapshot(s)",
-			SkipFlagParsing: false,
-			SkipArgReorder:  true,
-			Action:          delete,
-			Flags:           EtcdSnapshotFlags,
-		},
-		{
-			Name:            "ls",
-			Aliases:         []string{"list", "l"},
-			Usage:           "List snapshots",
-			SkipFlagParsing: false,
-			SkipArgReorder:  true,
-			Action:          list,
-			Flags: append(EtcdSnapshotFlags, &cli.StringFlag{
-				Name:        "o,output",
-				Usage:       "(db) List format. Default: standard. Optional: json",
-				Destination: &ServerConfig.EtcdListFormat,
-			}),
-		},
-		{
-			Name:            "prune",
-			Usage:           "Remove snapshots that match the name prefix that exceed the configured retention count",
-			SkipFlagParsing: false,
-			SkipArgReorder:  true,
-			Action:          prune,
-			Flags: append(EtcdSnapshotFlags, &cli.IntFlag{
-				Name:        "snapshot-retention",
-				Usage:       "(db) Number of snapshots to retain.",
-				Destination: &ServerConfig.EtcdSnapshotRetention,
-				Value:       defaultSnapshotRentention,
-			}),
-		},
-		{
-			Name:            "save",
-			Usage:           "Trigger an immediate etcd snapshot",
-			SkipFlagParsing: false,
-			SkipArgReorder:  true,
-			Action:          save,
-			Flags:           EtcdSnapshotFlags,
+		Action:          run,
+		Subcommands: []cli.Command{
+			{
+				Name:            "delete",
+				Usage:           "Delete given snapshot(s)",
+				SkipFlagParsing: false,
+				SkipArgReorder:  true,
+				Action:          delete,
+				Flags:           EtcdSnapshotFlags,
+			},
+			{
+				Name:            "ls",
+				Aliases:         []string{"list", "l"},
+				Usage:           "List snapshots",
+				SkipFlagParsing: false,
+				SkipArgReorder:  true,
+				Action:          list,
+				Flags: append(EtcdSnapshotFlags, &cli.StringFlag{
+					Name:        "o,output",
+					Usage:       "(db) List format. Default: standard. Optional: json",
+					Destination: &ServerConfig.EtcdListFormat,
+				}),
+			},
+			{
+				Name:            "prune",
+				Usage:           "Remove snapshots that match the name prefix that exceed the configured retention count",
+				SkipFlagParsing: false,
+				SkipArgReorder:  true,
+				Action:          prune,
+				Flags: append(EtcdSnapshotFlags, &cli.IntFlag{
+					Name:        "snapshot-retention",
+					Usage:       "(db) Number of snapshots to retain.",
+					Destination: &ServerConfig.EtcdSnapshotRetention,
+					Value:       defaultSnapshotRentention,
+				}),
+			},
+			{
+				Name:            "save",
+				Usage:           "Trigger an immediate etcd snapshot",
+				SkipFlagParsing: false,
+				SkipArgReorder:  true,
+				Action:          save,
+				Flags:           EtcdSnapshotFlags,
+			},
 		},
+		Flags: EtcdSnapshotFlags,
 	}
 }