-
Notifications
You must be signed in to change notification settings - Fork 133
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add defaults to Zowe yaml configuration #4017
Merged
Merged
Changes from 3 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
6808eae
Add defaults to Zowe yaml configuration
Martin-Zeithaml 94eb9bf
Add defaults.yaml section
Martin-Zeithaml 70309d9
Minor update
Martin-Zeithaml e8b6cba
Update zowe-yaml-configuration.md
Martin-Zeithaml 720d434
language refactor and inline comment
janan07 88d7a7c
Merge branch 'Martin-Zeithaml-defaults-yaml' of https://github.com/zo…
janan07 99fee75
Merge branch 'master' into Martin-Zeithaml-defaults-yaml
janan07 b767dcc
Add note
Martin-Zeithaml 982ccfa
Merge branch 'master' into Martin-Zeithaml-defaults-yaml
Martin-Zeithaml ffeb206
Merge branch 'master' into Martin-Zeithaml-defaults-yaml
janan07 6ea2d2e
formatting refactor
janan07 25b08a0
Merge branch 'master' into Martin-Zeithaml-defaults-yaml
janan07 acb11e7
Merge branch 'master' into Martin-Zeithaml-defaults-yaml
janan07 3cc3995
fix anchor link
janan07 d731a4e
Merge branch 'Martin-Zeithaml-defaults-yaml' of https://github.com/zo…
janan07 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -46,7 +46,32 @@ The Zowe YAML configuration file has template logic for relating one value to an | |
It can help to make your configuration portable between systems that need slightly different behavior while retaining the same configuration file. | ||
More details can be found [in the configmgr documentation.](../user-guide/configmgr-using.md#configuration-templates) | ||
|
||
### 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. | ||
|
||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Perhaps it would be useful to show the initial configuration prior to the user config. |
||
|
||
```yaml | ||
zowe: | ||
# job: | ||
# Zowe JES job name | ||
# name: ZW3SV1 | ||
# Prefix of component address space | ||
# prefix: ZW31 | ||
``` | ||
|
||
**Example of merged result:** | ||
|
||
```yaml | ||
zowe: | ||
job: | ||
name: ZWE1SV | ||
prefix: ZWE1 | ||
``` | ||
### Configuration override - inside zowe.yaml | ||
|
||
Inside `zowe.yaml`, you can define default values and they may be overridden in more granular level configurations. This can happen in several ways: | ||
|
||
|
@@ -293,7 +318,7 @@ zowe: | |
- `zowe.setup.security.groups.stc` is the group for Zowe started tasks. This configuration is optional. The default value is `ZWEADMIN`. | ||
- `zowe.setup.security.groups.sysProg` is system programmer user ID/group. This configuration is optional. The default value is `ZWEADMIN`. | ||
- `zowe.setup.security.users.zowe` is the userid for Zowe started task. This configuration is optional. The default value is `ZWESVUSR`. | ||
- `zowe.setup.security.users.zis` is userid for ZIS started task. This configuration is optional. Th default value is `ZWESIUSR`. | ||
- `zowe.setup.security.users.zis` is userid for ZIS started task. This configuration is optional. The default value is `ZWESIUSR`. | ||
- `zowe.setup.security.stcs.zowe` is Zowe started task name. This configuration is optional. The default value is `ZWESLSTC`. | ||
- `zowe.setup.security.stcs.zis` is ZIS started task name. This configuration is optional. The default value is `ZWESISTC`. | ||
- `zowe.setup.security.stcs.aux` is ZIS AUX started task name. This configuration is optional. The default value is `ZWESASTC`. | ||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
defaults.yaml
feature was added to Zowe 2.17. This should go to 2.17 and later. And V3 too.