Configure a CCS Apache Tomcat Region

Configure a CCS Apache Tomcat Region to host the web application for your product. Optionally, set the region to non-secure to allow Application Transparent Transport Layer Security (AT-TLS).
ccsfzos15
After CCS Apache Tomcat is deployed and security is configured, the Systems Administrator can configure a Region to host the web application for your product. Optionally, the Security Administrator can set the Region to non-secure to allow Application Transparent Transport Layer Security (AT-TLS) to handle security instead of the Region. Then, the Systems Administrator can start the CCS Apache Tomcat Region.
2
Configure the CCS Apache Tomcat Region
This procedure lists the variables that are required to run the TOMALLOC job. Several of the variables might be prepopulated with the values that you specified when completing the steps in Deploy CCS Apache Tomcat to the CCS Apache Tomcat Deployment zFS.
Follow these steps:
  1. Copy the members named TOMALLOC, TOMCR8IN, and (optional) TOMWAR from the CAW0JCL SMP/E target library to a library where you can customize them for your installation.
  2. Copy the TOMSEDIT member that you edited in Deploy CCS Apache Tomcat to the CCS Apache Tomcat Deployment zFS to the library where you copied the TOMALLOC and TOMCR8IN members.
  3. Edit the variables that are contained in the TOMSEDIT member. The member lets you specify the variables that you use in the subsequent jobs.
    Edit the TOMSEDIT member for all the following required variables, starting at the section header named
    Configure a CCS Apache Tomcat Region
    .
    Several of the following variables might be prepopulated with the information that you specified when completing the steps in Deploy CCS Apache Tomcat to the CCS Apache Tomcat Deployment zFS.
    • DISKUNIT
      Specifies the name of the disk unit to be used create the
      CCS Apache Tomcat Region zFS
      data sets.
      Default:
      3390
    • VOLNAME
      Specifies the volume to be used when creating the
      CCS Apache Tomcat Region zFS
      data sets. Specify the parameter only when SMS (Storage Management Subsystem) is not active on the system. When you specify the keyword, the SMS allocation parameter that is named STORCLAS is not used.
      Default:
      Disabled (commented out)
    • STORCLAS
      Specifies the storage class to be used when creating the
      CCS Apache Tomcat Region zFS
      data sets. Do not use STORCLAS if you specify the VOLNAME parameter.
      Default:
      SC01
      When creating data sets, you can specify STORCLAS or VOLNAME. When you specify both parameters, the VOLNAME parameter is used and STORCLAS is ignored.
    • DPLOYHLQ
      Specifies the high-level qualifier for the
      CCS Apache Tomcat Deployment zFS
      data set that was created when you deployed CCS Apache Tomcat in
      Deploy CCS Apache Tomcat to the CCS Apache Tomcat Deployment zFS
      .
      Default:
      CAI
    • DPLOYDIR
      Specifies the mount point for the
      CCS Apache Tomcat Deployment zFS
      that was created when you deployed CCS Apache Tomcat in
      Deploy CCS Apache Tomcat to the CCS Apache Tomcat Deployment zFS
      .
      Default:
      /cai/CADeploy/CCS150/tpv
    • REGNHLQ
      Specifies the high-level qualifier to use to create the data sets that are unique to a specific
      CCS Apache Tomcat Region
      . Usually, each product that uses CCS Apache Tomcat has its own set of region data sets. For example, using the default value creates the following data sets:
      CAI.PRODUCT.TOMCAT.CAIZFS CAI.PRODUCT.TOMCAT.CAW0OPTV CAI.PRODUCT.TOMCAT.CAW0PROC
      Default:
      CAI.PRODUCT
    • REGNDIR
      Specifies the directory that is used as the mount point for the
      CCS Apache Tomcat Region zFS
      data set. TOMALLOC mounts the zFS and then copies CCS Apache Tomcat folders and files from the
      CCS Apache Tomcat Deployment zFS
      to the
      CCS Apache Tomcat Region zFS
      .
      The CATALINA_BASE variable that is used by Apache Tomcat and various products refers to the
      tomcat
      directory at this mount point.
      Default:
      /cai/CADeploy/productx
      Default CATALINA_BASE:
      /cai/CADeploy/productx/tomcat
    • JAVAHOME
      Specifies the USS path to where IBM Java was installed.
      Default:
      /sys/java64bt/v8r0m0/usr/lpp/java/J8.0_64
      Java 8.0 or later is required.
    • PROCNAME
      Specifies the new name for the PROC or procedure. Each
      CCS Apache Tomcat Region
      has its own procedure.
      Default:
      TOMCATPR
      After the TOMALLOC job completes (Step 4), it creates the following sample PROC:
      <REGNHLQ>.TOMCAT.CAW0PROC
      .
    • SSLPORT
      Specifies the port number on which the
      CCS Apache Tomcat Region
      waits for secure (https) incoming TCP connections.
      Default:
      8443
    • SHUTPORT
      Specifies the port number that is used to send shutdown commands to the
      CCS Apache Tomcat Region
      .
      Default:
      8005
    • WARFROM
      (Optional)
      Specifies the USS directory or MVS data set from where you want to copy the product WAR file.
      Default:
      /cai/CASoftware/product
    • WARFNAME
      (Optional)
      If the value of WARFROM is:
      • A
        USS directory
        , specify the name of the WAR file that you want to copy. You can use wildcards (*.war) to copy more than one WAR file.
      • An
        MVS data set
        , specify the name of the WAR file in the
        CCS Apache Tomcat Region
        . Do not use wildcards.
      Default:
      warfile1.war
    • WARMEMBR
      (Optional)
      Specifies the member name of the WAR file that you want to copy. The parameter is required only when the value of WARFROM is an MVS data set. The parameter is ignored when the value is that of a USS directory.
      Default:
      Disabled (commented out)
  4. Edit and follow the instructions in TOMALLOC to create a
    CCS Apache Tomcat Region zFS
    . This file system stores files that are unique to a single
    CCS Apache Tomcat Region
    , such as configuration files, product-specific files, and log files. Each separate
    CCS Apache Tomcat Region
    that you run requires its own
    CCS Apache Tomcat Region zFS
    .
    If the Region file system exists, back up any custom changes that you specified, and run TOMCR8IN instead of TOMALLOC.
    When you submit the TOMALLOC job, it performs the following actions:
    • TOMALLOC creates and names a data set that is composed of the variables that you defined in Step 3. For example,
      <REGNHLQ>.TOMCAT.CAW0PROC(<PROCNAME>)
      .
      Retain the name of this data set.
      You must specify the name of the data set in Step 6.
    • TOMALLOC creates two PDS libraries to hold the specific JCL procedure for starting the region and the specific environment file for the region. The names of the PDS libraries are
      <REGNHLQ>.TOMCAT.CAW0PROC
      and
      <REGNHLQ>.TOMCAT.CAW0OPTV
      .
    • After you complete Steps 1 through 4, and the TOMALLOC job completes, it returns one of the following results:
      • RC=0 when VOLNAME is not defined
      • RC=2 when VOLNAME is defined
      • If the return code equals 1 (RC=1) or if it is greater than 2 (RC>2), an error occurred. To correct the problem, analyze the output and correct any errors or warnings that display.
    If you created a default certificate previously for the
    CCS Apache Tomcat Deployment zFS
    , the newly created
    CCS Apache Tomcat Region
    is configured to use the certificate automatically after you run the job.
  5. (Optional) To deploy your product WAR file, edit TOMWAR and follow its instructions to copy the WAR files to the
    CCS Apache Tomcat Region zFS
    .
    Complete this step only when you are explicitly instructed to do so by your product documentation.
    If your product supplies WAR files and jobs to deploy them, follow the steps that are provided in your product-specific documentation.
    You can also use TOMWAR to deploy updated WAR files to your
    CCS Apache Tomcat Region
    .
