Implement global tsh config file: /etc/tsh.yaml
#12598
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
* The user config file is merged into global config file, taking precedence. * If the global config file is absent, no error is raised.
github-actions
bot
requested review from
gabrielcorado,
nklaassen,
ptgott,
r0mant,
xinding33 and
zmb3
github-actions
bot
added
documentation
tsh
r0mant
approved these changes
May 12, 2022
tool/tsh/tshconfig.go
Outdated
| @@ -46,6 +52,26 @@ type ExtraProxyHeaders struct { | |||
| Headers map[string]string `yaml:"headers,omitempty"` | |||
| } | |||
|
|
|||
| // Merge two configs into one. The config from parameter has higher priority. | |||
There was a problem hiding this comment.
Nit: (Just so it's a little clearer)
Suggested change
| // Merge two configs into one. The config from parameter has higher priority. | |
| // Merge two configs into one. The passed in otherConfig has higher priority. |
gabrielcorado
approved these changes
May 12, 2022
| // Merge two configs into one. The config from parameter has higher priority. | ||
| func (config *TshConfig) Merge(otherConfig *TshConfig) TshConfig { | ||
| baseConfig := config | ||
| if baseConfig == nil { |
There was a problem hiding this comment.
Why is the nil check necessary here? The loadAllConfigs is not ignoring errors from loadConfig (which could generate those nil pointers).
In addition, it feels a bit contra-intuitive to call a method from a nil pointer (even if it is possible), so calling something like (*config)(nil).Merge(otherConfig) would return a valid result.
There was a problem hiding this comment.
Semantically nil and &TshConfig{} have exactly the same amount of information: zero, so it makes sense for the function to treat them equally. These assignments make it easier to implement the rest of the function, as I don't need to be on guard against nil pointers.
In the future (when I implement the rest of the RFD) there will be more fields to merge and having nil pointers makes it uglier.
Tener
added a commit
that referenced
this pull request
May 13, 2022
* Implement global tsh config file: `/etc/tsh.yaml`. The default location can be changed with `TELEPORT_GLOBAL_TSH_CONFIG` env var. * The user config file is merged with the global config file. The user config file has a higher priority. * If the global config file is absent, no error is raised.
Tener
added a commit
that referenced
this pull request
May 13, 2022
* Implement global tsh config file: `/etc/tsh.yaml`. The default location can be changed with `TELEPORT_GLOBAL_TSH_CONFIG` env var. * The user config file is merged with the global config file. The user config file has a higher priority. * If the global config file is absent, no error is raised.
Tener
added a commit
that referenced
this pull request
May 13, 2022
* Implement global tsh config file: `/etc/tsh.yaml`. The default location can be changed with `TELEPORT_GLOBAL_TSH_CONFIG` env var. * The user config file is merged with the global config file. The user config file has a higher priority. * If the global config file is absent, no error is raised.
Tener
added a commit
that referenced
this pull request
May 16, 2022
* Implement global tsh config file: `/etc/tsh.yaml`. The default location can be changed with `TELEPORT_GLOBAL_TSH_CONFIG` env var. * The user config file is merged with the global config file. The user config file has a higher priority. * If the global config file is absent, no error is raised.
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.
/etc/tsh.yaml, can be overridden withTELEPORT_TSH_CONFIG.Original, partial spec in RFD: https://github.com/gravitational/teleport/blob/master/rfd/0061-tsh-aliases.md#global-tsh-config
Fixes #12342.