Skip to content

Commit 59cb0d8

Browse files
authored
Merge pull request #278 from markcocker/dev
Add tutorial intro topic
2 parents cb9031e + 7ff4d73 commit 59cb0d8

9 files changed

+151
-67
lines changed

docs/_data/sidebars/cdp_sidebar.yml

Lines changed: 70 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,48 @@ entries:
99
url: index.html
1010
output: web
1111
folderitems:
12-
- title: Home
12+
13+
- title: Zowe CLI CICS deploy plug-in
1314
url: index.html
1415
output: web
16+
1517
- title: Requirements on z/OS
1618
url: cdp-Requirements.html
1719
output: web
20+
1821
- title: Installing
1922
url: cdp-Installing.html
2023
output: web
24+
2125
- title: Creating Zowe CLI profiles
2226
url: cdp-Creating-Zowe-CLI-profiles.html
2327
output: web
2428

2529
- title: Tutorials
26-
url: cdp-Preparing-a-zOS-PT-image.html
30+
url: cdp-Tutorials-overview.html
2731
output: web
2832
folderitems:
33+
34+
- title: Tutorials overview
35+
url: cdp-Tutorials-overview.html
36+
output: web
37+
2938
- title: Preparing a z/OS PT image
3039
url: cdp-Preparing-a-zOS-PT-image.html
3140
output: web
41+
3242
- title: Provisioning a CICS region
3343
url: cdp-Provisioning-a-CICS-region.html
3444
output: web
35-
- title: Deploying your first Node.js app
36-
url: cdp-Deploying-your-first-nodejs-app.html
45+
46+
- title: Deploying a Node.js application
47+
url: cdp-Deploying-a-nodejs-application.html
3748
output: web
49+
3850
- title: Deploying a CICS policy
3951
url: cdp-Deploying-a-CICS-policy.html
4052
output: web
53+
4154
- title: Deploying using individual actions
4255
url: cdp-Deploying-using-individual-actions.html
4356
output: web
@@ -46,12 +59,15 @@ entries:
4659
url: cdp-zowe-and-cli.html
4760
output: web
4861
folderitems:
62+
4963
- title: Zowe and the Zowe CLI
5064
url: cdp-zowe-and-cli.html
5165
output: web
66+
5267
- title: Zowe CLI profiles
5368
url: cdp-zowe-profiles.html
5469
output: web
70+
5571
- title: CICS bundles
5672
url: cdp-cics-bundles.html
5773
output: web
@@ -60,49 +76,68 @@ entries:
6076
url: cdp-Troubleshooting-General.html
6177
output: web
6278
folderitems:
79+
6380
- title: Log and trace files
6481
url: cdp-Troubleshooting-General.html
6582
output: web
83+
6684
- title: Precautionary checks
6785
url: cdp-Precautionary-Checks.html
6886
output: web
87+
6988
- title: Potential problems
7089
url: cdp-Troubleshooting-Symptoms.html
7190
output: web
7291

73-
- title: Commands - zowe profiles
74-
url: cdp-CLIReadMe#create--cre
92+
- title: Commands
7593
output: web
7694
folderitems:
77-
- title: create cics-deploy-profile
95+
96+
- title: Commands overview
7897
url: cdp-CLIReadMe#create--cre
7998
output: web
80-
- title: update cics-deploy-profile
81-
url: cdp-CLIReadMe#update--upd
82-
output: web
83-
- title: delete cics-deploy-profile
84-
url: cdp-CLIReadMe#delete--rm
85-
output: web
86-
- title: list cics-deploy-profile
87-
url: cdp-CLIReadMe#list--ls
88-
output: web
89-
- title: set-default cics-deploy-profile
90-
url: cdp-CLIReadMe#set-default--set
91-
output: web
9299

