Update Atmos logs. Update docs (#605)

* updates * updates * updates * updates * updates * updates * Update website/docs/cli/configuration.mdx Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]> * Update website/docs/cli/configuration.mdx Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]> * updates * updates * updates --------- Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
cloudposse · May 23, 2024 · df1c9bb · df1c9bb
1 parent f7aa382
commit df1c9bb
Show file tree

Hide file tree

Showing 31 changed files with 292 additions and 51 deletions.
diff --git a/.github/settings.yml b/.github/settings.yml
@@ -3,5 +3,5 @@ _extends: .github
 repository:
   name: atmos
   description: 👽 Terraform Orchestration Tool for DevOps. Keep environment configuration DRY with hierarchical imports of configurations, inheritance, and WAY more. Native support for Terraform and Helmfile.
-  homepage: https://cloudposse.com/accelerate
+  homepage: https://atmos.tools
   topics: ""
diff --git a/atmos.yaml b/atmos.yaml
@@ -74,7 +74,9 @@ workflows:
 
 logs:
   # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
-  file: "/dev/stdout"
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
   # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info

diff --git a/examples/quick-start/Dockerfile b/examples/quick-start/Dockerfile
@@ -6,7 +6,7 @@ ARG GEODESIC_OS=debian
 # https://atmos.tools/
 # https://github.com/cloudposse/atmos
 # https://github.com/cloudposse/atmos/releases
-ARG ATMOS_VERSION=1.73.0
+ARG ATMOS_VERSION=1.74.0
 
 # Terraform: https://github.com/hashicorp/terraform/releases
 ARG TF_VERSION=1.8.1

diff --git a/examples/quick-start/atmos.yaml b/examples/quick-start/atmos.yaml
@@ -74,7 +74,9 @@ workflows:
 
 logs:
   # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
-  file: "/dev/stdout"
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
   # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info

diff --git a/examples/quick-start/rootfs/usr/local/etc/atmos/atmos.yaml b/examples/quick-start/rootfs/usr/local/etc/atmos/atmos.yaml
@@ -73,8 +73,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands

diff --git a/examples/tests/atmos.yaml b/examples/tests/atmos.yaml
@@ -81,7 +81,9 @@ workflows:
 
 logs:
   # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
-  file: "/dev/stdout"
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
   # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info

diff --git a/examples/tests/rootfs/usr/local/etc/atmos/atmos.yaml b/examples/tests/rootfs/usr/local/etc/atmos/atmos.yaml
@@ -75,8 +75,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands

diff --git a/internal/exec/describe_affected_utils.go b/internal/exec/describe_affected_utils.go
@@ -514,8 +514,6 @@ func executeDescribeAffected(
 		return nil, err
 	}
 
-	u.LogTrace(cliConfig, "\nAffected components and stacks:\n")
-
 	return affected, nil
 }
 

