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,122 @@
+# 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
+:::
+
+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
+
+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, but making such changes to the yaml file is not recommended for simplified and optimized configuration of API ML.
+:::
+
+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.
+
+The configuration workflow described in this article is executed directly from a deployment of the Zowe PSWI.
+
+## 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.
+
+![Deployment Checklist](../images/zosmf/perform-workflows.png)
+
+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)
+
+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.
+When you expand **Define variables**, the following screen displays: 
+
+![Step1.1: Define the main variables](../images/zosmf/workflow-APIMLdefineMainVariablesV2.png)
+
+First, define the main variables for your configuration.
+
+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, whether a target dataset exists, or 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 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. **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 this installation, you can alternatively 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.md

@@ -13,7 +13,7 @@ Ensure that you meet the following requirements before you start your Zowe confi
 - Install and configure z/OSMF
 - Install Zowe with an SMP/E build, PSWI, or a convenience build
 
-You can complete the following tasks with the **Configuration of 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
@@ -31,12 +31,11 @@ You can complete the following tasks with the **Configuration of Zowe 2.0** work
 - Enable USS Explorer
 
 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 workflow z/OSMF during the workflow registration
-process.
+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.
 
-## Execute Configuration of Zowe 2.0 workflow from PSWI
+## Execute Full Zowe server-side configuration for Zowe 2.0 workflow from PSWI
 
 In the PSWI deployment phase, you are presented with a checklist that helps guide you through the deployment process.
 
@@ -45,23 +44,27 @@ In the PSWI deployment phase, you are presented with a checklist that helps guid
 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 perform the Zowe Mount workflow, you can start the **Configuration of Zowe 2.0** workflow.
+After you successfully perform the **Zowe Mount** workflow, you can start the **Full Zowe server-side configuration for Zowe 2.0** workflow.
 When you select this workflow from the list of Workflow Definition Files, the following screen discplays:
 
-![Configuration of Zowe 2.0 workflow](../images/zosmf/workflow-zoweConfiguration.png)
+![Full Zowe server-side configuration for Zowe 2.0 workflow](../images/zosmf/workflow-zoweConfiguration.png)
 
-You can see the workflow details by expanding the Workflow details panel.
+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. It contains many child sub-steps.
-When you expand this step, the following screen displays: 
+This workflow step includes the list of Zowe variables and contains many sub-steps.
+When you expand **Define variables**, the following screen displays: 
 
 ![Step1: Define variables](../images/zosmf/workflow-defineVariables.png)
 
 First, define the main variables of your configuration. 
-The other sub-steps are optional and depending on which components you choose to enable.
+The other sub-steps are optional depending on which components you choose to enable.
 
 Perform the following steps to execute each sub-step individually:
 
@@ -74,35 +77,35 @@ Perform the following steps to execute each sub-step individually:
    ![Enabling components](../images/zosmf/workflow-componentsVariables.png)
 
    :::note
-   Ensure that all the components that you enabled are configured in the next sub-steps of **Define variables** step.
-   The sub-steps for configuring components will be in the Ready state, and the remainder of components in the Skipped state.
+   Ensure that all the components that you enabled are configured in the next sub-steps of 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.
    :::
 
 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.
-But the workflow does not check, for example,  whether a target dataset exists, or a directory has sufficient space.
+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.
 :::
 
-After all sub-steps are completed the step **Define variables** is marked as Complete.
+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.
-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.
+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.
+This step consumes the zowe.yaml configuration file you created in the previous step and contains three sub-steps.
 
-1. **(Optional) Run the Zowe install (only for convenience build)** is needed only for convenience build. It runs the `zwe install` command.
+1. **Run the Zowe install** runs the `zwe install` command.
 2. **Run the Zowe init** runs `zwe init mvs` and `zwe init stc` commands.
 3. **Run the Zowe init security** is optional if you have already previously preformed security setup for Zowe. This sub-step requires Security Administrator permissions. It runs 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. 
 
@@ -115,6 +118,6 @@ For more information about `zwe install` and `zwe init` commands, see the follow
 * [zwe install command](../appendix/zwe_server_command_reference/zwe/zwe-install.md)
 * [Configuring Zowe with zwe init](initialize-zos-system.md)
 
-The **Configuration of 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.
+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.

versioned_docs/version-v2.18.x/user-guide/configuring-overview.md

@@ -28,7 +28,10 @@ To run the `zwe init` command, it is necessary to create a Zowe configuration fi
 * **Option 2: Configure Zowe with z/OSMF workflows**  
 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 workflow z/OSMF during the workflow registration process.
 
-    For more information, see [Configure Zowe with z/OSMF Workflows](./configure-zowe-zosmf-workflow.md).
+    For more information about configuring all Zowe server-side components, see [Configuring Zowe with z/OSMF Workflows](./configure-zowe-zosmf-workflow.md). 
+
+    To simplify configuration for Zowe API Mediation Layer, see 
+[Configuring API ML with z/OSMF Workflows](./configure-apiml-zosmf-workflow-2-18.md).
 
 ## Configuring the z/OS system for Zowe
 

versioned_docs/version-v2.18.x/user-guide/install-zos.md

@@ -106,7 +106,8 @@ The steps to prepare the z/OS environment to launch Zowe are the same for all in
 
 Choose from the following methods to configure the Zowe runtime: 
 - [Use a combination of JCL and the zwe command `zwe init`](./initialize-zos-system.md)
-- [Use z/OSMF Workflows](./configure-zowe-zosmf-workflow.md)
+- [Use Zowe z/OSMF Workflows](./configure-zowe-zosmf-workflow.md)
+- [Use API ML optimized z/OSMF Workflows](./configure-apiml-zosmf-workflow-2-18.md)
 
 :::tip
 We recommend you open the links to this configuration procedure in new tabs.

versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi-address-requirements.md

@@ -42,4 +42,4 @@ To download and unpack the pax file, you need free space that is approximately 3
 
 Configure SMP/E Internet Service Retrieval to receive and download maintenance on a regular cadence or build custom maintenance packages (order PTFs, APARs, critical, recommended, all, or just HOLDDATA). This step is our recommended best practice when installing maintenance and is required to use the z/OSMF Software Update. For configuration details, see the Mainframe Common Maintenance Procedures documentation.	
 
-After these requirements have been addressed, you are ready to [acquire a z/OSMF Portable Software Instance](./install-zowe-pswi-acquire/#download-the-portable-software-instance-from-zowe-downloads) or [Configure Zowe with z/OSMF Workflows](./configure-zowe-zosmf-workflow.md).
+After these requirements have been addressed, you are ready to [acquire a z/OSMF Portable Software Instance](./install-zowe-pswi-acquire/#download-the-portable-software-instance-from-zowe-downloads) or [Configure Zowe with z/OSMF Workflows](./configure-zowe-zosmf-workflow.md) or [Configuring API ML with z/OSMF Workflows](./configure-apiml-zosmf-workflow-2-18.md).