Generating a Configuration Variables Template

Microservices Runtime provides a utility to generate a configuration variables template based on the configuration of a running Microservices Runtime. This configuration variables template reflects the current configuration of the Microservices Runtime.

After the Microservices Runtime is configured, you can use the utility to generate the template. The resulting template serves as the starting point for creating a customized configuration variables template.

Before you generate the configuration variables template from a Microservices Runtime, you might want to:

Make sure to favorite (star) all of the server configuration parameters that you want to set with the template on the Settings > Extended page.

Ensure that the keystores and truststores are loaded. When a keystore or truststore is loaded it indicates that the keystore or truststore configuration is valid and that the Microservices Runtime initialized the keystore or truststore alias successfully. To see if a keystore or truststore is loaded, navigate to the Security > Keystore page and ensure that the Loaded column displays Yes.

Note:
You can create a configuration variables template manually. You do not need to generate a template from an existing configured Microservices Runtime. However, generating the template from a Microservices Runtime is a time-saving option that provides a starting point. A generated template may also be less prone to errors with key names in the template than a template created manually.

1. Open the Microservices Runtime Administrator for the Microservices Runtime from which you want to generate the variables

Microservices Runtime generates an application.properties file. The application.propeties file includes the text #Sample Generated Template followed by the date and time of the generation.

4. Download the application.properties file and save it to your preferred location for editing.

The date and time that Microservices Runtime generated the template.

Key-value pairs for asset properties for which a value is specified on the Microservices Runtime. The template does not include variables for assets that do not exist or for asset properties that are not specified.

For a list of assets and properties for which Microservices Runtime generates configuration variables see Configuration Variables Template Assets.

Note:
In the template, any key that contain a period (.) as part of its name is escaped using another period. For example, for a JMS connection alias named my.JMS.alias, the template property corresponding to the Client ID in the alias the name: jms.my..JMS..alias.clientID=value

Key-value pairs for the server configuration parameters that were starred on the Extended Settings page only.

Keystore and truststore alias properties for keystores and truststores that were loaded at the time of template generation only.

The text ****** for any passwords that appear as property values in the template.

The environment variable name in the format $env[environmentVariableName] for any key for which an environment variable was used as the value.

The Kubernetes variable itself in the format $secret[secretName] for any key for which a Kubernetes Secret was used as the value.

For a configured asset, the configuration variables template lists properties only for which a value is specified. For example, if you specify a client ID for a JMS connection alias, but do not specify a user name or password for use with the JMS connection alias, the configuration variables template contains jms.aliasName.clientID=value but not jms.aliasName.password or jms.aliasName.user.