Create and edit an IBM z/OS Connect API project in Red Hat OpenShift Container Platform

Set up an IBM z/OS Connect API project with Red Hat OpenShift Dev Spaces or Red Hat OpenShift Wazi Dev Spaces.

1. Create the API project template.
   At the command line on your workstation, change to the directory where you want to create your z/OS Connect API project.
   1. Enter the following command to create a project workspace directory called apiProjectWorkspace.

      mkdir apiProjectWorkspace

   2. Enter the following command to change to that directory:

      cd apiProjectWorkspace

   3. In the apiProjectWorkspace directory, create the subdirectories for the API project. These subdirectories are used for Liberty server configuration files.
      For Windows, enter the following command:

      mkdir apiProject\src\main\liberty\config

      For MacOS, enter the following command:

      mkdir -p apiProject/src/main/liberty/config

      The following image shows the directory structure:

      /apiProjectWorkspace
      |-- /apiProject/src/main/liberty/config

   4. To configure the connection to the z/OS Connect server, place the server configuration files in the apiProject/src/main/liberty/config directory.
      For more information, see Configuring the z/OS Connect server.
      The following example shows a server configuration file to authenticate the Db2® connection that is called db2.xml.

      <?xml version="1.0" encoding="UTF-8" ?>
      <server description="Default server">
          <featureManager>
              <feature>zosconnect:db2-1.0</feature>
          </featureManager>
          <zosconnect_credential user="${DB2_USERNAME}" password="${DB2_PASSWORD}" id="commonCredentials"/>
          <zosconnect_db2Connection id="db2Conn" host="${DB2_HOST}" port="${DB2_PORT}" credentialRef="commonCredentials"/> 
      </server>

      /apiProjectWorkspace
      |-- /apiProject/src/main/liberty/config/db2.xml

   5. Create a devfile.yaml and place it into the apiProject/ directory.
      This file contains the configuration that is needed to create a workspace in Red Hat OpenShift Dev Spaces for the z/OS Connect API Project, and allows the IBM z/OS Connect Designer to be started.

      schemaVersion: 2.1.0
      metadata:
        name: <API_PROJECT_NAME>
      attributes:
        controller.devfile.io/storage-type: ephemeral
      projects:
        - git:
            checkoutFrom:
              revision: main
            remotes:
              origin: '<SOURCE_CODE_REPOSITORY>.git'
          name: <API_PROJECT_NAME>
      components:
          - name: zosconnect
            container:
              endpoints:
                - exposure: public
                  name: zosconnect-ui
                  path: /zosConnect/designer/
                  protocol: http
                  targetPort: 9080
              env:
                - name: ZCON_DESIGNER_PROJECT
                  value: /projects/<API_PROJECT_NAME>/apiProject
              image: 'icr.io/zosconnect/ibm-zcon-designer:3.0.75'
              memoryLimit: 4927M
              mountSources: true

      Where <API_PROJECT_NAME> is the name of your API Project, and <SOURCE_CODE_REPOSITORY> is the name of the Git repository where your API Project is hosted. Note, the name must contain only lowercase characters and hyphens.
   6. Validate that the API project has the following structure.

      apiWorkspaceProject
      └── apiProject
          ├── devfile.yaml
          └── src/main/liberty/config/db2.xml

   7. Push the API project to the Git repository <SOURCE_CODE_REPOSITORY> hosted by a Source Code Management (SCM) solution.
2. Import an API project to create a Red Hat OpenShift Dev Spaces workspace from the API project template.
   1. Mount the server configuration environment variables (from step 1.d) into the workspace by using a Secret and a ConfigMap.
      Access your development environment where the Red Hat OpenShift Dev Space Operator is installed. Click in the navigation bar to add the Secrets and ConfigMaps objects.
      Continuing with the basic authentication connection to Db2. Create the following ConfigMap and Secret objects on the Red Hat OpenShift cluster with your own data:
      For example,

      kind: ConfigMap
      apiVersion: v1
      metadata:
        name: db2-connection
        namespace: <USER_DEVSPACES_NAMESPACE>
        labels:
          controller.devfile.io/mount-to-devworkspace: 'true'
          controller.devfile.io/watch-configmap: 'true'
        annotations:
          controller.devfile.io/mount-as: env
      data:
        DB2_HOST: <DB2_HOST>
        DB2_PORT: <DB2_PORT>

      kind: Secret
      apiVersion: v1
      metadata:
        name: db2-credentials
        namespace: <USER_DEVSPACES_NAMESPACE>
        labels:
          controller.devfile.io/mount-to-devworkspace: 'true'
          controller.devfile.io/watch-secret: 'true'
        annotations:
          controller.devfile.io/mount-as: env
      stringData:
        DB2_USERNAME: <DB2_USERNAME>
        DB2_PASSWORD: <DB2_PASSWORD>

      Where <USER_DEVSPACES_WORKSPACE> is the namespace where Red Hat OpenShift Dev Spaces is hosted for the active user.
      For more information, see Mounting Secrets and Mounting ConfigMaps.
   2. Access Red Hat OpenShift Dev Spaces.

      

   3. Import from Git.
      Add the git-raw URL of the devfile pushed to SCM into the Git Repo URL box. Click Create & Open.
      An example of the git-raw URL.

      https://raw.githubusercontent.com/example/main/apiProject/devfile.yaml

   4. The new workspace opens. Click Open in New Tab to open the z/OS Connect Designer.
      Note: It may take a few minutes for the z/OS Connect Designer to start, and Open in New Tab to appear.