Skip to content

Commit

Permalink
v1.26 docs (#1928)
Browse files Browse the repository at this point in the history
* 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-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 <and…
  • Loading branch information
Show file tree
Hide file tree
Showing 1,989 changed files with 77,460 additions and 9,436 deletions.
Binary file modified .DS_Store
Binary file not shown.
9 changes: 5 additions & 4 deletions docs/extend/extend-apiml/api-mediation-passtickets.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ The API Gateway provides the user ID and password in the Authorization header of

- [Outline for enabling PassTicket support](#outline-for-enabling-passticket-support)
- [Security configuration that allows the Zowe API Gateway to generate PassTickets for an API service](#security-configuration-that-allows-the-zowe-api-gateway-to-generate-passtickets-for-an-api-service)
- [CA ACF2](#ca-acf2)
- [CA Top Secret](#ca-top-secret)

- [ACF2](#acf2)
- [Top Secret](#top-secret)
- [RACF](#racf)
- [API services that support PassTickets](#api-services-that-support-passtickets)
- [API Services that register dynamically with API ML that provide authentication information](#api-services-that-register-dynamically-with-api-ml-that-provide-authentication-information)
Expand Down Expand Up @@ -48,7 +49,7 @@ Use the following variables to generate PassTickets for the API service to enabl

Replace the variables in the following examples with actual values.

### CA ACF2
### ACF2

Grant the Zowe started task user ID permission to generate PassTickets for users of that API service.
The following code is an example of security commands that need to be issued.
Expand All @@ -63,7 +64,7 @@ F ACF2,REBUILD(PTK),CLASS(P)
END
```

### CA Top Secret
### Top Secret

Grant the Zowe started task user ID permission to generate PassTickets for users of that API service.

Expand Down
2 changes: 1 addition & 1 deletion docs/extend/extend-apiml/api-mediation-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This method of basic routing is based on the service ID that identifies the serv

The URI identifies the resource, but does not identify the instance of the service as unique when multiple instances of the same service are provided. For example, when a service is running in high-availability (HA) mode.

Services of the same product that provide different resources, such as CA SYSVIEW on one system and CA SYSVIEW in a different sysplex, cannot have the same service ID (the same URI cannot have two different meanings).
Services of the same product that provide different resources, such as SYSVIEW on one system and SYSVIEW in a different sysplex, cannot have the same service ID (the same URI cannot have two different meanings).

In addition to the basic Zuul routing, the Zowe API Gateway supports versioning in which you can specify a major version. The Gateway routes a request only to an instance that provides the specified major version of the API.

Expand Down
5 changes: 3 additions & 2 deletions docs/extend/extend-apiml/api-mediation-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,10 +294,11 @@ Use the following property of the API Gateway to enable the `SAF Authentication
```
apiml.security.auth.provider: saf
```
**Note:** To provide your own implementation of the SAF IDT provider, see the [Implement new SAF provider](implement-new-saf-provider.md) guidelines.

##### Dummy Authentication Provider

The `Dummy Authentication Provider` implements simple authentication for development purpose using dummy credentials (username: `user`, password `user`). The `Dummy Authentication Provider` makes it possible for the API Gateway to run without authenticating with the z/OSMF service.
The `Dummy Authentication Provider` implements simple authentication for development purposes using dummy credentials (username: `user`, password `user`). The `Dummy Authentication Provider` makes it possible for the API Gateway to run without authenticating with the z/OSMF service.

Use the following property of API Gateway to enable the `Dummy Authentication Provider`:
```
Expand All @@ -308,7 +309,7 @@ apiml.security.auth.provider: dummy

Authorization is a method used to determine access rights of an entity.

In the API ML, authorization is performed by the z/OS security manager ([CA ACF2](https://www.broadcom.com/products/mainframe/identity-access/acf2), [IBM RACF](https://www.ibm.com/support/knowledgecenter/zosbasics/com.ibm.zos.zsecurity/zsecc_042.htm), [CA Top Secret](https://www.broadcom.com/products/mainframe/identity-access/top-secret)). An authentication token is used as proof of valid authentication. The authorization checks, however, are always performed by the z/OS security manager.
In the API ML, authorization is performed by the z/OS security manager ([ACF2](https://www.broadcom.com/products/mainframe/identity-access/acf2), [IBM RACF](https://www.ibm.com/support/knowledgecenter/zosbasics/com.ibm.zos.zsecurity/zsecc_042.htm), [Top Secret](https://www.broadcom.com/products/mainframe/identity-access/top-secret)). An authentication token is used as proof of valid authentication. The authorization checks, however, are always performed by the z/OS security manager.

### JWT Token

Expand Down
49 changes: 49 additions & 0 deletions docs/extend/extend-apiml/create-apiml-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# 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:

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

**Example:**
```yaml
---
name: apiml-extension
# Component identifier. This identifier matches artifact path in Zowe Artifactory https://zowe.jfrog.io/.
id: org.zowe.apiml.sdk.apiml-extension-package
# Component version is defined in gradle.properties for Gradle project
# Human readable component name
title: Your extension for API ML
# Human readable component description
description: JAR that contains the API ML extension.
license: EPL-2.0
repository:
type: git
url: https://github.com/zowe/api-layer.git
build:
branch: "{{build.branch}}"
number: "{{build.number}}"
commitHash: "{{build.commitHash}}"
timestamp: "{{build.timestamp}}"
# The following block contains all the extensions directory path
# (or file path) that will be included in the API ML
gatewaySharedLibs:
- 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 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.

**Example:**
```yaml
gatewaySharedLibs:
- path/to/my/lib1/extension1.jar
- path/to/my/lib2/extension2.jar
```
109 changes: 109 additions & 0 deletions docs/extend/extend-apiml/implement-new-saf-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Implement a new SAF IDT provider

As a Zowe API ML user, you can use the API Gateway to apply your own SAF Identity Token (IDT) provider by implementing
an existing interface.

- [How to create a SAF IDT provider](#how-to-create-a-saf-idt-provider)
- [How to integrate your extension with API ML](#how-to-integrate-your-extension-with-api-ml)
- [How to use an existing SAF IDT provider](#how-to-use-an-existing-saf-idt-provider)
- [How to use the SAF IDT provider](#how-to-use-the-saf-idt-provider)

To configure SAF IDT on z/OS, see [Configure signed SAF Identity tokens (IDT)](../../user-guide/configure-zos-system.md#configure-signed-saf-identity-tokens-idt).

## How to create a SAF IDT provider

To create your own implementation of the SAF IDT provider, follow these steps:

1. Implement the existing `org.zowe.apiml.gateway.security.service.saf.SafIdtProvider` interface.

```java
public interface SafIdtProvider {
/**
* If the current user has the proper rights generate the SAF token on its behalf and return it back.
*
* @return Either empty answer meaning the user is either unauthenticated or doesn't have the proper rights.
*/
Optional<String> generate(String username);

/**
* Verify that the provided saf token is valid.
*
* @param safToken Token to validate.
* @return true if the token is valid, false if it is invalid
*/
boolean verify(String safToken);
}
```

The `SafIdtProvider` interface contains the `generate` and `verify` methods. The `generate` method can be overridden by your SAF IDT implementation to generate the SAF token on behalf of the specified user. The `verify` method can be overridden to verify that the provided SAF token is valid.

2. Register a bean in order to use the implemented SAF IDT provider.

**Example:**

```java
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*/
package org.zowe.apiml.gateway.security.service.saf;

import lombok.RequiredArgsConstructor;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
import org.zowe.apiml.gateway.security.service.AuthenticationService;
import org.zowe.apiml.passticket.PassTicketService;

@Configuration
@RequiredArgsConstructor
public class SafProviderBeansConfig {
@Bean
@ConditionalOnProperty(name = "apiml.security.saf.provider", havingValue = "rest")
public SafIdtProvider restSafProvider(
RestTemplate restTemplate,
AuthenticationService authenticationService,
PassTicketService passTicketService
) {
return new SafRestAuthenticationService(restTemplate, authenticationService, passTicketService);
}
}
```

You created a SAF IDT provider.
## How to integrate your extension with API ML

To use your SAF IDT provider as an extension of API ML, see [Create an extension for API ML](create-apiml-extension.md).

## How to use the SAF IDT provider

To use the newly created SAF IDT provider, it is necessary to set the parameter `apiml.authentication.scheme` to `safIdt` in your service configuration.
Your application then properly recognizes the SAF IDT scheme and fills the `X-SAF-Token` header with the token produced by your SAF IDT provider.

## How to use an existing SAF IDT provider

You can generate and verify an existing SAF token by using an implementation of the SAF IDT provider that utilizes a ZSS solution.

[SafRestAuthenticationService](https://github.com/zowe/api-layer/blob/master/gateway-service/src/main/java/org/zowe/apiml/gateway/security/service/saf/SafRestAuthenticationService.java) is an example of the SAF IDT provider implementation which uses REST as a method of communication.

To use `SafRestAuthenticationService` ensure that `apiml.security.saf.provider` is set to `rest`. (This is the default value)
Set the following environment parameters in the `instance.env`:

* `APIML_SECURITY_SAF_URLS_AUTHENTICATE=https://${ZOWE_EXPLORER_HOST}:${GATEWAY_PORT}/zss/api/v1/saf/authenticate`
* `APIML_SECURITY_SAF_URLS_VERIFY=https://${ZOWE_EXPLORER_HOST}:${GATEWAY_PORT}/zss/api/v1/saf/verify`

These ZSS endpoints are used by the `SafRestAuthenticationService` to generate and validate the SAF token.

<img src={require("../../images/api-mediation/safidt-providers.png").default} alt="SAF IDT providers"/>

The following diagram illustrates how communication using the SAF IDT provider works:

<img src={require("../../images/api-mediation/safidt-diagram.png").default} alt="SAF IDT diagram"/>


2 changes: 2 additions & 0 deletions docs/extend/extend-apiml/onboard-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ As an API developer, you can onboard a REST API service to the Zowe&trade; API M

The specific method you use to onboard a REST API to the API ML depends on the programming language or framework used to build your REST service.

**Note:** To streamline the process of onboarding new REST API services to the Zowe API Mediation Layer, see [Onboarding a REST API service with the YAML Wizard](./onboard-wizard.md)

This Onboarding Overview article addresses the following topics:

- [Prerequisites](#prerequisites)
Expand Down
27 changes: 17 additions & 10 deletions docs/extend/extend-apiml/onboard-plain-java-enabler.md
Original file line number Diff line number Diff line change
Expand Up @@ -541,23 +541,30 @@ where:
**Note:** This is the default scheme when no authentication parameters are specified.
* **zoweJwt**
* **zoweJwt**
This value specifies that a service accepts the Zowe JWT. No additional processing is done by the API Gateway.
This value specifies that a service accepts the Zowe JWT. No additional processing is done by the API Gateway.
* **httpBasicPassTicket**
* **httpBasicPassTicket**
This value specifies that a service accepts PassTickets in the Authorization header of the HTTP requests using the basic authentication scheme.
It is necessary to provide a service APPLID in `authentication.applid` parameter.
This value specifies that a service accepts PassTickets in the Authorization header of the HTTP requests using the basic authentication scheme.
It is necessary to provide a service APPLID in `authentication.applid` parameter.

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

* **zosmf**
* **zosmf**

This value specifies that a service accepts z/OSMF LTPA (Lightweight Third-Party Authentication).
This scheme should be used only for a z/OSMF service used by the API Gateway Authentication Service and other z/OSMF services that use the same LTPA key.
This value specifies that a service accepts z/OSMF LTPA (Lightweight Third-Party Authentication).
This scheme should be used only for a z/OSMF service used by the API Gateway Authentication Service and other z/OSMF services that use the same LTPA key.

For more information about z/OSMF Single Sign-on, see [Establishing a single sign-on environment](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.4.0/com.ibm.zosmfcore.multisysplex.help.doc/izuG00hpManageSecurityCredentials.html)
For more information about z/OSMF Single Sign-on, see [Establishing a single sign-on environment](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.4.0/com.ibm.zosmfcore.multisysplex.help.doc/izuG00hpManageSecurityCredentials.html)

* **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`.
Expand Down
6 changes: 3 additions & 3 deletions docs/extend/extend-apiml/onboard-static-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,9 +371,9 @@ additionalServiceMetadata:

**Examples:**

- `org.zowe.file`
- `com.ca.sysview`
- `com.ibm.zosmf`
- `zowe.file`
- `ca.sysview`
- `ibm.zosmf`

* **apiInfo.gatewayUrl**

Expand Down
2 changes: 1 addition & 1 deletion docs/extend/extend-apiml/service-information.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ In IBM RACF, the access to the service information can be given by:
PERMIT APIML.SERVICES CLASS(ZOWE) ID(user) ACCESS(READ)
```

In CA Top Secret:
In Top Secret:

```markup
TSS PERMIT(user) ZOWE(APIML.SERVICES) ACCESS(READ)
Expand Down
2 changes: 2 additions & 0 deletions docs/extend/extend-zowe-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ To register a z/OS service with the API Mediation Layer, there are two approache

For information about how to onboard REST APIs, see the [Onboarding Overview](extend-apiml/onboard-overview.md).

To streamline the process of onboarding new REST API services to the API Mediation Layer, see [Onboarding a REST API service with the YAML Wizard](./extend-apiml/onboard-wizard.md)

### Dynamic API registration

Registration of a REST API service to the API ML is performed through a call to the Discovery Service by sending registration data and metadata for the service being registered. Registration requires that the z/OS service must know the web address of the API ML Discovery Service. When Dynamic registration is performed, the service that performs the registration must periodically send heartbeat requests to the Discovery Service for each registered service instance. These heartbeat requests serve to renew the corresponding service instance registration with API ML. These requests enable the Discovery Service to monitor the availability of registered service instances. Services that are registered dynamically display the status of the service in the API Catalog after initial service registration.
Expand Down
Loading

0 comments on commit 2e54451

Please sign in to comment.