Skip to content

Commit d9b5491

Browse files
authored
Merge pull request #169 from markcocker/master
Update doc to use new names for options
2 parents d6c538b + 7d1ce8b commit d9b5491

File tree

3 files changed

+15
-16
lines changed

3 files changed

+15
-16
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,17 @@ This profile identifies the CICS environment for deployment. You need to know th
7777
| Option | Description |
7878
| --- | --- |
7979
| cicsplex | CPSM CICSplex name. |
80-
| cicshlq | High Level Qualifier \(HLQ\) for the CICS data sets. |
81-
| cpsmhlq | High Level Qualifier \(HLQ\) for the CPSM data sets. |
80+
| cics-hlq | High Level Qualifier \(HLQ\) for the CICS data sets. |
81+
| cpsm-hlq | High Level Qualifier \(HLQ\) for the CPSM data sets. |
8282
| scope | CPSM scope to identify the CICS region or group of regions to deploy your application. |
83-
| 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. |
84-
| jobcard | JCL jobcard to use when submitting JCL that will run the CICS utility DFHDPLOY. If not specified, a default jobcard will be used. |
85-
| targetdir | Target directory on z/OS to which CICS bundles should be uploaded. |
83+
| csd-group or res-group | 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. |
84+
| job-card | JCL jobcard to use when submitting JCL that will run the CICS utility DFHDPLOY. If not specified, a default job card will be used. |
85+
| target-directory | Target directory on z/OS to which CICS bundles should be uploaded. |
8686

8787
For example to create a cics-deploy profile:
8888

8989
```console
90-
zowe profiles create cics-deploy-profile example --cicsplex PLEX1 --cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --scope TESTGRP1 --csdgroup BUNDGRP1 --targetdir /var/cicsts/bundles --overwrite
90+
zowe profiles create cics-deploy-profile example --cicsplex PLEX1 --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --scope TESTGRP1 --csd-group BUNDGRP1 --target-directory /var/cicsts/bundles --overwrite
9191
```
9292

9393
For help on using the options:

docs/pages/cdp/cdp-Deploying-using-individual-actions.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ However, there may be situations where you need more control of these actions or
2020

2121
### Undeploy a CICS bundle
2222

23-
Undeploying a CICS bundle disables the CICS bundle resource (BUNDLE) in CICS. Disabling the CICS bundle causes the resources defined in to also be disabled. For Node.js applications, CICS sends a SIGTERM signal that can be handled in the application to stop in a controlled manner, such as stopping new requests and completing existing requests. Once the CICS bundle has been disabled it is then discarded in CICS.
23+
Undeploying a CICS bundle disables the CICS bundle resource (BUNDLE) in CICS. Disabling the CICS bundle causes the resources defined in it to also be disabled. For Node.js applications, CICS sends a SIGTERM signal that can be handled in the application to stop in a controlled manner, such as stopping new requests and completing existing requests. Once the CICS bundle has been disabled it is then discarded in CICS.
2424

