Test Zowe in Sysplex

This documentation is manual test plan for deploying Zowe in Sysplex High Availability mode. To deploy Zowe in Sysplex, check documentation here.

Test Configuration

Test Case - zowe.yaml creation

Steps

• After normal installation, run command <instance-dir>/bin/utils/convert-to-zowe-yaml.sh <instance-dir>/zowe.yaml.

Exist Criteria

• <instance-dir>/zowe.yaml should be untagged and should be able to read from vi or cat utilities.
• <instance-dir>/zowe.yaml should contains all customized values defined in original instance.env

Test Case - zowe.yaml adoption

Steps

• Generate <instance-dir>/zowe.yaml,
• Delete or rename <instance-dir>/instance.env,
• Start Zowe with ZWESVSTC on tivlp13 by running <instance-dir>/bin/zowe-start.sh.

Exist Criteria

• Zowe should be started normally,
• All values defined in <instance-dir>/zowe.yaml should be converted back to <instance-dir>/.env/.instance-<hostname>.env, where <hostname> should be the system name where you start Zowe.
• Zowe job log should show correct instance environment variables.

Test Case - customize zowe.yaml adoption with ZWESVSTC

Steps

• Delete or rename <instance-dir>/instance.env,
• Put attachment zowe.yaml version 1 as <instance-dir>/zowe.yaml,
• Start Zowe with ZWESVSTC on tivlp13 by running <instance-dir>/bin/zowe-start.sh.

Exist Criteria

• Zowe should be started normally with job name ZWE1SV,
• All customized values defined in <instance-dir>/zowe.yaml should be converted back to <instance-dir>/.env/.instance-<hostname>.env, where <hostname> should be the system name where you start Zowe.
  • all Zowe services should be started normally on default ports.
• Zowe job log should show correct instance environment variables.

Test Case - customize zowe.yaml adoption with ZWESLSTC

Steps

• Delete or rename <instance-dir>/instance.env,
• Put attachment zowe.yaml version 1 as <instance-dir>/zowe.yaml,
• Start Zowe on tivlp13 with S ZWESLSTC,HAINST=TIVLP13.

Exist Criteria

• Zowe should be started normally with job name ZWESLSTC,
• All customized values defined in <instance-dir>/zowe.yaml should be converted back to <instance-dir>/.env/.instance-<hostname>.env, where <hostname> should be the system name where you start Zowe.
  • all Zowe services should be started normally on default ports.
• Zowe job log should show correct instance environment variables.

Test Case - zowe.yaml allows customization per instance

Steps

• Delete or rename <instance-dir>/instance.env,
• Put attachment zowe.yaml version 1 as <instance-dir>/zowe.yaml,
• Start Zowe on tivlp14 with S ZWESLSTC,HAINST=TIVLP14A.

Exist Criteria

• Zowe should be started normally with job name ZWESLSTC on tivlp14,
• All customized values defined in <instance-dir>/zowe.yaml should be converted back to <instance-dir>/.env/.instance-tivlp14.env.
  • CATALOG_PORT should have value of 17552.
  • ZWE_LAUNCH_COMPONENTS shouldn't have app-server and zss in it.
• Zowe job log should show information of starting app-server and zss.

Test Case - zowe.yaml allows deeper granular level of configuration

Steps

• Delete or rename <instance-dir>/instance.env,
• Put attachment zowe.yaml version 1 as <instance-dir>/zowe.yaml,
• Modify <instance-dir>/zowe.yaml and add haInstances.tivlp13.components.gateway.debug entry with value true,
• Start Zowe on tivlp13 with S ZWESLSTC,HAINST=TIVLP13.

Exist Criteria

• zowe.yaml should look like:

  haInstances:
    # HA instance ID
    tivlp13:
      # hostname where this instance will be started
      hostname: tivlp13.svl.ibm.com
      ip: 9.30.238.14
      # for this HA instance, we didn't customize "components", so it will use default value.
      components:
        gateway:
          debug: true
  

• Zowe should be started normally with job name ZWESLSTC,
• All customized values defined in <instance-dir>/zowe.yaml should be converted back to <instance-dir>/.env/.instance-<hostname>.env, where <hostname> should be the system name where you start Zowe.
  • all Zowe services should be started normally on default ports.
• Only <instance-dir>/.env/gateway/.instance-tivlp13.env should have entry APIML_DEBUG_MODE_ENABLED="true", but all other services should have APIML_DEBUG_MODE_ENABLED="false".
• Zowe job log should show correct instance environment variables. Only gateway service shows debug level logging.

Test Component Availability

Test Case -

Attachments

zowe.yaml version 1