diff --git a/internal/exec/helmfile.go b/internal/exec/helmfile.go
@@ -89,7 +89,7 @@ func ExecuteHelmfile(info schema.ConfigAndStacksInfo) error {
 	u.LogDebug(cliConfig, fmt.Sprintf("\nVariables for the component '%s' in the stack '%s':", info.ComponentFromArg, info.Stack))
 
 	if cliConfig.Logs.Level == u.LogLevelTrace || cliConfig.Logs.Level == u.LogLevelDebug {
-		err = u.PrintAsYAML(info.ComponentVarsSection)
+		err = u.PrintAsYAMLToFileDescriptor(cliConfig, info.ComponentVarsSection)
 		if err != nil {
 			return err
 		}

diff --git a/internal/exec/helmfile_generate_varfile.go b/internal/exec/helmfile_generate_varfile.go
@@ -61,7 +61,7 @@ func ExecuteHelmfileGenerateVarfileCmd(cmd *cobra.Command, args []string) error
 	u.LogDebug(cliConfig, fmt.Sprintf("\nVariables for the component '%s' in the stack '%s':", info.ComponentFromArg, info.Stack))
 
 	if cliConfig.Logs.Level == u.LogLevelTrace || cliConfig.Logs.Level == u.LogLevelDebug {
-		err = u.PrintAsYAML(info.ComponentVarsSection)
+		err = u.PrintAsYAMLToFileDescriptor(cliConfig, info.ComponentVarsSection)
 		if err != nil {
 			return err
 		}

diff --git a/internal/exec/terraform.go b/internal/exec/terraform.go
@@ -147,7 +147,7 @@ func ExecuteTerraform(info schema.ConfigAndStacksInfo) error {
 		u.LogDebug(cliConfig, fmt.Sprintf("\nVariables for the component '%s' in the stack '%s':", info.ComponentFromArg, info.Stack))
 
 		if cliConfig.Logs.Level == u.LogLevelTrace || cliConfig.Logs.Level == u.LogLevelDebug {
-			err = u.PrintAsYAML(info.ComponentVarsSection)
+			err = u.PrintAsYAMLToFileDescriptor(cliConfig, info.ComponentVarsSection)
 			if err != nil {
 				return err
 			}

diff --git a/internal/exec/terraform_generate_backend.go b/internal/exec/terraform_generate_backend.go
@@ -60,7 +60,7 @@ func ExecuteTerraformGenerateBackendCmd(cmd *cobra.Command, args []string) error
 	u.LogDebug(cliConfig, "Component backend config:\n\n")
 
 	if cliConfig.Logs.Level == u.LogLevelTrace || cliConfig.Logs.Level == u.LogLevelDebug {
-		err = u.PrintAsJSON(componentBackendConfig)
+		err = u.PrintAsJSONToFileDescriptor(cliConfig, componentBackendConfig)
 		if err != nil {
 			return err
 		}

diff --git a/internal/exec/terraform_generate_varfile.go b/internal/exec/terraform_generate_varfile.go
@@ -61,7 +61,7 @@ func ExecuteTerraformGenerateVarfileCmd(cmd *cobra.Command, args []string) error
 	u.LogDebug(cliConfig, fmt.Sprintf("\nVariables for the component '%s' in the stack '%s':", info.ComponentFromArg, info.Stack))
 
 	if cliConfig.Logs.Level == u.LogLevelTrace || cliConfig.Logs.Level == u.LogLevelDebug {
-		err = u.PrintAsYAML(info.ComponentVarsSection)
+		err = u.PrintAsYAMLToFileDescriptor(cliConfig, info.ComponentVarsSection)
 		if err != nil {
 			return err
 		}

diff --git a/internal/exec/utils.go b/internal/exec/utils.go
@@ -296,7 +296,7 @@ func ProcessStacks(
 			msg = "\nFound stack manifests:"
 		}
 		u.LogTrace(cliConfig, msg)
-		err = u.PrintAsYAML(cliConfig.StackConfigFilesRelativePaths)
+		err = u.PrintAsYAMLToFileDescriptor(cliConfig, cliConfig.StackConfigFilesRelativePaths)
 		if err != nil {
 			return configAndStacksInfo, err
 		}

diff --git a/internal/exec/worflow_utils.go b/internal/exec/worflow_utils.go
@@ -42,7 +42,7 @@ func ExecuteWorkflow(
 	logFunc(cliConfig, fmt.Sprintf("\nExecuting the workflow '%s' from '%s'\n", workflow, workflowPath))
 
 	if cliConfig.Logs.Level == u.LogLevelTrace || cliConfig.Logs.Level == u.LogLevelDebug {
-		err := u.PrintAsYAML(workflowDefinition)
+		err := u.PrintAsYAMLToFileDescriptor(cliConfig, workflowDefinition)
 		if err != nil {
 			return err
 		}

diff --git a/pkg/atlantis/atmos.yaml b/pkg/atlantis/atmos.yaml
@@ -63,8 +63,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands

diff --git a/pkg/aws/atmos.yaml b/pkg/aws/atmos.yaml
@@ -63,8 +63,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands

diff --git a/pkg/component/atmos.yaml b/pkg/component/atmos.yaml
@@ -63,8 +63,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands

diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -194,12 +194,12 @@ func InitCliConfig(configAndStacksInfo schema.ConfigAndStacksInfo, processStacks
 		// If `atmos.yaml` not found, use the default config
 		// Set `ATMOS_LOGS_LEVEL` ENV var to "Debug" to see the message about Atmos using the default CLI config
 		logsLevelEnvVar := os.Getenv("ATMOS_LOGS_LEVEL")
-		if logsLevelEnvVar == "Debug" {
+		if logsLevelEnvVar == u.LogLevelDebug || logsLevelEnvVar == u.LogLevelTrace {
 			u.PrintMessageInColor("'atmos.yaml' CLI config was not found in any of the searched paths: system dir, home dir, current dir, ENV vars.\n"+
 				"Refer to https://atmos.tools/cli/configuration for details on how to configure 'atmos.yaml'.\n"+
 				"Using the default CLI config:\n\n", color.New(color.FgCyan))
 
-			err = u.PrintAsYAML(defaultCliConfig)
+			err = u.PrintAsYAMLToFileDescriptor(cliConfig, defaultCliConfig)
 			if err != nil {
 				return cliConfig, err
 			}

diff --git a/pkg/describe/atmos.yaml b/pkg/describe/atmos.yaml
@@ -63,8 +63,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands

diff --git a/pkg/generate/atmos.yaml b/pkg/generate/atmos.yaml
@@ -63,8 +63,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands

diff --git a/pkg/spacelift/atmos.yaml b/pkg/spacelift/atmos.yaml
@@ -63,8 +63,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands

diff --git a/pkg/utils/json_utils.go b/pkg/utils/json_utils.go
@@ -1,13 +1,14 @@
 package utils
 
 import (
+	"github.com/cloudposse/atmos/pkg/schema"
 	"os"
 	"strings"
 
 	jsoniter "github.com/json-iterator/go"
 )
 
-// PrintAsJSON prints the provided value as YAML document to the console
+// PrintAsJSON prints the provided value as JSON document to the console
 func PrintAsJSON(data any) error {
 	j, err := ConvertToJSON(data)
 	if err != nil {
@@ -17,7 +18,17 @@ func PrintAsJSON(data any) error {
 	return nil
 }
 
-// WriteToFileAsJSON converts the provided value to YAML and writes it to the specified file
+// PrintAsJSONToFileDescriptor prints the provided value as JSON document to a file descriptor
+func PrintAsJSONToFileDescriptor(cliConfig schema.CliConfiguration, data any) error {
+	j, err := ConvertToJSON(data)
+	if err != nil {
+		return err
+	}
+	LogInfo(cliConfig, j)
+	return nil
+}
+
+// WriteToFileAsJSON converts the provided value to JSON and writes it to the specified file
 func WriteToFileAsJSON(filePath string, data any, fileMode os.FileMode) error {
 	j, err := ConvertToJSON(data)
 	if err != nil {

diff --git a/pkg/utils/yaml_utils.go b/pkg/utils/yaml_utils.go
@@ -4,6 +4,8 @@ import (
 	"os"
 
 	"gopkg.in/yaml.v2"
+
+	"github.com/cloudposse/atmos/pkg/schema"
 )
 
 // PrintAsYAML prints the provided value as YAML document to the console
@@ -16,6 +18,16 @@ func PrintAsYAML(data any) error {
 	return nil
 }
 
+// PrintAsYAMLToFileDescriptor prints the provided value as YAML document to a file descriptor
+func PrintAsYAMLToFileDescriptor(cliConfig schema.CliConfiguration, data any) error {
+	y, err := ConvertToYAML(data)
+	if err != nil {
+		return err
+	}
+	LogInfo(cliConfig, y)
+	return nil
+}
+
 // WriteToFileAsYAML converts the provided value to YAML and writes it to the specified file
 func WriteToFileAsYAML(filePath string, data any, fileMode os.FileMode) error {
 	y, err := ConvertToYAML(data)

diff --git a/pkg/validate/atmos.yaml b/pkg/validate/atmos.yaml
@@ -63,8 +63,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands

diff --git a/pkg/vender/atmos.yaml b/pkg/vender/atmos.yaml
@@ -63,8 +63,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands

diff --git a/pkg/workflow/atmos.yaml b/pkg/workflow/atmos.yaml
@@ -63,8 +63,12 @@ workflows:
   base_path: "stacks/workflows"
 
 logs:
-  file: "/dev/stdout"
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
   # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
   level: Info
 
 # Custom CLI commands