Skip to content
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 15 commits into from
Dec 10, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions docs/appendix/zowe-yaml-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

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?

Copy link
Collaborator Author

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.


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:**
Copy link
Collaborator

Choose a reason for hiding this comment

The 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:

Expand Down Expand Up @@ -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`.
Expand Down
Loading