What is the default? (should be a technical, not philosophical question)

[Martin-Zeithaml]

Defaults - we have trapped ourselves

• ZWE_zowe_runtimeDirectory/example-zowe.yaml is our best practice or recommendation
  • Not mandatory to use => not the defaults
• ZWE_zowe_runtimeDirectory/files/defaults.yaml is our default set of keys and values
  • Silently and mandatory to use
  • Any missing key is potentially replaced from here => real defaults

Example

# zowe.yaml
zowe:
  useConfigmgr: true

The result is merged config of zowe.yaml and ZWE_zowe_runtimeDirectory/files/defaults.yaml

$ /zowe/bin: ./zwe config get  --config zowe.yaml --path .components.gateway.apiml.security.auth --format
Temporary directory '/tmp/.zweenv-8479' created.
Zowe will remove it on success, but if zwe exits with a non-zero code manual cleanup would be needed.
{
  "provider": "zosmf",
  "zosmf": {
    "jwtAutoconfiguration": "jwt",
    "serviceId": "ibmzosmf"
  }
}

Problem

Doc: System Authorization Facility (SAF) is the default authentication provider:

• The default value in example-zowe.yaml is saf
• The default value in defaults.yaml is zosmf
• If we state, the default is key=default_value, IMHO omitting key must be the same as using key=default_value

Solution

Is to state which default, for example following are true:

• System Authorization Facility (SAF) is the default authentication provider in example-zowe.yaml
• zosmf is the default authentication provider
• zosmf is the default authentication provider (defined in defaults.yaml)

Key question

If you think this is confusing or you don't understand what's going on, what customers will think?