Creating an IBM App Connect Enterprise Integration Server Docker image on IBM z/OS Container Extensions (zCX) by using the supplied JCL

Create an IBM® App Connect Enterprise integration server Docker image on IBM z/OS® Container Extensions (zCX) by using the supplied JCL.

About this task

You can build your own integration server Docker image by using the supplied JCL. The image must be made available to the zCX instance. If you choose not to build your own image by using the supplied JCL, you can use any image that is built for the s390x architecture. The following alternatives are available:

If you use the supplied JCL to build your integration server Docker image, the feature that sends anonymous usage data for your IBM App Connect Enterprise installation is enabled. If you prefer not to provide anonymous usage data, you need to build your own image and disable this feature. You can disable anonymous usage data by using the disable-anonymous-usage-statistics parameter on the ace command as described in ace command, or by issuing the command ibmint modify installation --disable-anonymous-usage-statistics as described in ibmint modify installation command.

Procedure

To build your own integration server Docker image by using the supplied JCL, complete the following steps:

  1. Download an IBM App Connect Enterprise Linux® on IBM Z package from Passport Advantage / PassportAdvantage Express Overview and place it in the UNIX System Services file system on z/OS.

    Do not to use Secure Copy Protocol (SCP) to transfer the package. SCP assumes that files are text, so binary files that are copied between EBCDIC and ASCII operating systems are corrupted during the copying process.

  2. Set the environment variables in the environment file ENVFILE, as described in Environment variables in STDENV and BIPENVS.
    • Set the environment variable ACE_OPERATION_MODE to conform to the license agreement that you purchased. For example:
      ACE_OPERATION_MODE=advanced
      For more information about operation modes, see Operation modes.
    • Set the zCX access environment variables and the environment variables that are specific to creating an IBM App Connect Enterprise Integration Server Docker image on IBM z/OS Container Extensions (zCX).

      For more information about access options, see Configuring SSH access for IBM z/OS Container Extensions (zCX).

    • Specify the location of the downloaded Linux on IBM Z package. For example:
      ACE_DOWNLOAD_PACKAGE_DIR=/u/aceadmin
    • Specify the name of the downloaded Linux on IBM Z package. For example:
      ACE_DOWNLOAD_PACKAGE_NAME=ace-12.0.1.0.tar.gz
    • If you want to include a BAR file, place it in the UNIX System Services file system on z/OS and set the environment variables ACE_DOCKER_IMAGE_BAR_DIR, and ACE_DOCKER_IMAGE_BAR_NAME. For example:
      ACE_DOCKER_IMAGE_BAR_DIR=/u/aceadmin/bars
      ACE_DOCKER_IMAGE_BAR_NAME=zcx.bar
    • If you want to include a server.conf.yaml file, place it in the UNIX System Services file system on z/OS and set the environment variables ACE_DOCKER_IMAGE_YAML_DIR, and ACE_DOCKER_IMAGE_YAML_NAME. For example:
      ACE_DOCKER_IMAGE_YAML_DIR=/u/aceadmin
      ACE_DOCKER_IMAGE_YAML_NAME=server.conf.yaml
    • If you want to include an MQClient, download IBM MQ v9.2, or later Client deb install packages for IBM MQ on Ubuntu on z Systems from Fix Central. Place the downloaded image in the UNIX System Services file system on z/OS. Set the environment variables ACE_DOCKER_IMAGE_MQCLIENT_TAR_DIR, and ACE_DOCKER_IMAGE_MQCLIENT_TAR_NAME. For example:
      ACE_DOCKER_IMAGE_MQCLIENT_TAR_DIR=/u/aceadmin/tars
      ACE_DOCKER_IMAGE_MQCLIENT_TAR_NAME=9.2.0.0-IBM-MQC-UbuntuLinuxS390X.tar.gz
    • Specify the name of the image to build and specify a tag by setting the environment variables ACE_IMAGE, and ACE_TAG. For example:
      ACE_IMAGE=ace_jenkins_2020-06-15_09:59:01.957539
      ACE_TAG=testing
  3. Choose from two methods to provide access to the running integration server. Which method you choose depends on the level of access that you want to give to users who run IBM App Connect Enterprise commands.
  4. Customize the JCL job BIPXBLD as described in Customizing the JCL.
  5. Submit the JCL job BIPXBLD to build the image.

What to do next

You can then use either JCL or z/OS console commands to manage your integration servers and to run IBM App Connect Enterprise commands, as described in Administering IBM App Connect Enterprise on IBM z/OS Container Extensions (zCX) by using JCL and Administering IBM App Connect Enterprise on IBM z/OS Container Extensions (zCX) by using IBM z/OS console commands.