using environment var setting in ZE doc

[anaxceron]

Describe your pull request here: Addressing Issue 4682 to document how to use environment variables in a config file for ZE

List the file(s) included in this PR: docs\user-guide\ze-using-using-environment-variables.md, docs\user-guide\ze-install-configuring-ze.md

After creating the PR, follow the instructions in the comments.

[github-actions]

😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these steps.

• Add the label review: sme if an SME needs to check your content.
• Identify your content topic with a label. (Examples: area: apiml, area: cli, area: install and config, etc.)
• Specify the major Zowe release(s) for your content. (Examples: release: V1, release: V2, release: V3)
  • If adding content that needs to be removed from V3 documentation, add the V3 N/A tag.
• Link any Doc Issues related to this PR.
• Fix broken links found in your content areas.
• Notify the SME to review this PR (if applicable).
• Merge to the master branch if your PR updates content that is on the live site. Merge to docs-staging if your PR updates content for a future release.

[github-actions]

🚀 Deployed on https://6903b7ae239ece37df8a8c85--zowe-docs-master.netlify.app

[adam-wolfe]

If the Override With Environment Variables checkbox is checked, Zowe Explorer will use the values in $ZOWE_OPT_USER and $ZOWE_OPT_PASSWORD for user ID and password (regardless of what is in your config).

So, some ZOWE_OPT environment variables can be used by Zowe Explorer.

I might rephrase to something like: "If you need to connect to multiple LPARs using different credentials, do not use the ZOWE_OPT prefix for these environment variables. ZOWE_OPT is used by Zowe CLI to identify command options defined in environment variables."

[adam-wolfe]

Actually, the rephrasing might be more confusing.

If you only need one set of credentials, you can use the $ZOWE_OPT_USER and $ZOWE_OPT_PASSWORD environment variables, check the Override With Environment Variables setting, and be ready to connect to the mainframe.

If you need multiple sets of credentials, you should be sure to un-check the Override With Environment Variables setting, create your own non-ZOWE_OPT environment variables, add the environment variables to your config, and then be ready to connect to the mainframe.

[zFernand0]

yeah, it's a bit confusing either way. I like how you explained it here 🙏

If you only need one set of credentials, you can use the $ZOWE_OPT_USER and $ZOWE_OPT_PASSWORD environment variables, check the Override With Environment Variables setting, and be ready to connect to the mainframe.

If you need multiple sets of credentials, you should be sure to un-check the Override With Environment Variables setting, create your own non-ZOWE_OPT environment variables, add the environment variables to your config, and then be ready to connect to the mainframe.

Not sure how to condense all of that into the notes though 😋

[zFernand0]

yeah, it's a bit confusing either way. I like how you explained it here 🙏

If you only need one set of credentials, you can use the $ZOWE_OPT_USER and $ZOWE_OPT_PASSWORD environment variables, check the Override With Environment Variables setting, and be ready to connect to the mainframe.

If you need multiple sets of credentials, you should be sure to un-check the Override With Environment Variables setting, create your own non-ZOWE_OPT environment variables, add the environment variables to your config, and then be ready to connect to the mainframe.

Not sure how to condense all of that into the notes though 😋

[anaxceron]

@adam-wolfe @zFernand0: Should we include a config example for ZOWE_OPT_USER and ZOWE_OPT_PASSWORD?

[adam-wolfe]

We could, but I'm not sure about how it would with the API ML. I guess we could do something like:

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "lpar": {
            "properties": {
                "host": "my.company.com",
                "rejectUnauthorized": false
            },
            "profiles": {
                "zosmf": {
                    "type": "zosmf",
                    "properties": {
                        "port": 443
                    }
                }
            }
        }
    },
    "defaults": {
        "zosmf": "lpar.zosmf"
    },
    "autoStore": false
}

[adam-wolfe]

Assuming this is meant to be the z/OSMF port, I would move it into the lpar.zosmf profile properties.

[adam-wolfe]

I would put the API ML connection info (port, tokenType, tokenValue, and authOrder) in the lpar profile. Like we do it here: https://docs.zowe.org/stable/user-guide/cli-using-creating-profiles#accessing-services-through-multiple-api-ml-gateways