Skip to content

Commit e404a05

Browse files
committed
Clarify usage of z/OS PT provisioned directories
And clarify zosptfile entries are for Node.js
1 parent 3540454 commit e404a05

File tree

2 files changed

+46
-21
lines changed

2 files changed

+46
-21
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ zowe zos-uss issue ssh 'uname -a'
7272

7373
### Create a cics-deploy profile
7474

75-
The cics-deploy profile identifies the CICS environment for deployment. You need to know the following from your CICS system administrator:
75+
The cics-deploy profile identifies the CICS environment for deployment. An example of how to create an environment using using z/OS Provisioning Toolkit as described in [Provisioning a CICS region using z/OS PT](cdp-Provisioning-a-CICS-region-using-zospt). You need to know the following from your CICS system administrator:
7676

7777
| Option | Description |
7878
| --- | --- |

docs/pages/cdp/cdp-Provisioning-a-CICS-region-using-zospt.md

Lines changed: 45 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,23 @@ folder: cdp
99
toc: true
1010
---
1111

12-
The [z/OS Provisioning Toolkit](https://developer.ibm.com/mainframe/products/zospt/) (z/OS PT) provides a command line utility and z/OSMF workflows to provision CICS regions and other development environments on z/OS. This tutorial requires z/OS PT version 1.1.5 or above to be installed.
12+
The [z/OS Provisioning Toolkit](https://developer.ibm.com/mainframe/products/zospt/) (z/OS PT) provides a command line utility and z/OSMF workflows to provision CICS regions and other development environments on z/OS. This tutorial requires z/OS PT version 1.1.5 or above to be installed on z/OS.
1313

1414
### Prepare a z/OS PT image
1515

16-
A z/OS PT image contains the configuration and files necessary to provision a CICS region. This is typically prepared by the CICS system administrator. The CICS image should include the following properties. Other properties are available to customise the CICS region to your requirements - see [Configuration properties for CICS images](https://www.ibm.com/support/knowledgecenter/en/SSXH44E_1.0.0/zospt/cics/zospt-cics-properties.html).
16+
A z/OS PT image contains the configuration and files necessary to provision a CICS region. This is typically prepared by the CICS system administrator. The main configuration is in the file `zosptfile` in the form of properties that are described in [Configuration properties for CICS images](https://www.ibm.com/support/knowledgecenter/en/SSXH44E_1.0.0/zospt/cics/zospt-cics-properties.html).
17+
18+
For example, to support Node.js applications `zosptfile` should include:
1719

1820
| zosptfile entry                      | Usage |
1921
| --- | -- |
20-
| `FROM cics_55` | Provision a CICS TS V5.5 region. Required to support Node.js applications. |
21-
| `ENV DFH_CICS_TYPE=MAS` | The CICS region should be managed by CPSM. |
22-
| `ENV DFH_CICSPLEX=` | The name of the CICSplex. |
23-
| `ENV DFH_NODE_HOME=` | The installation directory for IBM SDK for Node.js - z/OS. Required to support Node.js applications. |
24-
| `COPY bundles bundles` | Create an empty bundles directory in the provisioned file system to contain CICS bundles. |
22+
| `FROM cics_55` | Provision a CICS TS V5.5 region that is the minimum release that supports Node.js applications. |
23+
| `ENV DFH_CICS_TYPE=MAS` | CICS region should be managed by CPSM to enable the DFHDPLOY utility to deploy applications. |
24+
| `ENV DFH_CICSPLEX=` | Name of the CICSplex this region is to join. |
25+
| `ENV DFH_NODE_HOME=` | Installation directory for Node.js runtime provided by IBM SDK for Node.js - z/OS. |
26+
| `COPY bundles bundles` | Create an empty `bundles` directory in the provisioned file system to contain CICS bundles. |
2527

26-
For example, to create the z/OS PT image source directory and configuration file, and build it ready for developers to provision CICS regions:
28+
To create a z/OS PT image source directory, a `zosptfile` file, and build it ready for developers to provision CICS regions, run the following commands on z/OS:
2729

2830
```console
2931
export ZOSPTIMAGE=~/zosptimages/cics_55_nodejs
@@ -43,16 +45,26 @@ chtag -tc UTF-8 $ZOSPTIMAGE/zosptfile
4345
zospt build $ZOSPTIMAGE -t cics_55_nodejs
4446
```
4547

46-
### Provision your CICS region and deploy a Node.js application
48+
### Provision your CICS region using a z/OS image
4749

4850
1. Update your user `.profile` file on z/OS to run z/OS PT.
4951

50-
Add the directory to the `zospt` command to your PATH, and add the following environment variables as described in [Configuring z/OS Provisioning Toolkit](https://www.ibm.com/support/knowledgecenter/en/SSXH44E_1.0.0/zospt/zospt-configuring.html):
52+
Add the directory to the `zospt` command to your PATH.
53+
```properties
54+
export PATH=$PATH:zospt_directory/bin
55+
```
56+
57+
Optional: To avoid the password prompt for each zospt command, specify your password as the environment variable. Ensure others do not have access to read your .profile:
58+
59+
```properties
60+
export zospt_pw=
61+
```
62+
63+
Optional: If z/OSMF is configured with domain and tenant names that are not the default as described in [Configuring z/OS Provisioning Toolkit](https://www.ibm.com/support/knowledgecenter/en/SSXH44E_1.0.0/zospt/zospt-configuring.html), add the following environment variables:
5164

5265
```properties
5366
export zospt_domain=
5467
export zospt_tenant=
55-
export zospt_pw=
5668
```
5769

5870
2. Provision your CICS region.
@@ -63,7 +75,7 @@ zospt build $ZOSPTIMAGE -t cics_55_nodejs
6375
zowe zos-uss issue ssh "zospt run cics_55_nodejs --name my_cics_region"
6476
```
6577

66-
3. Display the CICS region information.
78+
3. Display your CICS region information.
6779

6880
```console
6981
zowe zos-uss issue ssh "zospt inspect my_cics_region"
@@ -75,37 +87,50 @@ zospt build $ZOSPTIMAGE -t cics_55_nodejs
7587
"DFH_REGION_APPLID": "CICPY000",
7688
"DFH_REGION_ZFS_DIRECTORY": "/u/cicprov/mnt/CICPY000",</pre>
7789

78-
4. Update your Zowe CLI cics-deploy profile options.
90+
Your applications can make use of the directories and files under the DFH_REGION_ZFS_DIRECTORY path:
91+
92+
| DFH_REGION_ZFS_DIRECTORY<br>sub-directory | Usage |
93+
| --- | -- |
94+
| /JVMProfiles | JVM server profiles |
95+
| /bundles | CICS bundles |
96+
| /dfhconfig | CICS configuration files |
97+
| /dfhconfig/nodejsprofiles/general.profile | General profile containing values for WORK_DIR and NODE_HOME. Node.js application should include this by adding `%INCLUDE=&USSCONFIG;/nodejsprofiles/general.profile` to their CICS Node.js application profile |
98+
| /workdir | Trace, log and configuration files create by applications, Node.js runtimes, Java runtimes, and CICS runtimes |
99+
79100

80-
Update `--scope` to be the value from DFH_REGION_APPLID, and `--bundle-directory` to be a bundles subdirectory of DFH_REGION_ZFS_DIRECTORY. For example:
101+
4. Update your Zowe CLI cics-deploy profile options to deploy to your CICS region by default.
102+
103+
Update `--scope` to be the value from DFH_REGION_APPLID, and `--bundle-directory` to be the `bundles` subdirectory of DFH_REGION_ZFS_DIRECTORY. For example:
81104

82105
```console
83-
zowe profiles update cics-deploy cics --scope CICPY000 --bundle-directory /u/cicprov/mnt/CICPY000/bundles
106+
zowe profiles update cics-deploy cics --scope CICPY000 --bundle-directory "/u/cicprov/mnt/CICPY000/bundles"
84107
```
85108

86-
You are now ready to deploy applications to the provisioned CICS region. You can try this out by following the steps in [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app).
109+
### Deploying an application to your CICS region
110+
111+
You are now ready to deploy applications to the provisioned CICS region. You can try this out by following the steps in [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app). During deployment, the CICS bundle will be copied into the `/bundles` directory, and output files will be written into a sub-directory of `/workdir`.
87112

88113
### Stop your CICS region
89114

90-
The CICS region and the applications running in it can be stopped if you are not going to be using them for a while by using command:
115+
The CICS region and the applications running in it can be stopped if you are not going to be using them for a while by using the following command:
91116

92117
```console
93118
zowe zos-uss issue ssh "zospt stop my_cics_region"
94119
```
95120

96121
### Start your CICS region
97122

98-
The CICS region can be started after it was previously stopped, or the z/OS system was restarted, by using command:
123+
The CICS region can be started after it was previously stopped, or the z/OS system was restarted, by using the following command:
99124

100125
```console
101126
zowe zos-uss issue ssh "zospt start my_cics_region"
102127
```
103128

104129
### Deprovision your CICS region
105130

106-
The CICS region can be stopped and removed using the following commands. This will remove the z/OS directory used to upload your CICS bundles:
131+
The CICS region can be stopped and removed completely using the following commands. This will remove the z/OS directory used to upload your CICS applications:
107132

108133
```console
109134
zowe zos-uss issue ssh "zospt stop my_cics_region"
110135
zowe zos-uss issue ssh "zospt rm my_cics_region"
111-
```
136+
```

0 commit comments

Comments
 (0)