feat: Add Octopus.Action.Kubernetes.VerboseOutput variable to log CLI tool output (#1690)

HuyPhanNguyen · web-flow · commit 03276e2c7a17 · 2026-03-05T13:50:11.000+10:00
* add logSuccessAsInfo

* feat: Add Octopus.Action.Kubernetes.VerboseOutput variable to log CLI tool output at Info level for Kubernetes steps

* update the variable name
diff --git a/source/Calamari/Kubernetes/Integration/AwsCli.cs b/source/Calamari/Kubernetes/Integration/AwsCli.cs
@@ -4,6 +4,7 @@
 using Calamari.Common.Features.Processes;
 using Calamari.Common.Plumbing;
 using Calamari.Common.Plumbing.Logging;
+using Calamari.Common.Plumbing.Variables;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using Octopus.Versioning.Semver;
@@ -16,8 +17,9 @@ public AwsCli(
             ILog log,
             ICommandLineRunner commandLineRunner,
             string workingDirectory,
-            Dictionary<string, string> environmentVars)
-            : base(log, commandLineRunner, workingDirectory, environmentVars)
+            Dictionary<string, string> environmentVars,
+            IVariables variables)
+            : base(log, commandLineRunner, workingDirectory, environmentVars, variables)
         {
         }
 
diff --git a/source/Calamari/Kubernetes/Integration/AzureCli.cs b/source/Calamari/Kubernetes/Integration/AzureCli.cs
@@ -5,13 +5,14 @@
 using Calamari.Common.Plumbing;
 using Calamari.Common.Plumbing.FileSystem;
 using Calamari.Common.Plumbing.Logging;