You have configured the CCS Apache Tomcat Region to host the web application and started the region.
(Optional) Change the CCS Apache Tomcat Region to Non-Secure for AT-TLS
To allow AT-TLS to handle the security of your CCS Apache Tomcat Region, you must change the Region itself to non-secure. Having AT-TLS and CCS Apache Tomcat handle security simultaneously results in connection failures.
If your site does not require AT-TLS, skip this procedure to leave Region security enabled.
Follow these steps:
  1. Back up your
    TOMSVXML
    member in &REGNHLQ..TOMCAT.CAW0OPTV.
  2. Convert
    &REGNDIR/tomcat/conf/server.xml.unsecure.portoverride
    from ASCII to EBCDIC. Then, replace the
    TOMSVXML
    member with the converted file.
  3. In your
    TOMENVPR
    member in &REGNHLQ..TOMCAT.CAW0OPTV, uncomment the following line and specify a value for the port:
    -Dconnector.port=
    port
You have changed the CCS Apache Tomcat Region to non-secure to allow AT-TLS to handle security.
Start the CCS Apache Tomcat Region
Add the CCS Apache Tomcat Region to your SYSPROC concatenation and start the Region.
  1. The startup JCL for the
    CCS Apache Tomcat Region
    (the PROCNAME that is specified in TOMSEDIT) resides in the <REGNHLQ>.TOMCAT.CAW0PROC data set that you created Step 4. Place the procedure in your SYSPROC concatenation.
  2. Start the
    CCS Apache Tomcat Region
    using the following command:
    S <PROCNAME>
    The default value of the CCS Apache Tomcat PROC is TOMCATPR. If you specified a different value for the PROCNAME variable in the TOMSEDIT member, use that value to execute Start and Stop commands.
    When you issue the Start command, the following message displays:
    CATC0001I CA-CCS Tomcat is starting
    After CCS Apache Tomcat starts, the following message displays:
    CATC0002I CA-CCS Tomcat started in xxxx ms (Apache Tomcat/<apache-tomcat-release>)
    If an unsupported version of Java is running in your
    CCS Apache Tomcat Region
    , one or both of the following messages might display when you issue the start command:
    JVMJZBL2008E Could not find or load class: org.apache.catalina.startup.Bootstrap JVMJZBL2007E Stack trace follows: java.lang.UnsupportedClassVersionError: JVMCFRE003 bad major version
    To correct the problem, install Java 8 or later on the
    CCS Apache Tomcat Region
    and re-issue the start command.
If you must stop the
CCS Apache Tomcat Region
, issue the
P <PROCNAME>
command.
After CCS Apache Tomcat stops, the following message displays:
CATC0003I CA-CCS Tomcat stopping
You have started the CCS Apache Tomcat Region.