93-
- title: Commands - zowe cics-deploy
94-
url: cdp-CLIReadMe#generate--g--gen
95-
output: web
96-
folderitems:
97-
- title: generate bundle
98-
url: cdp-CLIReadMe#generate--g--gen
99-
output: web
100-
- title: push bundle
101-
url: cdp-CLIReadMe#push--p
102-
output: web
103-
- title: deploy bundle
104-
url: cdp-CLIReadMe#deploy--d--dep
105-
output: web
106-
- title: undeploy bundle
107-
url: cdp-CLIReadMe#undeploy--u--udep
108-
output: web
100+
subfolders:
101+
- title: zowe profiles
102+
output: web
103+
subfolderitems:
104+
105+
- title: create cics-deploy-profile
106+
url: cdp-CLIReadMe#create--cre
107+
output: web
108+
109+
- title: update cics-deploy-profile
110+
url: cdp-CLIReadMe#update--upd
111+
output: web
112+
113+
- title: delete cics-deploy-profile
114+
url: cdp-CLIReadMe#delete--rm
115+
output: web
116+
117+
- title: list cics-deploy-profile
118+
url: cdp-CLIReadMe#list--ls
119+
output: web
120+
121+
- title: set-default cics-deploy-profile
122+
url: cdp-CLIReadMe#set-default--set
123+
output: web
124+
125+
- title: zowe cics-deploy
126+
output: web
127+
subfolderitems:
128+
129+
- title: generate bundle
130+
url: cdp-CLIReadMe#generate--g--gen
131+
output: web
132+
133+
- title: push bundle
134+
url: cdp-CLIReadMe#push--p
135+
output: web
136+
137+
- title: deploy bundle
138+
url: cdp-CLIReadMe#deploy--d--dep
139+
output: web
140+
141+
- title: undeploy bundle
142+
url: cdp-CLIReadMe#undeploy--u--udep
143+
output: web

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

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ summary: "Zowe profiles let you store configuration details so you don't have to
66
sidebar: cdp_sidebar
77
permalink: cdp-Creating-Zowe-CLI-profiles.html
88
folder: cdp
9+
toc: false
910
---
1011

1112
The Zowe CLI lets you define arguments and options for commands in multiple ways, with the following order of precedence:
@@ -14,9 +15,18 @@ The Zowe CLI lets you define arguments and options for commands in multiple ways
1415
2. Environment variables
1516
3. Profiles
1617