2525
```console
2626
zowe cics-deploy undeploy bundle --name Express
@@ -38,18 +38,17 @@ zowe cics-deploy undeploy bundle --name Express --target-state disabled
3838

3939
Before uploading the CICS bundle to z/OS, you need to ensure the target directory is empty in order to prevent merging with a previously deployed version of the CICS bundle.
4040

41-
There are several ways to run shell commands and scripts on z/OS, such as SSH, batch jobs, and Zowe. When using Zowe, an SSH connection will be established using information in the Zowe ssh profile, and the shell .profile for the user will be run to setup the environment. The command is then run in the directory specified by the `--cwd` option.
41+
There are several ways to run shell commands and scripts on z/OS, such as SSH, batch jobs, and Zowe. When using Zowe, an SSH connection is established using information in the Zowe ssh profile, and then the shell .profile for the user will be run to setup the environment. The command is then run in the directory specified by the `--cwd` option. The return code from the Zowe CLI will be the same as that returned by the command run on z/OS, enabling you to take action in your script in error scenarios.
4242

4343
For example, to remove the target directory:
4444

4545
```console
46-
zowe zos-uss issue ssh "rm -Rv *" --cwd "/var/cicsts/bundles/myexpressapp_1.0.0"
47-
echo $?
46+
zowe zos-uss issue ssh "rm -Rv *" --cwd "/var/cicsts/bundles/myexpressapp_1.0.0" && echo RC=$?
4847
```
4948

5049
{% include tip.html content="You can run several commands in one request using the syntax described in [sh — Invoke a shell](https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.bpxa500/sh.htm)." %}
5150

52-
Typically you will need to upload some files as binary, some as text, and exclude others that are not required to run the application. In addition it is best practice to tag files on z/OS as binary or with their text codepage to allow for correct viewing and loading by environments such as Node.js. You can specify these requirements in a .zosattributes file and use the Zowe CLI to upload and tag files in a single command.
51+
Typically you will need to upload some files as binary, some as text, and exclude others that are not required to run the application. In addition, it is best practice to tag files on z/OS as binary or with their text codepage to allow for correct codepage translation by editors and environments such as Node.js. You can specify these requirements in a `.zosattributes` file and use the Zowe CLI to upload and tag files in a single command.
5352

5453
For example, create file **~/myExpressApp/.zosattributes** in the CICS bundle:
5554

@@ -82,7 +81,7 @@ zowe zos-files upload dir-to-uss ~/myExpressApp/ /var/cicsts/bundles/myexpressap
8281

8382
### Run npm on z/OS
8483

85-
A Node.js application typically depends on packages that are described in `package.json`. The dependencies can be installed by running `npm install` in the z/os directory containing `package.json`, for example:
84+
A Node.js application typically depends on packages that are described in `package.json`. The dependencies can be installed by running `npm install` in the z/OS directory containing `package.json`, for example:
8685

8786
```console
8887
zowe zos-uss issue ssh "npm install" --cwd "/var/cicsts/bundles/myexpressapp_1.0.0"
@@ -93,11 +92,11 @@ zowe zos-uss issue ssh "npm install" --cwd "/var/cicsts/bundles/myexpressapp_1.0
9392
Deploying a CICS bundle defines a CICS bundle resource (BUNDLE), then installs it, and finally enables it. When the CICS bundle is enabled, the Node.js application is started. For example:
9493

9594
```console
96-
zowe cics-deploy deploy bundle --name Express --bundledir /var/cicsts/bundles/myexpressapp_1.0.0
95+
zowe cics-deploy deploy bundle --name Express --bundle-directory /var/cicsts/bundles/myexpressapp_1.0.0
9796
```
9897

9998
Alternatively, to define and install the BUNDLE but not enable it:
10099

101100
```console
102-
zowe cics-deploy deploy bundle --name Express --bundledir /var/cicsts/bundles/myexpressapp_1.0.0 --target-state disabled
101+
zowe cics-deploy deploy bundle --name Express --bundle-directory /var/cicsts/bundles/myexpressapp_1.0.0 --target-state disabled
103102
```

docs/pages/cdp/cdp-zowe-profiles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ zowe zosmf check status --zosmf-profile myprofile
3131
```
3232
Zowe CLI profiles really come into their own when you decide to deploy your Node.js application(s) using `push bundle`. Using three profiles, you might issue:
3333
```
34-
zowe push bundle --name EXAMPLE --targetdir /u/example/bundles --zosmf-profile testplex --cics-deploy-profile devcics --ssh-profile ssh
34+
zowe push bundle --name EXAMPLE --target-directory /u/example/bundles --zosmf-profile testplex --cics-deploy-profile devcics --ssh-profile ssh
3535
```
3636
This is a much more economical and concise command-line than if were it necessary to enumerate all of the individual arguments from all of the profiles.
3737

@@ -50,7 +50,7 @@ When you create a Zowe CLI profile, a representation is written to an operating-
5050
</ul>
5151
<div class="tab-content">
5252
<div role="tabpanel" class="tab-pane active" id="windows">
53-
<p>On Windows, Zowe CLI profiles are written by default to <tt>C:\Users\&lt;Your user name&gt;\.zowe\profiles</tt></p>
53+
<p>On Windows, Zowe CLI profiles are written by default to <tt>%userprofile%\.zowe\profiles</tt></p>
5454
</div>
5555

5656
<div role="tabpanel" class="tab-pane" id="linux">

0 commit comments

Comments
 (0)