Skip to content

Commit f265c4c

Browse files
committed
Add doc to say user .profile needs npm config
Also a few tweaks to resolve linting suggestions.
1 parent ba84297 commit f265c4c

File tree

3 files changed

+32
-7
lines changed

3 files changed

+32
-7
lines changed

docs/pages/cdp/cdp-Create-Zowe-CLI-profiles.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,50 +10,64 @@ folder: cdp
1010

1111
### Step 1: Create a z/OSMF profile
1212

13-
This profile identifies the z/OSMF server that has access to the directory on z/OS into which the CICS bundle will be deployed. You need to know the following from your z/OS system administrator:
13+
This profile defines the parameters needed to connect to the z/OSMF server on z/OS. You need to know the following from your z/OS system administrator:
1414

1515
| Parameter | Description |
1616
| --- | --- |
17-
| host | Hostname of the z/OSMF server. |
17+
| host | Host name of the z/OSMF server. |
1818
| port | Port number of the z/OSMF server. |
1919
| user | User ID to identify yourself to the z/OSMF server. |
2020
| password | Password to identify yourself to the z/OSMF server. |
2121

22+
**Note**: The user ID needs to have sufficient permissions to remove and create directories and files in the directory specified by `--targetdir` in the cics-deploy profile.
23+
2224
For example, to create a z/OSMF profile:
25+
2326
```console
2427
zowe profiles create zosmf-profile myzos --host myzos.example.com --port 3000 --user myuserid --password mypassword --reject-unauthorized false --overwrite
2528
```
29+
2630
For help on using the options:
31+
2732
```console
2833
zowe profiles create zosmf-profile --help
2934
```
35+
3036
To test the connection to the z/OSMF server using the profile:
37+
3138
```console
3239
zowe zosmf check status
3340
```
3441

3542
### Step 2: Create an SSH profile
3643

37-
This profile defines the parameters needed to connect. to the remote SSH server. You need to know the following from your z/OS system administrator:
44+
This profile defines the parameters needed to connect to the SSH server on z/OS. You need to know the following from your z/OS system administrator:
3845

3946
| Parameter | Description |
4047
| --- | --- |
41-
| host | Hostname of the SSH server. |
48+
| host | Host name of the SSH server. |
4249
| port | Port number of the SSH server. This will default to 22. |
4350
| user | User ID to identify yourself to the SSH server. |
4451
| password | Password to identify yourself to the SSH server. |
4552

