Discovery Service configuration parameters
Discovery Service configuration parameters
Zowe runtime configuration parameters
As an application developer who wants to run Zowe, set the following parameters during the Zowe runtime configuration by modifying the <Zowe install directory>/components/discovery/bin/start.sh
file:
API ML configuration
Follow these steps:
- Open the file
zowe.yaml
. - Configure the following properties:
-
apiml.service.hostname
This property is used to set the Discovery Service hostname. The value can be set by defining the
ZWE_haInstance_hostname
property in thezowe.yaml
file. -
apiml.service.port
This property is used to set the Discovery Service port. The value can be set by defining the
ZWE_configs_port
property in thezowe.yaml
file. -
apiml.discovery.staticApiDefinitionsDirectories
The value of
apiml.discovery.staticApiDefinitionsDirectories
can be set by defining theZWE_STATIC_DEFINITIONS_DIR
property inzowe.yaml
. The static definition directories can be specified as a parameter at startup and will be scanned by the Discovery Service. These directories contain the definitions of static services. Example:ZWE_STATIC_DEFINITIONS_DIR: config/local/api-defs;config/local2/api-defs
-
apiml.discovery.allPeersUrls
The value of
apiml.discovery.allPeersUrls
can be set by defining theZWE_DISCOVERY_SERVICES_LIST
property inzowe.yaml
. This parameter contains the list of URLs of the Discovery Service in case of multiple instances of the service on different host. Example:ZWE_DISCOVERY_SERVICES_LIST: https://localhost2:10021/eureka/,https://localhost3:10031/eureka/
Note: Each URL within the list must be separated by a comma.The directories can be specified as a parameter at startup and will be scanned by the Discovery Service. These directories contain the definitions of static services.
-
components.discovery.apiml.security.ssl.verifySslCertificatesOfServices
This parameter makes it possible to prevent server certificate validation.
Important! Ensure that this parameter is set to
true
in production environments. Setting this parameter tofalse
in production environments significantly degrades the overall security of the system. -
components.discovery.apiml.discovery.serviceIdPrefixReplacer
This parameter is used to modify the service ID of a service instance, before it registers to API ML. Using this parameter ensures compatibility of services that use a non-conformant organization prefix with v2, based on Zowe v2 conformance. The value of the
*apiml.discovery.serviceIdPrefixReplacer
parameter is represented as a tuple that contains two strings, separated by a comma. The format of this parameter contains the following two elements:- First, the prefix that you want to replace in the service ID
- Second, the new prefix that will be replaced
Example: The value of the parameter has the following format:
oldServiceIdPrefix,newServiceIdPrefix
Set this parameter in your Zowe YAML configuration (typically
zowe.yaml
) by definingconfigs.apiml.discovery.serviceIdPrefixReplacer
. For example, defining it globally:configs:
apiml:
discovery:
serviceIdPrefixReplacer: ca*,bcmOr defining it only for lpar1 high availability instance:
haInstances:
lpar1:
configs:
apiml:
discovery:
serviceIdPrefixReplacer: ca*,bcm
- Restart Zowe&trade.