Skip to content

Commit

Permalink
sam 2.13 doc prep-merge the master into docs-staging (#3289)
Browse files Browse the repository at this point in the history
* Update certificate-configuration-scenarios.md (#3189)

Signed-off-by: samanthasusu <[email protected]>
- added the cross-references to the certificate configuration scenarios

* Update zowe-security-authentication.md (#3149)

* Update zowe-security-authentication.md

Signed-off-by: samanthasusu <[email protected]>
- fixed the URL for MFA documentation

* Update zowe-security-authentication.md

Signed-off-by: samanthasusu <[email protected]>
- change the absolute path to the related one

* fix the error msg (#3190)

Signed-off-by: samanthasusu <[email protected]>
Signed-off-by: Wen Ting Su (Sam) <[email protected]>

* tpsr link fix

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

* readd API ML release notes for 2.12 (#3202)

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

* updated release notes 2.12 (#3203)

Added notes for Application Framework.

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

* restoring the modified files (#3204)

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

* Updated version 2.12 (#3205)

Fixed some issues related to links.

Signed-off-by: lparadkar-rocket <[email protected]>

* add content back to ze chunked articles (#3206)

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

* adding Zowe v2.12, v2.11 site PDFs

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

* Reorganize Configuration section (#3176)

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

* install and config redesign working branch (#3058)

* install and config redesign working branch

Signed-off-by: samanthasusu <[email protected]>
- Modify the sidebar.json
- Create placeholder files

* initial commit

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

* rename article to comply with new proposed structure

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

* Move the security requirements to the new article

Signed-off-by: samanthasusu <[email protected]>
- Move the security requirements from system requirements section to the new one
- Deleted the content which is now in "address network requirements" and "address security requirements"
- Renamed two articles

* minor change in article titles

Signed-off-by: samanthasusu <[email protected]>
- modified the article titles

* add comments

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

* minr edit

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

* add comments

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

* add content to store reqs

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

* add sections

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

* specify that this article addresses security config for installation

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

* remove extending header

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

* add intro statement

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

* draft of security admin's responsibilities

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

* add security admin tasks

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

* Update docs/user-guide/address-security-requirements.md

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

* Update docs/user-guide/address-security-requirements.md

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

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

* Update docs/user-guide/address-security-requirements.md

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

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

* optional feature table refactor

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

* add a few points for brainstorming

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

* Update address-security-requirements.md

Signed-off-by: Wen Ting Su (Sam) <[email protected]>

* fix broken links

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

* Update docs/user-guide/address-security-requirements.md

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

* Update docs/user-guide/address-security-requirements.md

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

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

* Delete docs/user-guide/server-side-install-overview.md

This drafting of this server-side installation overview is in a separate branch and is contained in #3093

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

* add important note in initialize zowe security configuration

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

* add note

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

* add note to cosult security admin

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

* add intro to assigning user permissions

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

* formatting/section refactoring

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

* minor clarification

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

* Add components to the permission table

* refactoring from Jirka's comments

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

* add actions

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

* Update docs/user-guide/address-security-requirements.md

Co-authored-by: JirkaAichler <[email protected]>
Signed-off-by: Wen Ting Su (Sam) <[email protected]>

* Update address-security-requirements.md

fixed typo

Signed-off-by: Wen Ting Su (Sam) <[email protected]>

* add commands

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

* minor addition

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

* add link to zowe yaml configuration file reference

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

* language refactor

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

* Update address-network-requirements.md

fix the port name

Signed-off-by: Wen Ting Su (Sam) <[email protected]>

* change title and define role to adderess z/OS requirements

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

* note re security manangers

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

* Add instructions for TSS and ACF2

* Add instructions for TSS and ACF2

* Add instructions for TSS and ACF2

* Add instructions for TSS and ACF2

* Table reformat

* fix mfa link

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

* reorder table

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

* reorder table

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

* fix table

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

* remove duplicate ZSS from table

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

* Fix up

* Fix up

* address Jakub's comment

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

* Delete docs/user-guide/install-config-best-practices.md

Deleted file as the content is currently unknown and will not be addressed in 23PI3. To view this file, see the branch draft-configuration-best-practices

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

* create Address browser reqs and add former system req content to Address z/OS reqs

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

* add missing topics in table

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

* add indicators for the port number

Signed-off-by: samanthasusu <[email protected]>
- added the N/A to indicate that these variables don't have ports

* add indicators for the port number

Signed-off-by: samanthasusu <[email protected]>
- added the N/A to indicate that these variables don't have ports

* Delete docs/user-guide/install-config-best-practices.md

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

* add to intro

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

* improve intro statement

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

* style fix

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

* add role to intro

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

* fix typo

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

* chapter title fix

Signed-off-by: samanthasusu <[email protected]>
- Fix the titles according to the style guideline

* Update sidebars.js

resolve the conflicts in sidebar.js

Signed-off-by: Wen Ting Su (Sam) <[email protected]>

* Revert "Update sidebars.js"

This reverts commit f7b50da.

* split the content of installing Zowe via SMP/E (#3148)

Signed-off-by: samanthasusu <[email protected]>
- Split one chapter into two

* add container install flowchart (#3113)

* add container install flowchart

Signed-off-by: samanthasusu <[email protected]>
- Added the flowchart to container install chapter

* update the container install flowchart

Signed-off-by: samanthasusu <[email protected]>
- update the flowchart

* langugae/style refactoring

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

* language refactor

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

* Create 4-installation-methods.png

Signed-off-by: samanthasusu <[email protected]>
- added the overall diagram

---------

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

* Update sidebars.js

Signed-off-by: samanthasusu <[email protected]>
- Sync up the sidebar.js file with the master branch for the upcoming merging

* update the sidebar.js file

Signed-off-by: samanthasusu <[email protected]>
- fixed the display on sidebar
- removed the TOC on install via SMP/E page

* minor fix

Signed-off-by: samanthasusu [email protected]

* content moving around

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

- move the content from the content-in-server-side-installation-overview branch.

* minor refactoring

Signed-off-by: samanthasusu [email protected]

* minor updates in formatting

Signed-off-by: samanthasusu <[email protected]>
- minor updates in formatting
- removal of repeated content

* update the pic size

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

* minor updates

Signed-off-by: samanthasusu <[email protected]>
- update the links for KC
- update expected results
- update the roles and responsibilities

* comment fix

Signed-off-by: samanthasusu <[email protected]>
- fixed the comments from final review

* remove content for assigning permissions which is covered in the Configuring security section

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

* Update sidebars.js

* Revert "Merge branch 'install-docs-structure-redesign' of https://github.com/zowe/docs-site into install-docs-structure-redesign"

This reverts commit a86eaea, reversing
changes made to 04bf580.

* Revert "Revert "Merge branch 'install-docs-structure-redesign' of https://github.com/zowe/docs-site into install-docs-structure-redesign""

This reverts commit 6151de7.

* Update sidebars.js

Signed-off-by: samanthasusu <[email protected]>
- fixed the sidebar build issue compared against master branch

---------

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Wen Ting Su (Sam) <[email protected]>
Signed-off-by: Wen Ting Su (Sam) <[email protected]>
Signed-off-by: samanthasusu [email protected]
Signed-off-by: samanthasusu <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: JirkaAichler <[email protected]>
Co-authored-by: Jiri Aichler <[email protected]>

* Adjust the advanced config section (#3216)

* move the advanced config section

Signed-off-by: samanthasusu <[email protected]>
- moved the section under the installing

* Update sidebars.js

Signed-off-by: samanthasusu <[email protected]>
- fxied the sidebar display issue

* Language refactor of Installation overview (#3217)

* language and zwe init order refactor

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

* additional language refactoring

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

* add description of diagram

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

* fix typo

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

---------

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

* fix typo and add next step (#3219)

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

* Reorganize content in Preparing for Installation (#3218)

* Reorganize the article Prepare for installation

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

* add intro material for HA

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

* move the install overview to the parent topic

Signed-off-by: Wen Ting Su (Sam) <[email protected]>

* fix intro paragraph

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

* add ZIS acronym in sidebar

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

* remove ref to ceating a runtime

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

---------

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Wen Ting Su (Sam) <[email protected]>
Co-authored-by: Wen Ting Su (Sam) <[email protected]>

* fix api ml titles (#3222)

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

* Add user roles for preparing for Installation section (#3221)

* minor language refactoring and add roles

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

* add required roles

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

---------

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

* adding ZE v2.12 release notes

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

* Update installation checklist post install/config restructure (#3225)

* update installation checklist following the install/config restructure

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

* apply Sergei's comments

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

---------

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

* Fix tip in preparing for installation (#3229)

* fix formatting/descriptions

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

* fix recommendation of z/OSMF

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

---------

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

* updated link URLs

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

* updated link URL

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

* Fix adominitions (#3232)

* add content to perform these config steps post installation

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

* add adominitions

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

* add adominitions and fix formatting

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

* add missing punctuation

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

* fix adominition

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

* fix adominitions

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

* add OMVS link info

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

* fix adominitions

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

* fix tip

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

* fix undo sec config section

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

---------

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

* Add files via upload (#3241)

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

* change link to end-to-end diagram (#3234)

* change image size test

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

* test 2

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

* test 3

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

* fix adaminations

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

---------

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

* Add an overall flowchart to the beginning of the containerization installation chapter (#3237)

* Update k8s-introduction.md

Signed-off-by: samanthasusu <[email protected]>
- added the overall diagram

* language refactoring

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

---------

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

* More adominition fixes (#3244)

* language refactoring

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

* fix formatting

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

---------

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

* Add comments for review around configuration section (#3246)

* add comments

Signed-off-by: Pablo Hernán Carle <[email protected]>

* address Pablo's comments

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

* fix broken link

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

* fix broken link

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

* fix broken link

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

* fix link

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

---------

Signed-off-by: Pablo Hernán Carle <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Co-authored-by: Pablo Hernán Carle <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* typo fix (#3256)

* typo fix

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

* Update certificate-configuration-scenarios.md

Signed-off-by: samanthasusu <[email protected]>
- fixed the admonition

---------

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

* Streamline xmem config instructions (#3254)

* initial language refactor

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

* x-memory page updates draft (#3255)

* x-memory page updates draft

Signed-off-by: Sergei Kurnevich <[email protected]>

* update table of content

Signed-off-by: Sergei Kurnevich <[email protected]>

* language refactor

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

* fix typo

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

---------

Signed-off-by: Sergei Kurnevich <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>

* fix broken link

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

* fix member ref

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

---------

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Sergei Kurnevich <[email protected]>
Co-authored-by: Sergei Kurnevich <[email protected]>

* ZIS load module typo fix (#3258)

Signed-off-by: Sergei Kurnevich <[email protected]>

* Fix nodejs requirements page to list actually supported nodes (#3266)

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

* Add descriptions of runtime components and add description of ZIS (#3272)

* add descriptions of runtime components and add description of ZIS

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

* improve language per doc standards

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

---------

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

* Create Wen-Ting-Su-docs-site.txt (#3277)

Signed-off-by: Wen Ting Su <[email protected]>

* Added .txt file for DCO signoff 

Signed-off-by: lparadkar-rocket <[email protected]>

* addidng dco signoff

Signed-off-by: Sergei Kurnevich <[email protected]>

* Joe winchester/issue/3281 (#3282)

* Document ZWEL0073E missing schema

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

* Update launcher-error-codes.md

Signed-off-by: Wen Ting Su <[email protected]>

---------

Signed-off-by: Joe Winchester <[email protected]>
Signed-off-by: Wen Ting Su <[email protected]>
Co-authored-by: Wen Ting Su <[email protected]>

* create dco-yml

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

* Update certificate-configuration-scenarios.md (#3283)

Signed-off-by: Wen TIng Su (Sam) <[email protected]>
Specify the section to be edited by users.

---------

Signed-off-by: samanthasusu <[email protected]>
Signed-off-by: Wen Ting Su (Sam) <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: sj895092 <[email protected]>
Signed-off-by: lparadkar-rocket <[email protected]>
Signed-off-by: Wen Ting Su (Sam) <[email protected]>
Signed-off-by: samanthasusu [email protected]
Signed-off-by: Pablo Hernán Carle <[email protected]>
Signed-off-by: Sergei Kurnevich <[email protected]>
Signed-off-by: 1000TurquoisePogs <[email protected]>
Signed-off-by: Wen Ting Su <[email protected]>
Signed-off-by: Joe Winchester <[email protected]>
Co-authored-by: anaxceron <[email protected]>
Co-authored-by: ojcelis <[email protected]>
Co-authored-by: Andrew Jandacek <[email protected]>
Co-authored-by: lparadkar-rocket <[email protected]>
Co-authored-by: ShobhaJayanna <[email protected]>
Co-authored-by: JirkaAichler <[email protected]>
Co-authored-by: Jiri Aichler <[email protected]>
Co-authored-by: Pablo Carle <[email protected]>
Co-authored-by: Pablo Hernán Carle <[email protected]>
Co-authored-by: Sergei Kurnevich <[email protected]>
Co-authored-by: 1000TurquoisePogs <[email protected]>
Co-authored-by: Sergei Kurnevich <[email protected]>
Co-authored-by: Joe Winchester <[email protected]>
  • Loading branch information
14 people authored Dec 4, 2023
1 parent f173817 commit 9fe56be
Show file tree
Hide file tree
Showing 107 changed files with 3,253 additions and 1,687 deletions.
Binary file modified .DS_Store
Binary file not shown.
3 changes: 3 additions & 0 deletions .github/dco.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
allowRemediationCommits:
individual: true
thirdParty: true
3 changes: 3 additions & 0 deletions dco_signoffs/Lobhas-Paradkar-docs-site.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
I, Lobhas Paradkar, hereby sign-off-by all of my past commits to this repo subject to the Developer Certificate of Origin (DCO), Version 1.1.
In the past I have used email: [email protected]
41febb79fe07ae4670a746301b7215740e65a3c7 updated release notes 2.12 (#3203)
3 changes: 3 additions & 0 deletions dco_signoffs/Sergei-Kurnevich-docs-site.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
I, Sergei Kurnevich, hereby sign-off-by all of my past commits to this repo subject to the Developer Certificate of Origin (DCO), Version 1.1. In the past I have used emails: [email protected]

3b9ecfb727b8b0081cea8a3a395d278c1c26de42 ZIS load module typo fix (#3258)
6 changes: 6 additions & 0 deletions dco_signoffs/Wen-Ting-Su-docs-site.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
I, Wen Ting Su, hereby sign-off-by all of my past commits to this repo subject to the Developer Certificate of Origin (DCO), Version 1.1. In the past I have used emails: [email protected]
c2d5e239df7013223e5f52f1b8ac41a345891967 Update certificate-configuration-scenarios.md (#3189)
98a73862bbf28cea7ba227a4482030437729c228 Update zowe-security-authentication.md (#3149)
624fddc413f15bd35acfda827ff6dc16fb75ece9 Adjust the advanced config section (#3216)
b07fd2c678379338bf03a691eef2c1588176c679 Add an overall flowchart to the beginning of the containerization installation chapter (#3237)
277e136947f50d0703cd7e033fb07de17db35769 typo fix (#3256)
1 change: 1 addition & 0 deletions docs/appendix/zowe-security-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Read the following definitions for explanation of the security terms related to
- [Certificate verification](#certificate-verification)
- [Zowe certificate requirements](#zowe-certificate-requirements)
- [Certificate setup types](#certificate-setup-types)

## Certificate concepts

* [Keystore](#keystore)
Expand Down
9 changes: 3 additions & 6 deletions docs/extend/extend-apiml/api-mediation-message-service.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# API Mediation Layer Message Service Component
# Using API Mediation Layer Message Service

The API ML Message Service component unifies and stores REST API error messages and log messages in a single file. The Message Service component enables users to mitigate the problem of message definition redundancy which helps to optimize the development process.

- [API Mediation Layer Message Service Component](#api-mediation-layer-message-service-component)
- [Message Definition](#message-definition)
- [Creating a message](#creating-a-message)
- [Mapping a message](#mapping-a-message)
Expand All @@ -14,12 +13,10 @@ API ML uses a customizable infrastructure to format both REST API error messages

- Message `key` - a unique ID in the form of a dot-delimited string that describes the reason for the message. The `key` enables the UI or the console to show a meaningful and localized message.

**Tips:**

:::tip**Tips:**
- We recommend using the format `org.zowe.sample.apiservice.{TYPE}.greeting.empty` to define the message key. `{TYPE}` can be the api or log keyword.

- Use the message `key` and not the message `number`. The message `number` makes the code less readable, and increases the possibility of errors when renumbering values inside the `number`.

:::
- Message `number` - a typical mainframe message ID (excluding the severity code)

- Message `type` - There are two Massage types:
Expand Down
10 changes: 7 additions & 3 deletions docs/extend/extend-apiml/create-apiml-extension.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Create an Extension for API ML
# Creating 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 add it to the
API Gateway classpath.

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

**Follow these steps:**

Expand Down Expand Up @@ -41,7 +43,9 @@ For more information, see [Packaging z/OS extensions](../packaging-zos-extension

The extension directory `<instance>/workspace/gateway/sharedLibs/` is then added to the API Gateway class path as part of the Zowe instance preparation.

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

**Example:**
```yaml
Expand Down
68 changes: 39 additions & 29 deletions docs/extend/extend-apiml/custom-metadata.md
Original file line number Diff line number Diff line change
@@ -1,90 +1,100 @@
# Custom Metadata
# Customizing Metadata (optional)

(Optional) Additional metadata can be added to the instance information that is registered in the Discovery Service in the `customMetadata` section. This information is propagated from the Discovery Service to the onboarded services (clients). In general, additional metadata do not change the behavior of the client. Some specific metadata can configure the functionality of the API Mediation Layer. Such metadata are generally prefixed with the `apiml.` qualifier. We recommend you define your own qualifier, and group all metadata you wish to publish under this qualifier. If you use the Spring enabler, ensure that you include the prefix `apiml.service` before the parameter name.
Additional metadata can be added to the instance information that is registered in the Discovery Service in the `customMetadata` section. This information is propagated from the Discovery Service to the onboarded services (clients). In general, additional metadata do not change the behavior of the client. Some specific metadata can configure the functionality of the API Mediation Layer. Such metadata are generally prefixed with the `apiml.` qualifier. We recommend you define your own qualifier, and group all metadata you wish to publish under this qualifier. If you use the Spring enabler, ensure that you include the prefix `apiml.service` before the parameter name.

* **customMetadata.apiml.enableUrlEncodedCharacters**

When this parameter is set to `true`, the Gateway allows encoded characters to be part of URL requests redirected through the Gateway. The default setting of `false` is the recommended setting. Change this setting to `true` only if you expect certain encoded characters in your application's requests.

**Important!** When the expected encoded character is an encoded slash or backslash (`%2F`, `%5C`), make sure the Gateway is also configured to allow encoded slashes. For more information, see [Installing the Zowe runtime on z/OS](../../user-guide/install-zos.md).

**Note:** If you use the Spring enabler, use the following parameter name:

:::info**Important!**
When the expected encoded character is an encoded slash or backslash (`%2F`, `%5C`), make sure the Gateway is also configured to allow encoded slashes. For more information, see [Installing the Zowe runtime on z/OS](../../user-guide/install-zos.md).
:::

:::note
If you use the Spring enabler, use the following parameter name:
`apiml.service.customMetadata.apiml.enableUrlEncodedCharacters`
:::

* **customMetadata.apiml.connectTimeout**

The value in milliseconds that specifies a period in which API ML should establish a single, non-managed connection with this service. If omitted, the default value specified in the API ML Gateway service configuration is used.

**Note:** If you use the Spring enabler, use the following parameter name:

:::note
If you use the Spring enabler, use the following parameter name:
`apiml.service.customMetadata.apiml.connectTimeout`
:::

* **customMetadata.apiml.readTimeout**

The value in milliseconds that specifies the time of inactivity between two packets in response from this service to API ML. If omitted, the default value specified in the API MLGateway service configuration is used.

**Note:** If you use the Spring enabler, use the following parameter name:

:::note
If you use the Spring enabler, use the following parameter name:
`apiml.service.customMetadata.apiml.readTimeout`
:::

* **customMetadata.apiml.connectionManagerTimeout**

HttpClient employs a special entity to manage access to HTTP connections called by the HTTP connection manager. The purpose of an HTTP connection manager is to serve as a factory for new HTTP connections, to manage the life cycle of persistent connections, and to synchronize access to persistent connections. Internally, it works with managed connections which serve as proxies for real connections. `connectionManagerTimeout` specifies a period in which managed connections with API ML should be established. The value is in milliseconds. If omitted, the default value specified in the API ML Gateway service configuration is used.

**Note:** If you use the Spring enabler, use the following parameter name:

:::note
If you use the Spring enabler, use the following parameter name:
`apiml.service.customMetadata.apiml.connectionManagerTimeout`

:::
* **customMetadata.apiml.okToRetryOnAllOperations**

Specifies whether all operations can be retried for this service. The default value is `false`. The `false` value allows retries for only `GET` requests if a response code of `503` is returned. Setting this value to `true` enables retry requests for all methods, which return a `503` response code. Enabling retry can impact server resources resulting from buffering of the request body.

**Note:** If you use the Spring enabler, use the following parameter name:

:::note
If you use the Spring enabler, use the following parameter name:
`apiml.service.customMetadata.apiml.okToRetryOnAllOperations`

:::

* **customMetadata.apiml.corsEnabled**

When this parameter is set to `true`, CORS handling by the Gateway is enabled on the service level for all service routes.
For more information, refer to enabling CORS with Custom Metadata on the Gateway: [Advanced Gateway features configuration](../../user-guide/api-mediation/api-gateway-configuration.md).
Additional information can be found in this article about [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS).

**Note:** If you use the Spring enabler, use the following parameter name:

:::note
If you use the Spring enabler, use the following parameter name:
`apiml.service.customMetadata.apiml.corsEnabled`
:::

* **customMetadata.apiml.gatewayAuthEndpoint**

Specifies the Gateway authentication endpoint used by the ZAAS Client configuration. The default value is `/api/v1/gateway/auth`. For more information about ZAAS Client, see [ZAAS Client](zaas-client.md)

**Note:** If you use the Spring enabler, use the following parameter name:

:::note
If you use the Spring enabler, use the following parameter name:
`apiml.service.customMetadata.apiml.gatewayAuthEndpoint`
:::

* **customMetadata.apiml.gatewayPort**

Specifies the Gateway port used by the ZAAS Client configuration. The default value is `10010`. For more information about ZAAS Client, see [ZAAS Client](zaas-client.md).

**Note:** If you use the Spring enabler, use the following parameter name:

:::note
If you use the Spring enabler, use the following parameter name:
`apiml.service.customMetadata.apiml.gatewayPort`

:::

* **customMetadata.apiml.corsAllowedOrigins**

Optionally, service can specify which origins will be accepted by Gateway during the CORS handling. When this parameter is not set, the accepted origins are `*` by default. You can provide a coma separated list of values to explicitly limit the accepted origins.

**Note:** If you use the Spring enabler, use the following parameter name:
:::note
If you use the Spring enabler, use the following parameter name:
`apiml.service.customMetadata.apiml.corsAllowedOrigins`
:::

`apiml.service.customMetadata.apiml.corsAllowedOrigins`

For more information, refer to enabling CORS with Custom Metadata on the Gateway: [Advanced Gateway features configuration](../../user-guide/api-mediation/api-gateway-configuration.md).
For more information, refer to enabling CORS with Custom Metadata on the Gateway: [Advanced Gateway features configuration](../../user-guide/api-mediation/api-gateway-configuration.md).

* **customMetadata.apiml.lb.type**

This parameter is part of the load balancing configuration for the Deterministic Routing capability. Through this parameter, the service can specify which load balancing schema the service requires. If this parameter is not specified, the service is routed using the basic round robin schema. This parameter can be set to the following values:
This parameter is part of the load balancing configuration for the Deterministic Routing capability. Through this parameter, the service can specify which load balancing schema the service requires. If this parameter is not specified, the service is routed using the basic round robin schema. This parameter can be set to the following values:

* **`headerRequest`**
* **`headerRequest`**

This value applies the Header Request load balancing schema. Clients can call the API Gateway and provide a special header with the value of the requested instanceId. The Gateway understands this as a request from the client for routing to a specific instance. Clients have several possibilities for understanding the topology of service instances, such as via the `/eureka/apps` endpoint on the Discovery service, or the `/gateway/services` endpoint on the Gateway. In either case, the information is provided. The client can then request a specific instance by using the special header described below.

Expand Down
2 changes: 1 addition & 1 deletion docs/extend/extend-apiml/implement-new-saf-provider.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Implement a new SAF IDT provider
# Implementing 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.
Expand Down
Loading

0 comments on commit 9fe56be

Please sign in to comment.