Building Application Configurator Docker Image

The Application Configurator is a web application, which you can use to configure the TIBCO ActiveMatrix application and generate a YAML configuration file for the application. The YAML file is required for creating the Docker image of the application.

Before You Begin

See Preparing for Containerization.
(Optional) To update default JVM arguments and Log4j configuration for the Application Configurator, see Updating Default JVM Arguments and Logging Configuration for Application Configurator.
You can run the Application Configurator with SSL enabled. For more information, see Running Application Configurator with SSL Enabled.

Procedure

Navigate to amsgce-runtime-<version>/applicationConfigurator/build.

Build the Docker image of Application Configurator by using the following executable file:

For Linux Platform:

./build_amxce

For Windows Platform:

build_amxce.exe

Note: The Application Configurator uses the following default nomenclature. You can override these values when running the command.

- Node name: ACNode

- Environment name: ACEnvironment

- Image name: amxce_ac:1.0.1

The default port exposed by the Application Configurator container is 8087. You can change the port exposed by the Application Configurator container by updating the port value in the com.tibco.amxce.appconfig.config.yaml file. This YAML file is provided at amsgce-runtime-<version>/applicationConfigurator/application.

The following table lists the optional arguments that you can pass when building an Application Configurator Docker image. You can specify the arguments to be passed in the amsgce-runtime-<version>/applicationConfigurator/build/build_amxce.yaml file or you can specify the arguments when running the command. Configuration defined in the build_amxce.yaml file takes precedence over com.tibco.amxce.appconfig.config.yaml file. Arguments specified when running the command have precedence over the arguments specified in the build_amxce.yaml file.

Note: Do not delete or rename the amsgce-runtime-<version>/applicationConfigurator/build/build_amxce.yaml file. The build_amxce executable uses default arguments specified in this file.

Argument	Optional / Required	Description
-b / --base_dir <Base directory path>	Optional	The base directory in which the build files are located. If not specified, the current directory is considered as base location directory. Default: `amsgce-runtime-<version>/applicationConfigurator/build`
`-i / --image_tag <Image name>`	Optional	Image tag for the Docker image. <Image name> must be in the form of "Image name (Repository):tag or version" such as amxce_ac:1.0.1. Image name must not contain space.
`-n / --amxce_node <Nodename>`	Optional	ActiveMatrix Service Grid - Container Edition node name in the container. Default: ACNode Node name must start with an alphabet character. It can have only alphanumeric, underscore (_), and hyphen (-) characters. If the node name is specified when running the command, it overrides the node name specified in the YAML file. If the node name is not specified as a command argument, node name specified in the YAML file is used. If node name is not specified as a command argument or in YAML file, default node name is used.
`-e / --amxce_env <Environment name>`	Optional	ActiveMatrix Service Grid - Container Edition Environment name in a container. Default: ACEnvironment If the environment name is specified when running the command, it overrides the environment name specified in the YAML file. If the environment name is not specified as a command argument, environment name specified in the YAML file is used. If environment name is not specified as a command argument or in YAML file, default environment name is used.
`-l / --log_level <Image Build Log level>`	Optional	Set `log_level` to 1 for detailed output. Helpful in debugging build failures. Default: 0
`--java <Java package file location>`	Optional	Specify the location of the Java Package to be used to create the image. This option can be used to provide pre-downloaded JDK or JRE to be used while creating the image. Image creation script skips downloading Java from a remote site when this option is provided. Specified Java package is automatically copied to the `amsgce-runtime-<version>/runtime/java` folder. Previously specified Package is removed from `amsgce-runtime-<version>/runtime/java` before copying the new package. Note: Do not manually copy the package directly to `amsgce-runtime-<version>/runtime/java`. Note: Do not specify the folder location. This must be the compressed Java package file location. Example: `./build_amxce -i amxce_ac:1.0.1 --java /Users/Downloads/openjdk-11+28_linux-x64_bin.tar12.gz`
-a \| --app_location `<Application folder location>`	Optional	Location of the application folder or the `.zip` file that contains configuration YAML file, DAA, and optionally the Log4j and JVM configuration files. Default: `amsgce-runtime-<version>/applicationConfigurator/application` DAA and configuration YAML file required to create Application Configurator image are provided in `amsgce-runtime-<version>/applicationConfigurator/application.` If you want to use different location, you must copy files from this directory to new directory. Example: ./build_amxce -i amxce_ac:1.0.1 -a /Users/amxce/demo/configurator_app.zip ./build_amxce -i amxce_ac:1.0.1 -a /Users/amxce/demo/configurator_app
--dockerfile `<Dockerfile Name>`	Optional	Specify Dockerfile name to use a Dockerfile other than the default one. Default Dockerfile is `Dockerfile_alpine_java11`. Example: `./build_amxce --image_tag "amxce_ac:1.0.1" --dockerfile Dockerfile_ubi8_java11`
`-h / --help`	Optional	Displays help for the command.
--config <Configuration file>	Optional	Configuration YAML file in which you can specify arguments to be passed to the command. Default: `amsgce-runtime-<version>/applicationConfigurator/build/build_amxce.yaml`
-v / --version	Optional	Displays version of the `build_amxce` executable.