Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sam 2.13 doc prep-merge the master into docs-staging #3289

Merged
merged 59 commits into from
Dec 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
c2d5e23
Update certificate-configuration-scenarios.md (#3189)
samanthasusu Oct 23, 2023
98a7386
Update zowe-security-authentication.md (#3149)
samanthasusu Oct 24, 2023
7ce5699
fix the error msg (#3190)
samanthasusu Oct 24, 2023
71030df
Merge branch 'master' into anax-v2.12-publishdoc-docs
anaxceron Oct 24, 2023
3f4f828
Merge pull request #3200 from zowe/anax-v2.12-publishdoc-docs
ojcelis Oct 24, 2023
79db9aa
tpsr link fix
anaxceron Oct 24, 2023
47e742c
readd API ML release notes for 2.12 (#3202)
janan07 Oct 25, 2023
41febb7
updated release notes 2.12 (#3203)
lparadkar-rocket Oct 25, 2023
964a05a
Merge branch 'master' into anax-v2.12-tpsrlinkfix-docs
anaxceron Oct 25, 2023
bf2f62f
restoring the modified files (#3204)
Shobhajayanna Oct 25, 2023
eb584db
Merge branch 'master' into anax-v2.12-tpsrlinkfix-docs
anaxceron Oct 25, 2023
fac1a10
Merge pull request #3201 from zowe/anax-v2.12-tpsrlinkfix-docs
anaxceron Oct 25, 2023
402d3a3
Updated version 2.12 (#3205)
lparadkar-rocket Oct 25, 2023
52bfb93
add content back to ze chunked articles (#3206)
janan07 Oct 26, 2023
524695a
adding Zowe v2.12, v2.11 site PDFs
anaxceron Oct 26, 2023
2b3f038
Merge pull request #3210 from zowe/anax-v2.12-sitepdf-docs
anaxceron Oct 27, 2023
2672840
Reorganize Configuration section (#3176)
janan07 Oct 27, 2023
ddc79f1
install and config redesign working branch (#3058)
samanthasusu Oct 30, 2023
624fddc
Adjust the advanced config section (#3216)
samanthasusu Oct 30, 2023
3239fb8
Language refactor of Installation overview (#3217)
janan07 Oct 30, 2023
451859a
fix typo and add next step (#3219)
janan07 Oct 31, 2023
6fdeda7
Reorganize content in Preparing for Installation (#3218)
janan07 Oct 31, 2023
f9d3563
fix api ml titles (#3222)
janan07 Nov 1, 2023
f5bee4c
Add user roles for preparing for Installation section (#3221)
janan07 Nov 1, 2023
91da547
adding ZE v2.12 release notes
anaxceron Nov 1, 2023
57214ea
Update installation checklist post install/config restructure (#3225)
janan07 Nov 2, 2023
c4a27a6
Fix tip in preparing for installation (#3229)
janan07 Nov 2, 2023
c70d728
updated link URLs
anaxceron Nov 2, 2023
e03960c
updated link URL
anaxceron Nov 2, 2023
80a9094
Merge branch 'master' into anaz-2.12-zeRNs-ZE
anaxceron Nov 2, 2023
8b9e089
Merge pull request #3227 from zowe/anaz-2.12-zeRNs-ZE
anaxceron Nov 2, 2023
6a68a3e
Fix adominitions (#3232)
janan07 Nov 6, 2023
d3c2702
Add files via upload (#3241)
janan07 Nov 8, 2023
d188c8a
change link to end-to-end diagram (#3234)
janan07 Nov 8, 2023
b07fd2c
Add an overall flowchart to the beginning of the containerization ins…
samanthasusu Nov 9, 2023
4613c32
More adominition fixes (#3244)
janan07 Nov 10, 2023
3f0d388
Add comments for review around configuration section (#3246)
pablocarle Nov 13, 2023
277e136
typo fix (#3256)
samanthasusu Nov 15, 2023
903dcf7
Streamline xmem config instructions (#3254)
janan07 Nov 15, 2023
3b9ecfb
ZIS load module typo fix (#3258)
skurnevich Nov 15, 2023
66864c4
Fix nodejs requirements page to list actually supported nodes (#3266)
1000TurquoisePogs Nov 22, 2023
1edd197
Add descriptions of runtime components and add description of ZIS (#3…
janan07 Nov 27, 2023
8d717f6
Create Wen-Ting-Su-docs-site.txt (#3277)
samanthasusu Nov 30, 2023
089d4c1
Added .txt file for DCO signoff
lparadkar-rocket Dec 1, 2023
ecb1dc1
addidng dco signoff
skurnevich Dec 1, 2023
80544d9
Joe winchester/issue/3281 (#3282)
Joe-Winchester Dec 1, 2023
011b4e3
Merge branch 'master' into dco-signoff
anaxceron Dec 1, 2023
d9bae05
Merge branch 'master' into lparadkar-rocket-patch-6
anaxceron Dec 1, 2023
7f656dd
Merge pull request #3280 from zowe/lparadkar-rocket-patch-6
anaxceron Dec 1, 2023
ebfb142
Merge branch 'master' into dco-signoff
anaxceron Dec 1, 2023
f1c3d22
Merge pull request #3284 from skurnevich/dco-signoff
anaxceron Dec 1, 2023
785db54
create dco-yml
anaxceron Dec 1, 2023
f03e99a
Merge pull request #3286 from zowe/anax-dcoconfig-docs
anaxceron Dec 1, 2023
7599d48
Update certificate-configuration-scenarios.md (#3283)
samanthasusu Dec 4, 2023
4d0592b
Merge branch 'docs-staging' into sam-2.13-doc-prep
samanthasusu Dec 4, 2023
73d7919
DCO Remediation Commit for lparadkar-rocket <lparadkar@rocketsoftware…
samanthasusu Dec 4, 2023
c24c415
add DCO information
samanthasusu Dec 4, 2023
04bdc06
Merge branch 'sam-2.13-doc-prep' of https://github.com/zowe/docs-site…
samanthasusu Dec 4, 2023
88f983b
Add DCO information
samanthasusu Dec 4, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading