Skip to content

Commit 61b50e7

Browse files
Pothulapatiroboquat
authored andcommitted
installer: clarify experimental config flag
Fixes #8107 This PR updates the flag descriptions, and the `render` display notes to be more explicit on what experimental config is. This flag is required, to make sure users are opting in explicitely/ knowlingly to use the experimental config. Signed-off-by: Tarun Pothulapati <[email protected]>
1 parent d46f49f commit 61b50e7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

install/installer/cmd/render.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ A config file is required which can be generated with the init command.`,
4646

4747
if cfg.Experimental != nil {
4848
if renderOpts.UseExperimentalConfig {
49-
fmt.Fprintf(os.Stderr, "rendering using experimental config - here be dragons\n")
49+
fmt.Fprintf(os.Stderr, "rendering using experimental config\n")
5050
} else {
51-
fmt.Fprintf(os.Stderr, "config contains experimental options - ignoring them\n")
51+
fmt.Fprintf(os.Stderr, "ignoring experimental config. Use `--use-experimental-config` to include the experimental section in config\n")
5252
cfg.Experimental = nil
5353
}
5454
}
@@ -190,5 +190,5 @@ func init() {
190190
renderCmd.PersistentFlags().StringVarP(&renderOpts.ConfigFN, "config", "c", os.Getenv("GITPOD_INSTALLER_CONFIG"), "path to the config file")
191191
renderCmd.PersistentFlags().StringVarP(&renderOpts.Namespace, "namespace", "n", "default", "namespace to deploy to")
192192
renderCmd.Flags().BoolVar(&renderOpts.ValidateConfigDisabled, "no-validation", false, "if set, the config will not be validated before running")
193-
renderCmd.Flags().BoolVar(&renderOpts.UseExperimentalConfig, "danger-use-unsupported-config", false, "enable use of unsupported config")
193+
renderCmd.Flags().BoolVar(&renderOpts.UseExperimentalConfig, "use-experimental-config", false, "enable the use of experimental config that is prone to be changed")
194194
}

0 commit comments

Comments
 (0)