JCLCheck REST API server in a Zowe API ML HA environment.
search cancel

JCLCheck REST API server in a Zowe API ML HA environment.

book

Article ID: 414699

calendar_today

Updated On:

Products

JCLCheck Workload Automation

Issue/Introduction

This Knowledge Base article provides instructions for running the JCLCheck REST API server in a Zowe API ML High Availability environment.

Resolution

1) Configure Zowe API ML for High Availability.  Instructions are found here

2) Each of your JCLCheck REST API servers need to point to the HA Discovery Service urls.

Here's a sample apiml profile in the jclcheck.yml file: 

apiml:                                                                                              
    enabled: true                                                                                    
    service:                                                                                        
        serviceId: cajclcheck                                                                        
        title: JCLCheck Workload Automation                                                          
      description: Validates job control language (JCL)                          
        scheme: https                                                                                
        hostname: <<REST API HostName>>                                                          
        serviceIpAddress: <<REST API IP_address>>                                                              
        port: <<REST API port>>                                                                                  
        baseUrl: ${apiml.service.scheme}://${apiml.service.hostname}:${apiml.service.port}          
        discoveryServiceUrls:                                                                        
          - https://<<APIML hostname1>>:<<APIML port1>>/eureka/ **
          - https://<<APIML hostname2>>:<<APIML port2>>/eureka/ **                                      
        routes:                                                                                      
            -   gatewayUrl: api/v1                                                                  
                serviceUrl: cajclcheck/api/v1      
        apiInfo:
          -   apiId: com.broadcom.jclcheck
                gatewayUrl: api/v1
                swaggerUrl: ${apiml.service.scheme}://${apiml.service.hostname}:${apiml.service.port}${apiml.service.contextPath}/v3/api-docs
        authentication:
            scheme: zoweJwt   

** Sample scenario:  The JCLCheck REST servers are active on sysa1.company.com and sysa2.company.com.  The APIML hostname may be coded as follows: https://sysax.company.com:nnnn/eureka

 

3) Set the port number of the API ML catalog in the zowe.config.json file:

        "jclcheck": {
            "type": "jclcheck",
            "properties": {
                "port": {apiml-catalog-port},
                "basePath": "cajclcheck/api/v1"
            },

 

Important notes

The JCLCheck REST server is not automatically started during a failover.  Therefore you can activate the JCLCheck REST server on all  the participating LPARs, or use automation to start the JCLCheck REST server in the event of a failover.