Merge pull request #3709 from zowe/anax-v1.28.7-publishdocs-docs

Anax v1.28.7 publishdocs docs

docs/extend/extend-apiml/api-mediation-infinispan.md

@@ -31,6 +31,8 @@ Configure Infinispan as a storage solution through the Caching service by settin
   This property specifies the list of cluster nodes (members). In case of multiple instances, the value for each Caching Service instance can be 
   either a list of all the members, separated by a comma, or just the replica. The format is `${haInstance.hostname}[${zowe.components.caching-service.storage.infinispan.jgroups.port}]`.
 
+  either a list of all the members, separated by a comma, or just the replica. The format is `${haInstance.hostname}[${zowe.components.caching-service.storage.infinispan.jgroups.port}]`.
+
 * **`zowe.components.caching-service.storage.infinispan.persistence.dataLocation`**
 
   The path where the Soft-Index store keeps its data files for the Infinispan Soft-Index Cache Store. 

docs/user-guide/api-mediation/configuration-at-tls.md

@@ -1,11 +1,9 @@
 # Configuring AT-TLS for API Mediation Layer
 
-The communication server on z/OS provides a functionality to encrypt HTTP communication for on-platform running jobs. This functionality is refered to as Application Transparent Transport Layer Security (AT-TLS).
-
-Review this article for descriptions of the configuration parameters required to make the Zowe API Mediation Layer work with AT-TLS, and security recommendations.
+Review this article for descriptions of the configuration parameters required to make Zowe API Mediation Layer work with AT-TLS, including AT-TLS inbound and outbound rules, using AT-TLS in high availability, and troubleshooting. Security recommendations are also provided.
 
 :::info Role: security administrator