zowe:
  runtimeDirectory: /global/zowe/runtime122
  jobPrefix: ZWE
  identifier: "1"
  externalDomains:
    - zhaplex.svl.ibm.com
    # - 9.30.238.45
  environments:
    ZOWE_IP_ADDRESS: 9.30.238.45
    KEYSTORE_DIRECTORY: /global/zowe/keystore122
    ZOWE_ZLUX_SSH_PORT: "22"
    ZOWE_ZLUX_TELNET_PORT: "992"
    ZOWE_ZLUX_SECURITY_TYPE: "tls"
    EXTERNAL_ROOT_CA: ""
    SSO_FALLBACK_TO_NATIVE_AUTH: "true"
    RESOLVER_CONFIG: "//'USER.PARMLIB(TCPDATA)'"
  externalPort: "7554"
  launchScript:
    logLevel: ""
  externalCertificate:
    keystore:
      alias: localhost
      password: password
      file: /global/zowe/keystore122/localhost/localhost.keystore.p12
      type: PKCS12
    trustStore:
      file: /global/zowe/keystore122/localhost/localhost.truststore.p12
      certificateAuthorities: ""
    pem:
      key: /global/zowe/keystore122/localhost/localhost.keystore.key
      certificate: /global/zowe/keystore122/localhost/localhost.keystore.cer-ebcdic
      certificateAuthority: /global/zowe/keystore122/local_ca/localca.cer-ebcdic
  internalCertificate:
    keystore:
      alias: localhost
      password: password
      file: /global/zowe/keystore122/localhost/localhost.keystore.p12
      type: PKCS12
    trustStore:
      file: /global/zowe/keystore122/localhost/localhost.truststore.p12
      certificateAuthorities: ""
    pem:
      key: /global/zowe/keystore122/localhost/localhost.keystore.key
      certificate: /global/zowe/keystore122/localhost/localhost.keystore.cer-ebcdic
      certificateAuthority: /global/zowe/keystore122/local_ca/localca.cer-ebcdic
  sso:
    token:
      name: ""
      label: ""
components:
  gateway:
    enabled: true
    port: "7554"
    apiml:
      service:
        allowEncodedSlashes: true
        corsEnabled: false
        preferIpAddress: false
      gateway:
        timeoutMillis: "600000"
      security:
        x509:
          enabled: false
          externalMapperUrl: https://zhaplex.svl.ibm.com:7554/zss/api/v1/certificate/x509/map
        zosmf:
          applid: IZUDFLT
        auth:
          provider: zosmf
        authorization:
          endpoint:
            url: https://zhaplex.svl.ibm.com:7554/zss/api/v1/saf-auth
        ssl:
          verifySslCertificatesOfServices: false
          nonStrictVerifySslCertificatesOfServices: true
    debug: false
    server:
      maxConnectionsPerRoute: "100"
      maxTotalConnections: "1000"
  discovery:
    enabled: true
    port: "7553"
    apiml:
      service:
        preferIpAddress: false
      security:
        ssl:
          verifySslCertificatesOfServices: false
          nonStrictVerifySslCertificatesOfServices: true
    debug: false
    alternativeStaticApiDefinitionsDirectories: ""
  api-catalog:
    enabled: true
    port: "7552"
    environment:
      preferIpAddress: false
    debug: false
  caching-service:
    enabled: true
    environment:
      preferIpAddress: false
    debug: false
    port: "7555"
    storage:
      size: "10000"
      evictionStrategy: reject
      mode: VSAM
      vsam:
        name: "IBMUSER.ZWE122.CACHE1"
    apiml:
      security:
        ssl:
          verifySslCertificatesOfServices: false
          nonStrictVerifySslCertificatesOfServices: true
  app-server:
    enabled: true
    port: "8544"
  zss:
    enabled: true
    port: "8542"
    crossMemoryServerName: ZWESIS_STD
    tls: true
  jobs-api:
    enabled: true
    port: "8545"
  files-api:
    enabled: true
    port: "8547"
  explorer-jes:
    enabled: true
    port: "8546"
    frameAncestors: zhaplex.svl.ibm.com:*,9.30.238.45:*
  explorer-mvs:
    enabled: true
    port: "8548"
    frameAncestors: zhaplex.svl.ibm.com:*,9.30.238.45:*
  explorer-uss:
    enabled: true
    port: "8550"
    frameAncestors: zhaplex.svl.ibm.com:*,9.30.238.45:*
java:
  home: /usr/lpp/java/J8.0_64
node:
  home: /global/nodejs/v12/node-v12.18.0-os390-s390x
zOSMF:
  port: "443"
  host: zhaplex.svl.ibm.com
  applId: IZUDFLT

# we can customize configurations for each HA instance
haInstances:
  # HA instance ID
  tivlp13:
    # hostname where this instance will be started
    hostname: tivlp13.svl.ibm.com
    ip: 9.30.238.14
    # for this HA instance, we didn't customize "components", so it will use default value.
  
  # HA instance ID, we will start 2 instances on tivlp14
  # Please note, we can only start one gateway in same LPAR
  tivlp14a:
    # hostname where this instance will be started
    hostname: tivlp14.svl.ibm.com
    ip: 9.30.238.15

    # these configurations will overwrite highest level "components" definitions
    components:
      discovery:
        # use customized port on this instance
        port: "17553"
      api-catalog:
        port: "17552"
      app-server:
        # no app-server in this instance
        enabled: false
      zss:
        # no app-server in this instance
        enabled: false
      jobs-api:
        port: "18545"
      files-api:
        port: "18547"
      explorer-jes:
        port: "18546"
      explorer-mvs:
        port: "18548"
      explorer-uss:
        port: "18550"
      caching-service:
        port: "17555"
  tivlp14b:
    hostname: tivlp14.svl.ibm.com
    ip: 9.30.238.15

    # these configurations will overwrite highest level "components" definitions
    components:
      gateway:
        enabled: false
      discovery:
        enabled: false
      api-catalog:
        enabled: false
      app-server:
        enabled: false
        port: "28544"
      zss:
        enabled: false
        port: "28542"
      jobs-api:
        enabled: true
      files-api:
        enabled: false
      explorer-jes:
        enabled: false
      explorer-mvs:
        enabled: false
      explorer-uss:
        enabled: false
      caching-service:
        enabled: false