User/zlatnikp/apimlwfdoc for v2x

docs/user-guide/configure-zowe-zosmf-workflow.md

@@ -39,20 +39,25 @@ In the PSWI deployment phase, you are presented with a checklist that helps guid
 
 ![Deployment Checklist](../images/zosmf/perform-workflows.png)
 
-The **Perform Workflows** step enables you to run either all attached workflows or just the
+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 **Full Zowe server-side configuration for Zowe 3.0** workflow.
+After you successfully performed the **Zowe Mount** workflow, you can start the **Full Zowe server-side configuration for Zowe 3.0** workflow.
+
 When you select this workflow from the list of Workflow Definition Files, the following screen displays: 
 
 ![Full Zowe server-side configuration for Zowe 3.0 workflow](../images/zosmf/workflow-zoweConfiguration.png)
 
 You can see the workflow details by expanding the Workflow details panel.
 This workflow has three main steps:
 
+[1. Define variables](#1-define-variables)  
+[2. Create configuration](#2-create-configuration)  
+[3. Perform Zowe installation](#3-perform-zowe-installation)
+
 ### 1. **Define variables**
 
-This workflow step includes the list of Zowe variables and contains many child sub-steps.
+This workflow step includes the list of Zowe variables and contains many sub-steps.
 When you expand this step, the following screen displays: 
 
 ![Step1: Define variables](../images/zosmf/workflow-defineVariables.png)
@@ -72,30 +77,30 @@ Perform the following steps to execute each sub-step individually:
 
    :::note
    Ensure that all components you enabled are  configured in the sub-steps presented in the **Define variables** step. 
-   The sub-steps for configuring components will be in the Ready state, and the remainder of components in the Skipped state.
+   The sub-steps for configuring components will be in the **Ready** state, and the remainder of components in the **Skipped** state.
    :::
 
 4. Select **Next**. 
 5. Repeat the previous two steps to complete all items until the **Finish** option is available.
 
 :::note
-A basic validation is supported in many of the fields like a proper path structure, dataset name conventions, or numeric size.
+Basic validation is supported in many of the fields like a proper path structure, dataset name conventions, or numeric size.
 The workflow, however, does not check, for example, whether a target dataset exists, or a directory has sufficient space.
 :::
 
 After all sub-steps are completed, the step **Define variables** is marked as Complete.
 
 ### 2. **Create configuration**
 
-Execute this step to create a configuration zowe.yaml file with the variable setup that was defined in the previous step. 
+This step creates a configuration zowe.yaml file with the variable setup that was defined in the previous step. 
 In this step you can review your configurations and, if necessary, make further changes directly in the JCL. 
 When you are done, click **Finish**. The zowe.yaml file is ready, and the step is marked as Complete.
 
 :::note
 The **Create configuration** step is mandatory. A valid zowe.yaml is required to execute the **Zowe installation** step.
 :::
 
-### 3. **Zowe Installation**
+### 3. **Perform Zowe installation**
 
 This step consumes the zowe.yaml configuration file you created in the previous step. It contains three sub-steps:
 

versioned_docs/version-v2.18.x/user-guide/configure-apiml-zosmf-workflow-2-18.md

@@ -0,0 +1,127 @@
+# Configuring API ML with z/OSMF Workflows
+
+After you install Zowe, you can register and execute the z/OSMF workflows in the web interface to perform a range of
+API Mediation Layer (API ML) and other Zowe configuration tasks. The **Stand-alone Zowe API ML Configuration** workflow simplifies configuration of Zowe API Mediation Layer and does not require the level of
+expertise that is needed to perform manual API ML/Zowe configuration. The **Stand-alone Zowe API ML Configuration** workflow also runs the `zwe install` and `zwe init` command to initialize Zowe z/OS runtime.
+
+:::info Required role: system programmer
+:::
+## Prerequisites
+
+Ensure that you meet the following requirements before you start your Zowe configuration:
+
+- Install and configure z/OSMF
+- Install Zowe with an SMP/E build, PSWI, or a convenience build
+
+## Overview of Stand-alone Zowe API ML Configuration workflow
+
+The following components are automatically enabled after performing the **Stand-alone Zowe API ML Configuration** workflow:
+
+- Zowe configuration manager
+- Gateway
+- Gateway internal mapper
+- API Gateway
+- API Catalog
+- Discovery service
+- Caching service
+
+The following components are automatically disabled:
+
+- Metrics service
+- Cloud gateway
+- Application server
+- Jobs API
+- Files API
+- ZSS component
+- JES Explorer
+- MVS Explorer
+- USS Explorer
+
+:::note
+These disabled components can be enabled by performing manual changes in the yaml file. Note that making such changes to the yaml file is not recommended for simplified and optimized configuration of API ML.
+:::
+
+You can execute the **Stand-alone Zowe API ML 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 in z/OSMF during the workflow registration process.
+
+The configuration workflow described in this article is executed directly from a deployment of the Zowe PSWI.
+
+## Executing Stand-alone Zowe API ML Configuration workflow from PSWI
+
+In the PSWI deployment phase, follow each step outlined in the **Deployment Checklist**.
+
+![Deployment Checklist](../images/zosmf/perform-workflows.png)
+
+:::note
+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.
+When you select this workflow from the list of Workflow Definition Files, the following screen displays: 
+
+![Stand-alone Zowe API ML Configuration workflow](../images/zosmf/workflow-APIMLConfiguration.png)
+
+Expand the **Workflow Details** panel to see the workflow details and the state of each step.
+This workflow has three main steps:
+
+[1. Define variables](#1-define-variables)  
+[2. Create configuration](#2-create-configuration)  
+[3. Perform Zowe installation](#3-perform-zowe-installation)
+
+### 1. **Define variables**
+
+This workflow step includes the list of Zowe variables.
+When you expand **Define variables**, the following screen displays: 
+
+![Step1.1: Define the main variables](../images/zosmf/workflow-APIMLdefineMainVariablesV2.png)
+
+**1.1.** First, define the main variables for your configuration as presented in the list under **Input Variables**.
+
+**1.2.** After you complete defining the main variables for your configuration, define all ports for automatically enabled API ML services.  
+
+![Step1.2: Ports](../images/zosmf/workflow-APIMLdefinePortsV2.png)
+
+Perform the following steps to execute each sub-step individually:
+
+1. Click the title of the sub-step.
+2. Select the **Perform** tab.
+3. Review the step contents and update the variables that are marked by a red asterisk based on your mainframe environment.
+4. Select **Next**. 
+5. Repeat the previous two steps to complete all items until the **Finish** option is available.
+
+:::note
+Basic validation is supported in many fields. Validation includes proper path structure, dataset name conventions, or numeric size.
+The workflow, however, does not check, for example, if a target dataset exists, or if a directory has sufficient space.
+:::
+
+After both sub-steps, **Define the main variables** and **Ports** are completed, the step **Define variables** is marked as Complete.
+
+### 2. **Create configuration**
+
+This step creates a configuration zowe.yaml file with the variable setup that was defined in step 1. 
+Review your configurations and, if necessary, make further changes directly in the JCL. 
+When you are done, click **Finish**. The zowe.yaml file is ready, and the step is marked as Complete.
+
+:::note
+The **Create configuration** step is mandatory. A valid zowe.yaml is required to execute the **Zowe installation** step.
+:::
+
+### 3. **Perform Zowe Installation**
+
+This step consumes the zowe.yaml configuration file you created in the previous step. It contains two sub-steps:
+
+1. **Run the Zowe install** to run the `zwe install` command.
+2. **Run the Zowe init** to run `zwe init mvs` and `zwe init stc` commands.
+
+:::note
+If you did not set up security prior to this installation, you can  submit the `ZWESECUR` JCL. For details, see [Configuring security](configuring-security.md).
+:::
+
+For more information about `zwe install` and `zwe init` commands, see the following articles:
+* [zwe install command](../appendix/zwe_server_command_reference/zwe/zwe-install.md)
+* [Configuring Zowe with zwe init](initialize-zos-system.md)
+
+The **Stand-alone Zowe API ML Configuration** workflow strictly follows the Zowe v2 install and configuration schema. This workflow generates the zowe.yaml file and runs the Zowe `zwe` CLI tool.
+After completing the workflow execution, you can return to the **Deployment Checklist** for the Zowe PSWI. 
+After you complete the steps in the checklist you are ready to start your Zowe instance with optimized setup for Zowe API Mediation Layer.

versioned_docs/version-v2.18.x/user-guide/configure-zowe-runtime.md

@@ -43,4 +43,6 @@ Another option to initialize Zowe z/OS runtime is to configure Zowe with z/OSMF
 
 You can execute the 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 z/OSMF workflow during the workflow registration process.
 
-For more information about this z/OS runtime initialization method, see [Configuring Zowe with z/OSMF Workflows](./configure-zowe-zosmf-workflow).
+For more information about this z/OS runtime initialization method, see [Configuring Zowe with z/OSMF Workflows](./configure-zowe-zosmf-workflow).
+
+For details about API ML optimized initialization, see [Configuring API ML with z/OSMF Workflows](./configure-apiml-zosmf-workflow-2-18).

versioned_docs/version-v2.18.x/user-guide/configure-zowe-zosmf-workflow-2-18.md

@@ -0,0 +1,166 @@
+# Configuring Zowe with z/OSMF Workflows
+
+After you install Zowe, you can register and execute the z/OSMF workflows in the web interface to perform a range of
+Zowe configuration tasks. z/OSMF helps to simplify the Zowe configuration tasks and does not require the level of
+expertise that is needed to perform manual Zowe configuration. This configuration method also runs the `zwe init`
+command to initialize Zowe z/OS runtime.
+
+:::info Required role: system programmer
+:::
+
+## Prerequisites
+
+Ensure that you meet the following requirements before you start your Zowe configuration:
+
+- Install and configure z/OSMF
+- Install Zowe with an SMP/E build, PSWI, or a convenience build
+
+## Overview of Full Zowe server-side configuration for Zowe 2.0 workflow
+
+You can complete the following tasks with the **Full Zowe server-side configuration for Zowe 2.0** workflow:
+
+- Configure the Zowe instance
+- Enable the Gateway service
+- Enable the API Catalog
+- Enable the Discovery service
+- Enable the Caching service
+- Enable the Cloud gateway service
+- Enable the Metrics service
+- Enable the Application server
+- Enable ZSS component
+- Enable the jobs API
+- Enable the files API
+- Enable JES Explorer
+- Enable MVS Explorer
+- Enable USS Explorer
+
+You can execute the **Full Zowe server-side configuration for Zowe 2.0** workflow either from a PSWI during deployment or later from a created software
+instance in z/OSMF. Alternatively, you can execute the configuration workflow in z/OSMF during the workflow registration process.
+
+The configuration workflow described in this article is executed directly from a deployment of the Zowe PSWI.
+
+## Executing Full Zowe server-side configuration workflow for Zowe 2.0 from PSWI
+
+After Zowe installation, follow this procedure to perform Zowe server-side configuration.
+
+:::tip
+For more information, see [Installing Product Software Using z/OSMF Deployments](./install-zowe-pswi-deployment.md).
+:::
+
+1. In the **Software Management** panel, click **Actions** and **Add from z/OSMF System**. 
+2. Specify your system name and file location path (UNIX file).
+3. Click **Retrieve**. 
+4. Review the Deployment Jobs and click **Deployment Checklist**.
+5. Follow each step outlined in the **Deployment Checklist**.
+
+![Deployment Checklist](../images/zosmf/perform-workflows.png)
+
+As presented in the **Deployment Checklist**, during deployment you have the option to perform workflows.
+
+6. After you complete all of the preceding steps outlined in the Deployment checklist, click **Perform workflows** to leverage configuration with z/OSMF workflows.
+
+    Each workflow appears in the panel. 
+
+:::note
+The **Perform Workflows** step enables you to run either all attached workflows or just the
+    post-deployment workflow for mounting, which is required.
+:::
+
+:::caution Important
+Ensure that you first perform the **Zowe Mount** workflow as described in the IBM documentation.
+:::
+
+After you successfully perform the **Zowe Mount** workflow, you can start the **Full Zowe server-side configuration for Zowe 2.0** workflow.
+
+Select the **Full Zowe server-side configuration for Zowe 2.0** workflow from the list of Workflow Definition Files.  
+The following screen displays:
+
+![Full Zowe server-side configuration for Zowe 2.0 workflow](../images/zosmf/workflow-zoweConfiguration.png)
+
+Expand the **Workflow Details** panel to see the workflow details and the state of each step.
+This workflow is in three parts:
+
+[Define variables](#define-variables)  
+[Create configuration](#create-configuration)  
+[Perform Zowe installation](#perform-zowe-installation)
+
+### Define variables
+
+This workflow step includes the list of Zowe variables for configuration and as well as sub-steps.
+
+1. Expand **Define variables** to display the following screen: 
+
+    ![Step1: Define variables](../images/zosmf/workflow-defineVariables.png)
+
+2. Under **Input Variables**, click **Define the main variables**.
+3. Click the **Perform** tab. The input variables are displayed by category. 
+4. Customize workflow variables in the fields provided.  
+   **Example:**
+
+    ![Enabling components](../images/zosmf/workflow-componentsVariables.png)
+
+5. Perform the applicable sub-steps that correspond to the components you choose to enable.
+
+#### Sequence to execute steps and sub-steps in the workflow
+
+   Perform the following steps for each step and sub-step:
+
+  1. Click the title of the step or sub-step.
+  2. Select the **Perform** tab.
+  3. Review the step contents and update the variables that are marked by a red asterisk based on your mainframe environment.  
+   :::note
+    Once completed, sub-steps for configured components are in the **Ready** state. Components that are not enabled are shown in the **Skipped** state.
+    :::
+
+  4. Select **Next**.
+  5. Repeat the previous steps in this sequent to complete all items until the **Finish** option is available.  
+   :::note Notes
+      * You can click **Save**, to save your values and **Finish** to populate these values in subsequent steps.
+
+      * Basic validation is supported in many of the fields including the proper path structure, dataset name conventions, or numeric size.
+   The workflow, however, does not check, for example, if a target dataset exists, or if a directory has sufficient space.
+   :::
+   6.  When you complete this list of Input variables, click **Next** to view the components. Tick each component in this list that you want to enable.
+   7. Click **Finish** to populate the values. This action customizes your workflow according to the components.  
+   You are then presented with enabled sub-steps according to the Zowe component you specified. 
+   8. Click each sub-step and customize component specific variables. Click **Next** until you complete your customization of the variables.
+   9. Click **Finish** to apply the values.
+
+
+After all sub-steps are completed, the step **Define variables** is marked as Complete.
+
+### Create configuration
+
+This step creates a configuration zowe.yaml file with the variable setup that was defined in step 1.
+
+1. Review your configurations and, if necessary, make further changes directly in the JCL.
+2. Customize the JCL according you your specifications and click **Finish**.  
+   The zowe.yaml file is ready, and the step is marked as Complete.
+
+:::note
+The **Create configuration** step is mandatory. A valid zowe.yaml is required to execute the **Zowe installation** step.
+:::
+
+### Perform Zowe installation
+
+This step consumes the zowe.yaml configuration file you created in step 2 and contains three sub-steps.
+
+1. **Run Zowe install** runs the `zwe install` command.
+2. **Run Zowe init** runs `zwe init mvs` and `zwe init stc` commands.
+3. **Run Zowe init security**.  
+   This sub-step is optional if you already preformed security setup for Zowe. This sub-step requires Security Administrator permissions, which are required to run the `zwe init apfauth` and `zwe init security` commands. If security is not set up for Zowe, contact your Security Administrator to perform this setup. 
+
+   :::note
+   An alternative to executing **Run the Zowe init security** is to submit `ZWESECUR` JCL. For details, see [Configuring security](configuring-security.md).
+   :::
+
+For more information about `zwe install` and `zwe init` commands, see the following articles:
+
+* [zwe install command](../appendix/zwe_server_command_reference/zwe/zwe-install.md)
+* [Configuring Zowe with zwe init](initialize-zos-system.md)
+
+### Additional information
+
+The **Full Zowe server-side configuration for Zowe 2.0** workflow strictly follows Zowe v2 install and configuration schema. This workflow generates the zowe.yaml file and runs Zowe's zwe CLI tool.
+After completing the workflow execution, you can return to the **Deployment Checklist** for the Zowe PSWI.
+After you complete the steps in the checklist you are ready to start your Zowe instance.