User/zlatnikp/apimlwfdoc for v2x #4179
Conversation
Signed-off-by: Pavel Zlatnik <[email protected]>
Signed-off-by: Pavel Zlatnik <[email protected]>
|
😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.
Need help? Contact the Doc Squad in the #zowe-doc Slack channel. |
|
📁 The PR description is missing the file name(s) for the updated content. List all the files included in this PR so this information displays in our Zowe Docs GitHub Slack channel. If you have addressed this issue already, refresh this page in your browser to remove this comment. |
|
💾 The release label is missing. Add a If you have addressed this issue already, refresh this page in your browser to remove this comment. |
|
📌 The subject area label is missing. Add an If you have addressed this issue already, refresh this page in your browser to remove this comment. |
|
🔍 The review label is missing. Add a If you have addressed this issue already, refresh this page in your browser to remove this comment. |
| ::: | ||
|
|
||
| You can execute the API ML/Zowe configuration workflow either from a PSWI during deployment or later from a created software | ||
| instance in z/OSMF. Alternatively, you can execute the configuration workflow z/OSMF during the workflow registration process. |
There was a problem hiding this comment.
Is "configuration workflow z/OSMF" the correct name of the workflow?
There was a problem hiding this comment.
there is missing filler, probably better formulation is: you can execute the configuration workflow in z/OSMF during the workflow registration process
| post-deployment workflow for mounting, which is required. | ||
|
|
||
| After you successfully performed the Zowe Mount workflow, you can start the **Stand-alone Zowe API ML Configuration** workflow. | ||
| When you select this workflow from the list of Workflow Definition Files, the following screen displays: |
There was a problem hiding this comment.
Is "Workflow Definition Files" the name of the list? If not, should these words be capitalized?
There was a problem hiding this comment.
Workflow Definition Files is IBM "name" for workflow (which is not yet executed, let say it is that xml before it is loaded within "workflows panel"), so yes, it is correct.
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Pavel Zlatnik <[email protected]>
…owe/docs-site into user/zlatnikp/apimlwfdocForV2x
Signed-off-by: pavelzlatnik <[email protected]>
Signed-off-by: Pavel Zlatnik <[email protected]>
…owe/docs-site into user/zlatnikp/apimlwfdocForV2x
|
|
||
| ## Execute Stand-alone Zowe API ML Configuration workflow from PSWI | ||
|
|
||
| In the PSWI deployment phase, you are presented with a checklist that helps guide you through the deployment process. |
There was a problem hiding this comment.
I think we need more detail about how this helps the user through the deployment process.
|
|
||
|  | ||
|
|
||
| The **Perform Workflows** step enables you to run either all attached workflows or just the |
There was a problem hiding this comment.
We were talking about the checklist. Now we're describing "Perform Workflows". I don't follow the connection. Is this an overview of what the workflows do? I need to review this with you to understand this connection.
|
|
||
|  | ||
|
|
||
| You can see the workflow details by expanding the **Workflow Details** panel. |
There was a problem hiding this comment.
We need to mention where the user accesses this list in Workload Definition Files.
| The **Perform Workflows** step enables you to run either all attached workflows or just the | ||
| post-deployment workflow for mounting, which is required. | ||
|
|
||
| After you successfully performed the **Zowe Mount** workflow, you can start the **Stand-alone Zowe API ML Configuration** workflow. |
There was a problem hiding this comment.
Do we have a link so the reader knows where to find information about the Zowe Mount workflow?
| 2. **Run the Zowe init** to run `zwe init mvs` and `zwe init stc` commands. | ||
|
|
||
| :::note | ||
| If you did not set up security prior this installation, you can alternatively submit the `ZWESECUR` JCL. For details, see [Configuring security](configuring-security.md). |
There was a problem hiding this comment.
Can we remove the word "alternatively"? We are not describing any other way, so there it would seem that "alternatively" does not mean anything in this sentence.
Or, should we mention running Zowe init security?
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
| In this step you can review your configurations and if needed you can make further changes directly in the JCL. | ||
| When you are done, click Finish and the zowe.yaml file will be ready, and the step will be marked as Complete. | ||
| This step creates a configuration zowe.yaml file with the variable setup that was defined in step 1. | ||
| In this step you can review your configurations and, if necessary, you can make further changes directly in the JCL. |
There was a problem hiding this comment.
I think we need a screenshot and steps describing where and how to perform this step.
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
| ::: | ||
|
|
||
| :::caution Important | ||
| Ensure that you first perform the **Zowe Mount** workflow as described in the IBM documentation. |
There was a problem hiding this comment.
Please provide the name of the IBM documentation that describes performing the Zowe Mount point. We do not need to provide the link in IBM doc, but we should provide the article name.
There was a problem hiding this comment.
I would say, the best what IBM provides and is relevant (because workflow from PSWI execution is slightly different from native execution from workflow tab) are those 2 links https://www.ibm.com/docs/en/zos/3.1.0?topic=overview-about-workflows https://www.ibm.com/docs/en/zos/3.1.0?topic=task-managing-steps-in-workflow
There was a problem hiding this comment.
and what you are interested in is this, session from GSE about PSWI deployments, namely slide 62 and following, https://www.newera.com/INFO/061422_zOSMF_SM.pdf , and in previous slides you see the screen over which user have to jump before he get to phase where he can perform workflows within deployment/install phase
Signed-off-by: Andrew Jandacek <[email protected]>
…low for v3 Signed-off-by: Andrew Jandacek <[email protected]>
…-zosmf-workflow for v3 Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Describe your pull request here:
I have prepared doc changes related to new API ML configuration workflow which final version is part of 2.18x.
Doc Update for version 2.18x related to zowe/zowe-install-packaging#4176
List the file(s) included in this PR:
After creating the PR, follow the instructions in the comments.