46-
It is recommended that you use the same user ID and host to connect with SSH as is used in the z/OSMF profile, failure to do so results in undefined behaviour.
53+
**Note**: It is recommended that you use the same user ID and host name to connect with SSH as is used in the z/OSMF profile, failure to do so results in undefined behaviour. When an SSH connection is made, the [z/OS shell .profile](https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.bpxa400/cupro.htm) is used to setup the shell environment and variables. The user .profile should include enviroonment variables and npm configuration required to run `npm install` in order to resolve Node.js appplication dependencies such as compiling native code. This is descibed in
54+
[Installing and configuring](https://www.ibm.com/support/knowledgecenter/SSTRRS_6.0.0/com.ibm.nodejs.zos.v6.doc/install.htm).
55+
4756

4857
For example, to create an SSH profile:
58+
4959
```console
5060
zowe profiles create ssh-profile myzos --host myzos.example.com --user myuserid --password mypassword --overwrite
5161
```
62+
5263
For help on using the options:
64+
5365
```console
5466
zowe profiles create ssh-profile --help
5567
```
68+
5669
To test the connection to the SSH server using the profile:
70+
5771
```console
5872
zowe zos-uss issue ssh 'uname -a'
5973
```
@@ -68,17 +82,21 @@ This profile identifies the CICS environment for deployment. You need to know th
6882
| cicshlq | High Level Qualifier \(HLQ\) for the CICS data sets. |
6983
| cpsmhlq | High Level Qualifier \(HLQ\) for the CPSM data sets. |
7084
| scope | CPSM scope to identify the CICS region or group of regions to deploy your application. |
71-
| csdgroup | CICS CSD group name or CPSM BAS resource group name into which the bundle is defined. If not specified, BUNDLE resources are defined in CPSM BAS for installation and then removed. |
85+
| resgroup or basgroup | CICS CSD group name or BAS resource group name into which the bundle is defined. If not specified, BUNDLE resources are defined in CPSM BAS for installation and then removed. |
7286
| jobcard | JCL jobcard to use when submitting JCL that will run the CICS utility DFHDPLOY. If not specified, a default jobcard will be used. |
73-
| targetdir | Target zFS location to which CICS bundles should be uploaded. |
87+
| targetdir | Target directory on z/OS to which CICS bundles should be uploaded. |
7488

7589
For example to create a cics-deploy profile:
90+
7691
```console
7792
zowe profiles create cics-deploy-profile example --cicsplex PLEX1 --cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --scope TESTGRP1 --csdgroup BUNDGRP1 --targetdir /var/cicsts/bundles
7893
--overwrite
7994
```
95+
8096
For help on using the options:
97+
8198
```console
8299
zowe profiles create cics-deploy-profile --help
83100
```
101+
84102
To test the cics-deploy profile, follow the steps in [Deploying your first app](cdp-Deploying-your-first-app).

docs/pages/cdp/cdp-Installation.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,26 @@ toc: false
1010
---
1111

1212
1. Install [Node.js V8.0](https://nodejs.org/en/download/) or later, and Node Package Manager (npm) V5.0 or later, that are required by Zowe CLI. To verify the versions installed:
13+
1314
```console
1415
node --version
1516
npm --version
1617
```
1718

1819
2. Install [Zowe CLI](https://zowe.github.io/docs-site/latest/user-guide/cli-installcli.html). For example to install using npm:
20+
1921
```console
2022
npm install -g zowe-cli
2123
```
2224

2325
3. Install the cics-deploy plugin:
26+
2427
```console
2528
zowe plugins install zowe-cli-cics-deploy-plugin
2629
```
2730

2831
4. Verify the version of the plugin that is installed:
32+
2933
```console
3034
zowe plugins list
3135
```

docs/pages/cdp/cdp-Requirements.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,17 @@ toc: false
1010
---
1111

1212
### z/OS Management Facility
13+
1314
A [z/OS Management Facility (z/OSMF)](https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.izua300/IZUHPINFO_PartConfiguring.htm) server is required to run the [push bundle](Commands#command-push-bundle), [deploy bundle](Commands#command-deploy-bundle), and [undeploy bundle](Commands#command-undeploy-bundle) commands. These commands call the API for [`zowe zos-jobs submit`](https://zowe.github.io/docs-site/latest/user-guide/cli-usingcli.html#zos-jobs) to submit JCL that executes the DFHDPLOY utility to deploy and undeploy CICS bundles.
1415

1516
The z/OSMF server is also required by the [push bundle](Commands#command-push-bundle) command when it uses the API for [`zowe files upload dir-to-uss`](https://github.com/zowe/zowe-cli/issues/207) to copy a CICS bundle to a z/OS directory.
1617

1718
### z/OS Secure SHell daemon
19+
1820
The [z/OS Secure SHell daemon (sshd)](https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.foto100/sshset.htm) is required to run the [push bundle](Commands#command-push-bundle) command. This command uses the API for [`zowe zos-uss issue ssh`](https://github.com/zowe/zowe-cli/pull/308) to remove old files from the CICS bundle directory on z/OS and execute `npm install` on z/OS to install dependencies for Node.js applications.
1921

2022
### DFHDPLOY utility
23+
2124
The [DFHDPLOY](https://www.ibm.com/support/knowledgecenter/SSGMCP_5.5.0/applications/deploying/dfhdploy_overview.html) utility is provided with IBM CICS Transaction Server (CICS) and is required to run the [push bundle](Commands#command-push-bundle), [deploy bundle](Commands#command-deploy-bundle), and [undeploy bundle](Commands#command-undeploy-bundle) commands. These commands start DFHDPLOY with a script to perform deploy and undeploy operations. For example the deploy operation will define, install, then enable a CICS BUNDLE resource in a one or more CICS regions.
2225

2326
The DFHDPLOY utility requires CICSPlex System Manager \(CPSM\) that is also provided with CICS to be configured, and for CPSM to be connected to the target CICS regions.

0 commit comments

Comments
 (0)