Skip to content

Commit

Permalink
Publish v1.22.0 docs (#1716)
Browse files Browse the repository at this point in the history
* 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-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]>

Co-authored-by: Pavlin Zahariev <[email protected]>
Co-authored-by: Brandon Jenkins <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Joe-Winchester <[email protected]>
Co-authored-by: Carson Cook <[email protected]>
Co-authored-by: Carson Cook <[email protected]>
Co-authored-by: Jakub Balhar <[email protected]>
Co-authored-by: 1000TurquoisePogs <[email protected]>
Co-authored-by: ajinrocket <[email protected]>
Co-authored-by: Jack (T.) Jia <[email protected]>
Co-authored-by: David Janda <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: Michael Aimino <[email protected]>
Co-authored-by: achmelo <[email protected]>
Co-authored-by: Andrea Tabone <[email protected]>
Co-authored-by: Jakub Balhar <[email protected]>
Co-authored-by: Petr Plavjanik <[email protected]>
Co-authored-by: Igor Kazmyr <[email protected]>
Co-authored-by: Pluto <[email protected]>
Co-authored-by: Martin Zeithaml <[email protected]>
Co-authored-by: Kumar Saurabh Raj <[email protected]>
Co-authored-by: zowe-robot <[email protected]>
Co-authored-by: Zowe Robot <[email protected]>
Co-authored-by: NayerNajafi <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: JadinLuong <[email protected]>
Co-authored-by: Jadin Luong <[email protected]>
Co-authored-by: Jack (T.) Jia <[email protected]>
  • Loading branch information
