You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# zowe-cli-cics-deploy-plugin
2
2
3
-
This project provides a plug-in for [Zowe CLI](https://github.com/zowe/zowe-cli) to deploy applications developed on a workstation to IBM CICS Transaction Server for z/OS (CICS). It aims to provide an experience similar to deploying to a cloud platform when deploying to CICS. It will also provide low-level commands for performing individual steps of the deployment process that could be used as part of a CI/CD pipeline.
3
+
This project provides a plug-in for [Zowe CLI](https://github.com/zowe/zowe-cli) to deploy applications developed on a workstation to IBM CICS® Transaction Server for z/OS (CICS). It aims to provide an experience similar to deploying to a cloud platform when deploying to CICS®. It will also provide low-level commands for performing individual steps of the deployment process that could be used as part of a CI/CD pipeline.
4
4
5
5
## Status
6
6
7
-
The project was started in February 2019 and is at an early stage of development. It will initially focus on generating and deploying CICS bundles containing Node.js applications.
7
+
The project was started in February 2019 and is at an early stage of development. It will initially focus on generating and deploying CICS® bundles containing Node.js applications.
8
8
9
9
To try it out, install the plug-in by following the steps in [installing](https://ibm.github.io/zowe-cli-cics-deploy-plugin/installing.html).
Copy file name to clipboardExpand all lines: docs/pages/cdp/cdp-Common-Errors.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,15 +12,15 @@ folder: cdp
12
12
13
13
If you experience errors while using the cics-deploy plug-in, check the following potential causes before investigating further:
14
14
15
-
* CICS must be authorized to read the bundle directory `META-INF`.
15
+
* CICS® must be authorized to read the bundle directory `META-INF`.
16
16
* The port specified by the `--port` argument of the `cics-deploy generate bundle` command *must* be free on z/OS before you attempt to deploy an application.
17
-
* If you set a `WORK_DIR` in the CICS Node.js application profile, such as `nodejsapps/<your application name>.profile`, it must be *writeable* by CICS.
17
+
* If you set a `WORK_DIR` in the CICS® Node.js application profile, such as `nodejsapps/<your application name>.profile`, it must be *writeable* by CICS®.
18
18
19
19
## Deployment errors
20
20
21
21
{% include note.html content="For further troubleshooting steps, see [Troubleshooting Node.js applications](https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.5.0/troubleshooting/node/node-troubleshooting.html)." %}
22
22
23
-
{% include important.html content="To definitively diagnose a problem based on the suggested symptoms, you might need to refer to one or more [system logs and traces](cdp-Log-and-trace-files) particularly the STDERR Node.js log and the file assigned the MSGUSR DD name in the relevant CICS job. Depending on your familiarity with z/OS and CICS, and your system privileges, you may also need to consult a CICS systems administrator to get to the bottom of certain problems." %}
23
+
{% include important.html content="To definitively diagnose a problem based on the suggested symptoms, you might need to refer to one or more [system logs and traces](cdp-Log-and-trace-files) particularly the STDERR Node.js log and the file assigned the MSGUSR DD name in the relevant CICS® job. Depending on your familiarity with z/OS and CICS®, and your system privileges, you may also need to consult a CICS® systems administrator to get to the bottom of certain problems." %}
24
24
25
25
### Application incorrectly deploys in a DISABLED state
26
26
@@ -33,7 +33,7 @@ If you experience errors while using the cics-deploy plug-in, check the followin
33
33
### Command error: DFHDPLOY stopped processing due to an error
34
34
35
35
*Possible causes*:
36
-
* The `--scope` and/or `--cicsplex` settings for the current deploy profile are wrong, and don't correctly identify a current CICS system, CICS System Group and/or a correct CICSPlex respectively.
36
+
* The `--scope` and/or `--cicsplex` settings for the current deploy profile are wrong, and don't correctly identify a current CICS® system, CICS® System Group and/or a correct CICSPlex respectively.
37
37
* The CMAS for the current CICSPlex is inactive.
38
38
* CPSM is not functioning correctly.
39
39
@@ -50,15 +50,15 @@ If you experience errors while using the cics-deploy plug-in, check the followin
50
50
*Suggested actions*:
51
51
52
52
* Confirm that the `--scope` and `--cicsplex` settings are correct.
53
-
* Ask your CICS Systems Programmer to check that the CMAS for the current CICSPlex is alive and that CPSM is working properly.
53
+
* Ask your CICS® Systems Programmer to check that the CMAS for the current CICSPlex is alive and that CPSM is working properly.
54
54
55
55
### Command error: ... validation of - -cicshlq dataset failed: z/OSMF REST API Error
56
56
57
57
*Possible cause*: The profile setting for `--cicshlq` is incorrect.
58
58
59
59
*Representative output*:
60
60
<preclass="messageText">
61
-
A failure occurred during CICS bundle deployment.
61
+
A failure occurred during CICS® bundle deployment.
62
62
Reason = Validation of --cicshlq dataset failed: z/OSMF REST API Error:
63
63
Rest API failure with HTTP(S) status 404
64
64
category: 4
@@ -70,11 +70,11 @@ details:
70
70
</pre>
71
71
72
72
*Suggested action*:
73
-
Check that your `--cicshlq` profile setting matches the value configured for CICS high-level qualifiers in your CICS region.
73
+
Check that your `--cicshlq` profile setting matches the value configured for CICS® high-level qualifiers in your CICS® region.
74
74
75
75
### BUNDLE ... cannot be deployed (1)
76
76
77
-
*Possible cause*: CICS does not have permission to read the bundle directory.
77
+
*Possible cause*: CICS® does not have permission to read the bundle directory.
Copy file name to clipboardExpand all lines: docs/pages/cdp/cdp-Creating-Zowe-CLI-profiles.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ The Zowe CLI lets you define arguments and options for commands in multiple ways
17
17
18
18
Therefore by creating and setting options in the following profiles, they will become your defaults and you do not need to repeat them when using Zowe CLI commands unless you wish to override them. Further details are 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).
19
19
20
-
The CICS deploy plug-in makes use of the following profiles:
20
+
The CICS® deploy plug-in makes use of the following profiles:
21
21
22
22
| Profile | Used by command | Connects to z/OS server |
23
23
| --- | --- | --- |
@@ -37,7 +37,7 @@ The z/OSMF profile defines the options needed to connect to the z/OSMF server on
37
37
| user | User ID to identify yourself to the z/OSMF server. |
38
38
| password | Password to identify yourself to the z/OSMF server. |
39
39
40
-
{% include note.html content="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. The user ID also needs permission to submit JCL and to run the DFHDPLOY utility as described in the **Security** heading in topic [Automate the deployment and undeployment of CICS bundles and applications with the DFHDPLOY utility](https://www.ibm.com/support/knowledgecenter/SSGMCP_5.5.0/applications/deploying/dfhdploy_overview.html)." %}
40
+
{% include note.html content="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. The user ID also needs permission to submit JCL and to run the DFHDPLOY utility as described in the **Security** heading in topic [Automate the deployment and undeployment of CICS® bundles and applications with the DFHDPLOY utility](https://www.ibm.com/support/knowledgecenter/SSGMCP_5.5.0/applications/deploying/dfhdploy_overview.html)." %}
41
41
42
42
For example, to create a z/OSMF profile:
43
43
@@ -88,19 +88,19 @@ To test the connection to the SSH server using the profile:
88
88
zowe zos-uss issue ssh 'uname -a'
89
89
```
90
90
91
-
### CICS deploy profile
91
+
### CICS® deploy profile
92
92
93
-
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:
93
+
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:
94
94
95
95
| Option | Description |
96
96
| --- | --- |
97
97
| cicsplex | CPSM CICSplex name. |
98
-
| cics-hlq | High Level Qualifier \(HLQ\) for the CICS data sets. |
98
+
| cics-hlq | High Level Qualifier \(HLQ\) for the CICS® data sets. |
99
99
| cpsm-hlq | High Level Qualifier \(HLQ\) for the CPSM data sets. |
100
-
| scope | CPSM scope to identify the CICS region or group of regions to deploy your application. |
101
-
| 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. |
102
-
| 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. |
103
-
| target-directory | Target directory on z/OS to which CICS bundles should be uploaded. |
100
+
| scope | CPSM scope to identify the CICS® region or group of regions to deploy your application. |
101
+
| 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. |
102
+
| 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. |
103
+
| target-directory | Target directory on z/OS to which CICS® bundles should be uploaded. |
To test the cics-deploy profile, follow the steps in [Deploying a Node.js application](cdp-Deploying-a-Nodejs-application).
118
118
119
-
### CICS profile
119
+
### CICS® profile
120
120
121
-
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:
121
+
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:
122
122
123
123
| Option | Description |
124
124
| --- | --- |
125
125
| 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. |
127
-
| protocol | HTTP or HTTPS to use to connect to the CICS WUI server. |
128
-
| host | Host name of the CICS WUI server. |
129
-
| port | Port number of the CICS WUI server. |
130
-
| user | User ID to identify yourself to the CICS WUI server . |
131
-
| password | Password to identify yourself to the CICS WUI server. |
126
+
| region-name | The name of the CICS® region name to interact with. |
127
+
| protocol | HTTP or HTTPS to use to connect to the CICS® WUI server. |
128
+
| host | Host name of the CICS® WUI server. |
129
+
| port | Port number of the CICS® WUI server. |
130
+
| user | User ID to identify yourself to the CICS® WUI server . |
131
+
| password | Password to identify yourself to the CICS® WUI server. |
132
132
133
133
For example, to create an SSH profile:
134
134
@@ -142,7 +142,7 @@ For help on using the options:
142
142
zowe profiles create cics-profile --help
143
143
```
144
144
145
-
To test the connection to the CICS WUI server using the profile:
145
+
To test the connection to the CICS® WUI server using the profile:
146
146
147
147
```text
148
148
zowe cics get resource CICSRegion | grep -E "applid|cicsstatus|jobname|mvssysname|strttime|cputime"
summary: "The following steps take you through deploying a sample CICS bundle containing a policy."
5
+
summary: "The following steps take you through deploying a sample CICS® bundle containing a policy."
6
6
sidebar: cdp_sidebar
7
7
permalink: cdp-Deploying-a-CICS-policy.html
8
8
folder: cdp
9
9
toc: true
10
10
---
11
11
12
-
[CICS policies](https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.5.0/fundamentals/policies/policies.html) are used to monitor the state of the CICS region, and the resources and workload in it. A policy consists of rules that define the conditions that are required to be met for the rule to trigger, and the action to take when the conditions are met.
12
+
[CICS policies](https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.5.0/fundamentals/policies/policies.html) are used to monitor the state of the CICS® region, and the resources and workload in it. A policy consists of rules that define the conditions that are required to be met for the rule to trigger, and the action to take when the conditions are met.
13
13
14
-
This tutorial shows how to download a sample CICS policy and deploy it using the CICS deploy plug-in. The policy rule condition is when the number of active tasks in your CICS regions goes above 90% of your MXT value, and action is to issue message DFHMP3009 to the CICS region JES job log. CICS policies and this sample are described in article [Using CICS policy system rules to monitor system health](https://developer.ibm.com/cics/2017/07/04/using-cics-policy-system-rules-monitor-system-health/).
14
+
This tutorial shows how to download a sample CICS® policy and deploy it using the CICS® deploy plug-in. The policy rule condition is when the number of active tasks in your CICS® regions goes above 90% of your MXT value, and action is to issue message DFHMP3009 to the CICS® region JES job log. CICS® policies and this sample are described in article [Using CICS® policy system rules to monitor system health](https://developer.ibm.com/cics/2017/07/04/using-cics-policy-system-rules-monitor-system-health/).
15
15
16
16
### Procedure
17
17
@@ -27,13 +27,13 @@ This tutorial shows how to download a sample CICS policy and deploy it using the
27
27
cd cics-policy-samples/bundles/CICSDEV_system_rule
A progress bar is shown with status messages as the CICS bundle is deployed. This can take a few minutes. The command will summarize the deployment, for example:
36
+
A progress bar is shown with status messages as the CICS® bundle is deployed. This can take a few minutes. The command will summarize the deployment, for example:
37
37
38
38
<preclass="messageText">
39
39
WARNING: No .zosAttributes file found in the bundle directory, default values will be applied.
@@ -43,14 +43,14 @@ This tutorial shows how to download a sample CICS policy and deploy it using the
43
43
44
44
The warning can be ignored as the default values result in the files being uploaded in text that is suitable for this bundle.
45
45
46
-
The CICS BUNDLE resource named `Policy` is defined, installed, and enabled in CICS. If the BUNDLE `Policy` was already defined or installed in CICS, it is undeployed first. As the BUNDLE is enabled, the policy is also enabled. If there are errors, retry with the `--verbose` option for more detailed output, or refer to [Troubleshooting](cdp-Log-and-trace-files).
46
+
The CICS BUNDLE resource named `Policy` is defined, installed, and enabled in CICS®. If the BUNDLE `Policy` was already defined or installed in CICS®, it is undeployed first. As the BUNDLE is enabled, the policy is also enabled. If there are errors, retry with the `--verbose` option for more detailed output, or refer to [Troubleshooting](cdp-Log-and-trace-files).
47
47
48
48
### Results
49
49
50
-
The CICS policy is enabled in the CICS region. When the policy rule is triggered, CICS will write message DFHMP3009 to the CICS region JES job log. For details on how to view this log see [Log and trace files](cdp-Log-and-trace-files).
50
+
The CICS® policy is enabled in the CICS® region. When the policy rule is triggered, CICS® will write message DFHMP3009 to the CICS® region JES job log. For details on how to view this log see [Log and trace files](cdp-Log-and-trace-files).
51
51
52
-
To get started with defining your own CICS policy:
52
+
To get started with defining your own CICS® policy:
53
53
54
-
*[Download and start the CICS Explorer](https://www.ibm.com/support/knowledgecenter/en/SSSQ3W_5.5.0/com.ibm.cics.core.help/topics/concepts/install_planning_client.html).
55
-
* Create a CICS bundle project using the procedure [Creating a CICS bundle project](https://www.ibm.com/support/knowledgecenter/SSSQ3W_5.5.0/com.ibm.cics.core.help/topics/tasks/create_bundle.html).
56
-
* Create a policy using the procedure [To create a policy in a CICS bundle project](https://www.ibm.com/support/knowledgecenter/SSSQ3W_5.5.0/com.ibm.cics.core.help/topics/tasks/task_create_policy.html).
54
+
*[Download and start the CICS® Explorer](https://www.ibm.com/support/knowledgecenter/en/SSSQ3W_5.5.0/com.ibm.cics.core.help/topics/concepts/install_planning_client.html).
55
+
* Create a CICS® bundle project using the procedure [Creating a CICS® bundle project](https://www.ibm.com/support/knowledgecenter/SSSQ3W_5.5.0/com.ibm.cics.core.help/topics/tasks/create_bundle.html).
56
+
* Create a policy using the procedure [To create a policy in a CICS® bundle project](https://www.ibm.com/support/knowledgecenter/SSSQ3W_5.5.0/com.ibm.cics.core.help/topics/tasks/task_create_policy.html).
0 commit comments