feat: improve configuration parsing #24
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pkg/config/config.go
Outdated
|
|
||
| var Config AppConfig | ||
|
|
||
| func ReadConfig(f *pflag.FlagSet, configFile string) error { |
There was a problem hiding this comment.
ReadConfig reads more like reading the configuration from file, but we are doing more a generating of the configuration in this case,
Therefore i would suggest renaming to:
Suggested change
| func ReadConfig(f *pflag.FlagSet, configFile string) error { | |
| func GenerateConfig(f *pflag.FlagSet, configFile string) error { |
bavarianbidi
approved these changes
Nov 21, 2023
Co-authored-by: bavarianbidi <mario.constanti@mercedes-benz.com>
bavarianbidi
requested changes
Nov 21, 2023
README.md
Outdated
| curl -L https://github.com/mercedes-benz/garm-operator/releases/download/${GARM_OPERATOR_VERSION}/garm-operator-all.yaml | envsubst | kubectl apply -f - | ||
| ``` | ||
|
|
||
| The Full Configuration Parsing Documentation can be found in the [configuration parsing guide](./docs/config/configuration-parsing.md) |
There was a problem hiding this comment.
Suggested change
| The Full Configuration Parsing Documentation can be found in the [configuration parsing guide](./docs/config/configuration-parsing.md) | |
| The full configuration parsing documentation can be found in the [configuration parsing guide](./docs/config/configuration-parsing.md) |
docs/config/configuration-parsing.md
Outdated
|
|
||
| # Configuration Parsing | ||
|
|
||
| The Configuration Parsing for the Garm Operator is implemented with [koanf](https://github.com/knadh/koanf). |
There was a problem hiding this comment.
Suggested change
| The Configuration Parsing for the Garm Operator is implemented with [koanf](https://github.com/knadh/koanf). | |
| The configuration parsing for the Garm Operator is implemented with [koanf](https://github.com/knadh/koanf). |
docs/config/configuration-parsing.md
Outdated
|
|
||
| The Configuration Parsing for the Garm Operator is implemented with [koanf](https://github.com/knadh/koanf). | ||
|
|
||
| The Configuration can be defined with `ENVs`, `Flags` and `config file (yaml)`. |
There was a problem hiding this comment.
Suggested change
| The Configuration can be defined with `ENVs`, `Flags` and `config file (yaml)`. | |
| The configuration can be defined with `ENVs`, `Flags` and `config file (yaml)`. |
docs/config/configuration-parsing.md
Outdated
|
|
||
| For the Garm Operator the following order is defined, which is to be considered in ascending order from lowest to highest priority: | ||
|
|
||
| 1. Defined Default Values ([see section Configuration Default Values](#configuration-default-values)) |
There was a problem hiding this comment.
Suggested change
| 1. Defined Default Values ([see section Configuration Default Values](#configuration-default-values)) | |
| 1. Defined default values ([see section configuration default values](#configuration-default-values)) |
docs/config/configuration-parsing.md
Outdated
| --dry-run | ||
| ``` | ||
|
|
||
| The `--config` flag can be set to specify the path to the `config file (yaml)` which contains the configuration ([see section Config File Strucutre](#config-file-structure)). |
There was a problem hiding this comment.
Suggested change
| The `--config` flag can be set to specify the path to the `config file (yaml)` which contains the configuration ([see section Config File Strucutre](#config-file-structure)). | |
| The `--config` flag can be set to specify the path to the `config file (yaml)` which contains the configuration ([see section config file structure](#config-file-structure)). |
docs/config/configuration-parsing.md
Outdated
|
|
||
| The `--config` flag can be set to specify the path to the `config file (yaml)` which contains the configuration ([see section Config File Strucutre](#config-file-structure)). | ||
|
|
||
| The `--dry-run` flag can be set to show the parsed configuration, without starting the Garm Operator. The Output can be similar to the following: |
There was a problem hiding this comment.
Suggested change
| The `--dry-run` flag can be set to show the parsed configuration, without starting the Garm Operator. The Output can be similar to the following: | |
| The `--dry-run` flag can be set to show the parsed configuration, without starting the Garm Operator. The output can be similar to the following: |
docs/config/configuration-parsing.md
Outdated
|
|
||
| ## Parsing Validation | ||
|
|
||
| After the Configuration has been parsed by koanf and unmarshelled into a struct, the [validator](https://github.com/go-playground/validator) checks whether the generated struct is valid or not. |
There was a problem hiding this comment.
Suggested change
| After the Configuration has been parsed by koanf and unmarshelled into a struct, the [validator](https://github.com/go-playground/validator) checks whether the generated struct is valid or not. | |
| After the configuration has been parsed by koanf and unmarshalled into a struct, the [validator](https://github.com/go-playground/validator) checks whether the generated struct is valid or not. |
bavarianbidi
approved these changes
Nov 21, 2023
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR ensures, that the configuration of the garm-operator can be done with
ENVs,FlagsandConfig File (yaml)