Add defaults to Zowe yaml configuration #4017
Open
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
Signed-off-by: Martin Zeithaml <[email protected]>
Martin-Zeithaml
added
wip: do not merge
area: install and config
|
😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.
Need help? Contact the Doc Squad in the #zowe-doc Slack channel. |
Signed-off-by: Martin Zeithaml <[email protected]>
Signed-off-by: Martin Zeithaml <[email protected]>
Martin-Zeithaml
added
review: doc
janan07
reviewed
Nov 26, 2024
| ### Configuration override | ||
| ### Configuration override - defaults.yaml | ||
|
|
||
| There is a [`defaults.yaml`](https://github.com/zowe/zowe-install-packaging/blob/v3.x/staging/files/defaults.yaml) file, which defines values for global configuration and components. This file is always merged with current config(s) when `configmgr` is used. |
There was a problem hiding this comment.
Won't this address be v3.x/master and not v3.x/staging when this goes GA? Should this PR be targeting master or docs-staging?
There was a problem hiding this comment.
The defaults.yaml feature was added to Zowe 2.17. This should go to 2.17 and later. And V3 too.
janan07
reviewed
Nov 26, 2024
|
|
||
| For example, if you decide to remove `zowe.job` section by commenting or deleting, after the merging with the defaults the `zowe.job` section will be present again: | ||
|
|
||
| **Example of user config:** |
There was a problem hiding this comment.
Perhaps it would be useful to show the initial configuration prior to the user config.
Signed-off-by: Martin Zeithaml <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
…we/docs-site into Martin-Zeithaml-defaults-yaml
Signed-off-by: Martin Zeithaml <[email protected]>
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.
Describe your pull request here:
With Zowe 2.17, there is a
defaults.yamlfile, which is always merged with current config. There are some consequences, which should be documented.What might be confusing for users, is existing paragraph about Configuration override. This is using defaults defined inside the config only. With the
defaults.yamlyou have another sets of defaults, which makes it complicated to describe and use.Note: The
defaults.yamlfile and the merging of configs was added in 2.17.List the file(s) included in this PR:
docs/appendix/zowe-yaml-configuration.md
After creating the PR, follow the instructions in the comments.