+using Calamari.Common.Plumbing.Variables;
 
 namespace Calamari.Kubernetes.Integration
 {
     public class AzureCli : CommandLineTool
     {
-        public AzureCli(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars)
-            : base(log, commandLineRunner, workingDirectory, environmentVars)
+        public AzureCli(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars, IVariables variables)
+            : base(log, commandLineRunner, workingDirectory, environmentVars, variables)
         {
         }
 
diff --git a/source/Calamari/Kubernetes/Integration/CommandLineTool.cs b/source/Calamari/Kubernetes/Integration/CommandLineTool.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using Calamari.Common.Features.Processes;
 using Calamari.Common.Plumbing.Logging;
+using Calamari.Common.Plumbing.Variables;
 
 namespace Calamari.Kubernetes.Integration
 {
@@ -10,23 +11,31 @@ public class CommandLineTool
         protected readonly ILog log;
         protected string workingDirectory;
         protected Dictionary<string, string> environmentVars;
+        protected readonly IVariables variables;
 
         readonly ICommandLineRunner commandLineRunner;
 
         protected CommandLineTool(
             ILog log,
             ICommandLineRunner commandLineRunner,
             string workingDirectory,
-            Dictionary<string, string> environmentVars)
+            Dictionary<string, string> environmentVars,
+            IVariables variables)
         {
             this.log = log;
             this.commandLineRunner = commandLineRunner;
             this.workingDirectory = workingDirectory;
             this.environmentVars = environmentVars;
+            this.variables = variables;
         }
 
         public string ExecutableLocation { get; protected set; }
 
+        protected virtual bool ShouldLogSuccessfulOutputAsInfo()
+        {
+            return variables.GetFlag(SpecialVariables.LogCliOutputAsInfo);
+        }
+
         protected CommandResult ExecuteCommandAndLogOutput(CommandLineInvocation invocation)
             => ExecuteCommandAndLogOutput(invocation, false);
 
@@ -52,7 +61,8 @@ CommandResult ExecuteCommandAndLogOutput(CommandLineInvocation invocation, bool
 
             var result = commandLineRunner.Execute(invocation);
 
-            LogCapturedOutput(result, captureCommandOutput, logOutputAsVerbose);
+            var logSuccessAsInfo = ShouldLogSuccessfulOutputAsInfo();
+            LogCapturedOutput(result, captureCommandOutput, logOutputAsVerbose, logSuccessAsInfo);
 
             return result;
         }
@@ -62,13 +72,21 @@ void LogCommandText(CommandLineInvocation invocation)
             log.Verbose(invocation.ToString());
         }
 
-        void LogCapturedOutput(CommandResult result, CaptureCommandOutput captureCommandOutput, bool logOutputAsVerbose)
+        void LogCapturedOutput(CommandResult result, CaptureCommandOutput captureCommandOutput, bool logOutputAsVerbose, bool logSuccessAsInfo)
         {
             foreach (var message in captureCommandOutput.Messages)
             {
                 if (result.ExitCode == 0)
                 {
-                    log.Verbose(message.Text);
+                    // When logSuccessAsInfo is true, log successful output at Info level
+                    if (logSuccessAsInfo)
+                    {
+                        log.Info(message.Text);
+                    }
+                    else
+                    {
+                        log.Verbose(message.Text);
+                    }
                     continue;
                 }
 
diff --git a/source/Calamari/Kubernetes/Integration/GCloud.cs b/source/Calamari/Kubernetes/Integration/GCloud.cs
@@ -6,15 +6,16 @@
 using Calamari.Common.Plumbing;
 using Calamari.Common.Plumbing.FileSystem;
 using Calamari.Common.Plumbing.Logging;
+using Calamari.Common.Plumbing.Variables;
 
 namespace Calamari.Kubernetes.Integration
 {
     public class GCloud : CommandLineTool
     {
-        private readonly ICalamariFileSystem fileSystem;
+        readonly ICalamariFileSystem fileSystem;
 
-        public GCloud(ILog log, ICommandLineRunner commandLineRunner, ICalamariFileSystem fileSystem, string workingDirectory, Dictionary<string, string> environmentVars)
-            : base(log, commandLineRunner, workingDirectory, environmentVars)
+        public GCloud(ILog log, ICommandLineRunner commandLineRunner, ICalamariFileSystem fileSystem, string workingDirectory, Dictionary<string, string> environmentVars, IVariables variables)
+            : base(log, commandLineRunner, workingDirectory, environmentVars, variables)
         {
             this.fileSystem = fileSystem;
         }
diff --git a/source/Calamari/Kubernetes/Integration/GkeGcloudAuthPlugin.cs b/source/Calamari/Kubernetes/Integration/GkeGcloudAuthPlugin.cs
@@ -3,13 +3,14 @@
 using Calamari.Common.Features.Processes;
 using Calamari.Common.Plumbing;
 using Calamari.Common.Plumbing.Logging;
+using Calamari.Common.Plumbing.Variables;
 
 namespace Calamari.Kubernetes.Integration
 {
     public class GkeGcloudAuthPlugin : CommandLineTool
     {
-        public GkeGcloudAuthPlugin(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars)
-            : base(log, commandLineRunner, workingDirectory, environmentVars)
+        public GkeGcloudAuthPlugin(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars, IVariables variables)
+            : base(log, commandLineRunner, workingDirectory, environmentVars, variables)
         {
         }
 
diff --git a/source/Calamari/Kubernetes/Integration/HelmCli.cs b/source/Calamari/Kubernetes/Integration/HelmCli.cs
@@ -23,15 +23,13 @@ public class HelmCli : CommandLineTool
     {
         readonly ICommandLineRunner commandLineRunner;
         readonly ICalamariFileSystem fileSystem;
-        readonly IVariables variables;
         bool isCustomExecutable;
 
         public HelmCli(ILog log, ICommandLineRunner commandLineRunner, RunningDeployment runningDeployment, ICalamariFileSystem fileSystem)
-            : base(log, commandLineRunner, runningDeployment.CurrentDirectory, runningDeployment.EnvironmentVariables)
+            : base(log, commandLineRunner, runningDeployment.CurrentDirectory, runningDeployment.EnvironmentVariables, runningDeployment.Variables)
         {
             this.commandLineRunner = commandLineRunner;
             this.fileSystem = fileSystem;
-            variables = runningDeployment.Variables;
             ExecutableLocation = SetExecutable();
         }
 
@@ -116,7 +114,7 @@ public string GetManifest(string releaseName, int revisionNumber)
 
             return result.Output.MergeInfoLogs();
         }
-        
+
         public CommandResult Upgrade(string releaseName, string packagePath, IEnumerable<string> upgradeArgs)
         {
             var buildArgs = new List<string>
diff --git a/source/Calamari/Kubernetes/Integration/Kubectl.cs b/source/Calamari/Kubernetes/Integration/Kubectl.cs
@@ -31,7 +31,7 @@ public Kubectl(IVariables variables,
                        ILog log,
                        ICommandLineRunner commandLineRunner,
                        string workingDirectory,
-                       Dictionary<string, string> environmentVariables) : base(log, commandLineRunner, workingDirectory, environmentVariables)
+                       Dictionary<string, string> environmentVariables) : base(log, commandLineRunner, workingDirectory, environmentVariables, variables)
         {
             customKubectlExecutable = variables.Get("Octopus.Action.Kubernetes.CustomKubectlExecutable");
         }
diff --git a/source/Calamari/Kubernetes/Integration/Kubelogin.cs b/source/Calamari/Kubernetes/Integration/Kubelogin.cs
@@ -4,13 +4,14 @@
 using Calamari.Common.Features.Processes;
 using Calamari.Common.Plumbing;
 using Calamari.Common.Plumbing.Logging;
+using Calamari.Common.Plumbing.Variables;
 
 namespace Calamari.Kubernetes.Integration
 {
     public class KubeLogin : CommandLineTool
     {
-        public KubeLogin(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars)
-            : base(log, commandLineRunner, workingDirectory, environmentVars)
+        public KubeLogin(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars, IVariables variables)
+            : base(log, commandLineRunner, workingDirectory, environmentVars, variables)
         {
         }
 
diff --git a/source/Calamari/Kubernetes/SetupKubectlAuthentication.cs b/source/Calamari/Kubernetes/SetupKubectlAuthentication.cs
@@ -174,8 +174,9 @@ void SetupGCloudContext(string @namespace)
                                        commandLineRunner,
                                        fileSystem,
                                        workingDirectory,
-                                       environmentVars);
-            var gkeGcloudAuthPlugin = new GkeGcloudAuthPlugin(log, commandLineRunner, workingDirectory, environmentVars);
+                                       environmentVars,
+                                       variables);
+            var gkeGcloudAuthPlugin = new GkeGcloudAuthPlugin(log, commandLineRunner, workingDirectory, environmentVars, variables);
             var gcloudAuth = new GoogleKubernetesEngineAuth(gcloudCli,
                                                             gkeGcloudAuthPlugin,
                                                             kubectl,
@@ -186,8 +187,8 @@ void SetupGCloudContext(string @namespace)
 
         void SetupAzureContext(string @namespace, string kubeConfig)
         {
-            var azureCli = new AzureCli(log, commandLineRunner, workingDirectory, environmentVars);
-            var kubeloginCli = new KubeLogin(log, commandLineRunner, workingDirectory, environmentVars);
+            var azureCli = new AzureCli(log, commandLineRunner, workingDirectory, environmentVars, variables);
+            var kubeloginCli = new KubeLogin(log, commandLineRunner, workingDirectory, environmentVars, variables);
             var azureAuth = new AzureKubernetesServicesAuth(azureCli, kubectl, kubeloginCli, variables);
             azureAuth.Configure(@namespace, kubeConfig);
         }
@@ -317,7 +318,7 @@ void SetupContextForUsernamePassword(string user)
 
         void SetupAwsContext(string @namespace, string clusterUrl, string user)
         {
-            var awsCli = new AwsCli(log, commandLineRunner, workingDirectory, environmentVars);
+            var awsCli = new AwsCli(log, commandLineRunner, workingDirectory, environmentVars, variables);
             var awsAuth = new AwsCliAuth(awsCli, kubectl, variables, environmentVars, log);
 
             awsAuth.Configure(@namespace, clusterUrl, user);
diff --git a/source/Calamari/Kubernetes/SpecialVariables.cs b/source/Calamari/Kubernetes/SpecialVariables.cs
@@ -18,6 +18,7 @@ public static class SpecialVariables
         public const string OutputKubeConfig = "Octopus.Action.Kubernetes.OutputKubeConfig";
         public const string CustomKubectlExecutable = "Octopus.Action.Kubernetes.CustomKubectlExecutable";
         public const string ResourceStatusCheck = "Octopus.Action.Kubernetes.ResourceStatusCheck";
+        public const string LogCliOutputAsInfo = "Octopus.Action.Kubernetes.LogCliOutputAsInfo";
         public const string DeploymentStyle = "Octopus.Action.KubernetesContainers.DeploymentStyle";
         public const string DeploymentWait = "Octopus.Action.KubernetesContainers.DeploymentWait";
         public const string CustomResourceYamlFileName = "Octopus.Action.KubernetesContainers.CustomResourceYamlFileName";

Original file line number	Diff line number	Diff line change
`@@ -5,13 +5,14 @@`
`5`	`5`	`using Calamari.Common.Plumbing;`
`6`	`6`	`using Calamari.Common.Plumbing.FileSystem;`
`7`	`7`	`using Calamari.Common.Plumbing.Logging;`
	`8`	`+using Calamari.Common.Plumbing.Variables;`
`8`	`9`
`9`	`10`	`namespace Calamari.Kubernetes.Integration`
`10`	`11`	`{`
`11`	`12`	`public class AzureCli : CommandLineTool`
`12`	`13`	`{`
`13`		`- public AzureCli(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars)`
`14`		`- : base(log, commandLineRunner, workingDirectory, environmentVars)`
	`14`	`+ public AzureCli(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars, IVariables variables)`
	`15`	`+ : base(log, commandLineRunner, workingDirectory, environmentVars, variables)`
`15`	`16`	`{`
`16`	`17`	`}`
`17`	`18`
Original file line number	Diff line number	Diff line change
`@@ -6,15 +6,16 @@`
`6`	`6`	`using Calamari.Common.Plumbing;`
`7`	`7`	`using Calamari.Common.Plumbing.FileSystem;`
`8`	`8`	`using Calamari.Common.Plumbing.Logging;`
	`9`	`+using Calamari.Common.Plumbing.Variables;`
`9`	`10`
`10`	`11`	`namespace Calamari.Kubernetes.Integration`
`11`	`12`	`{`
`12`	`13`	`public class GCloud : CommandLineTool`
`13`	`14`	`{`
`14`		`- private readonly ICalamariFileSystem fileSystem;`
	`15`	`+ readonly ICalamariFileSystem fileSystem;`
`15`	`16`
`16`		`- public GCloud(ILog log, ICommandLineRunner commandLineRunner, ICalamariFileSystem fileSystem, string workingDirectory, Dictionary<string, string> environmentVars)`
`17`		`- : base(log, commandLineRunner, workingDirectory, environmentVars)`
	`17`	`+ public GCloud(ILog log, ICommandLineRunner commandLineRunner, ICalamariFileSystem fileSystem, string workingDirectory, Dictionary<string, string> environmentVars, IVariables variables)`
	`18`	`+ : base(log, commandLineRunner, workingDirectory, environmentVars, variables)`
`18`	`19`	`{`
`19`	`20`	`this.fileSystem = fileSystem;`
`20`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,13 +3,14 @@`
`3`	`3`	`using Calamari.Common.Features.Processes;`
`4`	`4`	`using Calamari.Common.Plumbing;`
`5`	`5`	`using Calamari.Common.Plumbing.Logging;`
	`6`	`+using Calamari.Common.Plumbing.Variables;`
`6`	`7`
`7`	`8`	`namespace Calamari.Kubernetes.Integration`
`8`	`9`	`{`
`9`	`10`	`public class GkeGcloudAuthPlugin : CommandLineTool`
`10`	`11`	`{`
`11`		`- public GkeGcloudAuthPlugin(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars)`
`12`		`- : base(log, commandLineRunner, workingDirectory, environmentVars)`
	`12`	`+ public GkeGcloudAuthPlugin(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars, IVariables variables)`
	`13`	`+ : base(log, commandLineRunner, workingDirectory, environmentVars, variables)`
`13`	`14`	`{`
`14`	`15`	`}`
`15`	`16`
Original file line number	Diff line number	Diff line change
`@@ -23,15 +23,13 @@ public class HelmCli : CommandLineTool`
`23`	`23`	`{`
`24`	`24`	`readonly ICommandLineRunner commandLineRunner;`
`25`	`25`	`readonly ICalamariFileSystem fileSystem;`
`26`		`- readonly IVariables variables;`
`27`	`26`	`bool isCustomExecutable;`
`28`	`27`
`29`	`28`	`public HelmCli(ILog log, ICommandLineRunner commandLineRunner, RunningDeployment runningDeployment, ICalamariFileSystem fileSystem)`
`30`		`- : base(log, commandLineRunner, runningDeployment.CurrentDirectory, runningDeployment.EnvironmentVariables)`
	`29`	`+ : base(log, commandLineRunner, runningDeployment.CurrentDirectory, runningDeployment.EnvironmentVariables, runningDeployment.Variables)`
`31`	`30`	`{`
`32`	`31`	`this.commandLineRunner = commandLineRunner;`
`33`	`32`	`this.fileSystem = fileSystem;`
`34`		`- variables = runningDeployment.Variables;`
`35`	`33`	`ExecutableLocation = SetExecutable();`
`36`	`34`	`}`
`37`	`35`
`@@ -116,7 +114,7 @@ public string GetManifest(string releaseName, int revisionNumber)`
`116`	`114`
`117`	`115`	`return result.Output.MergeInfoLogs();`
`118`	`116`	`}`
`119`		`-`
	`117`	`+`
`120`	`118`	`public CommandResult Upgrade(string releaseName, string packagePath, IEnumerable<string> upgradeArgs)`
`121`	`119`	`{`
`122`	`120`	`var buildArgs = new List<string>`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public Kubectl(IVariables variables,`
`31`	`31`	`ILog log,`
`32`	`32`	`ICommandLineRunner commandLineRunner,`
`33`	`33`	`string workingDirectory,`
`34`		`- Dictionary<string, string> environmentVariables) : base(log, commandLineRunner, workingDirectory, environmentVariables)`
	`34`	`+ Dictionary<string, string> environmentVariables) : base(log, commandLineRunner, workingDirectory, environmentVariables, variables)`
`35`	`35`	`{`
`36`	`36`	`customKubectlExecutable = variables.Get("Octopus.Action.Kubernetes.CustomKubectlExecutable");`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,14 @@`
`4`	`4`	`using Calamari.Common.Features.Processes;`
`5`	`5`	`using Calamari.Common.Plumbing;`
`6`	`6`	`using Calamari.Common.Plumbing.Logging;`
	`7`	`+using Calamari.Common.Plumbing.Variables;`
`7`	`8`
`8`	`9`	`namespace Calamari.Kubernetes.Integration`
`9`	`10`	`{`
`10`	`11`	`public class KubeLogin : CommandLineTool`
`11`	`12`	`{`
`12`		`- public KubeLogin(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars)`
`13`		`- : base(log, commandLineRunner, workingDirectory, environmentVars)`
	`13`	`+ public KubeLogin(ILog log, ICommandLineRunner commandLineRunner, string workingDirectory, Dictionary<string, string> environmentVars, IVariables variables)`
	`14`	`+ : base(log, commandLineRunner, workingDirectory, environmentVars, variables)`
`14`	`15`	`{`
`15`	`16`	`}`
`16`	`17`