Skip to content

Commit

Permalink
addressing adam feedback
Browse files Browse the repository at this point in the history
Signed-off-by: anaxceron <[email protected]>
  • Loading branch information
anaxceron committed Feb 26, 2024
1 parent e9a8a38 commit ca274fb
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 11 deletions.
7 changes: 4 additions & 3 deletions docs/user-guide/cli-install-configure-zosmf-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,17 @@ Before you allow users to issue z/OS console commands with Zowe CLI, security ad

:::

The following table details the required z/OSMF REST services and examples of the Zowe CLI features they enable. If the profile validation command returns any errors, use this table to find IBM documentation for the z/OSMF REST APIs.
The following table details the required z/OSMF REST services and examples of the Zowe CLI features they enable.


| z/OSMF REST Service | REST Endpoint | Description | More information |
| ----------- | ----------- | ---------- | ------------- |
| Cloud provisioning services | Endpoints that begin with: `/zosmf/provisioning/` | Cloud provisioning for development environments. | <ul><li>[Cloud provisioning services](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-cloud-provisioning)</li></ul> |
| Cloud provisioning services | Endpoints that begin with: `/zosmf/provisioning/` | Cloud provisioning for development environments (`zowe provisioning list instance-info`). | <ul><li>[Cloud provisioning services](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-cloud-provisioning)</li></ul> |
| TSO/E address space services | Endpoints that begin with: `/zosmf/tsoApp` | TSO commands (`zowe zos-tso issue`). | <ul><li>[TSO/E address space services](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-tsoe-address-space)</li><li>[Class activations that z/OSMF requires](https://www.ibm.com/docs/en/zos/2.5.0?topic=guide-security-structures-zosmf#DefaultSecuritySetupForZosmf__ResourceAuthorizationsForRESTapi__title__1)</li></ul> |
| z/OS console services | Endpoints that begin with: `/zosmf/restconsoles/`<br/> Example: `/zosmf/restconsoles/defcn` | Console commands (`zowe zos-console issue`). Any MVS console command such as MODIFY and DISPLAY. | <ul><li>[z/OS console services](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-zos-console)</li><li>[Resource authorizations for the z/OS console services REST interface](https://www.ibm.com/docs/en/zos/2.5.0?topic=guide-security-structures-zosmf#DefaultSecuritySetupForZosmf__zOSConsolesRestAPI__title__1)</li></ul> |
| z/OS data set and file REST interface | Endpoints that begin with: `/zosmf/restfiles/` Example: `/zosmf/restfiles/ds/<dsname>` | Create data sets (`zowe zos-files create`), delete data sets (`zowe zos-files delete`), read (download) data sets (`zowe zos-files download`), and write (upload) data sets (`zowe zos-files upload`). <br/>Access to access method services (IDCAMS) (`zowe zos-files invoke access-method-services`). | <ul><li>[z/OS data set and file REST interface](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-zos-data-set-file-rest-interface)</li><li>[Resource authorizations for the z/OS data set and file REST interface](https://www.ibm.com/docs/en/zos/2.5.0?topic=guide-security-structures-zosmf#DefaultSecuritySetupForZosmf__ResourceAuthorizationsForRESTdsfilesAPI__title__1)</li></ul> |
| z/OS jobs REST interface | Endpoints that begin with: `/zosmf/restjobs/` Example: `/zosmf/restjobs/jobs/<jobname>/<jobid>` | Submit jobs (`zowe zos-jobs submit`), purge jobs, and read job output. <br/>List jobs (`zowe zos-jobs list`). | <ul><li>[z/OS jobs REST interface](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-zos-jobs-rest-interface)</li><li>[Resource authorizations for the z/OS jobs REST interface](https://www.ibm.com/docs/en/zos/2.5.0?topic=guide-security-structures-zosmf#DefaultSecuritySetupForZosmf__ResourceAuthorizationsForRESTapi__title__1)</li></ul> |
| z/OSMF workflow services | Endpoints that begin with: `/zosmf/workflow/` | Cloud provisioning for development environments. | <ul><li>[z/OSMF workflow services](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-zosmf-workflow)</li></ul> |
| z/OSMF workflow services | Endpoints that begin with: `/zosmf/workflow/` | Cloud provisioning for development environments (`zowe zos-workflows list active-workflows`). | <ul><li>[z/OSMF workflow services](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-zosmf-workflow)</li></ul> |

## Configuring z/OS console REST interface

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/cli-install-configure-zosmf.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Zowe CLI was designed and tested to integrate with z/OSMF running on IBM version
| CEA (Communications Enabled Applications) Server | CEA server is a co-requisite for the CIM server. The CEA server lets z/OSMF deliver z/OS events to C-language clients. <br/>z/OSMF requires the CEA server to perform the following types of tasks: <ul><li>Problem determination</li><li>Sysplex</li><li>z/OS classic interfaces</li> <li>z/OS Operator Console</li></ul> **Notes:** <ul><li>Start the CEA server before you start z/OSMF (the IZU* started tasks).</li><li> Set up CEA server in Full Function Mode and assign the TRUSTED attribute to the CEA started task.</li></ul> For more information, see [Customizing for CEA](https://www.ibm.com/docs/en/zos/2.5.0?topic=test-customizing-cea) on the IBM Documentation. |
| CIM (Common Information Model) Server | z/OSMF requires the CIM server to perform the following types of tasks: <ul><li>Capacity provisioning </li><li> Problem determination </li><li> Workload management </li></ul> **Note:** Start the CIM server before you start z/OSMF (the IZU* started tasks). <br/> For more information, see [Configuring the CIM server for your system](https://www.ibm.com/docs/en/zos/2.5.0?topic=configurations-configuring-cim-server-your-system) on the IBM Documentation. <br/> For more information on how to perform asynchronous operations, review the [required authorizations for z/OSMF](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-zos-jobs-rest-interface#izuhpinfo_api_restjobs__RequiredAuthorizationsForRestServices__title__1) on the IBM Documntation.|
| Console Command | The `CONSOLE` and `CONSPROF` commands must exist in the authorized command table. |
| Java version | IBM 64-bit SDK for z/OS, Java Technology Edition V7.1 or higher is required. However, we experienced problems accessing z/OSMF 2.2 using Java version 8. If you use z/OSMF 2.3, Java version 8.0_64 is required. <br/>```SYS1.PARMLIB member IZUPRMxx.... JAVA_HOME('/sys/java64bt/v7r1m0/usr/lpp/java/J7.1_64'/etc/profile ............................................... export JAVA_HOME=/sys/java31bt/v7r1m0/usr/lpp/java/J7.1 ```<br/>For more information, see [Software prerequisites for z/OSMF](https://www.ibm.com/docs/en/zos/2.5.0?topic=zosmf-software-prerequisites) on the IBM Documentation. |
| Java version | IBM® 64-bit SDK for z/OS®, Java Technology Edition V8 SR4 FP10 (5655-DGH) or higher is required. However, we experienced problems accessing z/OSMF 2.2 using Java version 8. If you use z/OSMF 2.3, Java version 8.0_64 is required. <br/><br/>For more information, see [Software prerequisites for z/OSMF](https://www.ibm.com/docs/en/zos/2.5.0?topic=zosmf-software-prerequisites) on the IBM Documentation. |
| Maximum region size | To prevent exceeds maximum region size errors, ensure that you have a TSO maximum region size of at least 65536 KB for the z/OS system. |
| User IDs | User IDs require a TSO segment (access) and an OMVS segment. During workflow processing and REST API requests, z/OSMF may start one or more TSO address spaces under the following job names: <ul><li>*userid*</li><li>*substr(userid, 1, 6)//CN* (Console)</li></ul> Example: ```(userid = USRMY01, USRMY0CN )```
| User IDs | User IDs require a TSO segment (access) and an OMVS segment. During workflow processing and REST API requests, z/OSMF may start one or more TSO address spaces under the following job names: <ul><li>*userid*</li><li>*substr(userid, 1, 6)//CN* (Console)</li></ul> Example: ```(userid = USRMY01, USRMY0CN )```

## Selecting and configuring your z/OSMF plug-ins

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/cli-installcli.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Installation steps for Zowe CLI depend on whether your z/Linux environment requi
1. Follow the steps in [Installing Zowe CLI and Zowe CLI plug-ins from an npm online registry](#installing-zowe-cli-and-zowe-cli-plug-ins-from-an-npm-online-registry) or [Installing Zowe CLI and Zowe CLI plug-ins from a local package](#installing-zowe-cli-and-zowe-cli-plug-ins-from-a-local-package).
2. Follow the steps in [Configuring Zowe CLI where secure credential storage is not available](./cli-configure-cli-on-os-where-scs-unavailable.md).

### Installing Zowe on a USS system, or O/S without secure credential storage
### Installing Zowe CLI on a USS system, or an OS without secure credential storage

Follow the steps in [Configuring Zowe CLI where secure credential storage is not available](../user-guide/cli-configure-cli-on-os-where-scs-unavailable.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/cli-uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ To list the profiles that you created, delete the profiles, and uninstall Zowe C
:::note
You might receive an `ENOENT` error when issuing this command if you installed Zowe CLI from a local package (.tgz) and the package was moved from its original location. In the event that you receive the error, open an issue in the Zowe CLI GitHub repository.
You might receive an `ENOENT` error when issuing this command if you installed Zowe CLI from a local package (.tgz) and the package was moved from its original location. To resolve this, add the `--force` option to the `npm uninstall --global @zowe/cli` command and to bypass any errors.
:::
Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/cli-updatingcli.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ If necessary, you can update or revert Zowe CLI to a known, previously released

- `<X.Y.Z>`

Specifies the version that Zowe CLI or Zowe CLI plug-ins are to be updated or reverted to. For example, `npm install -g @zowe/[email protected]`.
Specifies release number that Zowe CLI or Zowe CLI plug-ins are to be updated or reverted to. For example, `npm install -g @zowe/[email protected]`.

2. See [Next steps](#next-steps) for recommended tasks after installation.

Expand All @@ -104,13 +104,13 @@ If necessary, you can update or revert Zowe CLI to a known, previously released

3. Read the End User License Agreement for Zowe and click **I agree** to download the core package.

`zowe-cli-package-next-YYYYMMDD.zip` is downloaded to your computer (where YYYYMMDD indicates the year, month, and day of the build).
`zowe-cli-package-next-<X.Y.Z>.zip` is downloaded to your computer (where `<X.Y.Z>` indicates the year, month, and day of the build).

4. If updating or reverting Zowe CLI plug-ins, navigate to [Download Zowe](https://www.zowe.org/download.html) and click the **Zowe \<X.Y.Z\> CLI Plugins** button (where \<X.Y.Z\> specifies the release number).

5. If updating or reverting Zowe CLI plug-ins, read the End User License Agreement for Zowe and click **I agree** to download the plug-ins package.

`zowe-cli-plugins-next-YYYYMMDD.zip` is downloaded to your computer.
`zowe-cli-plugins-next-<X.Y.Z>.zip` is downloaded to your computer.

6. Unzip the contents of `zowe-cli-package-<X.Y.Z>.zip` (and `zowe-cli-plugins-<X.Y.Z>.zip`, if downloaded) to a working directory.

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/cli-using-using-daemon-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To enable daemon mode and configure Zowe to run Zowe CLI constantly in daemon mo

You have successfully configured Zowe CLI to run on daemon mode.

Each time a Zowe CLI command is issued, the daemon binary creates or reuses a file in the user's home directory. In some cases, this behavior might be undesirable. (For example, the home directory resides on a network drive and has poor file performance.)
Each time a Zowe CLI command is issued, the daemon binary creates or reuses a file in the user's home directory. In some cases, this behavior might be undesirable.

To change the location that the daemon uses, see [Setting CLI daemon mode properties](../user-guide/cli-configuringcli-ev.md#setting-cli-daemon-mode-properties).

Expand Down

0 comments on commit ca274fb

Please sign in to comment.