17-
This provides flexibility when you issue commands and write automation scripts. Further detail is in [Understanding command option order of precedence](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#understanding-command-option-order-of-precedence). Therefore by creating and setting options in the following profiles, they will become your defaults and do not need to repeat them on Zowe CLI command unless you wish to override them.
18+
Therefore by creating and setting options in the following profiles, they will become your defaults and do not need to repeat them on Zowe CLI command unless you wish to override them. This provides flexibility when you issue commands and write automation scripts. Further detail is in [Understanding command option order of precedence](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#understanding-command-option-order-of-precedence).
1819

19-
### Create a z/OSMF profile
20+
The CICS deploy plug-in makes use of the following profiles:
21+
22+
| Profile | Used by command | Connects to z/OS server |
23+
| --- | --- | --- |
24+
| [z/OSMF profile](#zosmf-profile) | **zowe cics-deploy ...** <br /> zowe console ... <br /> zowe zos-files ... <br /> zowe zos-jobs ... <br /> zowe zos-tso ... <br /> zowe zos-workflows ... <br /> zowe zosmf ... <br /> zowe provisioing ... | z/OSMF |
25+
| [SSH profile](#ssh-profile) | **zowe cics-deploy push ...** <br /> zowe zos-uss ... | SSH |
26+
| [CICS deploy profile](#cics-deploy-profile) | **zowe cics-deploy ...** | |
27+
| [CICS profile](#cics-profile) | **zowe cics-deploy push ...** <br /> zowe cics ... | CICSPlex SM WUI |
28+
29+
### z/OSMF profile
2030

2131
The z/OSMF profile defines the options needed to connect to the z/OSMF server on z/OS. You need to know the following from your z/OS system administrator:
2232

@@ -31,23 +41,23 @@ The z/OSMF profile defines the options needed to connect to the z/OSMF server on
3141

3242
For example, to create a z/OSMF profile:
3343

34-
```console
44+
```text
3545
zowe profiles create zosmf-profile myzos --host myzos.example.com --port 3000 --user myuserid --password mypassword --reject-unauthorized false --overwrite
3646
```
3747

3848
For help on using the options:
3949

40-
```console
50+
```text
4151
zowe profiles create zosmf-profile --help
4252
```
4353

4454
To test the connection to the z/OSMF server using the profile:
4555

46-
```console
56+
```text
4757
zowe zosmf check status
4858
```
4959

50-
### Create an SSH profile
60+
### SSH profile
5161

5262
The SSH profile defines the options needed to connect to the SSH server on z/OS. You need to know the following from your z/OS system administrator:
5363

@@ -58,27 +68,27 @@ The SSH profile defines the options needed to connect to the SSH server on z/OS.
5868
| user | User ID to identify yourself to the SSH server. |
5969
| password | Password to identify yourself to the SSH server. |
6070

61-
{% include note.html content="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 user's remote [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 set-up the shell environment and variables. This remote .profile should include any necessary environment variables and npm configuration required to run `npm install`. This is descibed in [Installing and configuring](https://www.ibm.com/support/knowledgecenter/SSTRRS_6.0.0/com.ibm.nodejs.zos.v6.doc/install.htm)." %}
71+
{% include note.html content="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 user's remote [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 set-up the shell environment and variables. This remote .profile should include any necessary environment variables and npm configuration required to run `npm install`. This is described in [Installing and configuring](https://www.ibm.com/support/knowledgecenter/SSTRRS_6.0.0/com.ibm.nodejs.zos.v6.doc/install.htm)." %}
6272

6373
For example, to create an SSH profile:
6474

65-
```console
75+
```text
6676
zowe profiles create ssh-profile myzos --host myzos.example.com --user myuserid --password mypassword --overwrite
6777
```
6878

6979
For help on using the options:
7080

71-
```console
81+
```text
7282
zowe profiles create ssh-profile --help
7383
```
7484

7585
To test the connection to the SSH server using the profile:
7686

77-
```console
87+
```text
7888
zowe zos-uss issue ssh 'uname -a'
7989
```
8090

81-
### Create a cics-deploy profile
91+
### CICS deploy profile
8292

8393
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:
8494

@@ -94,25 +104,26 @@ The cics-deploy profile identifies the CICS environment for deployment. An examp
94104

95105
For example to create a cics-deploy profile:
96106

97-
```console
98-
zowe profiles create cics-deploy-profile cics --cicsplex PLEX1 --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --scope TESTGRP1 --csd-group BUNDGRP1 --target-directory /var/cicsts/bundles --overwrite
107+
```text
108+
zowe profiles create cics-deploy-profile cics --cicsplex PLEX1 --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --scope CICPY000 --csd-group BUNDGRP1 --target-directory /var/cicsts/bundles --overwrite
99109
```
100110

101111
For help on using the options:
102112

103-
```console
113+
```text
104114
zowe profiles create cics-deploy-profile --help
105115
```
106116

107-
To test the cics-deploy profile, follow the steps in [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app).
117+
To test the cics-deploy profile, follow the steps in [Deploying a Node.js application](cdp-Deploying-a-nodejs-application).
108118

109-
### Create a CICS profile
119+
### CICS profile
110120

111121
The CICS profile identifies the connection to the CICS Web User Interface (WUI) server to query application resources. You need to know the following from your CICS system administrator:
112122

113123
| Option | Description |
114124
| --- | --- |
115125
| cics-plex | CPSM CICSplex name. This will typically be set to the same as cicsplex in the cics-deploy profile. |
126+
| region-name | The name of the CICS region name to interact with. |
116127
| protocol | HTTP or HTTPS to use to connect to the CICS WUI server. |
117128
| host | Host name of the CICS WUI server. |
118129
| port | Port number of the CICS WUI server. |
@@ -121,18 +132,26 @@ The CICS profile identifies the connection to the CICS Web User Interface (WUI)
121132

122133
For example, to create an SSH profile:
123134

124-
```console
125-
zowe profiles create cics-profile cics --cics-plex PLEX1 --protocol https --host myzos.example.com --port 1490 --user myuserid --password mypassword --overwrite
135+
```text
136+
zowe profiles create cics-profile cics --cics-plex PLEX1 --region-name CICPY000 --protocol https --host myzos.example.com --port 1490 --user myuserid --password mypassword --overwrite
126137
```
127138

128139
For help on using the options:
129140

130-
```console
141+
```text
131142
zowe profiles create cics-profile --help
132143
```
133144

134145
To test the connection to the CICS WUI server using the profile:
135146

136-
```console
137-
zowe cics get resource CICSRegion
147+
```text
148+
zowe cics get resource CICSRegion | grep -E "applid|cicsstatus|jobname|mvssysname|strttime|cputime"
138149
```
150+
151+
<pre class="messageText">
152+
applid: CICPY00V
153+
cicsstatus: ACTIVE
154+
cputime: 0000:02:29.2824
155+
jobname: CICPY00V
156+
mvssysname: MV2C
157+
strttime: 2019-06-13T16:08:15.938572+00:00</pre>

docs/pages/cdp/cdp-Deploying-a-CICS-policy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ This tutorial shows how to download a sample CICS policy and deploy it using the
1919

2020
2. Create Zowe CLI profiles by following the steps in [Creating Zowe CLI profiles](cdp-Creating-Zowe-CLI-profiles).
2121

22-
3. Clone the [cics-policy-samples](https://github.ibm.com/CICS/cics-policy-samples/tree/master) repository.
22+
3. Clone the [cics-policy-samples](https://github.com/cicsdev/cics-policy-samples) repository from GitHub.
2323

2424
```text
25-
git clone https://github.ibm.com/CICS/cics-policy-samples.git
25+
git clone https://github.com/cicsdev/cics-policy-samples.git
2626
2727
cd cics-policy-samples/bundles/CICSDEV_system_rule
2828
```

docs/pages/cdp/cdp-Deploying-your-first-nodejs-app.md renamed to docs/pages/cdp/cdp-Deploying-a-nodejs-application.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Deploying your first Node.js app
2+
title: Deploying a Node.js application
33
tags: [tutorial]
44
keywords:
5-
summary: "The following steps take you through deploying your first Node.js application to CICS using the Express Application Generator."
5+
summary: "The following steps take you through creating a Node.js application using the Express Application Generator then deploying it to CICS."
66
sidebar: cdp_sidebar
7-
permalink: cdp-Deploying-your-first-nodejs-app.html
7+
permalink: cdp-Deploying-a-nodejs-application.html
88
folder: cdp
99
toc: true
1010
---

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ folder: cdp
99
toc: true
1010
---
1111

12-
The `zowe cics-deploy push bundle` command performs a set of actions to deploy applications to CICS, as can be seen in [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app). The main actions include:
12+
The `zowe cics-deploy push bundle` command performs a set of actions to deploy applications to CICS, as can be seen in [Deploying a Node.js application](cdp-Deploying-a-nodejs-application). The main actions include:
1313

1414
* undeploy the old version of the CICS bundle in CICS
1515
* upload the new version of the CICS bundle to z/OS

docs/pages/cdp/cdp-Home.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ folder: cdp
1010

1111
The cics-deploy plug-in provides a CICS deployment workflow for developers and CI/CD automation pipelines similar to that experienced when deploying applications to cloud environments.
1212

13-
Before you start, and especially if you are not familiar with the world of z/OS, Zowe, and CICS, it's a good idea to read about some of the key concepts, which include [Zowe](cdp-zowe-and-cli), [Zowe CLI profiles](cdp-zowe-profiles) and [CICS bundles](cdp-cics-bundles). If you're keen to get going quickly, you can jump right in and follow along with our tutorial on [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app).
13+
Before you start, and especially if you are not familiar with the world of z/OS, Zowe, and CICS, it's a good idea to read about some of the key concepts, which include [Zowe](cdp-zowe-and-cli), [Zowe CLI profiles](cdp-zowe-profiles) and [CICS bundles](cdp-cics-bundles). If you're keen to get going quickly, you can jump right in and follow along with our tutorial on [Deploying a Node.js application](cdp-Deploying-a-nodejs-application).
1414

1515
When everything is [installed](cdp-Installing) and you have [created the Zowe CLI profiles](cdp-Creating-Zowe-CLI-profiles), you can deploy an application from your workstation to CICS in two steps:
1616

docs/pages/cdp/cdp-Preparing-a-zOS-PT-image.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Preparing a z/OS Provisioning Toolkit image
33
tags: [tutorial]
44
keywords:
5-
summary: "The following steps take you through preparing a z/OS Provisioning Toolkit image for CICS, and optionally including an application in the image."
5+
summary: "The following steps take you through preparing a z/OS Provisioning Toolkit image for CICS, and optionally include an application in the image."
66
sidebar: cdp_sidebar
77
permalink: cdp-Preparing-a-zOS-PT-image.html
88
folder: cdp
@@ -93,7 +93,7 @@ Run the following commands on your workstation.
9393

9494
#### Results
9595

96-
The image is now ready for developers to provision CICS regions and deploy their Node.js applications using [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app). The image source can be stored with other images and shared using a source code management system.
96+
The image is now ready for developers to provision CICS regions and deploy their Node.js applications using [Deploying a Node.js application](cdp-Deploying-a-nodejs-application). The image source can be stored with other images and shared using a source code management system.
9797

9898
### Prepare a z/OS PT image for CICS including an application
9999

@@ -107,7 +107,7 @@ Run the following commands on your workstation.
107107

108108
2. Create Zowe CLI profiles for at least z/OSMF and SSH following the steps in [Creating Zowe CLI profiles](cdp-Creating-Zowe-CLI-profiles).
109109

110-
3. Prepare your environment and Node.js application by following steps 1 to 4 in tutorial [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app).
110+
3. Prepare your environment and Node.js application by following steps 1 to 4 in tutorial [Deploying a Node.js application](cdp-Deploying-a-nodejs-application).
111111

112112
4. Setup environment variables for the name of your image, and paths for the image source on the workstation and z/OS.
113113

0 commit comments

Comments
 (0)