From 01bbdde09a5bbaffbb9d4ababe27b267925370e9 Mon Sep 17 00:00:00 2001 From: mmattel Date: Wed, 8 Nov 2023 15:28:31 +0100 Subject: [PATCH 1/3] [docs-only] Fix some Audit envvar description texts --- services/audit/pkg/config/config.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/services/audit/pkg/config/config.go b/services/audit/pkg/config/config.go index 54384e54a..475c9078e 100644 --- a/services/audit/pkg/config/config.go +++ b/services/audit/pkg/config/config.go @@ -33,10 +33,10 @@ type Events struct { // Auditlog holds audit log information type Auditlog struct { - LogToConsole bool `yaml:"log_to_console" env:"AUDIT_LOG_TO_CONSOLE" desc:"Logs to Stdout if true. Independent of the log to file option."` - LogToFile bool `yaml:"log_to_file" env:"AUDIT_LOG_TO_FILE" desc:"Logs to file if true. Independent of the log to Stdout file option."` - FilePath string `yaml:"filepath" env:"AUDIT_FILEPATH" desc:"Filepath to the logfile. Mandatory if LogToFile is true."` - Format string `yaml:"format" env:"AUDIT_FORMAT" desc:"Log format. Using json is advised."` + LogToConsole bool `yaml:"log_to_console" env:"AUDIT_LOG_TO_CONSOLE" desc:"Logs to stdout if set to 'true'. Independent of the LOG_TO_FILE option."` + LogToFile bool `yaml:"log_to_file" env:"AUDIT_LOG_TO_FILE" desc:"Logs to file if set to 'true'. Independent of the LOG_TO_CONSOLE option."` + FilePath string `yaml:"filepath" env:"AUDIT_FILEPATH" desc:"Filepath of the logfile. Mandatory if LOG_TO_FILE is set to 'true'."` + Format string `yaml:"format" env:"AUDIT_FORMAT" desc:"Log format. Supported vales are '' (empty) and 'json'. Using 'json' is advised, '' (empty) renders the 'minimal' format. See the text description for details."` } // Tracing defines the available tracing configuration. From ed3ae669b602e75155d583e7ca7be072c6363f81 Mon Sep 17 00:00:00 2001 From: mmattel Date: Wed, 8 Nov 2023 15:32:02 +0100 Subject: [PATCH 2/3] fix typo --- services/audit/pkg/config/config.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/services/audit/pkg/config/config.go b/services/audit/pkg/config/config.go index 475c9078e..cc0fc70de 100644 --- a/services/audit/pkg/config/config.go +++ b/services/audit/pkg/config/config.go @@ -36,7 +36,7 @@ type Auditlog struct { LogToConsole bool `yaml:"log_to_console" env:"AUDIT_LOG_TO_CONSOLE" desc:"Logs to stdout if set to 'true'. Independent of the LOG_TO_FILE option."` LogToFile bool `yaml:"log_to_file" env:"AUDIT_LOG_TO_FILE" desc:"Logs to file if set to 'true'. Independent of the LOG_TO_CONSOLE option."` FilePath string `yaml:"filepath" env:"AUDIT_FILEPATH" desc:"Filepath of the logfile. Mandatory if LOG_TO_FILE is set to 'true'."` - Format string `yaml:"format" env:"AUDIT_FORMAT" desc:"Log format. Supported vales are '' (empty) and 'json'. Using 'json' is advised, '' (empty) renders the 'minimal' format. See the text description for details."` + Format string `yaml:"format" env:"AUDIT_FORMAT" desc:"Log format. Supported values are '' (empty) and 'json'. Using 'json' is advised, '' (empty) renders the 'minimal' format. See the text description for details."` } // Tracing defines the available tracing configuration. From 80b5a6bbe7d7ddb5be3ea72adc7ac2315830a85c Mon Sep 17 00:00:00 2001 From: Martin Date: Wed, 8 Nov 2023 15:48:12 +0100 Subject: [PATCH 3/3] Update services/audit/pkg/config/config.go --- services/audit/pkg/config/config.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/services/audit/pkg/config/config.go b/services/audit/pkg/config/config.go index cc0fc70de..8fd6cc2b6 100644 --- a/services/audit/pkg/config/config.go +++ b/services/audit/pkg/config/config.go @@ -36,7 +36,7 @@ type Auditlog struct { LogToConsole bool `yaml:"log_to_console" env:"AUDIT_LOG_TO_CONSOLE" desc:"Logs to stdout if set to 'true'. Independent of the LOG_TO_FILE option."` LogToFile bool `yaml:"log_to_file" env:"AUDIT_LOG_TO_FILE" desc:"Logs to file if set to 'true'. Independent of the LOG_TO_CONSOLE option."` FilePath string `yaml:"filepath" env:"AUDIT_FILEPATH" desc:"Filepath of the logfile. Mandatory if LOG_TO_FILE is set to 'true'."` - Format string `yaml:"format" env:"AUDIT_FORMAT" desc:"Log format. Supported values are '' (empty) and 'json'. Using 'json' is advised, '' (empty) renders the 'minimal' format. See the text description for details."` + Format string `yaml:"format" env:"AUDIT_FORMAT" desc:"Log format. Supported values are '' (empty) and 'json'. Using 'json' is advised, '' (empty) renders the 'minimal' format. See the text description for more details."` } // Tracing defines the available tracing configuration.