Skip to content

Commit

Permalink
Merge pull request #3155 from zowe/anax-v1.28.5-publishdoc2-docs
Browse files Browse the repository at this point in the history
Anax v1.28.5 publishdoc2 docs
  • Loading branch information
ojcelis authored Oct 11, 2023
2 parents db97c09 + c225ced commit 6891852
Show file tree
Hide file tree
Showing 474 changed files with 26,997 additions and 5,802 deletions.
38 changes: 23 additions & 15 deletions docs/user-guide/systemrequirements-zos.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,15 @@ Be sure your z/OS system meets the following prerequisites:

### z/OS

- z/OS version is in active support, such as Version 2.3 and Version 2.4
- z/OS version is in active support, such as Version 2.4, 2.5, and 3.1

**Note:** z/OS V2.2 reached end of support on 30 September 2020. For more information, see the z/OS v2.2 lifecycle details [https://www.ibm.com/support/lifecycle/details?q45=Z497063S01245B61](https://www.ibm.com/support/lifecycle/details?q45=Z497063S01245B61).
**Note:** Zowe Version 2.11 or higher is required when using z/OS Version 3.1

- zFS volume has at least 833 mb of free space for Zowe server components, their keystore, instance configuration files and logs, and third-party plug-ins.
**Note:** z/OS V2.3 reached end of support on 30 September 2022. For more information, see the z/OS v2.3 lifecycle details [https://www.ibm.com/support/pages/zos23x-withdrawal-notification](https://www.ibm.com/support/pages/zos23x-withdrawal-notification)

- (Optional, recommended) z/OS OpenSSH V2.2.0 or later
- zFS volume has at least 1200 mb of free space for Zowe server components, their keystore, instance configuration files and logs, and third-party plug-ins.

- (Optional, recommended) z/OS OpenSSH

Some features of Zowe require SSH, such as the Desktop's SSH terminal. Install and manage Zowe via SSH, as an alternative to OMVS over TN3270.

Expand All @@ -48,19 +50,19 @@ Be sure your z/OS system meets the following prerequisites:

### Node.js

- Node.js v14.x (except v14.17.2), or v16.x
- Node.js v16.x or v18.x

Node is not included with z/OS so must be installed separately. To install Node.js on z/OS, follow the instructions in [Installing Node.js on z/OS](install-nodejs-zos.md).

**Note:** If you are a software vendor building extensions for Zowe, when using Node.js v14.x or later, it is highly recommended that plug-ins used are tagged. For more information, see [Tagging on z/OS](../extend/extend-desktop/mvd-buildingplugins.md#tagging-plugin-files-on-z-os).
**Note:** If you are a software vendor building extensions for Zowe it is highly recommended that plug-ins used are tagged. For more information, see [Tagging on z/OS](../extend/extend-desktop/mvd-buildingplugins.md#tagging-plugin-files-on-z-os).

### Java

- IBM SDK for Java Technology Edition V8

### z/OSMF (Optional)

- (Optional, recommended) IBM z/OS Management Facility (z/OSMF) Version 2.2, Version 2.3 or Version 2.4.
- (Optional, recommended) IBM z/OS Management Facility (z/OSMF) Version 2.4, Version 2.5 or Version 3.1.

z/OSMF is included with z/OS so does not need to be separately installed. If z/OSMF is present, Zowe will detect this when it is configured and use z/OSMF for the following purposes:

Expand Down Expand Up @@ -182,12 +184,18 @@ Zowe requires ACF2 APAR LU01316 to be applied when using the ACF2 security manag

## Memory requirements

Zowe API ML components have following memory requiremets:
Zowe's components have following memory requiremets:

Component name | Category | Average memory usage
---|---|---
Gateway service | API Mediation Layer | 512MB
Discovery service | API Mediation Layer | 512MB
API Catalog | API Mediation Layer | 512MB
Metrics service | API Mediation Layer | 512MB
Caching service | API Mediation Layer | 512MB
ZSS | Application Framework | 32MB
App Server | Application Framework | 350MB

Each of the above components can be enabled or disabled to optimize your resource consumption according to your use cases.
Zowe can use more memory if there are extensions installed.

Component name | Memory usage
---|---
Gateway service | 256MB
Discovery service | 256MB
API Catalog | 512MB
Metrics service | 512MB
Caching service | 512MB
Binary file modified static/v1.28.x/CLIReference_Zowe.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion static/v1.28.x/typedoc/assets/js/search.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -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.3</title>
<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.3">
<title>Login | Zowe Node.js SDK - v1.28.5</title>
<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.5">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
Expand All @@ -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.3</a>
<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.5</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -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.15/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.19/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">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.3</title>
<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.3">
<title>LoginConstants | Zowe Node.js SDK - v1.28.5</title>
<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.5">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
Expand All @@ -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.3</a>
<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.5</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -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.15/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.19/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">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.3</title>
<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.3">
<title>Logout | Zowe Node.js SDK - v1.28.5</title>
<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.5">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
Expand All @@ -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.3</a>
<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.5</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -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.15/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.19/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">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.3</title>
<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.3">
<title>LogoutConstants | Zowe Node.js SDK - v1.28.5</title>
<meta name="description" content="Documentation for Zowe Node.js SDK - v1.28.5">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
Expand All @@ -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.3</a>
<a href="../index.html" class="title">Zowe Node.js SDK - v1.28.5</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -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.15/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.19/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">
Expand All @@ -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.15/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.19/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">
Expand Down
Loading

0 comments on commit 6891852

Please sign in to comment.