rpk: rename mode container to dev-container

vbotbuildovich · Aug 12, 2022 · 2375a7b · 2375a7b
1 parent 0da2825
commit 2375a7b
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/src/go/rpk/pkg/cli/cmd/container/common/common.go b/src/go/rpk/pkg/cli/cmd/container/common/common.go
@@ -282,7 +282,7 @@ func CreateNode(
 		AdvertiseAddresses(ip, config.DefaultProxyPort, proxyPort),
 		"--advertise-rpc-addr",
 		net.JoinHostPort(ip, strconv.Itoa(config.Default().Redpanda.RPCServer.Port)),
-		"--mode container",
+		"--mode dev-container",
 	}
 	containerConfig := container.Config{
 		Image:    image,

diff --git a/src/go/rpk/pkg/cli/cmd/redpanda/start.go b/src/go/rpk/pkg/cli/cmd/redpanda/start.go
@@ -162,10 +162,10 @@ func NewStartCommand(fs afero.Fs, launcher rp.Launcher) *cobra.Command {
 			// configuration itself.
 			cfg = cfg.FileOrDefaults()
 			if cfg.Redpanda.DeveloperMode && len(mode) == 0 {
-				mode = "container"
+				mode = "dev-container"
 			}
 			switch mode {
-			case "container":
+			case "dev-container":
 				fmt.Fprintln(os.Stderr, "WARNING: This is a setup for development purposes only; in this mode your clusters may run unrealistically fast and data can be corrupted any time your computer shuts down uncleanly.")
 				setContainerModeFlags(cmd)
 				setContainerModeCfgFields(cfg)
@@ -1071,7 +1071,7 @@ func mergeMaps(a, b map[string]string) map[string]string {
 	return a
 }
 
-// setContainerModeFlags sets flags bundled into --mode container flag.
+// setContainerModeFlags sets flags bundled into --mode dev-container flag.
 func setContainerModeFlags(cmd *cobra.Command) {
 	devMap := map[string]string{
 		overprovisionedFlag:   "true",
@@ -1080,7 +1080,7 @@ func setContainerModeFlags(cmd *cobra.Command) {
 		unsafeBypassFsyncFlag: "true",
 	}
 	// We don't override the values set during command execution, e.g:
-	//   rpk redpanda start --mode container --smp 2
+	//   rpk redpanda start --mode dev-container --smp 2
 	// will apply all dev flags, but smp will be 2.
 	for k, v := range devMap {
 		if !cmd.Flags().Changed(k) {
@@ -1105,7 +1105,7 @@ func setContainerModeCfgFields(cfg *config.Config) {
 const helpMode = `Mode uses well-known configuration properties for development or tests 
 environments:
 
---mode container
+--mode dev-container
     Bundled flags:
         * --overprovisioned
         * --reserve-memory 0M

diff --git a/src/go/rpk/pkg/cli/cmd/redpanda/start_test.go b/src/go/rpk/pkg/cli/cmd/redpanda/start_test.go
@@ -1382,10 +1382,10 @@ func TestStartCommand(t *testing.T) {
 			require.Equal(st, expected, rpArgs.ExtraArgs)
 		},
 	}, {
-		name: "--mode container flag set required bundle of flags",
+		name: "--mode dev-container flag set required bundle of flags",
 		args: []string{
 			"--install-dir", "/var/lib/redpanda",
-			"--mode", "container",
+			"--mode", "dev-container",
 		},
 		postCheck: func(
 			fs afero.Fs,
@@ -1411,10 +1411,10 @@ func TestStartCommand(t *testing.T) {
 			require.Equal(st, expectedClusterFields, conf.Redpanda.Other)
 		},
 	}, {
-		name: "override flags set by --mode container",
+		name: "override flags set by --mode dev-container",
 		args: []string{
 			"--install-dir", "/var/lib/redpanda",
-			"--mode", "container", "--reserve-memory", "2M",
+			"--mode", "dev-container", "--reserve-memory", "2M",
 		},
 		postCheck: func(
 			fs afero.Fs,
@@ -1423,7 +1423,7 @@ func TestStartCommand(t *testing.T) {
 		) {
 			// override value:
 			require.Equal(st, "2M", rpArgs.SeastarFlags["reserve-memory"])
-			// rest of --mode container bundle
+			// rest of --mode dev-container bundle
 			require.Equal(st, "true", rpArgs.SeastarFlags["overprovisioned"])
 			require.Equal(st, "true", rpArgs.SeastarFlags["unsafe-bypass-fsync"])
 			conf, err := new(config.Params).Load(fs)
@@ -1432,7 +1432,7 @@ func TestStartCommand(t *testing.T) {
 			require.Equal(st, true, conf.Redpanda.DeveloperMode)
 		},
 	}, {
-		name: "redpanda.developer_mode: true behaves like --mode container",
+		name: "redpanda.developer_mode: true behaves like --mode dev-container",
 		args: []string{"--install-dir", "/var/lib/redpanda"},
 		before: func(fs afero.Fs) error {
 			conf, _ := new(config.Params).Load(fs)
@@ -1462,10 +1462,10 @@ func TestStartCommand(t *testing.T) {
 			require.Equal(st, expectedClusterFields, conf.Redpanda.Other)
 		},
 	}, {
-		name: "--set overrides cluster configs set by --mode container",
+		name: "--set overrides cluster configs set by --mode dev-container",
 		args: []string{
 			"--install-dir", "/var/lib/redpanda",
-			"--mode", "container",
+			"--mode", "dev-container",
 		},
 		before: func(fs afero.Fs) error {
 			// --set flags are parsed "outside" of Cobra, directly from
@@ -1493,7 +1493,7 @@ func TestStartCommand(t *testing.T) {
 				// set by --set flag
 				"auto_create_topics_enabled": false,
 				"group_topic_partitions":     1,
-				// rest of --mode container cfg fields
+				// rest of --mode dev-container cfg fields
 				"storage_min_free_bytes":     10485760,
 				"topic_partitions_per_shard": 1000,
 			}