feat: added debug flag to enable increase verbosity on the output whe…

…n creating resources on cloud providers. Signed-off-by: Adrian Riobo <[email protected]>
redhat-developer · Dec 17, 2024 · 607fe5b · 607fe5b
1 parent 121045e
commit 607fe5b
Show file tree

Hide file tree

Showing 13 changed files with 74 additions and 29 deletions.
diff --git a/cmd/mapt/cmd/aws/hosts/fedora.go b/cmd/mapt/cmd/aws/hosts/fedora.go
@@ -51,7 +51,8 @@ func getFedoraCreate() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 
 			// Initialize gh actions runner if needed
 			if viper.IsSet(params.InstallGHActionsRunner) {
@@ -111,7 +112,8 @@ func getFedoraDestroy() *cobra.Command {
 
 			maptContext.InitBase(
 				viper.GetString(params.ProjectName),
-				viper.GetString(params.BackedURL))
+				viper.GetString(params.BackedURL),
+				viper.IsSet(params.Debug))
 
 			if err := fedora.Destroy(); err != nil {
 				logging.Error(err)

diff --git a/cmd/mapt/cmd/aws/hosts/mac.go b/cmd/mapt/cmd/aws/hosts/mac.go
@@ -60,7 +60,8 @@ func getMacRequest() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 
 			// Initialize gh actions runner if needed
 			if viper.IsSet(params.InstallGHActionsRunner) {
@@ -112,7 +113,8 @@ func getMacRelease() *cobra.Command {
 			// Run create
 			if err := mac.Release(
 				"main",
-				viper.GetString(dhID)); err != nil {
+				viper.GetString(dhID),
+				viper.IsSet(params.Debug)); err != nil {
 				logging.Error(err)
 			}
 			return nil
@@ -140,7 +142,8 @@ func getMacDestroy() *cobra.Command {
 
 			if err := mac.Destroy(
 				"main",
-				viper.GetString(dhID)); err != nil {
+				viper.GetString(dhID),
+				viper.IsSet(params.Debug)); err != nil {
 				logging.Error(err)
 			}
 			return nil

diff --git a/cmd/mapt/cmd/aws/hosts/rhel.go b/cmd/mapt/cmd/aws/hosts/rhel.go
@@ -47,7 +47,8 @@ func getRHELCreate() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 
 			// Initialize gh actions runner if needed
 			if viper.IsSet(params.InstallGHActionsRunner) {
@@ -123,7 +124,8 @@ func getRHELDestroy() *cobra.Command {
 
 			maptContext.InitBase(
 				viper.GetString(params.ProjectName),
-				viper.GetString(params.BackedURL))
+				viper.GetString(params.BackedURL),
+				viper.IsSet(params.Debug))
 
 			if err := rhel.Destroy(); err != nil {
 				logging.Error(err)

diff --git a/cmd/mapt/cmd/aws/hosts/windows.go b/cmd/mapt/cmd/aws/hosts/windows.go
@@ -60,7 +60,8 @@ func getWindowsCreate() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 
 			// Initialize gh actions runner if needed
 			if viper.IsSet(params.InstallGHActionsRunner) {
@@ -117,7 +118,8 @@ func getWindowsDestroy() *cobra.Command {
 
 			maptContext.InitBase(
 				viper.GetString(params.ProjectName),
-				viper.GetString(params.BackedURL))
+				viper.GetString(params.BackedURL),
+				viper.IsSet(params.Debug))
 
 			if err := windows.Destroy(); err != nil {
 				logging.Error(err)

diff --git a/cmd/mapt/cmd/azure/hosts/linux.go b/cmd/mapt/cmd/azure/hosts/linux.go
@@ -60,7 +60,8 @@ func getCreateLinux(ostype azureLinux.OSType, defaultOSVersion string) *cobra.Co
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 
 			// ParseEvictionRate
 			var spotToleranceValue = spotAzure.DefaultEvictionRate
@@ -124,7 +125,8 @@ func getDestroyLinux() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 			if err := azureLinux.Destroy(); err != nil {
 				logging.Error(err)
 			}

diff --git a/cmd/mapt/cmd/azure/hosts/rhel.go b/cmd/mapt/cmd/azure/hosts/rhel.go
@@ -51,7 +51,8 @@ func getCreateRHEL() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 
 			// ParseEvictionRate
 			var spotToleranceValue = spotAzure.DefaultEvictionRate
@@ -133,7 +134,8 @@ func getDestroyRHEL() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 			if err := azureRHEL.Destroy(); err != nil {
 				logging.Error(err)
 			}

diff --git a/cmd/mapt/cmd/azure/hosts/windows.go b/cmd/mapt/cmd/azure/hosts/windows.go
@@ -62,7 +62,8 @@ func getCreateWindowsDesktop() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 
 			// ParseEvictionRate
 			var spotToleranceValue = spotAzure.DefaultEvictionRate
@@ -143,7 +144,8 @@ func getDestroyWindowsDesktop() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 			if err := azureWindows.Destroy(); err != nil {
 				logging.Error(err)
 			}

diff --git a/cmd/mapt/cmd/azure/services/aks.go b/cmd/mapt/cmd/azure/services/aks.go
@@ -56,7 +56,8 @@ func getCreateAKS() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 
 			// ParseEvictionRate
 			var spotToleranceValue = spotAzure.DefaultEvictionRate
@@ -111,7 +112,8 @@ func getDestroyAKS() *cobra.Command {
 				viper.GetString(params.ProjectName),
 				viper.GetString(params.BackedURL),
 				viper.GetString(params.ConnectionDetailsOutput),
-				viper.GetStringMapString(params.Tags))
+				viper.GetStringMapString(params.Tags),
+				viper.IsSet(params.Debug))
 			if err := azureAKS.Destroy(); err != nil {
 				logging.Error(err)
 			}

diff --git a/cmd/mapt/cmd/constants/constants.go b/cmd/mapt/cmd/constants/constants.go
@@ -8,9 +8,11 @@ const (
 	ProjectName                 string = "project-name"
 	ProjectNameDesc             string = "project name to identify the instance of the stack"
 	BackedURL                   string = "backed-url"
-	BackedURLDesc               string = "backed for stack state. Can be a local path with format file:///path/subpath or s3 s3://existing-bucket"
+	BackedURLDesc               string = "backed for stack state. (local) file:///path/subpath (s3) s3://existing-bucket, (azure) azblob://existing-blobcontainer. See more https://www.pulumi.com/docs/iac/concepts/state-and-backends/#using-a-self-managed-backend"
 	ConnectionDetailsOutput     string = "conn-details-output"
 	ConnectionDetailsOutputDesc string = "path to export host connection information (host, username and privateKey)"
+	Debug                       string = "debug"
+	DebugDesc                   string = "Enable debug traces and set verbosity to max. Typically to get information to troubleshooting an issue."
 	LinuxArch                   string = "arch"
 	LinuxArchDesc               string = "architecture for the machine. Allowed x86_64 or arm64"
 	LinuxArchDefault            string = "x86_64"

diff --git a/cmd/mapt/cmd/root.go b/cmd/mapt/cmd/root.go
@@ -57,6 +57,7 @@ func init() {
 	flagSet := pflag.NewFlagSet(commandName, pflag.ExitOnError)
 	flagSet.StringP(params.ProjectName, "", "", params.ProjectNameDesc)
 	flagSet.StringP(params.BackedURL, "", "", params.BackedURLDesc)
+	flagSet.Bool(params.Debug, false, params.DebugDesc)
 	rootCmd.PersistentFlags().AddFlagSet(flagSet)
 	// Subcommands
 	rootCmd.AddCommand(

diff --git a/pkg/manager/context/context.go b/pkg/manager/context/context.go
@@ -23,28 +23,31 @@ type context struct {
 	projectName           string
 	backedURL             string
 	resultsOutput         string
+	debug                 bool
 	tags                  map[string]string
 	tagsAsPulumiStringMap pulumi.StringMap
 }
 
 var c *context
 
-func Init(projectName, backedURL, resultsOutput string, tags map[string]string) {
+func Init(projectName, backedURL, resultsOutput string, tags map[string]string, debug bool) {
 	c = &context{
 		runID:         CreateRunID(),
 		projectName:   projectName,
 		backedURL:     backedURL,
 		resultsOutput: resultsOutput,
+		debug:         debug,
 		tags:          tags,
 	}
 	addCommonTags()
 	logging.Debugf("context initialized for %s", c.runID)
 }
 
-func InitBase(projectName, backedURL string) {
+func InitBase(projectName, backedURL string, debug bool) {
 	c = &context{
 		projectName: projectName,
 		backedURL:   backedURL,
+		debug:       debug,
 	}
 }
 
@@ -104,6 +107,10 @@ func StackNameByProject(stackName string) string {
 	return fmt.Sprintf("%s-%s", stackName, c.projectName)
 }
 
+func Debug() bool {
+	return c.debug
+}
+
 func addCommonTags() {
 	c.tags[tagKeyOrigin] = origin
 	c.tags[TagKeyProjectName] = c.projectName

diff --git a/pkg/manager/manager.go b/pkg/manager/manager.go
@@ -9,6 +9,7 @@ import (
 	"github.com/pulumi/pulumi/sdk/v3/go/auto/optdestroy"
 	"github.com/pulumi/pulumi/sdk/v3/go/auto/optup"
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
+	maptContext "github.com/redhat-developer/mapt/pkg/manager/context"
 	"github.com/redhat-developer/mapt/pkg/manager/credentials"
 	"github.com/redhat-developer/mapt/pkg/util/logging"
 )
@@ -27,6 +28,8 @@ type ManagerOptions struct {
 	Baground bool
 }
 
+var logLevel uint = 9
+
 func UpStack(targetStack Stack, opts ...ManagerOptions) (auto.UpResult, error) {
 	return UpStackTargets(targetStack, nil, opts...)
 }
@@ -38,11 +41,16 @@ func UpStackTargets(targetStack Stack, targetURNs []string, opts ...ManagerOptio
 	// TODO add when loglevel debug control in place
 	w := logging.GetWritter()
 	defer w.Close()
-	var logLevel uint = 10
 	mOpts := []optup.Option{
 		optup.ProgressStreams(w),
-		optup.DebugLogging(
-			debug.LoggingOptions{LogLevel: &logLevel}),
+	}
+	if maptContext.Debug() {
+		mOpts = append(mOpts, optup.DebugLogging(
+			debug.LoggingOptions{
+				LogLevel:      &logLevel,
+				Debug:         true,
+				FlowToPlugins: true,
+				LogToStdErr:   true}))
 	}
 	if len(targetURNs) > 0 {
 		mOpts = append(mOpts, optup.Target(targetURNs))
@@ -64,8 +72,18 @@ func DestroyStack(targetStack Stack, opts ...ManagerOptions) (err error) {
 	objectStack := getStack(ctx, targetStack)
 	w := logging.GetWritter()
 	defer w.Close()
-	stdoutStreamer := optdestroy.ProgressStreams(w)
-	if _, err := objectStack.Destroy(ctx, stdoutStreamer); err != nil {
+	// stdoutStreamer := optdestroy.ProgressStreams(w)
+	mOpts := []optdestroy.Option{
+		optdestroy.ProgressStreams(w),
+	}
+	if maptContext.Debug() {
+		mOpts = append(mOpts, optdestroy.DebugLogging(
+			debug.LoggingOptions{
+				LogLevel:      &logLevel,
+				FlowToPlugins: true,
+				LogToStdErr:   true}))
+	}
+	if _, err := objectStack.Destroy(ctx, mOpts...); err != nil {
 		logging.Error(err)
 		os.Exit(1)
 	}

diff --git a/pkg/provider/aws/action/mac/mac.go b/pkg/provider/aws/action/mac/mac.go
@@ -66,7 +66,7 @@ func Request(r *MacRequest) error {
 // get projectName (tag on the dh)
 // load machine stack based on those params
 // run release update on it
-func Release(prefix string, hostID string) error {
+func Release(prefix string, hostID string, debug bool) error {
 	host, err := data.GetDedicatedHost(hostID)
 	if err != nil {
 		return err
@@ -75,7 +75,7 @@ func Release(prefix string, hostID string) error {
 	// Set context based on info from dedicated host to be released
 	maptContext.InitBase(
 		*hi.ProjectName,
-		*hi.BackedURL)
+		*hi.BackedURL, debug)
 
 	// Set a default request
 	r := &MacRequest{
@@ -89,7 +89,7 @@ func Release(prefix string, hostID string) error {
 // Initial scenario consider 1 machine
 // If we request destroy mac machine it will look for any machine
 // and check if it is locked if not locked it will destroy it
-func Destroy(prefix, hostID string) error {
+func Destroy(prefix, hostID string, debug bool) error {
 	host, err := data.GetDedicatedHost(hostID)
 	if err != nil {
 		return err
@@ -98,7 +98,7 @@ func Destroy(prefix, hostID string) error {
 	// Set context based on info from dedicated host to be released
 	maptContext.InitBase(
 		*hi.ProjectName,
-		*hi.BackedURL)
+		*hi.BackedURL, debug)
 	// Dedicated host is not on a valid state to be deleted
 	// With same backedURL check if machine is locked
 	machineLocked, err := isMachineLocked(prefix, hi)