1 parent 3446220 commit 9551e5d
Show file tree
Hide file tree
Showing 47 changed files with 1,917 additions and 488 deletions.
4 changes: 2 additions & 2 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// load versions list
const ZOWE_VERSIONS = require('./versions.json')
const CURRENT_ZOWE_VERSION = '1.21.0 LTS'
const CURRENT_ZOWE_VERSION = '1.22.0 LTS'
// Due to VuePress limitation, publish url path cannot have dot (.) inside
// so we convert it to dash
const PUBLISH_TARGET_PATH = (process.env.PUBLISH_TARGET_PATH || 'stable').replace(/\./g, '-')
Expand Down Expand Up @@ -131,7 +131,7 @@ module.exports = {
version: CURRENT_ZOWE_VERSION,
base: `/${PUBLISH_TARGET_PATH}/`,
dest: `.deploy/${PUBLISH_TARGET_PATH}/`,
description: 'Version 1.21.x LTS',
description: 'Version 1.22.x LTS',
extraWatchFiles: [
'.vuepress/theme/'
],
Expand Down
15 changes: 13 additions & 2 deletions docs/.vuepress/pages.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@
"baseuri": "/user-guide/",
"items": [
{
"text": "Planning and preparing the installation",
"text": "Planning and preparing the z/OS installation",
"items": [
"user-guide/installandconfig.md",
"user-guide/systemrequirements.md",
"user-guide/systemrequirements-zos.md",
"user-guide/install-nodejs-zos.md",
"user-guide/systemrequirements-zosmf.md",
"user-guide/systemrequirements-zosmf-lite.md",
Expand Down Expand Up @@ -83,9 +83,20 @@
"user-guide/configuring-docker.md"
]
},
{
"text": "Zowe High Availability",
"items": [
"user-guide/install-ha-sysplex.md",
"user-guide/configure-sysplex.md",
"user-guide/systemrequirements-zosmf-ha.md",
"user-guide/configure-caching-service-ha.md",
"user-guide/configure-zowe-ha-server.md"
]
},
{
"text": "Installing Zowe CLI",
"items": [
"user-guide/systemrequirements-cli.md",
"user-guide/cli-installcli.md",
"user-guide/install-cli-via-proxy.md",
"user-guide/cli-updatingcli.md",
Expand Down
Binary file not shown.
6 changes: 5 additions & 1 deletion docs/.vuepress/versions.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
[{
"text": "v1.21.x LTS",
"text": "v1.22.x LTS",
"link": "stable/"
},
{
"text": "v1.21.x LTS",
"link": "v1-21-x/"
},
{
"text": "v1.20.x LTS",
"link": "v1-20-x/"
Expand Down
5 changes: 3 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,10 @@ footer: Except where otherwise noted, content on this site is licensed under a C

### Zowe documentation

You can download the Version 1.x.x Zowe documentation in PDF format from the links below. The latest version on this website is 1.21.0.
You can download the Version 1.x.x Zowe documentation in PDF format from the links below. The latest version on this website is 1.22.0.

**[V1.21.x](https://docs.zowe.org/stable/Zowe_Documentation.pdf)** |
**[V1.22.x](https://docs.zowe.org/stable/Zowe_Documentation.pdf)** |
**[V1.21.x](./Zowe_Documentation_1.21.0.pdf)** |
**[V1.20.x](./Zowe_Documentation_1.20.x.pdf)** |
**[V1.19.x](./Zowe_Documentation_1.19.1.pdf)** |
**[V1.18.0](./Zowe_Documentation_1.18.0.pdf)** |
Expand Down
2 changes: 2 additions & 0 deletions docs/extend/extend-apiml/service-information.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ RECKEY APIML ADD(SERVICES SERVICE(READ) ROLE(user) ALLOW)
F ACF2,REBUILD(ZWE)
```

API Gateway can be configured to check for SAF resource authorization in several ways. For details, see [SAF Resource Checking](../../user-guide/api-mediation/api-gateway-configuration.md#saf-resource-checking)

## API Endpoints

### Obtain Information about a Specific Service
Expand Down
219 changes: 178 additions & 41 deletions docs/extend/install-configure-zos-extensions.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extend/lifecycling-with-zwesvstc.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Zowe UNIX System Services (USS) components are run as part of the started ta

To start Zowe, the script `<INSTANCE_DIR>/bin/zowe-start.sh` is run from a USS shell. This uses a REXX program to launch the started task `ZWESVSTC`, passing the instance directory path as a parameter. It is the equivalent of using the TSO command `/S ZWESVSTC,INSTANCE='<INSTANCE_DIR>',JOBNAME='<JOBNAME>'`. The `ZWESVSTC` PROCLIB uses the program that creates a USS process and starts the script `<INSTANCE_DIR>/bin/internal/run-zowe.sh`. By using `BPXATSL` to start the USS process, all of the address spaces started under this shell are managed by SDSF. If the `zowe-start.sh` run `run-zowe.sh` directly, the USS processes will not run as a started task and will run under the user ID of whoever ran the `run-zowe.sh` script rather than the Zowe user ID of `ZWESVUSR`, likely leading to permission errors accessing the contents of the `<RUNTIME_DIR>` as well as the Zowe certificate. For these reasons, the `zowe-start.sh` script launches Zowe's USS process beneath the started task `ZWESVSTC`.

When `run-zowe.sh` is run in the USS shell that `BPXBATSL` creates, it executes the file `<INSTANCE_DIR>/instance.env`. This file sets a number of shell variables, such as `ROOT_DIR` that points to the directory with the `<RUNTIME_DIR>`, variables for all of the ports used by the Zowe components, and other configuration data. For more information, see [Reviewing the instance.env file](../user-guide/configure-instance-directory.md#reviewing-the-instance.env-file).
When `run-zowe.sh` is run in the USS shell that `BPXBATSL` creates, it executes the file `<INSTANCE_DIR>/instance.env`. This file sets a number of shell variables, such as `ROOT_DIR` that points to the directory with the `<RUNTIME_DIR>`, variables for all of the ports used by the Zowe components, and other configuration data. For more information, see [Updating the instance.env configuration file](../user-guide/configure-instance-directory.md#updating-the-instance-env-configuration-file).

**Note:**

Expand Down
5 changes: 4 additions & 1 deletion docs/getting-started/cli-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,10 @@ Most command groups require a `zosmf-profile`, but some plug-ins add their own p
zowe profiles create zosmf-profile myprofile123 --host my.company.com --port 123 --user myusername123 --password mypassword123
```

**Note:** The port defaults to 443 if you omit the `--port` option. Specify a different port if your host system does not use port 443.
**Notes:**

- The port defaults to 443 if you omit the `--port` option. Specify a different port if your host system does not use port 443.
- If z/OSMF is configured for high availability in Sysplex, create the CLI zosmf-profile with DVIPA address/hostname to ensure availability of REST services. For more information, see [Configuring z/OSMF high availability in Sysplex](../user-guide/systemrequirements-zosmf-ha.md).

### Using a zosmf profile

Expand Down
1 change: 1 addition & 0 deletions docs/getting-started/diagrams/apiml-architecture
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile host="app.diagrams.net" modified="2021-06-02T08:12:22.019Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36" etag="zHhaogb-oBZeHCUM-A96" version="14.2.4" type="google"><diagram id="byKG3oOZK-FctaXXBS_F" name="Page-1">7Vttc9s2DP41vnUf1tO75Y+Jk7bZuluW3G5rv+xoiZbYyaKPot/66wdK1Lsc27NkJkuSO1sEQUnEA4AASI/M6WL7kaFl+Cv1cTQyNH87Mm9GhqE7YxO+BGWXUdyJkxECRnzJVBIeyXcsiZqkroiPkxojpzTiZFknejSOscdrNMQY3dTZ5jSqP3WJAtwiPHooalP/JD4PJVV3JmXHJ0yCUD7aNeT8FihnljNJQuTTTYVk3o7MKaOUZ1eL7RRHQni5XLJxH/b0Fi/GcMyPGWDh352b4JeF//fDnX+zmk1mD3c/6YZ8Ob7LZ4x9EIBsUsZDGtAYRbcl9ZrRVexjcVsNWiXPZ0qXQNSB+A1zvpNoohWnQAr5IpK9eEv4X2L4e1u2vlR6brbyzmljlzdiznbZIMPO21+qneW4tJUPzCYoZrVXcJKU0BXz8FPSkgqIWID5E3xWAS/YBaYLDO8D4xiOECfr+nsgqaBBwVdiCBcSxhMgNdRAWsBTw+a9fQCdBITJr4ShAiGmMc5pH4iYtioEDZUIyvuuUbSSTxoZTgSvez1jcBXwVCZNyh8JZi3kweksU8A8ThkwbULC8eMSpULagMuuozgHoU9pJFhhtOnb2PWtFBFG/8GVHteYmY5TYLPGjOPt0+i0pSkHmI70kHKJsGRzU/rbnBRWPG0+qn/xmy/QJ6pyicaLcIktg7q6vwPCNCJiwk2061ieaDIIu3Ovy2Qcz8WzeT8mY7kHTUY3LmkzZkvCNyTxKExSvPUjZmsC8utT0PM5drxOQfvjyUzT+hG00RC07qiWtG4p9U4V31R6qgPeSR+dFBL06J2sI72TqXS5d9UGbEOtHQel7pwpdTn0nhLhxHOTta26ybZukWmNHFViB0Eo2lXYloIhOf05pSpkdywVo5jjGSuZmthkwODeR0mYvpuuxvR17UwtPC8ysVV68/w6Q3N8pDsfQAm+rRbLfM6IeTkle/8xNGP6MxAkt0cXxHsm6jPpw4ed6nocu+F6NLuqiQf5bVsbDe+qnLNVuwr0QRU5K+fSXPO/ZF3jk5bOmiV4EUoS4jWMIX/yPWYEAMBMXUxkq9Bsa9LQbFt7UrPN8ZP8w2i2lGAl2fmION6goVKdy5RhmjnlM0h1lC6O9UKMdqxLqHkE/YBH6NGs7SPNWmmqY7csRxZiEEcRDXq1mrnr4e4Cwcy1LXugAkHRVmY1TlvGKx7CdIgHCNN4JN7GQSKaus4+gSJYKCPfc45kiIqNLf47S2PpnxhBY16hZ3/DuDf1QOnnB0iXruScGPr36N7GL8G9FVu9qio5xkmrz5HxqAIUz90t6KWgk8eW+2JPyz6PP/cs+/ht/Un+gbI2JeVllYWiY3VSbaFovCdyerlbK+09LNULcqEyz6IQ//y8t3ukpYxVGorbMpTvcJ/fHoF2z6i/8vrd771MltG0FdtQbSuT/WKOQCPhE6/To4BFJqG9+/ooukE+8AEZCfuxVyQus/PuPDsk8iihAsUUeSGJg6HKUUoErb4cZbTX4OzMlYY8DycJTkQina7KpdKvCSqonjxuor273ULmLbC4gtZXuhGc0893bYMA+fFmqFQVuoyVqghJEopIEIuVAR4pysjXAg3ioehKdiyI76crWBf6df0QablcvyY9OTStEdu2wXU7sLUGw7a9bBzAVhB4CHIKQrgqCsCvFL+Javza61H9iNcbjp04QohS97K6YiDN9mrWSHQ0D6UVSk4ZTr8BMnFXQTy88P1fgXQah2i7ypuXBbJ9irncJXuDsAvChk/VbdUQGi0IH3BAEpCd8Jri5ob2CUO+OcMoq6y9CqCai19XaNoFlDkYUO3jt29ACYGbdaDMianYotpHBx7oioMIxM/ainThtUUhVmPxMjvOs1/WoNob1W84dWRtR6Ztw+HU3uyepqEFSEwMLmpSEEP+IFwhXmPRvQnTL7aK4yzWoPN5hf2VwNk8FmgpDzj2Z+GHjzCg+hGGV4JhM4ErbK1/k4Rm+WvlbL+x/M23efsv</diagram></mxfile>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/getting-started/freqaskques.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ To get up and running with the Zowe CLI component quickly, see [Zowe CLI quick s

<summary></summary>

Prerequisites vary by component used, but in most cases the primary prerequisites are Java and NodeJS on z/OS and the z/OS Management Facility enabled and configured. For a complete list of software requirements listed by component, see [System requirements](../user-guide/systemrequirements.md).
Prerequisites vary by component used, but in most cases the primary prerequisites are Java and NodeJS on z/OS and the z/OS Management Facility enabled and configured. For a complete list of software requirements listed by component, see [System requirements for z/OS components](../user-guide/systemrequirements-zos.md) and [System requirements for Zowe CLI](../user-guide/systemrequirements-cli.md).

</details>

Expand Down
15 changes: 13 additions & 2 deletions docs/getting-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ For information about extending the functionality of Zowe CLI by installing plug

**More Information:**

- [System requirements for Zowe CLI](../user-guide/systemrequirements.md)
- [System requirements for Zowe CLI](../user-guide/systemrequirements-cli.md)
- [Installing Zowe CLI](../user-guide/cli-installcli.md)

</details>
Expand Down Expand Up @@ -147,14 +147,15 @@ The API Mediation Layer provides a single point of access for mainframe service
* Consistent Access: API routing and standardization of API service URLs through the Gateway component provides users with a consistent way to access mainframe APIs at a predefined address.
* Dynamic Discovery: The Discovery Service automatically determines the location and status of API services.
* High-Availability: API Mediation Layer is designed with high-availability of services and scalability in mind.
* Caching Service: This feature is designed for Zowe components in a high availability configuration. It supports the High Availability of all components within Zowe, allowing components to be stateless by providing a mechanism to offload their state to a location accessible by all instances of the service, including those which just started.
* Redundancy and Scalability: API service throughput is easily increased by starting multiple API service instances without the need to change configuration.
* Presentation of Services: The API Catalog component provides easy access to discovered API services and their associated documentation in a user-friendly manner. Access to the contents of the API Catalog is controlled through a z/OS security facility.
* Encrypted Communication: API ML facilitates secure and trusted communication across both internal components and discovered API services.

#### API Mediation Layer architecture
The following diagram illustrates the single point of access through the Gateway, and the interactions between API ML components and services:

![API Mediation Layer Architecture diagram](./diagrams/service-relationship-diagram.png)
![API Mediation Layer Architecture diagram](./diagrams/apiml-architecture.png)

#### Components
The API Layer consists of the following key components:
Expand All @@ -179,6 +180,10 @@ The API Catalog is the catalog of published API services and their associated do

Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, CA ACF2, or CA Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the z/OSMF API.

**Caching Service**

It provides an API in high-availability mode which offers the possibility to store, retrieve and delete data associated with keys. The service will be used only by internal Zowe applications and will not be exposed to the internet.

#### Onboarding APIs
Essential to the API Mediation Layer ecosystem is the API services that expose their useful APIs. Use the following topics to discover more about adding new APIs to the API Mediation Layer and using the API Catalog:

Expand All @@ -192,6 +197,12 @@ Essential to the API Mediation Layer ecosystem is the API services that expose t

To learn more about the architecture of Zowe, see [Zowe architecture](zowe-architecture.md).

### Zowe Launcher

Provides an advanced launcher for Zowe components in a high availability configuration. It performs the following operations:
- Stopping the Zowe server using the `STOP` (or `P`) operator command
- Stopping and starting specific Zowe components without restarting the entire Zowe using `MODIFY` (or `F`) operator command

## Zowe Third-Party Software Requirements and Bill of Materials

- [Third-Party Software Requirements (TPSR)](../appendix/tpsr.md)
Expand Down
Loading

0 comments on commit 9551e5d

Please sign in to comment.