Skip to content

Commit

Permalink
v1.27 documentation (#1979)
Browse files Browse the repository at this point in the history
* Update CLIReference_Zowe.pdf (#1560)

Signed-off-by: Michael Aimino <[email protected]>

* Rip/gh931/micronaut enabler (#1563)

* Fix the release date (#1558)

Signed-off-by: nannanli <[email protected]>
Signed-off-by: achmelo <[email protected]>

* add micronaut enabler to extending

Signed-off-by: achmelo <[email protected]>

* Initial language refactor

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: achmelo <[email protected]>

* Second language refactor

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: achmelo <[email protected]>

* yaml fields description

Signed-off-by: achmelo <[email protected]>

* layout

Signed-off-by: achmelo <[email protected]>

* refacotr language/formatting

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: achmelo <[email protected]>

* rephrase the ssl param hints, logging motivation

Signed-off-by: achmelo <[email protected]>

* Minor refactor

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: achmelo <[email protected]>

Co-authored-by: nannanli <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Formatting fix for example of ZWED0021I message (#1559)

* Initial commit

Signed-off-by: Joe-Winchester <[email protected]>

* Initial Commit

Signed-off-by: Joe-Winchester <[email protected]>

* Removing files that got into the PR bymistake

Signed-off-by: Joe-Winchester <[email protected]>

Co-authored-by: nannanli <[email protected]>

* API ML Onboarding Node.js Enabler doc (#1565)

Signed-off-by: Andrew Jandacek <[email protected]>

* Indentation and consistency for enablers  (#1572)

Signed-off-by: Andrew Jandacek <[email protected]>

* Allow removal or replacing of API catalog within the API ML (#1570)

* Provide the configuration for the API Catalog.

Signed-off-by: Jakub Balhar <[email protected]>

* refactor Replace or remove catalog with another service

Signed-off-by: Andrew Jandacek <[email protected]>

* add bullet to TOC

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Jakub Balhar <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Small update of the npm package name of nodejs enabler (#1574)

Signed-off-by: at670475 <[email protected]>

* 1.19.1 release (#1575)

Signed-off-by: Michael Aimino <[email protected]>

* State the requirement for server cert to also be enabled for client authentication  (#1576)

Add information about requirements to enable client auth for a server certificate

Signed-off-by: at670475 <[email protected]>

* API ML - Obtaining Information about API Services (#1520)

* Fix reference to script that starts the gateway

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Add documentation for connection limits

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Initial service information documentation

Signed-off-by: Petr Plavjanik <[email protected]>

* Other service info endpoints

Signed-off-by: Petr Plavjanik <[email protected]>

* ServiceInfo response format

Signed-off-by: Petr Plavjanik <[email protected]>

* Minor changes

Signed-off-by: Petr Plavjanik <[email protected]>

* Update

Signed-off-by: Petr Plavjanik <[email protected]>

* Add 1.18 version number

Signed-off-by: BrandonJenkins14 <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* fix version number

Signed-off-by: BrandonJenkins14 <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* fix toc

Signed-off-by: BrandonJenkins14 <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Create Zowe_Documentation_1.17.0.pdf

Signed-off-by: nannanli <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* General article refactor for clarification

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Minor refactor

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Information about the resource

Signed-off-by: Petr Plavjanik <[email protected]>

* Cleanup

Signed-off-by: Petr Plavjanik <[email protected]>

* Mac and license updates

Signed-off-by: Joe-Winchester <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Tweaks

Signed-off-by: nannanli <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Add new log messages for connection limits

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Add new gw config for zuul/hystrix

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Add more detail to gw connection limits

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Improve connection limit log

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Minor refactor of connection limits

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* General tech info refactoring

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Explain the changes for the standalone setup of the API Mediation Layer

Signed-off-by: Jakub Balhar <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Code review comments

Signed-off-by: Petr Plavjanik <[email protected]>

* Examples of security commands

Signed-off-by: Petr Plavjanik <[email protected]>

* minor formating fix

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Carson Cook <[email protected]>
Co-authored-by: BrandonJenkins14 <[email protected]>
Co-authored-by: nannanli <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Joe-Winchester <[email protected]>
Co-authored-by: Jakub Balhar <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Update systemrequirements-zosmf-lite.md (#1580)

Signed-off-by: Michael Aimino <[email protected]>

* Update the Zowe Explorer section (#1581)

* update zowe explorer gifs

Signed-off-by: Igor Kazmyr <[email protected]>

* update 2 gifs and procedures

Signed-off-by: Igor Kazmyr <[email protected]>

* update several gifs and procedures

Signed-off-by: Igor Kazmyr <[email protected]>

* add Profile Validation

Signed-off-by: Igor Kazmyr <[email protected]>

* add the open recent member tip

Signed-off-by: Igor Kazmyr <[email protected]>

* added the record for v1.19.x (#1586)

Signed-off-by: nannanli <[email protected]>

* Typo fixed (#1583)

Signed-off-by: nannanli <[email protected]>

* Environment variable usage (#1589)

* Usage of environment variable

Signed-off-by: achmelo <[email protected]>

* rephrase

Signed-off-by: achmelo <[email protected]>

* refactor env var description

Signed-off-by: Andrew Jandacek <[email protected]>

* minor language refactor of env var

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* New authentication scheme (#1596)

Signed-off-by: Andrew Jandacek <[email protected]>

* Document the use of DSNL004I message for working out Db2 profile information (#1551)

* Initial commit

Signed-off-by: Joe-Winchester <[email protected]>

* Describe DSNL004I as way to help getting profile information

Signed-off-by: Joe-Winchester <[email protected]>

* Update cli-db2plugin.md

* Stash

Signed-off-by: Joe-Winchester <[email protected]>

Co-authored-by: Pluto <[email protected]>
Co-authored-by: nannanli <[email protected]>

* Plain java enabler configuration file description (#1602)

* configuration file description

Signed-off-by: achmelo <[email protected]>

* refactor service-configuration.yml description

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Update summaryofchanges.md

Signed-off-by: nannanli <[email protected]>

* Zowe Explorer r.notes update (#1607)

Signed-off-by: Igor Kazmyr <[email protected]>

* minor fixes (#1610)

Signed-off-by: Andrew Jandacek <[email protected]>

* Re-pull APIML changelogs

Signed-off-by: nannanli <[email protected]>

* Add full paths to abbreviated endpoints (#1612)

* Add full paths to abbreviated endpoints

Signed-off-by: Andrew Jandacek <[email protected]>

* Change localhost ref to https://{gatewayUrl}:{gatewayPort}/

Signed-off-by: Andrew Jandacek <[email protected]>

* Add missing `/` to endpoint

Signed-off-by: Andrew Jandacek <[email protected]>

* Users/jack/auth failure (#1609)

* update troubleshooting on Authentication failed for 3 types error

Signed-off-by: Jack (T.) Jia <[email protected]>

* update app-troubleshoot

Signed-off-by: Jack (T.) Jia <[email protected]>

* fix typo

Signed-off-by: Jack (T.) Jia <[email protected]>

* instruction on modifying APIML_SECURITY_ZOSMF_JWT_AUTOCONFIGURATION_MODE

Signed-off-by: Jack (T.) Jia <[email protected]>

* remove the APIML_SECURITY_ZOSMF_JWT_AUTOCONFIGURATION_MODE guide

Signed-off-by: Jack (T.) Jia <[email protected]>

* Tweaks

Signed-off-by: nannanli <[email protected]>

Co-authored-by: nannanli <[email protected]>

* TPSR, cleanup

Signed-off-by: nannanli <[email protected]>

* fix broken link (#1615)

Signed-off-by: Andrew Jandacek <[email protected]>

* Update zweag705e (#1616)

Signed-off-by: Carson Cook <[email protected]>

* Update cli-scsplugin.md (#1628)

Signed-off-by: Michael Aimino <[email protected]>

* Apiml start script variables (#1627)

* x509 variables

* Minor refactor of APIML_GATEWAY_EXTERNAL_MAPPER and APIML_GATEWAY_MAPPER_USER

Signed-off-by: Andrew Jandacek <[email protected]>

* add context

* Minor language refactor and formatting fixes

Signed-off-by: Andrew Jandacek <[email protected]>

* Fix step enumeration and formatting

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>

* Addition to FAQ - z/OS ZIIP processor support (#1597)

Signed-off-by: nannanli <[email protected]>

* Update install-docker-image.md (#1629)

Signed-off-by: ajinrocket <[email protected]>

* updated directories for customization (#1630)

Signed-off-by: ajinrocket <[email protected]>

Co-authored-by: 1000TurquoisePogs <[email protected]>

* UX Testing study (API ML installation observer notes)#1008 (#1632)

Signed-off-by: Andrew Jandacek <[email protected]>

* Prep for v1.21.0

Signed-off-by: nannanli <[email protected]>

* Update Zowe CLI docs for 1.20 release (#1618)

Signed-off-by: Michael Aimino <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Tidy up install-app.sh instructions (#1512)

Signed-off-by: Joe-Winchester <[email protected]>

Co-authored-by: nannanli <[email protected]>

* First run of release notes for 1.21.0

Signed-off-by: nannanli <[email protected]>

* v1.21.0 changes notes and certificate related changes (#1642)

* v1.21.0 changes notes and certificate related changes

Signed-off-by: Jack (T.) Jia <[email protected]>

* wording fixes

Signed-off-by: Jack (T.) Jia <[email protected]>

* Edits

Signed-off-by: nannanli <[email protected]>

* fix typo

Signed-off-by: Jack (T.) Jia <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Pull in APIML release notes

Signed-off-by: nannanli <[email protected]>

* Pull in app server release notes

Signed-off-by: nannanli <[email protected]>

* Fix date

Signed-off-by: nannanli <[email protected]>

* Update summaryofchanges.md (#1647)

minor edits to zowe cli section

* Add missing release notes for app server

Signed-off-by: nannanli <[email protected]>

* Minor formatting fixes to API ML Summary of Changes for r1.21 (#1648)

Signed-off-by: Andrew Jandacek <[email protected]>

* TPSR for 1.21.0

Signed-off-by: nannanli <[email protected]>

* non strict verify certificates (#1649)

Signed-off-by: achmelo <[email protected]>

* Add known issue Re: Java z/OS components unable to read certificates from keyring (#1640)

Signed-off-by: Andrew Jandacek <[email protected]>

* Automatic update for the Error messages in API-Layer PR (#1663)

* Update error codes

Signed-off-by: Zowe Robot <[email protected]>

* Update error codes

Signed-off-by: Zowe Robot <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>

* SAF resource checking (#1653)

Signed-off-by: Andrew Jandacek <[email protected]>

* Update error codes (#1669)

Signed-off-by: Zowe Robot <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>
Co-authored-by: Jakub Balhar <[email protected]>

* Changes for enabling SSO (#1668)

* Sync updates  (#1650)

Signed-off-by: nannanli <[email protected]>

* Bump url-parse from 1.4.7 to 1.5.1 (#1665)

Signed-off-by: nannanli <[email protected]>

* changes for enabling SSO

Signed-off-by: Nayer Najafi <[email protected]>

Co-authored-by: nannanli <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Joe Winchester <[email protected]>

* Bump release version

Signed-off-by: nannanli <[email protected]>

* Add documentation for the Zowe component upgrade script (#1674)

Add doc for the zowe-upgrade-component script

Signed-off-by: at670475 <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>

* change password using SAF (#1676)

* change password using SAF

Signed-off-by: achmelo <[email protected]>

* refactor Change Password

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>

* Missing prop for saf check endpoint (#1677)

* add prop

Signed-off-by: jandadav <[email protected]>

* language refactor

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>

* Add subsequent release versions to SMPE doc (#1683)

Signed-off-by: nannanli <[email protected]>

Co-authored-by: Joe Winchester <[email protected]>

* State risks for zowe updater in the doc (#1684)

Update doc to state the issues

Signed-off-by: at670475 <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>

* Documentation addition for extension installation and verification works (#1679)

* Added docs for zowe extensions verification

Signed-off-by: Jadin Luong <[email protected]>

* Made changes to zowe-verify-component.sh docs

Signed-off-by: Jadin Luong <[email protected]>

* Fixed typo

Signed-off-by: Jadin Luong <[email protected]>

* Fixed typo

Signed-off-by: Jadin Luong <[email protected]>

* Made changes to extension docs to make it more clear

Signed-off-by: Jadin Luong <[email protected]>

* Update install-configure-zos-extensions.md

Signed-off-by: nannanli <[email protected]>

* Added releases notes for this new feature

Signed-off-by: nannanli <[email protected]>

Co-authored-by: Jadin Luong <[email protected]>
Co-authored-by: nannanli <[email protected]>

* Automatic update for the Error messages in API-Layer PR (#1696)

* Update error codes

Signed-off-by: Zowe Robot <[email protected]>

* Minor grammar fixes

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* zOSMF and Zowe requirements for HA in Sysplex (#1681)

* zOSMF and Zowe requirements for HA in Sysplex

Signed-off-by: Nayer Najafi <[email protected]>

* zOSMF and Zowe requirements for HA in Sysplex

Signed-off-by: Nayer Najafi <[email protected]>

* Zowe HA documentation changes

Signed-off-by: Nayer Najafi <[email protected]>

* Edits

- Made some editorial changes to the descriptions/wording/style
- Added the new topic to the doc site sidebar

Co-authored-by: nannanli <[email protected]>

* Added word about how to get the sources image (#1631)

Signed-off-by: 1000TurquoisePogs <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Automatic update for the Error messages in API-Layer PR (#1699)

* Update error codes

Signed-off-by: Zowe Robot <[email protected]>

* Refactor ZWEAG710E

Signed-off-by: Andrew Jandacek <[email protected]>

* Add 'the'

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Update error codes (#1707)

Signed-off-by: Zowe Robot <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>

* User and security pre-req information in table format (#1678)

* Table for User IDs and permissions

Signed-off-by: Joe-Winchester <[email protected]>

* Update the table

Signed-off-by: nannanli <[email protected]>

* Update preparing-zos.md

Signed-off-by: nannanli <[email protected]>

* Separate CLI and z/OS pre-reqs and added ports needed

Signed-off-by: Joe-Winchester <[email protected]>

* Edits

Signed-off-by: nannanli <[email protected]>

* Edits to the sysreqs

Signed-off-by: nannanli <[email protected]>

* Remove unused documents

Signed-off-by: nannanli <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Update systemrequirements.md (#1710)

* Update systemrequirements.md

Signed-off-by: nannanli <[email protected]>

It's now two separate files. To not confuse users or cause broken links, update this link to direct people to the target locations.

* Update systemrequirements.md

Signed-off-by: nannanli <[email protected]>

* Update summaryofchanges.md (#1712)

Added Zowe CLI information for release 1.2.2.0

* Pull 1.22.0 release notes

Signed-off-by: nannanli <[email protected]>

* Changed pre-req for z/OS to be Java/Node/zOSMF to make it clearer for sysprogs (#1714)

* Changed pre-req order

Signed-off-by: Joe-Winchester <[email protected]>

* edits

Signed-off-by: nannanli <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Update ZE RNs (#1715)

* update ZE RNs

Signed-off-by: Igor Kazmyr <[email protected]>

* add another bug fix to ZE RNs

Signed-off-by: Igor Kazmyr <[email protected]>

* fix small typographic issue

Signed-off-by: Igor Kazmyr <[email protected]>

* WIP: Zowe HA documentation changes (#1688)

* Zowe HA documentation changes

Signed-off-by: Nayer Najafi <[email protected]>

* Zowe HA documentation changes

Signed-off-by: Nayer Najafi <[email protected]>

* Update docs/getting-started/overview.md

Co-authored-by: Carson Cook <[email protected]>

* WIP: Zowe HA Installation Roadmap

Signed-off-by: Nayer Najafi <[email protected]>

* WIP: Zowe HA Installation Roadmap

Signed-off-by: Nayer Najafi <[email protected]>

* WIP: Zowe HA Installation Roadmap

Signed-off-by: Nayer Najafi <[email protected]>

* Update apiml diagram with source

Signed-off-by: jandadav <[email protected]>

* Update instance.env HA variables

Signed-off-by: Carson Cook <[email protected]>

* Fix discovery services list description

Signed-off-by: Carson Cook <[email protected]>

* Add Zowe HA started task (ZWESLSTC) configuration, change to Zowe HA installation roadmap, change to Configuring the z/OS system for Zowe

Signed-off-by: Nayer Najafi <[email protected]>

* add zowe.yaml doc

Signed-off-by: Jack (T.) Jia <[email protected]>

* add change log

Signed-off-by: Jack (T.) Jia <[email protected]>

* wording updates

Signed-off-by: Jack (T.) Jia <[email protected]>

* changes to HA installation roadmap, Zowe started task

Signed-off-by: Nayer Najafi <[email protected]>

* wording updates

Signed-off-by: Nayer Najafi <[email protected]>

* Add Zowe launcher start and stop commands

Signed-off-by: Nayer Najafi <[email protected]>

* wording updates

Signed-off-by: Nayer Najafi <[email protected]>

* fix conflicts

Signed-off-by: Nayer Najafi <[email protected]>

* add 2 links to left panel

Signed-off-by: Jack (T.) Jia <[email protected]>

* add modify command to start zowe ha component, changes to uninstalling Zowe section

Signed-off-by: Nayer Najafi <[email protected]>

* haInstances is not optional

Signed-off-by: Jack (T.) Jia <[email protected]>

* clarify zowe.externalCertificate and zowe.internalCertificate, add configure sysplex page

Signed-off-by: Jack (T.) Jia <[email protected]>

* edits: Create a HA specific section

Signed-off-by: nannanli <[email protected]>

* edits: Update roadmap diagram, wording, links

Signed-off-by: nannanli <[email protected]>

* add prepare VSAM page

Signed-off-by: Jack (T.) Jia <[email protected]>

* edits: wording, link

Signed-off-by: nannanli <[email protected]>
- enable users to open the diagram links in a new tab
- updated the caching service topic
- updated toc

* edits: final edits

Signed-off-by: nannanli <[email protected]>
- Commented out links not alive yet
- Fixed wording, format, organization, etc

* fix: broken link

Signed-off-by: nannanli <[email protected]>

* fix: pdf build issue

Signed-off-by: nannanli <[email protected]>

Co-authored-by: Carson Cook <[email protected]>
Co-authored-by: David Janda <[email protected]>
Co-authored-by: Carson Cook <[email protected]>
Co-authored-by: Jack (T.) Jia <[email protected]>
Co-authored-by: nannanli <[email protected]>

* fix wrong path of convert-to-zowe-yaml.sh (#1717)

Signed-off-by: Jack (T.) Jia <[email protected]>

* Add Caching service and storage documentation (#1506)

* Add vsam documentation

Signed-off-by: at670475 <[email protected]>

* small change

Signed-off-by: at670475 <[email protected]>

* Small enhancement

Signed-off-by: at670475 <[email protected]>

* Add metadescription

Signed-off-by: Andrew Jandacek <[email protected]>

* Add doc for caching service

Signed-off-by: at670475 <[email protected]>

* Fix format

Signed-off-by: at670475 <[email protected]>

* Fix image link

Signed-off-by: at670475 <[email protected]>

* improve vsam doc config

Signed-off-by: at670475 <[email protected]>

* add metadescription

* Improvement of doc

Signed-off-by: at670475 <[email protected]>

* small change

Signed-off-by: at670475 <[email protected]>

* refactor intro

* refactor description

Signed-off-by: Andrew Jandacek <[email protected]>

* fix typos

Signed-off-by: Andrew Jandacek <[email protected]>

* add VSAM for production

Signed-off-by: Andrew Jandacek <[email protected]>

* Small change under vsam header

Signed-off-by: at670475 <[email protected]>

* Add paragraph about customized implementation

Signed-off-by: at670475 <[email protected]>

* refactor description

Signed-off-by: Andrew Jandacek <[email protected]>

* add VSAM description

Signed-off-by: Andrew Jandacek <[email protected]>

* Small fix

Signed-off-by: at670475 <[email protected]>

* refactor metadescription

Signed-off-by: Andrew Jandacek <[email protected]>

* fix typo

Signed-off-by: Andrew Jandacek <[email protected]>

* Small refactor

Signed-off-by: at670475 <[email protected]>

* Remove heading

Signed-off-by: at670475 <[email protected]>

* remove additional storage. FIx formatting

Signed-off-by: Andrew Jandacek <[email protected]>

* Remove diagram and add todo

Signed-off-by: at670475 <[email protected]>

* add TOC

Signed-off-by: Andrew Jandacek <[email protected]>

* Add the properties related to size and eviction strategy.

Signed-off-by: Jakub Balhar <[email protected]>

* refactor configuration properties

Signed-off-by: Andrew Jandacek <[email protected]>

* Add the messages from the Cacihng Service to the docs-site

Signed-off-by: Jakub Balhar <[email protected]>

* Caching service authentication

* Add basic redis info

Signed-off-by: Carson Cook <[email protected]>

* Add redis details

Signed-off-by: Carson Cook <[email protected]>

* Change redis sentinel node ip to host in config

Signed-off-by: Carson Cook <[email protected]>

* Add information about IP address registration

Signed-off-by: Carson Cook <[email protected]>

* language/formating refactor

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Jakub Balhar <[email protected]>
Co-authored-by: jandadav <[email protected]>
Co-authored-by: Carson Cook <[email protected]>
Co-authored-by: nannanli <[email protected]>

* alter docs (#1718)

Signed-off-by: jandadav <[email protected]>

* Create .DS_Store

Signed-off-by: nannanli <[email protected]>

* Document APIML load balancing props (#1734)

Add doc for deterministic routing configuration

Signed-off-by: at670475 <[email protected]>

* Fix must gather (#1697)

* Fix must gather

Signed-off-by: 1000TurquoisePogs <[email protected]>

* more updates

Signed-off-by: 1000TurquoisePogs <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Document requirements for OMVS zss service (#1750)

Signed-off-by: Leonty Chudinov <[email protected]>

Co-authored-by: Leonty Chudinov <[email protected]>

* Update Redis configuration documentation (#1752)

* Update redis config for environment vars

Signed-off-by: Carson Cook <[email protected]>

* update redis yaml config entries

Signed-off-by: Jack (T.) Jia <[email protected]>

Co-authored-by: Jack (T.) Jia <[email protected]>

* Archive v1.22.x and bump version to v1.23.x

Signed-off-by: nannanli <[email protected]>

* Prepare docs-staging before publish

These changes aim to increase the build time on docs-staging branch. Once it's ready to publish, these changes should be added back.
Signed-off-by: nannanli <[email protected]>

* Remove `v1.14.x` archived docs in docs-staging (#1753)

* fix: Duplicate headings in doc (#1751)

* Remove v1.14.x archived docs

* Commented docsVersionDropdown object

* Add v1.23.x release notes placeholder section

Signed-off-by: nannanli <[email protected]>

* Minor changes to improve info about HA (#1748)

Signed-off-by: 1000TurquoisePogs <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Automatic update for the Error messages in API-Layer PR (#1754)

* Update error codes

Signed-off-by: Zowe Robot <[email protected]>

* Update troubleshoot-apiml-error-codes.md

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>
Co-authored-by: nannanli <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: David Janda <[email protected]>

* General language refactor of API Mediation Security (#1743)

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: nannanli <[email protected]>
Co-authored-by: David Janda <[email protected]>

* Update contributing.md (#1749)

* Update contributing.md

Signed-off-by: Michael Aimino <[email protected]>

* Update contributing.md

Signed-off-by: Michael Aimino <[email protected]>

* Update contributing.md

Signed-off-by: Michael Aimino <[email protected]>

* Update contributing.md

Signed-off-by: Michael Aimino <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Add docs for troubleshooting launcher (#1746)

* Add docs for troubeshooting launcher

Signed-off-by: Leonty Chudinov <[email protected]>

* Additions after review of launcher troubleshooting documentation

Signed-off-by: 1000TurquoisePogs <[email protected]>

* Remove duplicate `the`

Signed-off-by: Leonty Chudinov <[email protected]>

* Add troubleshooting topics for launcher to sidebar

Signed-off-by: Leonty Chudinov <[email protected]>

* Minor fix: add backticks for component-name

Signed-off-by: Leonty Chudinov <[email protected]>

Co-authored-by: Leonty Chudinov <[email protected]>
Co-authored-by: 1000TurquoisePogs <[email protected]>
Co-authored-by: nannanli <[email protected]>
Co-authored-by: 1000TurquoisePogs <[email protected]>

* Zis plugin attributes (#1729)

* Added a section for ZIS plugin attributes in manifest.yaml


Co-authored-by: Leanid Astrakou <[email protected]>
Co-authored-by: nannanli <[email protected]>
Co-authored-by: 1000TurquoisePogs <[email protected]>

* Add documentation about HA for app-server and zss. Also add more documentation about zss dataservices (#1758)

Signed-off-by: 1000TurquoisePogs <[email protected]>

* Document spring onboarding enabler artifacts (#1765)

* fix: Duplicate headings in doc (#1751)

* Signoff (#1756)

Fixed a typo in configuration instructions for z/OS System

Signed off by Steven Perva <[email protected]>

Signed-off-by: Steven Perva (Ensono) <[email protected]>

* Document new spring onboarding enabler artifact with old artifacts documented

Signed-off-by: Carson Cook <[email protected]>

* Document new spring onboarding enabler artifact with old artifacts documented

Signed-off-by: Carson Cook <[email protected]>

Co-authored-by: Arijit Kundu <[email protected]>
Co-authored-by: Steven Perva (Ensono) <[email protected]>

* Update ZaasClient documentation (#1761)

* fix: Duplicate headings in doc (#1751)

* Signoff (#1756)

Fixed a typo in configuration instructions for z/OS System

Signed off by Steven Perva <[email protected]>

Signed-off-by: Steven Perva (Ensono) <[email protected]>

* Update dependency and class information for zaas client

Signed-off-by: Carson Cook <[email protected]>

* Fix maven dependency

Signed-off-by: Carson Cook <[email protected]>

* Clarifying versioning

Signed-off-by: Carson Cook <[email protected]>

* Clarify SampleZaasClientImplementation

Signed-off-by: Carson Cook <[email protected]>

* Grammar fix

Signed-off-by: Carson Cook <[email protected]>

Co-authored-by: Arijit Kundu <[email protected]>
Co-authored-by: Steven Perva (Ensono) <[email protected]>

* [1.23] Update static doc content for Zowe CLI/SDKs (#1759)

* Add Typedoc for Zowe Node.js SDK vNext

Signed-off-by: Timothy Johnson <[email protected]>

* updated zowe_web_help

Signed-off-by: Michael Aimino <[email protected]>

* Update zowe-nodejs-sdk-typedoc.zip

Signed-off-by: Michael Aimino <[email protected]>

Co-authored-by: Michael Aimino <[email protected]>

* Rename the ze filename

It confused the build with a history of lower case i versus upper case i in "issue", so rename it slightly to avoid confusion.
Signed-off-by: nannanli <[email protected]>

* Updated diagrams (#1764)

* Updated diagrams

Signed-off-by: Joe-Winchester <[email protected]>

* Restore sidebars.js to include troubleshoot/ze/ze-issue line

Signed-off-by: Joe-Winchester <[email protected]>

* edits

Signed-off-by: nannanli <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Pull v1.23 release notes from changelogs

Signed-off-by: nannanli <[email protected]>

* Added back previous versions

Getting ready for the new version publish
Signed-off-by: nannanli <[email protected]>

* Minor language refactor of api ml troubleshooting (#1763)

Signed-off-by: Andrew Jandacek <[email protected]>

* Document httpOnly property in the ZAAS client (#1396)

Signed-off-by: Andrew Jandacek <[email protected]>

* Distributed load balancer cache (#1769)

* Distributed load balancer cache

Signed-off-by: jandadav <[email protected]>

* Language refactor

Signed-off-by: Andrew Jandacek <[email protected]>

* sticky session description

Signed-off-by: jandadav <[email protected]>

* Language refactor

Signed-off-by: Andrew Jandacek <[email protected]>

* fix typo

Signed-off-by: jandadav <[email protected]>

* minor language refactor

Signed-off-by: Andrew Jandacek <[email protected]>

* minor language refactor

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Updated files for 1.23 (#1773)

* Updated files for 1.23

Signed-off-by: Michael Aimino <[email protected]>

* Delete zowe-web-help.zip

Signed-off-by: Michael Aimino <[email protected]>

* Updated PDF and typedocs

Signed-off-by: Michael Aimino <[email protected]>

* Moved typedoc and typedoc_next to correct folders

Signed-off-by: Michael Aimino <[email protected]>

* Publish Zowe v1.23 documentation (#1770)

* Update extend-zowe-overview.md

* Refactor conformance program meta-description

Signed-off-by: Andrew Jandacek <[email protected]>

* grammar, minor details, etc..

Signed-off-by: BrandonJenkins14 <[email protected]>

* remove spacing

Signed-off-by: BrandonJenkins14 <[email protected]>

* Initial language refactor of API ML paragraphs

Signed-off-by: Andrew Jandacek <[email protected]>

* Language Refactor

Signed-off-by: Andrew Jandacek <[email protected]>

* Refactor description of dynamic and static registration

Signed-off-by: Andrew Jandacek <[email protected]>

* fix broken link

Signed-off-by: Andrew Jandacek <[email protected]>

* Remove ZoweCert reference

Signed-off-by: Joe-Winchester <[email protected]>

* Refactor descriptions for accuracy.

Signed-off-by: Andrew Jandacek <[email protected]>

* Fix missing period

Signed-off-by: Andrew Jandacek <[email protected]>

* Add 1.18 version number

Signed-off-by: BrandonJenkins14 <[email protected]>

* fix version number

Signed-off-by: BrandonJenkins14 <[email protected]>

* fix toc

Signed-off-by: BrandonJenkins14 <[email protected]>

* Add "microservices ecosystem"

Signed-off-by: Andrew Jandacek <[email protected]>

* Minor language edit

Signed-off-by: Andrew Jandacek <[email protected]>

* Fix reference to script that starts the gateway

Signed-off-by: Carson Cook <[email protected]>

* Add documentation for connection limits

Signed-off-by: Carson Cook <[email protected]>

* Mac and license updates

Signed-off-by: Joe-Winchester <[email protected]>

* Create Zowe_Documentation_1.17.0.pdf

Signed-off-by: nannanli <[email protected]>

* Tweaks

Signed-off-by: nannanli <[email protected]>

* Add new log messages for connection limits

Signed-off-by: Carson Cook <[email protected]>

* Add new gw config for zuul/hystrix

Signed-off-by: Carson Cook <[email protected]>

* Add more detail to gw connection limits

Signed-off-by: Carson Cook <[email protected]>

* Minor refactor of connection limits

Signed-off-by: Andrew Jandacek <[email protected]>

* General tech info refactoring

Signed-off-by: Andrew Jandacek <[email protected]>

* Improve connection limit log

Signed-off-by: Carson Cook <[email protected]>

* Explain the changes for the standalone setup of the API Mediation Layer

Signed-off-by: Jakub Balhar <[email protected]>

* Docker Documentation (#1398)

Signed-off-by: nannanli <[email protected]>

* Update 1.18 release notes

Signed-off-by: nannanli <[email protected]>
- Updated the date
- Pulled content from CHANGELOGs

* Tweaks to 1.18 doc

Signed-off-by: nannanli <[email protected]>
- Removed out-of-date section about Zowe deck
- Removed install section from 1.18 release notes (no change in this release)

* Add install API ML as a standalone component (#1532)

Signed-off-by: Andrew Jandacek <[email protected]>

* app server release notes for 1.18 (#1533)

Signed-off-by: alexanderjin <[email protected]>

* Minor updates to release doc

Signed-off-by: nannanli <[email protected]>

* Incorporate John's comments

Signed-off-by: nannanli <[email protected]>

* Introduce package manifest - for v1.19.0 release (#1526)

Signed-off-by: nannanli <[email protected]>

* Doc site basic setup for new release (#1541)

Signed-off-by: nannanli <[email protected]>

* #1066 api ml standalone (#1536)

Signed-off-by: Andrew Jandacek <[email protected]>

* Address John's comments

Signed-off-by: nannanli <[email protected]>

* Release x509 client certificate auth documentation (#1539)

* release x509 documentation

* refactor client cert description

* minor language refactor

* general language refactor

* general language refactor

* refactor User IDs and groups for the Zowe started tasks

* Enhance prerequisities

* Start script locations with new packaging

* Add image and minor tweaks

* fixup broken link

Co-authored-by: Andrew Jandacek <[email protected]>

* Add notes of spring enabler prefix to parameter names (#1534)

Signed-off-by: Andrew Jandacek <[email protected]>

* Pull 1.19 changes from CHANGELOGs

Signed-off-by: nannanli <[email protected]>

* 1.19 appserver release notes (#1546)

Signed-off-by: alexanderjin <[email protected]>

* added additional hotkeys to editor doc (#1547)

Signed-off-by: alexanderjin <[email protected]>

* X509 enhance prerequisities - Zowe user password set (#1548)

* updates to the hotkeys doc for the editor (#1549)

Signed-off-by: ajinrocket <[email protected]>

* User/joewinchester/startup messages (#1537)

* Initial commit

Signed-off-by: Joe-Winchester <[email protected]>

* Initial commit

Signed-off-by: Joe-Winchester <[email protected]>

* startup messages documented

Signed-off-by: Joe-Winchester <[email protected]>

* Moved dev audit stuff out of branch

Signed-off-by: Joe-Winchester <[email protected]>

* Remove early dev pipeline docs (not yet ready for 1.19)

Signed-off-by: Joe-Winchester <[email protected]>

* Edits to the doc

Signed-off-by: nannanli <[email protected]>

* Minor update

Signed-off-by: Joe-Winchester <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Refactor X.509 client certificate authentication in Notable Changes (#1553)

Signed-off-by: nannanli <[email protected]>

* Sync APIML release notes

Signed-off-by: nannanli <[email protected]>

* Minor edit to x.509 notable change (#1554)

Signed-off-by: nannanli <[email protected]>

* Update zowe-architecture.md

Signed-off-by: nannanli <[email protected]>

* Improve description of API ML changes in r1.19 (#1556)

Signed-off-by: nannanli <[email protected]>

* Fixes

Signed-off-by: nannanli <[email protected]>

* Client cert auth add zosmf rights prerequisite (#1557)

Signed-off-by: Andrew Jandacek <[email protected]>

* Added support for node v14 (#1544)

* Added support for node v14

Signed-off-by: nannanli <[email protected]>

* Update systemrequirements.md

updated to support edge 79, chrome 79, and safari 13
Signed-off-by: nannanli <[email protected]>

* Update systemrequirements.md

Signed-off-by: nannanli <[email protected]>

* Update CLIReference_Zowe.pdf (#1560)

Signed-off-by: Michael Aimino <[email protected]>

* Rip/gh931/micronaut enabler (#1563)

* Fix the release date (#1558)

Signed-off-by: nannanli <[email protected]>
Signed-off-by: achmelo <[email protected]>

* add micronaut enabler to extending

Signed-off-by: achmelo <[email protected]>

* Initial language refactor

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: achmelo <[email protected]>

* Second language refactor

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: achmelo <[email protected]>

* yaml fields description

Signed-off-by: achmelo <[email protected]>

* layout

Signed-off-by: achmelo <[email protected]>

* refacotr language/formatting

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: achmelo <[email protected]>

* rephrase the ssl param hints, logging motivation

Signed-off-by: achmelo <[email protected]>

* Minor refactor

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: achmelo <[email protected]>

Co-authored-by: nannanli <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Formatting fix for example of ZWED0021I message (#1559)

* Initial commit

Signed-off-by: Joe-Winchester <[email protected]>

* Initial Commit

Signed-off-by: Joe-Winchester <[email protected]>

* Removing files that got into the PR bymistake

Signed-off-by: Joe-Winchester <[email protected]>

Co-authored-by: nannanli <[email protected]>

* API ML Onboarding Node.js Enabler doc (#1565)

Signed-off-by: Andrew Jandacek <[email protected]>

* Indentation and consistency for enablers  (#1572)

Signed-off-by: Andrew Jandacek <[email protected]>

* Allow removal or replacing of API catalog within the API ML (#1570)

* Provide the configuration for the API Catalog.

Signed-off-by: Jakub Balhar <[email protected]>

* refactor Replace or remove catalog with another service

Signed-off-by: Andrew Jandacek <[email protected]>

* add bullet to TOC

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Jakub Balhar <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Small update of the npm package name of nodejs enabler (#1574)

Signed-off-by: at670475 <[email protected]>

* 1.19.1 release (#1575)

Signed-off-by: Michael Aimino <[email protected]>

* State the requirement for server cert to also be enabled for client authentication  (#1576)

Add information about requirements to enable client auth for a server certificate

Signed-off-by: at670475 <[email protected]>

* API ML - Obtaining Information about API Services (#1520)

* Fix reference to script that starts the gateway

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Add documentation for connection limits

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Initial service information documentation

Signed-off-by: Petr Plavjanik <[email protected]>

* Other service info endpoints

Signed-off-by: Petr Plavjanik <[email protected]>

* ServiceInfo response format

Signed-off-by: Petr Plavjanik <[email protected]>

* Minor changes

Signed-off-by: Petr Plavjanik <[email protected]>

* Update

Signed-off-by: Petr Plavjanik <[email protected]>

* Add 1.18 version number

Signed-off-by: BrandonJenkins14 <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* fix version number

Signed-off-by: BrandonJenkins14 <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* fix toc

Signed-off-by: BrandonJenkins14 <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Create Zowe_Documentation_1.17.0.pdf

Signed-off-by: nannanli <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* General article refactor for clarification

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Minor refactor

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Information about the resource

Signed-off-by: Petr Plavjanik <[email protected]>

* Cleanup

Signed-off-by: Petr Plavjanik <[email protected]>

* Mac and license updates

Signed-off-by: Joe-Winchester <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Tweaks

Signed-off-by: nannanli <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Add new log messages for connection limits

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Add new gw config for zuul/hystrix

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Add more detail to gw connection limits

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Improve connection limit log

Signed-off-by: Carson Cook <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Minor refactor of connection limits

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* General tech info refactoring

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Explain the changes for the standalone setup of the API Mediation Layer

Signed-off-by: Jakub Balhar <[email protected]>
Signed-off-by: Petr Plavjanik <[email protected]>

* Code review comments

Signed-off-by: Petr Plavjanik <[email protected]>

* Examples of security commands

Signed-off-by: Petr Plavjanik <[email protected]>

* minor formating fix

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Carson Cook <[email protected]>
Co-authored-by: BrandonJenkins14 <[email protected]>
Co-authored-by: nannanli <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Joe-Winchester <[email protected]>
Co-authored-by: Jakub Balhar <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Update systemrequirements-zosmf-lite.md (#1580)

Signed-off-by: Michael Aimino <[email protected]>

* Update the Zowe Explorer section (#1581)

* update zowe explorer gifs

Signed-off-by: Igor Kazmyr <[email protected]>

* update 2 gifs and procedures

Signed-off-by: Igor Kazmyr <[email protected]>

* update several gifs and procedures

Signed-off-by: Igor Kazmyr <[email protected]>

* add Profile Validation

Signed-off-by: Igor Kazmyr <[email protected]>

* add the open recent member tip

Signed-off-by: Igor Kazmyr <[email protected]>

* added the record for v1.19.x (#1586)

Signed-off-by: nannanli <[email protected]>

* Typo fixed (#1583)

Signed-off-by: nannanli <[email protected]>

* Environment variable usage (#1589)

* Usage of environment variable

Signed-off-by: achmelo <[email protected]>

* rephrase

Signed-off-by: achmelo <[email protected]>

* refactor env var description

Signed-off-by: Andrew Jandacek <[email protected]>

* minor language refactor of env var

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* New authentication scheme (#1596)

Signed-off-by: Andrew Jandacek <[email protected]>

* Document the use of DSNL004I message for working out Db2 profile information (#1551)

* Initial commit

Signed-off-by: Joe-Winchester <[email protected]>

* Describe DSNL004I as way to help getting profile information

Signed-off-by: Joe-Winchester <[email protected]>

* Update cli-db2plugin.md

* Stash

Signed-off-by: Joe-Winchester <[email protected]>

Co-authored-by: Pluto <[email protected]>
Co-authored-by: nannanli <[email protected]>

* Plain java enabler configuration file description (#1602)

* configuration file description

Signed-off-by: achmelo <[email protected]>

* refactor service-configuration.yml description

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Update summaryofchanges.md

Signed-off-by: nannanli <[email protected]>

* Zowe Explorer r.notes update (#1607)

Signed-off-by: Igor Kazmyr <[email protected]>

* minor fixes (#1610)

Signed-off-by: Andrew Jandacek <[email protected]>

* Re-pull APIML changelogs

Signed-off-by: nannanli <[email protected]>

* Add full paths to abbreviated endpoints (#1612)

* Add full paths to abbreviated endpoints

Signed-off-by: Andrew Jandacek <[email protected]>

* Change localhost ref to https://{gatewayUrl}:{gatewayPort}/

Signed-off-by: Andrew Jandacek <[email protected]>

* Add missing `/` to endpoint

Signed-off-by: Andrew Jandacek <[email protected]>

* Users/jack/auth failure (#1609)

* update troubleshooting on Authentication failed for 3 types error

Signed-off-by: Jack (T.) Jia <[email protected]>

* update app-troubleshoot

Signed-off-by: Jack (T.) Jia <[email protected]>

* fix typo

Signed-off-by: Jack (T.) Jia <[email protected]>

* instruction on modifying APIML_SECURITY_ZOSMF_JWT_AUTOCONFIGURATION_MODE

Signed-off-by: Jack (T.) Jia <[email protected]>

* remove the APIML_SECURITY_ZOSMF_JWT_AUTOCONFIGURATION_MODE guide

Signed-off-by: Jack (T.) Jia <[email protected]>

* Tweaks

Signed-off-by: nannanli <[email protected]>

Co-authored-by: nannanli <[email protected]>

* TPSR, cleanup

Signed-off-by: nannanli <[email protected]>

* fix broken link (#1615)

Signed-off-by: Andrew Jandacek <[email protected]>

* Update zweag705e (#1616)

Signed-off-by: Carson Cook <[email protected]>

* Update cli-scsplugin.md (#1628)

Signed-off-by: Michael Aimino <[email protected]>

* Apiml start script variables (#1627)

* x509 variables

* Minor refactor of APIML_GATEWAY_EXTERNAL_MAPPER and APIML_GATEWAY_MAPPER_USER

Signed-off-by: Andrew Jandacek <[email protected]>

* add context

* Minor language refactor and formatting fixes

Signed-off-by: Andrew Jandacek <[email protected]>

* Fix step enumeration and formatting

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>

* Addition to FAQ - z/OS ZIIP processor support (#1597)

Signed-off-by: nannanli <[email protected]>

* Update install-docker-image.md (#1629)

Signed-off-by: ajinrocket <[email protected]>

* updated directories for customization (#1630)

Signed-off-by: ajinrocket <[email protected]>

Co-authored-by: 1000TurquoisePogs <[email protected]>

* UX Testing study (API ML installation observer notes)#1008 (#1632)

Signed-off-by: Andrew Jandacek <[email protected]>

* Prep for v1.21.0

Signed-off-by: nannanli <[email protected]>

* Update Zowe CLI docs for 1.20 release (#1618)

Signed-off-by: Michael Aimino <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Tidy up install-app.sh instructions (#1512)

Signed-off-by: Joe-Winchester <[email protected]>

Co-authored-by: nannanli <[email protected]>

* First run of release notes for 1.21.0

Signed-off-by: nannanli <[email protected]>

* v1.21.0 changes notes and certificate related changes (#1642)

* v1.21.0 changes notes and certificate related changes

Signed-off-by: Jack (T.) Jia <[email protected]>

* wording fixes

Signed-off-by: Jack (T.) Jia <[email protected]>

* Edits

Signed-off-by: nannanli <[email protected]>

* fix typo

Signed-off-by: Jack (T.) Jia <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Pull in APIML release notes

Signed-off-by: nannanli <[email protected]>

* Pull in app server release notes

Signed-off-by: nannanli <[email protected]>

* Fix date

Signed-off-by: nannanli <[email protected]>

* Update summaryofchanges.md (#1647)

minor edits to zowe cli section

* Add missing release notes for app server

Signed-off-by: nannanli <[email protected]>

* Minor formatting fixes to API ML Summary of Changes for r1.21 (#1648)

Signed-off-by: Andrew Jandacek <[email protected]>

* TPSR for 1.21.0

Signed-off-by: nannanli <[email protected]>

* non strict verify certificates (#1649)

Signed-off-by: achmelo <[email protected]>

* Add known issue Re: Java z/OS components unable to read certificates from keyring (#1640)

Signed-off-by: Andrew Jandacek <[email protected]>

* Automatic update for the Error messages in API-Layer PR (#1663)

* Update error codes

Signed-off-by: Zowe Robot <[email protected]>

* Update error codes

Signed-off-by: Zowe Robot <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>

* SAF resource checking (#1653)

Signed-off-by: Andrew Jandacek <[email protected]>

* Update error codes (#1669)

Signed-off-by: Zowe Robot <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>
Co-authored-by: Jakub Balhar <[email protected]>

* Changes for enabling SSO (#1668)

* Sync updates  (#1650)

Signed-off-by: nannanli <[email protected]>

* Bump url-parse from 1.4.7 to 1.5.1 (#1665)

Signed-off-by: nannanli <[email protected]>

* changes for enabling SSO

Signed-off-by: Nayer Najafi <[email protected]>

Co-authored-by: nannanli <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Joe Winchester <[email protected]>

* Bump release version

Signed-off-by: nannanli <[email protected]>

* Add documentation for the Zowe component upgrade script (#1674)

Add doc for the zowe-upgrade-component script

Signed-off-by: at670475 <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>

* change password using SAF (#1676)

* change password using SAF

Signed-off-by: achmelo <[email protected]>

* refactor Change Password

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>

* Missing prop for saf check endpoint (#1677)

* add prop

Signed-off-by: jandadav <[email protected]>

* language refactor

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>

* Add subsequent release versions to SMPE doc (#1683)

Signed-off-by: nannanli <[email protected]>

Co-authored-by: Joe Winchester <[email protected]>

* State risks for zowe updater in the doc (#1684)

Update doc to state the issues

Signed-off-by: at670475 <[email protected]>

Co-authored-by: Andrew Jandacek <[email protected]>

* Documentation addition for extension installation and verification works (#1679)

* Added docs for zowe extensions verification

Signed-off-by: Jadin Luong <[email protected]>

* Made changes to zowe-verify-component.sh docs

Signed-off-by: Jadin Luong <[email protected]>

* Fixed typo

Signed-off-by: Jadin Luong <[email protected]>

* Fixed typo

Signed-off-by: Jadin Luong <[email protected]>

* Made changes to extension docs to make it more clear

Signed-off-by: Jadin Luong <[email protected]>

* Update install-configure-zos-extensions.md

Signed-off-by: nannanli <[email protected]>

* Added releases notes for this new feature

Signed-off-by: nannanli <[email protected]>

Co-authored-by: Jadin Luong <[email protected]>
Co-authored-by: nannanli <[email protected]>

* Automatic update for the Error messages in API-Layer PR (#1696)

* Update error codes

Signed-off-by: Zowe Robot <[email protected]>

* Minor grammar fixes

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* zOSMF and Zowe requirements for HA in Sysplex (#1681)

* zOSMF and Zowe requirements for HA in Sysplex

Signed-off-by: Nayer Najafi <[email protected]>

* zOSMF and Zowe requirements for HA in Sysplex

Signed-off-by: Nayer Najafi <[email protected]>

* Zowe HA documentation changes

Signed-off-by: Nayer Najafi <[email protected]>

* Edits

- Made some editorial changes to the descriptions/wording/style
- Added the new topic to the doc site sidebar

Co-authored-by: nannanli <[email protected]>

* Added word about how to get the sources image (#1631)

Signed-off-by: 1000TurquoisePogs <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Automatic update for the Error messages in API-Layer PR (#1699)

* Update error codes

Signed-off-by: Zowe Robot <[email protected]>

* Refactor ZWEAG710E

Signed-off-by: Andrew Jandacek <[email protected]>

* Add 'the'

Signed-off-by: Andrew Jandacek <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* Update error codes (#1707)

Signed-off-by: Zowe Robot <[email protected]>

Co-authored-by: Zowe Robot <[email protected]>

* User and security pre-req information in table format (#1678)

* Table for User IDs and permissions

Signed-off-by: Joe-Winchester <[email protected]>

* Update the table

Signed-off-by: nannanli <[email protected]>

* Update preparing-zos.md

Signed-off-by: nannanli <[email protected]>

* Separate CLI and z/OS pre-reqs and added ports needed

Signed-off-by: Joe-Winchester <[email protected]>

* Edits

Signed-off-by: nannanli <[email protected]>

* Edits to the sysreqs

Signed-off-by: nannanli <[email protected]>

* Remove unused documents

Signed-off-by: nannanli <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Update systemrequirements.md (#1710)

* Update systemrequirements.md

Signed-off-by: nannanli <[email protected]>

It's now two separate files. To not confuse users or cause broken links, update this link to direct people to the target locations.

* Update systemrequirements.md

Signed-off-by: nannanli <[email protected]>

* Update summaryofchanges.md (#1712)

Added Zowe CLI information for release 1.2.2.0

* Pull 1.22.0 release notes

Signed-off-by: nannanli <[email protected]>

* Changed pre-req for z/OS to be Java/Node/zOSMF to make it clearer for sysprogs (#1714)

* Changed pre-req order

Signed-off-by: Joe-Winchester <[email protected]>

* edits

Signed-off-by: nannanli <[email protected]>

Co-authored-by: nannanli <[email protected]>

* Update ZE RNs (#1715)

* update ZE RNs

Signed-off-by: Igor Kazmyr <[email protected]>

* add another bug fix to ZE RNs

Signed-off-by: Igor Kazmyr <[email protected]>

* fix small typographic issue

Signed-off-by: Igor Kazmyr <[email protected]>

* WIP: Zowe HA documentation changes (#1688)

* Zowe HA documentation changes

Signed-off-by: Nayer Najafi <[email protected]>

* Zowe HA documentation changes

Signed-off-by: Nayer Najafi <[email protected]>

* Update docs/getting-started/overview.md

Co-authored-by: Carson Cook <[email protected]>

* WIP: Zowe HA Installation Roadmap

Signed-off-by: Nayer Najafi <[email protected]>

* WIP: Zowe HA Installation Roadmap

Signed-off-by: Nayer Najafi <[email protected]>

* WIP: Zowe HA Installation Roadmap

Signed-off-by: Nayer Najafi <[email protected]>

* Update apiml diagram with source

Signed-off-by: jandadav <[email protected]>

* Update instance.env HA variables

Signed-off-by: Carson Cook <[email protected]>

* Fix discovery services list description

Signed-off-by: Carson Cook <[email protected]>

* Add Zowe HA started task (ZWESLSTC) configuration, change to Zowe HA installation roadmap, change to Configuring the z/OS system for Zowe

Signed-off-by: Nayer Najafi <[email protected]>

* add zowe.yaml doc

Signed-off-by: Jack (T.) Jia <[email protected]>

* add change log

Signed-off-by: Jack (T.) Jia <[email protected]>

* wording updates

Signed-off-by: Jack (T.) Jia <[email protected]>

* changes to HA installation roadmap, Zowe started task

Signed-off-b…
  • Loading branch information
Show file tree
Hide file tree
Showing 2,337 changed files with 719,489 additions and 9,911 deletions.
Binary file modified .DS_Store
Binary file not shown.
21 changes: 12 additions & 9 deletions docs/extend/extend-apiml/api-mediation-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,17 +314,15 @@ In the API ML, authorization is performed by the z/OS security manager ([ACF2](h

The JWT secret that signs the JWT Token is an asymmetric private key that is generated during Zowe keystore configuration. The JWT token is signed with the RS256 signature algorithm.

You can find the JWT secret, alias `jwtsecret`, in the PKCS12 keystore that is stored in `${KEYSTORE_DIRECTORY}/localhost/localhost.keystore.p12`. The public key necessary to validate the JWT signature is read from the keystore.

For easy access, you can find the public key in the `${KEYSTORE_DIRECTORY}/localhost/localhost.keystore.jwtsecret.pem` file.
You can find the JWT secret, alias `localhost`, in the PKCS12 keystore that is stored in `${KEYSTORE_DIRECTORY}/localhost/localhost.keystore.p12`. The public key necessary to validate the JWT signature is read from the keystore.

You can also use the `/api/v1/gateway/auth/keys/public/all` endpoint to obtain all public keys that can be used to verify JWT tokens signature in standard [JWK format](https://openid.net/specs/).

### z/OSMF JSON Web Tokens Support

Your z/OSMF instance can be enabled to support JWT tokens as described at [Enabling JSON Web Token support](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.4.0/com.ibm.zos.v2r4.izua300/izuconfig_EnableJSONWebTokens.htm).
In this case, the Zowe API ML uses this JWT token and does not generate its own Zowe JWT token. All authentication APIs, such as `/api/v1/gateway/login` and `/api/v1/gateway/check` function in the same way as without z/OSMF JWT.
The `zowe-setup-certificates.sh` stores the z/OSMF JWT public key to the `localhost.keystore.jwtsecret.pem` that can be used for JWT signature validation.
Gateway service endpoint `/api/v1/gateway/auth/keys/public/all` serves the z/OSMF JWK that can be used for JWT signature validation.

### API ML truststore and keystore

Expand Down Expand Up @@ -352,7 +350,6 @@ The elements in the following list, which apply to the API ML SAF Keyring, have
- Server certificate of the Gateway (with PK). This can be signed by the local CA or an external CA.
- Server certificate of the Discovery Service (with PK). This can be signed by the local CA.
- Server certificate of the Catalog (with PK). This can be signed by the local CA.
- Private asymmetric key for the JWT token, alias `jwtsecret`. The public key is exported to the `localhost.keystore.jwtsecret.cer` directory.
- The API ML keystore is used by API ML services.

**The API ML truststore or API ML SAF Keyring**
Expand Down Expand Up @@ -442,6 +439,7 @@ for detailed knowledge of the REST API calls presented in this section. The Clie
- To validate and get details from a JWT token
- To invalidate the JWT token
- To obtain a PassTicket
- To change a password

### Pre-requisites

Expand All @@ -456,6 +454,7 @@ The plain java library provides the `ZaasClient` interface with following public
```java
public interface ZaasClient {
String login(String userId, String password) throws ZaasClientException;
String login(String userId, String password, String newPassword) throws ZaasClientException;
String login(String authorizationHeader) throws ZaasClientException;
ZaasToken query(String token) throws ZaasClientException;
ZaasToken query(HttpServletRequest request) throws ZaasClientException;
Expand Down Expand Up @@ -483,13 +482,17 @@ To integrate login, call one of the following methods for login in the `ZaasClie

- If the user provides credentials as Basic Auth, use the following method:

```java
String login(String authorizationHeader) throws ZaasClientException;
```
```java
String login(String authorizationHeader) throws ZaasClientException;
```
- If the user provides credentials in the request body, there is also the option to change the password. Call the login method adding another String variable for the new password, call the following method from your API:

```java
String login(String userId, String password, String newPassword) throws ZaasClientException;
```
These methods return the JWT token as a String. This token can then be used to authenticate the user in subsequent APIs.

**Note:** Both methods automatically use the truststore file to add a security layer, which requires configuration in the `ConfigProperties` class.
**Note:** Each of these methods automatically use the truststore file to add a security layer, which requires configuration in the `ConfigProperties` class.

#### Validate and get details from the token (`query`)

Expand Down
52 changes: 42 additions & 10 deletions docs/extend/extend-apiml/create-apiml-extension.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
# Create an Extension for API ML

Zowe allows extenders to define their own extension for API ML. Follow the steps in this article to create your extension and include it to the
API Gateway classpath:
Zowe allows extenders to define their own extension for API ML.

1. Create a JAR file from your extension.
2. Create a `manifest.yml` with the following structure (check out [Packaging z/OS extensions](../packaging-zos-extensions.md) for more information):
## API ML Services with Class Path Extension Support

For API ML services with extension support, extension executables can be loaded by setting the shared library path variable that corresponds to the particular service.

|Service |Extension directory environment variable|
|-----------------|----------------------------------------|
|API Gateway | `ZWE_GATEWAY_SHARED_LIBS` |
|Discovery Service| `ZWE_DISCOVERY_SHARED_LIBS` |

## API ML Services with Library Path Extension Support

The API Gateway can load native Java libraries by setting `ZWE_GATEWAY_LIBRARY_PATH` to a path pointing to the native library.

## Example API Gateway Extension

Follow the steps in this article to create your extension. The example in this article is for an extension of the API Gateway.

**Note:** The `api-sample-extension-package` contains a sample `manifest.yml`, and the `apiml-sample-extension` JAR that contains the extension.

**Follow these steps:**

1. Create a JAR file from your extension. See the [API ML sample extension](https://github.com/zowe/api-layer/blob/master/apiml-sample-extension) to model the format of the JAR.
2. Create a `manifest.yml` with the following structure. See the sample [`manifest.yml`](https://github.com/zowe/api-layer/blob/master/apiml-sample-extension-package/src/main/resources/manifest.yaml) to model the format of the yaml file.

For more information, see [Packaging z/OS extensions](../packaging-zos-extensions.md).

**Example:**

```yaml
---
name: apiml-extension
Expand All @@ -32,18 +55,27 @@ API Gateway classpath:
- path/to/my/lib1/
- path/to/my/lib2/
```
3. Define the `ZWE_GATEWAY_SHARED_LIBS` environment variable in the `instance.env`. This variable points to the
extension directory.

**Example:** `<instance>/workspace/gateway/sharedLibs/<extension_id>`

The `ZWE_GATEWAY_SHARED_LIBS` environment variable points to the
extension directory `<instance>/workspace/gateway/sharedLibs/`.
The extension directory is then added to the API Gateway class path as part of the Zowe instance preparation.
**Note:** The paths defined under `gatewaySharedLibs` can either be a path to the directory where the
extensions JARs are located, or a path to the files.

**Note:** The paths defined under `gatewaySharedLibs` can either be a path to the directory where the extensions JARs are located, or a path to the files.

**Example:**
```yaml
gatewaySharedLibs:
- path/to/my/lib1/extension1.jar
- path/to/my/lib2/extension2.jar
```
After the JAR file and `manifest.yml` are customized according to your application, the extension is extracted, scanned, and added to the extension directory during the Zowe instance preparation. When the API Gateway starts, the API Gateway consumes the sample extension.

The extension should now be correctly added to the API Gateway classpath.

## Call the REST endpoint for validation

Follow these steps to validate that you can call the REST endpoint defined in the controller via the API Gateway:

1. Call the `https://<hostname>:<gatewayPort>/api/v1/greeting` endpoint though Gateway.
2. Verify that you receive the message, `Hello, I'm a sample extension!` as the response.
10 changes: 10 additions & 0 deletions docs/extend/extend-apiml/onboard-static-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,16 @@ additionalServiceMetadata:

**Tip:** For more information, see [Enabling PassTicket creation for API Services that accept PassTickets](api-mediation-passtickets.md).

* **safIdt**

This value specifies that the application recognizes the SAF IDT scheme and fills the `X-SAF-Token` header with the token produced by the Saf IDT provider implementation.

For more information, see [SAF IDT provider](implement-new-saf-provider.md)

* **x509**

This value specifies that a service accepts client certificates forwarded in the HTTP header. The Gateway service extracts information from a valid client certificate. For validation, the certificate needs to be trusted by API Mediation Layer, and needs to contain a Client Authentication (1.3.6.1.5.5.7.3.2) entry in Extended Key Usage. To use this scheme, it is also necessary to specify which headers to include. Specify these parameters in `headers`.

* **zosmf**

This value specifies that a service accepts z/OSMF LTPA (Lightweight Third-Party Authentication).
Expand Down
81 changes: 81 additions & 0 deletions docs/getting-started/release-notes/v1_27.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Version 1.27 (January 2022)

Welcome to the Version 1.27.0 release of Zowe!

To see a full list of release enhancements and fixes, see [New features and enhancements](#new-features-and-enhancements) and [Bug fixes](#bug-fixes).

**Release demo:** Join the Zowe System Demo on January 31, 2022 to see a demo of what's new in this release, and ask the community questions. Check out the [Zowe calendar](https://lists.openmainframeproject.org/g/zowe-dev/calendar) for detailed call-in information.

**Download v1.27.0 build:** Want to try new features as soon as possible? You can download the v1.27.0 build from [Zowe.org](https://www.zowe.org/download.html).

## New features and enhancements

### Zowe API Mediation Layer

* Enabled Discovery Service class path extensions and Gateway native library extensions (#1987) ([fd03db5](https://github.com/zowe/api-layer/commit/fd03db5)), closes [#1987](https://github.com/zowe/api-layer/issues/1987)
* Added Zaas methods for password change support (#1991) ([7597bd7](https://github.com/zowe/api-layer/commit/7597bd7)), closes [#1991](https://github.com/zowe/api-layer/issues/1991)
* Created API ML sample extension. This extension contains a sample controller (#1947) ([a085cf3](https://github.com/zowe/api-layer/commit/a085cf3)), closes [#1947](https://github.com/zowe/api-layer/issues/1947)
* Removed jwtsecret from usage (#1976) ([62e9d1d](https://github.com/zowe/api-layer/commit/62e9d1d)), closes [#1976](https://github.com/zowe/api-layer/issues/1976)

### Zowe Application Framework

* The app framework and the rest of Zowe no longer requires a PKCS#11 ISCF setup. Previously, PKCS#11 was used for single sign on (SSO) by ZSS, but ZSS now automatically completes SSO setup at start-up of Zowe through negotiation with the API Mediation Layer Gateway. As a result, SSO is now automatic and enabled by default when the API mediation layer, ZSS, and optionally the app server is enabled. This enhancement will work with existing PKCS#11 setups, but they are no longer used.
* The app framework and the rest of Zowe no longer requires a "jwtsecret" object in the Zowe keystore. Previously, this was used for single sign on (SSO) but SSO has been simplified, and now only HTTPS keys and certificates are needed within the keystore. This enhancement will work with existing keystores but the jwtsecret object is no longer used.

### Zowe CLI

The following enhancements were added to the **core CLI**:

The following enhancement was added to the **Imperative CLI Framework**:

### z/OS FTP Plug-in for Zowe CLI

The following enhancements were added to the **z/OS FTP Plug-in for Zowe CLI**:

* Added second shortcuts to match with Zowe core CLI options.

## Bug fixes

### Zowe API Mediation Layer

* Build conformant images properly (#2009) ([5f07073](https://github.com/zowe/api-layer/commit/5f07073)), closes [#2009](https://github.com/zowe/api-layer/issues/2009)
* Add log masking class for sensitive logs (#2003) ([994b483](https://github.com/zowe/api-layer/commit/994b483)), closes [#2003](https://github.com/zowe/api-layer/issues/2003)

### Zowe Application Framework

#### zLUX App Server

* Fixed development environment case in which app-server would crash without agent config being fully defined.

#### zLUX Server Framework

* Added small check on agent network configuration to avoid throwing an exception if the agent configuration included JWT information, but not network information



### Zowe CLI

The following bugs were fixed in **core Zowe CLI**:

* Corrected issue where, in certain circumstances, downloaded files were truncated. [(#1170)](https://github.com/zowe/zowe-cli/issues/1170)
* Updated Imperative to absorb bug fixes that were introduced in version `4.17.2`.

#### Imperative CLI Framework

The following bugs were fixed in the **Imperative CLI Framework**:

* Fixed `AbstractRestClient` silently failing to decompress the last chunk of gzip-compressed binary data that is truncated.
* Updated dependencies for improved security. [(#719)](https://github.com/zowe/imperative/issues/719)

#### CICS Plug-in for Zowe CLI

* Updated Readme links.

#### Secure Credential Store Plug-in for Zowe CLI

* Updated Readme links.

#### z/OS FTP Plug-in for Zowe CLI

* Fixed `download uss-file` and `view uss-file` for files under a symbolically linked directory.

20 changes: 13 additions & 7 deletions docs/troubleshoot/troubleshoot-apiml-error-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,19 +303,25 @@ The following error message codes may appear on logs or API responses. Use the f

### ZWEAM511E

The certificate of the service accessed using URL '%s' is not trusted by the API Gateway: %s
There was a TLS request error accessing the URL '%s': '%s'

**Reason:**

The Gateway does not trust the requested service and refuses to communicate with it.
The Gateway refuses to communicate with the requested service.

**Action:**

Possible actions regarding to message content:
- Message: The certificate is not trusted by the API Gateway.
Action: Verify trust of the certificate is the issue by disabling certificate verification and retry the request.
- Message: Certificate does not match any of the subject alternative names.
Action: Verify that the hostname which the certificate is issued for matches the hostname of the service.
Action: Verify that the hostname which the certificate is issued for matches the hostname of the service.
- Message: Unable to find the valid certification path to the requested target.
Action: Import the root CA that issued services's certificate to API Gateway truststore
Action: Import the root CA that issued services' certificate to API Gateway truststore.
- Message: Verify the requested service supports TLS.
Action: Ensure the requested service is running with TLS enabled.
- Message: Review the APIML debug log for more information.
Action: Enable APIML debug mode and retry the request, then review the APIML log for TLS errors.

### ZWEAM600W

Expand Down Expand Up @@ -969,19 +975,19 @@ The following error message codes may appear on logs or API responses. Use the f

### ZWEAG704E

Configuration error '%s' when trying to read jwt secret: %s
Configuration error '%s' when trying to read the public and private key for signing JWT: %s

**Reason:**

A problem occurred while trying to read the JWT secret key from the keystore.
A problem occurred while trying to read the certificate-key pair from the keystore.

**Action:**

Review the mandatory fields used in the configuration such as the keystore location path, the keystore and key password, and the keystore type.

### ZWEAG705E

Failed to load public or private key from key with alias '%s' in the keystore '%s'. The Gateway is shutting down.
Failed to load public or private key from key with alias '%s' in the keystore '%s'. Gateway is shutting down.

**Reason:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ This section describes runtime configuration properties.
```
where:
* `{expirationTimeInSeconds}`
* **`{expirationTimeInSeconds}`**
refers to the specific time before expiration
refers to the specific time before expiration
4. Restart Zowe&trade.
Expand Down Expand Up @@ -112,20 +112,14 @@ This section describes runtime configuration properties.
**Note:** Use either dot separation, or the UPPER_CASE naming convention when adding an additional environmental variable.
One use case for adding an environmental variable is to provide a label for a JWT secret. This secret is usually generated during Zowe installation. In some scenarios, however, users may want to use their own secret which is already created and labled differently. Use this procedure to use a customized secret.
One use case for adding an environmental variable is to change the authentication provider. The `SAF Authentication Provider` allows the API Gateway to authenticate directly with the z/OS SAF provider that is installed on the system. The user needs a SAF account to authenticate. Use this procedure to customize authentication provider.
**Follow the steps:**
1. Open the file `<Zowe instance directory>/instance.env`.
2. Add a new line with the following property:
`apiml.security.auth.jwtKeyAlias=<your_jwtsecter_label>`.
where:
* **apiml.security.auth.jwtKeyAlias**
is the label under which the secret is located. This secret is used to sign the JWT. This secret is stored in the keystore or keyring. The secret generated by the Zowe install script is stored under the default label `jwtsecret`.
`apiml.security.auth.provider=saf`.
## Service configuration
Expand Down
Loading

0 comments on commit 98a2d86

Please sign in to comment.