Cloud Software Group, Inc. EBX®
Documentation > Administration Guide > EBX® Container Edition
Navigation mode Documentation > Administration Guide > EBX® Container Edition

# Building the image

## Overview

TIBCO EBX® Container Edition image is Linux OS based for several architectures and includes the following:

- Application Server Apache Tomcat® 10.1

- Java JDK 21

## Requirement

The image can be built on a POSIX native system or using a compatible layer:

- Operating system : Linux, macOS, Windows (10 version 2004, Server 2022 or greater) using WSL2,

- Processor type : AMD64 (Intel 64 bits), ARM64,

- Docker Engine installed and running,

- Access to Internet .

## Building the image

### Download installers

To build an EBX® image, one needs to download file TIB_ebx_6.2.1_addon_6.2.X_container_edition.zip from TIBCO eDelivery.

### Running the interactive installer

To start installer on Linux or macOS :

- Unzip the TIB_ebx_6.2.1_addon_6.2.X_container_edition.zip ,

- Open a terminal in folder where file ebx-ce-installer.sh file is located,

- Execute command ./ebx-ce-installer.sh .

To start installer on Windows :

- Unzip the TIB_ebx_6.2.1_addon_6.2.X_container_edition.zip ,

- Open a Windows PowerShell in folder where file ebx-ce-installer.bat file is located,

- Execute command ebx-ce-installer.bat .

Follow the instructions and select the optional components to be added to the image. If Metadata is selected, the interactive installer automatically adds the following addons: DAMA, DINT, DMDV, DPRA and TESE.

The installer will then build the image and print a summary similar to:

    **********************************************************************************************
    The TIBCO EBX Container Edition image was successfully created with following names:
     ebx:latest
     ebx:6.2.1-metadata-dama-dint-dmdv-dpra-mame-tese-6.2.X
    This image includes the following optional component(s):
     Metadata
     Digital Asset Manager (DAMA)
     Data Exchange (New) (DINT)
     Data Model and Data Visualization (DMDV)
     Insight (New) (DPRA)
     Match and Merge (MAME)
     Information Search (TESE)
     Data Exchange (ADIX, legacy)
     Insight (DQID, legacy)
     EBX GO (MODA, legacy)
    To run this image with the default configuration and an embedded database, use command:
     docker run -p 8080:8080 -d ebx:latest
    You can test EBX by visiting http://localhost:8080 in a browser.
    To run this image with other configurations, for example with an external database, see
    documentation.
    **********************************************************************************************

If you select the Generate image only for Linux on current architecture? option, the install prompts for additional architectures that you want to build EBX® Container Edition for. In that case, Docker image tags will contain the architecture it was built for. For instance, ebx:6.2.1-metadata-dama-dint-dmdv-dpra-mame-tese-6.2.X-amd64 .

### Running the batch installer

To start batch installer on Linux or macOS :

- Unzip the TIB_ebx_6.2.1_addon_6.2.X_container_edition.zip .

- Open a terminal in the folder where the ebx-ce-installer-batch.sh file is located.

- Execute the following command: ./ebx-ce-installer-batch.sh [options] [metadata] [<addon(s)>]

    Batch script to build image with optionally Metadata and/or addons.

    Options:
      -a             add Metadata and all addons excluding legacy addons
      -al            add Metadata and all addons including legacy addons
      -p <arch,...>  architecture(s) to build on (i.e. \"amd64,arm64/v8,ppc64le\")
                     possible values: amd64, arm64/v8, ppc64le, s390x
                     using this parameter the default image tag is suffixed
      -t <tag_file>  create a file named tag_file including the image tag built
      --help         display this help and exit

      [metadata]     install Metadata
      [<addon(s)>]   install one or more addons (separated by a white space)
                     for example: mame tese

To start the batch installer on Windows :

- Unzip the TIB_ebx_6.2.1_addon_6.2.X_container_edition.zip .

- Open a Windows PowerShell in the folder where the ebx-ce-installer-batch.bat file is located.

- Execute the following command: ebx-ce-installer-batch.bat [options] [metadata] [<addon(s)>]

The batch installer will then build the image and print a summary identical to the interactive installer.

### Testing the image

The image can be run locally using command:

    docker run -p 8080:8080 -d ebx:latest

In production , it is recommended to not use the latest tag. The installer always generates another tag, depending on the selected optional components.

Using the previous example, the tag is 6.2.1-metadata-dama-dint-dmdv-dpra-mame-tese-6.2.X because optional components where selected:

- Metadata,

- Digital Asset Manager (DAMA),

- Data Exchange (New) (DINT),

- Data Model and Data Visualization (DMDV),

- Insight (New) (DPRA),

- Match and Merge (MAME),

- Information Search (TESE).

The image can then be run using the following command:

    docker run -p 8080:8080 -d ebx:6.2.1-metadata-dama-dint-dmdv-dpra-mame-tese-6.2.X

If no optional components are selected, the tag is 6.2.1 .

The image can be run using the following command:

    docker run -p 8080:8080 -d ebx:6.2.1

### Sharing the image

The steps to share an image depend on your company’s infrastructure.

In the following example, the image is pushed to a Docker private registry named myregistry :

    docker tag ebx:6.2.1 myregistry:5000/ebx:6.2.1
    docker push myregistry:5000/ebx:6.2.1

In the event that the image is built for several architectures, detailed instructions are provided in the README-MULTIARCH.md file located in the files/ subdirectory.

### Other architectures than AMD64

The installers are tested on AMD64 (Intel 64 bits). On these architectures the generated image’s architecture will be linux/amd64 .

The installers may succeed when running on a system using another architecture. In that case the generated image platform will be linux for that architecture type.

For example, if the installer runs on a macOS M1 workstation, the generated image’s platform will be linux/arm64 .

Attention

Generating an Linux image for AMD64 (Intel 64 bits) or ARM64 architecture is fully supported. The other platforms are experimental and are not supported in production .

Documentation > Administration Guide > EBX® Container Edition