You need to configure the z/OS system before you can start Zowe. This work can be done in parallel to configuring the Zowe instance.
Create the run time configuration file
Copy the yaml file from product directory to the instance directory
for example
cd /u/tmp/zowep
cp example-zowe.yaml /u/tmp/zowec/zowe.yaml
cd /u/tmp/zowec
oedit zowe.yamlBasic editing of the zowe.yaml file
The example-zowe.yaml file composes of the definitions used above to set up the MVS definitions, and the configuration of the run time.
Once you have configured the started tasks, APF, security, and security, you do not need the definitions in the run time configuration.
Edit the zowe.yaml file, and delete from the start of the file down to just before
# >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
# **COMMONLY_CUSTOMIZED**
Insert
zowe:
starting in column 1 at the start of the file.
Run time parameters
The run time directory
This is the directory with the product code.
runtimeDirectory: /u/colin/zowep
Note. The runtime… is indented by two characters. You will have used this, either in your PATH statement, or in /u/colin/zowep/bin/zwe above.
Where to store runtime logs.
This is machine and instance dependant.
You need to decide which directory is used. Should it be available across all systems, or only available on one system, and if the LPAR and Zowe instance name is part of the directory structure. See High level directory structures.
The default value of logDirectory: is /global/zowe/logs.
Where to place the workspace directory.
This directory is used to store Zowe internal configuration information. See the discussion above in Where to store runtime logs.
The default value of workspaceDirectory: is /global/zowe/workspace
Where extensions are installed
See Where to store extensions, for a discussion about wanting to shared extension files between instances.
The default value of extensionDirectory: is
/global/zowe/extensions
What job names to use?
You can specify
job:
# Zowe JES job name
# name: ZWE1SV
# Prefix of component address space
prefix: ZWE1
When the Java instances are started, the BPXAS address spaces are given names like ZWE1GW. You can use this in the WLM definitions.
Set two variables to default values
Role Based Access Control(rbac) is an advanced topic.
cookieIdentifier is used when there are multiple Zowe instances. You can specify a value so each instance gets its own cookies.
rbacProfileIdentifier: "1"
cookieIdentifier: "1"
Initially set these values to “1” and review them when you have multiple Zowe instances.
Quit on error or give warning and continue
You can specify
configmgr:
# STRICT=quit on any error, including missing schema
# COMPONENT-COMPAT=if component missing schema, skip it with warning instead of quit
validation: "STRICT"
Specify the TCP/IP domain name
externalDomains:
# this should be the domain name to access Zowe APIML Gateway
- sample-domain.com
Specify the TCP/IP port needed for the gateway
externalPort: 7554
Configure the TLS definitions
network:
server:
tls:
attls: false
# TLS settings only apply when attls=false
# Else you must use AT-TLS configuration for TLS customization.
minTls: "TLSv1.2"
maxTls: "TLSv1.3"
client:
tls:
attls: false
Depending on whether you use TLS 1.2 and/or TLS 1.2, you might want to start with minTls: Tlsv1.2 and migrate to TLS 1.3 later.
Which messages go to syslog?
You can configure which messages are written to the syslog, in addition to the internal message logs. The supplied list is
sysMessages:
# # Zowe starting
- "ZWEL0021I"
# # Zowe started
- "ZWEL0018I"
- "ZWEL0006I"
# # Zowe ready to use
- "ZWES1601I"
# # Zowe stopping
- "ZWEL0008I"
# # Zowe stopped
- "ZWEL0022I"
# # Zowe components starting
- "ZWEL0001I"
# # Zowe components stopped
- "ZWEL0002I"
# # API ML components ready
- "ZWEAM000I"
# # App server ready
- "ZWED0031I"
# # ZSS ready
- "ZWES1013I"
You may want to configure your automation to respond to these messages, so your status displays can show the status of the Zowe instance.
Enable debug at startup
launchScript:
logLevel: "warn"
onComponentConfigureFail: "warn"
If you have problems starting Zowe, set this to debug.
Once Zowe has been configured and is working satisfactory, you can reset this to warn.
Specify the names of the certificate and keyrings
certificate:
keystore:
type: JCERACFKS
file: safkeyring:////IZUSVR/CCPKeyring.IZUDFLT
alias: CONN2.IZUDFLT
truststore:
type: JCERACFKS
file: safkeyring:////IZUSVR/CCPKeyring.IZUDFLT
verifyCertificates: STRICT
The directories for Java and NodeJS
java:
home: /usr/lpp/java/J17.0_64
node:
home: /usr/lpp/IBM/cnj/IBM/node-v20.11.0-os390-s390x-202402131732
Specify some z/OSMF value
You can use z/OSMF for authentication. You need to specify some values even though you are not initially using z/OSMF.
zOSMF:
host: 127.0.0.1
port: 10443
applId: IZUDFLT
Define the components
The gateway component
When setting up Zowe for the first time, define just one component, and get that working. Once it is working you can add more components
components:
gateway:
enabled: true
port: 7554
debug: true
apiml:
security:
auth:
provider: saf
# zosmf:
# jwtAutoconfiguration: jwt
# serviceId: ibmzosmf
authorization:
endpoint:
enabled: false
provider: "native"
x509:
enabled: false
Initially set these to enabled: false
zaas:
enabled: false # was true
port: 7558
debug: false
api-catalog:
enabled: false # was true
port: 7552
debug: true
discovery:
enabled: false # was true
port: 7553
debug: true
app-server:
enabled: false
port: 7556
debug: true
caching-service:
enabled: false
port: 7555
storage:
evictionStrategy: reject
mode: imMemory
size: 10000
For zss set enabled: true so it starts when Zowe starts.
zss:
enabled: true
port: 7557
crossMemoryServerName: ZWESIS_STD
agent:
jwt:
fallback: true
64bit: true
# https:
# trace: true
Now what?
The Zowe started task procedure needs to point to this configuration file.
ColinPaice 