-:::
+::: 
 
 - [AT-TLS configuration for Zowe](#at-tls-configuration-for-zowe)
 - [AT-TLS rules](#at-tls-rules)
@@ -76,17 +74,17 @@ zowe:
 
 While API ML does not handle TLS on its own with AT-TLS enabled, API ML requires information about the server certificate that is defined in the AT-TLS rule. Ensure that the server certificates provided by the AT-TLS layer are trusted in the configured Zowe keyring. Ideally, AT-TLS should be configured with the same Zowe keyring.
 
-2. If there is an outbound AT-TLS rule configured for the link between the API Gateway and z/OSMF, set the `zowe.zOSMF.scheme` property to `http`.
+If there is an outbound AT-TLS rule configured for the link between the API Gateway and z/OSMF, set the `zowe.zOSMF.scheme` property to `http`.
 
 :::note Notes
-* Currently, AT-TLS is not supported in the API Cloud Gateway Mediation Layer component.
+* AT-TLS is supported in the API Cloud Gateway Mediation Layer component beginning with version 2.17.
 
 * As the Gateway is a core component of API ML, other components that need to interact with the Gateway, such as Zowe ZLUX App Server, also require AT-TLS configuration.
 :::
 
 :::caution Important security consideration
 
-Configuring AT-TLS for the Zowe API Mediation Layer requires careful consideration of security settings, specifically as these settings apply to the Client Certificate authentication feature in Zowe API Mediation Layer components, as well as for onboarded services that support the x.509 client certificates authentication scheme.
+Configuring AT-TLS for the Zowe API Mediation Layer requires careful consideration of security settings. These security settings apply to the Client Certificate authentication feature in Zowe API Mediation Layer components, as well as for onboarded services that support the x.509 client certificates authentication scheme.
 
 Outbound AT-TLS rules (i.e. to make a transparent https call through http) that are configured to send the server certificate should be limited to the services that __require__ service to service authentication. If an API ML-onboarded southbound service needs to support x.509 client certificate authentication, we recommend to use the integrated TLS handshake capabilities of API ML. Do not configure an outbound AT-TLS rule for these services.
 
@@ -145,6 +143,8 @@ The `PortRange` of this inbound rule is taken from the list of API Mediation Lay
 |API Catalog | default port 7552 |
 | Metrics Service | default port 7551 |
 
+**Follow this step:**
+
 Replace `ApimlKeyring` with the keyring configured for your installation. Follow [the SAF keyring instructions](../../getting-started/zowe-certificates-overview.md#saf-keyring) in the article _Zowe Certificates overview_ to configure keyrings for your Zowe instance.
 
 Note the setting `HandshakeRole`. This setting applies to core services which authenticate through certificates with each other. This setting allows the API Gateway to receive and accept X.509 client certificates from API Clients.
@@ -290,6 +290,19 @@ Ensure that the `RemoteAddr` setting in the rules accounts for the following con
 - Gateway Service to southbound services running in another LPAR.
 - Southbound services to Discovery Service. This applies during onboarding.
 
+## Multi-tenancy deployment
+
+For specific scenario when Central API ML is running on z/OS with AT-TLS enabled, it is important to override protocol for external URL. This information is used by the Central API ML to call domain API ML and it needs to reflect outbound AT-TLS rule. In this case, update your domain API ML configuration as follows:
+
+```
+zowe:
+  components:
+    gateway: 
+      apiml:
+        gateway:
+          externalProtocol: http
+```
+
 ## AT-TLS Troubleshooting
 
 This section describes some common issues when using AT-TLS with API ML and how to resolve these issues.

docs/user-guide/at-tls-configuration.md

@@ -0,0 +1,23 @@
+# Enabling AT-TLS across your Zowe environment
+
+The communication server on z/OS provides functionality to encrypt HTTP communication for on-platform jobs. This functionality is referred to as Application Transparent Transport Layer Security (AT-TLS).
+
+:::info Required roles: security administrator
+:::
+
+## Configuration Parameters
+
+To enable AT-TLS for Zowe components, configure the following parameters:
+```yaml
+zowe:
+    network:
+        server:
+            tls:
+                attls: true
+```
+
+## Component-Specific Configuration
+
+For detailed configuration instructions specific to each component, refer to the following guides:
+- [Configuring AT-TLS for API Mediation Layer](../user-guide/api-mediation/configuration-at-tls.md)
+- [Using AT-TLS in the App Framework](../user-guide/mvd-configuration#using-at-tls-in-the-app-framework)

sidebars.js

@@ -200,6 +200,7 @@ module.exports = {
                 "user-guide/generate-certificates",
                 "user-guide/use-certificates",
                 "user-guide/certificates-setup",
+                "user-guide/at-tls-configuration",
               ],
             },
             {

static/v1.28.x/typedoc/classes/_zowe_core_for_zowe_sdk.login.html

@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>Login | Zowe Node.js SDK - v1.28.5</title>
-	<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.5">
+	<title>Login | Zowe Node.js SDK - v1.28.7</title>
+	<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.7">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.5</a>
+					<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.7</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -111,7 +111,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> apiml<wbr>Login</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v6.40.19/packages/core/src/auth/Login.ts#L30">@zowe/core-for-zowe-sdk/src/auth/Login.ts:30</a></li>
+									<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v6.40.28/packages/core/src/auth/Login.ts#L30">@zowe/core-for-zowe-sdk/src/auth/Login.ts:30</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

static/v1.28.x/typedoc/classes/_zowe_core_for_zowe_sdk.loginconstants.html

@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>LoginConstants | Zowe Node.js SDK - v1.28.5</title>
-	<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.5">
+	<title>LoginConstants | Zowe Node.js SDK - v1.28.7</title>
+	<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.7">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.5</a>
+					<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.7</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -107,7 +107,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
 					<div class="tsd-signature tsd-kind-icon">APIML_<wbr><wbr>V1_<wbr>RESOURCE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;/api/v1/gateway/auth/login&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v6.40.19/packages/core/src/auth/LoginConstants.ts#L27">@zowe/core-for-zowe-sdk/src/auth/LoginConstants.ts:27</a></li>
+							<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v6.40.28/packages/core/src/auth/LoginConstants.ts#L27">@zowe/core-for-zowe-sdk/src/auth/LoginConstants.ts:27</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

static/v1.28.x/typedoc/classes/_zowe_core_for_zowe_sdk.logout.html

@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>Logout | Zowe Node.js SDK - v1.28.5</title>
-	<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.5">
+	<title>Logout | Zowe Node.js SDK - v1.28.7</title>
+	<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.7">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.5</a>
+					<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.7</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -111,7 +111,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> apiml<wbr>Logout</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v6.40.19/packages/core/src/auth/Logout.ts#L30">@zowe/core-for-zowe-sdk/src/auth/Logout.ts:30</a></li>
+									<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v6.40.28/packages/core/src/auth/Logout.ts#L30">@zowe/core-for-zowe-sdk/src/auth/Logout.ts:30</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

static/v1.28.x/typedoc/classes/_zowe_core_for_zowe_sdk.logoutconstants.html

@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>LogoutConstants | Zowe Node.js SDK - v1.28.5</title>
-	<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.5">
+	<title>LogoutConstants | Zowe Node.js SDK - v1.28.7</title>
+	<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.7">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.5</a>
+					<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.7</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -108,7 +108,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
 					<div class="tsd-signature tsd-kind-icon">APIML_<wbr><wbr>V1_<wbr>RESOURCE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;/api/v1/gateway/auth/logout&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v6.40.19/packages/core/src/auth/LogoutConstants.ts#L27">@zowe/core-for-zowe-sdk/src/auth/LogoutConstants.ts:27</a></li>
+							<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v6.40.28/packages/core/src/auth/LogoutConstants.ts#L27">@zowe/core-for-zowe-sdk/src/auth/LogoutConstants.ts:27</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -130,7 +130,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
 					<div class="tsd-signature tsd-kind-icon">APIML_<wbr><wbr>V1_<wbr>TOKEN_<wbr>EXP_<wbr>ERR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;TokenExpireException&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v6.40.19/packages/core/src/auth/LogoutConstants.ts#L35">@zowe/core-for-zowe-sdk/src/auth/LogoutConstants.ts:35</a></li>
+							<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v6.40.28/packages/core/src/auth/LogoutConstants.ts#L35">@zowe/core-for-zowe-sdk/src/auth/LogoutConstants.ts:35</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">