Bank of Z

Configuration Reference

Bank of Z uses the .setup/config/config.yaml file to define environment-specific settings used during setup, build, and deployment. The configuration file uses YAML format and supports variable expansion to simplify configuration management.

Configuration file overview

The configuration file supports:

  • Hierarchical configuration using YAML sections
  • Variable expansion using {{section.key}} syntax
  • Environment variable references using ${ENV_VAR} syntax
  • Comments using the # character

Required settings

The following settings are required for a successful setup.

Sandbox configuration

The sandbox section defines the root directory on z/OS UNIX System Services (USS) where Bank of Z components are installed.

sandbox:
  path: /usr/local/sandboxes/bank-of-z
Setting Description
path Absolute path to the Bank of Z workspace on USS. You need to have write access to this location.

Application configuration

The app section defines application naming conventions used for datasets, resources, and deployment artifacts.

app:
  base_name: BANKZ
  short_name: BOZ
  zos_version: V0R1M0
Setting Description
base_name Dataset high-level qualifier used for generated artifacts. Maximum 8 characters.
short_name Short application identifier used in resource names. Maximum 4 characters.
zos_version Version identifier used in dataset naming conventions.

DBB configuration

The dbb section identifies the IBM Dependency Based Build (DBB) installation and Java runtime.

dbb:
  dbb_home: /usr/lpp/IBM/dbb
  java_home: /usr/lpp/java/java21/current_64
Setting Description
dbb_home Location of the DBB installation on z/OS.
java_home Java runtime used by DBB.

Optional settings

Depending on your environment and tooling requirements, additional configuration sections can be defined.

Repository configuration

Defines repositories that are cloned during setup.

repositories:

name: dbb
    url: https://github.com/IBM/dbb.git
    target_dir: dbb

zBuilder configuration

Defines where zBuilder source and deployment artifacts are located.

zbuilder:
  source_dir: build
  target_dir: ${sandbox.path}/zBuilder
  java_home: /usr/lpp/java/java21/current_64

zconfig configuration

Defines settings for z/OS configuration tooling.

ZCodeScan configuration

Defines settings used for static code analysis.

Wazi Deploy configuration

Defines deployment automation settings used by Wazi Deploy.

TAZ configuration

Defines settings for automated unit testing and test execution.

CICS configuration

Defines CICS connection information required for automation and deployment tasks.

Variable expansion

Configuration values can reference other configuration entries.

Example:

sandbox:
  path: /usr/local/sandboxes/bank-of-z

dbb:
  dbb_build: ${sandbox.path}/Bank-of-Z/.setup/build

Variables are resolved during setup processing.

Environment variables can also be referenced:

cics:
  user: ${CICS_USER}
  password: ${CICS_PASSWORD}

Note: Using environment variables is recommended for sensitive information such as credentials.

Validation rules

The setup process validates configuration values before run.

Validation includes:

  • Required configuration settings are present
  • Referenced variables can be resolved
  • Paths use valid absolute path formats
  • Application naming limits are respected
  • Required tool locations are defined

Note: Correcting configuration issues before running setup helps prevent build and deployment failures.