Merge pull request #1139 from thaJeztah/add_orchestrator_warning

Warn if DOCKER_ORCHESTRATOR is still used but not DOCKER_STACK_ORCHESTRATOR

cli/command/orchestrator.go

@@ -2,6 +2,7 @@ package command
 
 import (
 	"fmt"
+	"io"
 	"os"
 )
 
@@ -19,6 +20,7 @@ const (
 
 	defaultOrchestrator           = OrchestratorSwarm
 	envVarDockerStackOrchestrator = "DOCKER_STACK_ORCHESTRATOR"
+	envVarDockerOrchestrator      = "DOCKER_ORCHESTRATOR"
 )
 
 // HasKubernetes returns true if defined orchestrator has Kubernetes capabilities.
@@ -53,13 +55,16 @@ func normalize(value string) (Orchestrator, error) {
 
 // GetStackOrchestrator checks DOCKER_STACK_ORCHESTRATOR environment variable and configuration file
 // orchestrator value and returns user defined Orchestrator.
-func GetStackOrchestrator(flagValue, value string) (Orchestrator, error) {
+func GetStackOrchestrator(flagValue, value string, stderr io.Writer) (Orchestrator, error) {
 	// Check flag
 	if o, err := normalize(flagValue); o != orchestratorUnset {
 		return o, err
 	}
 	// Check environment variable
 	env := os.Getenv(envVarDockerStackOrchestrator)
+	if env == "" && os.Getenv(envVarDockerOrchestrator) != "" {
+		fmt.Fprintf(stderr, "WARNING: experimental environment variable %s is set. Please use %s instead\n", envVarDockerOrchestrator, envVarDockerStackOrchestrator)
+	}
 	if o, err := normalize(env); o != orchestratorUnset {
 		return o, err
 	}

cli/command/orchestrator_test.go

@@ -1,6 +1,7 @@
 package command
 
 import (
+	"io/ioutil"
 	"os"
 	"testing"
 
@@ -107,7 +108,7 @@ func TestOrchestratorSwitch(t *testing.T) {
 			err := cli.Initialize(options)
 			assert.NilError(t, err)
 
-			orchestrator, err := GetStackOrchestrator(testcase.flagOrchestrator, cli.ConfigFile().StackOrchestrator)
+			orchestrator, err := GetStackOrchestrator(testcase.flagOrchestrator, cli.ConfigFile().StackOrchestrator, ioutil.Discard)
 			assert.NilError(t, err)
 			assert.Check(t, is.Equal(testcase.expectedKubernetes, orchestrator.HasKubernetes()))
 			assert.Check(t, is.Equal(testcase.expectedSwarm, orchestrator.HasSwarm()))

cli/command/stack/cmd.go

@@ -3,11 +3,11 @@ package stack
 import (
 	"errors"
 	"fmt"
+	"io"
 	"strings"
 
 	"github.com/docker/cli/cli"
 	"github.com/docker/cli/cli/command"
-	cliconfig "github.com/docker/cli/cli/config"
 	"github.com/docker/cli/cli/config/configfile"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
@@ -27,12 +27,12 @@ func NewStackCommand(dockerCli command.Cli) *cobra.Command {
 		Short: "Manage Docker stacks",
 		Args:  cli.NoArgs,
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
-			orchestrator, err := getOrchestrator(dockerCli.ConfigFile(), cmd)
+			orchestrator, err := getOrchestrator(dockerCli.ConfigFile(), cmd, dockerCli.Err())
 			if err != nil {
 				return err
 			}
 			opts.orchestrator = orchestrator
-			hideFlag(cmd, orchestrator)
+			hideOrchestrationFlags(cmd, orchestrator)
 			return checkSupportedFlag(cmd, orchestrator)
 		},
 
@@ -43,13 +43,7 @@ func NewStackCommand(dockerCli command.Cli) *cobra.Command {
 	}
 	defaultHelpFunc := cmd.HelpFunc()
 	cmd.SetHelpFunc(func(cmd *cobra.Command, args []string) {
-		config := cliconfig.LoadDefaultConfigFile(dockerCli.Err()) // dockerCli is not yet initialized, but we only need config file here
-		o, err := getOrchestrator(config, cmd)
-		if err != nil {
-			fmt.Fprint(dockerCli.Err(), err)
-			return
-		}
-		hideFlag(cmd, o)
+		hideOrchestrationFlags(cmd, opts.orchestrator)
 		defaultHelpFunc(cmd, args)
 	})
 	cmd.AddCommand(
@@ -78,15 +72,15 @@ func NewTopLevelDeployCommand(dockerCli command.Cli) *cobra.Command {
 	return cmd
 }
 
-func getOrchestrator(config *configfile.ConfigFile, cmd *cobra.Command) (command.Orchestrator, error) {
+func getOrchestrator(config *configfile.ConfigFile, cmd *cobra.Command, stderr io.Writer) (command.Orchestrator, error) {
 	var orchestratorFlag string
 	if o, err := cmd.Flags().GetString("orchestrator"); err == nil {
 		orchestratorFlag = o
 	}
-	return command.GetStackOrchestrator(orchestratorFlag, config.StackOrchestrator)
+	return command.GetStackOrchestrator(orchestratorFlag, config.StackOrchestrator, stderr)
 }
 
-func hideFlag(cmd *cobra.Command, orchestrator command.Orchestrator) {
+func hideOrchestrationFlags(cmd *cobra.Command, orchestrator command.Orchestrator) {
 	cmd.Flags().VisitAll(func(f *pflag.Flag) {
 		if _, ok := f.Annotations["kubernetes"]; ok && !orchestrator.HasKubernetes() {
 			f.Hidden = true
@@ -96,7 +90,7 @@ func hideFlag(cmd *cobra.Command, orchestrator command.Orchestrator) {
 		}
 	})
 	for _, subcmd := range cmd.Commands() {
-		hideFlag(subcmd, orchestrator)
+		hideOrchestrationFlags(subcmd, orchestrator)
 	}
 }
 

cli/command/system/version.go

@@ -126,7 +126,7 @@ func runVersion(dockerCli command.Cli, opts *versionOptions) error {
 		return cli.StatusError{StatusCode: 64, Status: err.Error()}
 	}
 
-	orchestrator, err := command.GetStackOrchestrator("", dockerCli.ConfigFile().StackOrchestrator)
+	orchestrator, err := command.GetStackOrchestrator("", dockerCli.ConfigFile().StackOrchestrator, dockerCli.Err())
 	if err != nil {
 		return cli.StatusError{StatusCode: 64, Status: err.Error()}
 	}