Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel5
minLevel3

You must have Docker Engine installed as per https://docs.docker.com/install for this installation option.

FlexDeploy Docker Images

There are various images available for FlexDeploy. Choose option based on your specific need. Documentation is available on Docker Hub for each image, and this document will explain it at high level.

...

(tick) - production ready

fd_tcat_53

Start command session to Docker host and make sure you can run docker commands. If necessary sudo to root or other user.

Image Removed

Here are main steps for this type of docker image. If you are trying to upgrade FlexDeploy for Docker, please following FlexDeploy Upgrade - Docker.

  1. Setup docker volume folder and copy plugins in it from download zip.
  2. Setup FlexDeploy Database
  3. Pull docker image
  4. Start container using specific image.

Step 1 - Setup Docker Volume Folder on Docker Host

This particular image only contains FlexDeploy with Tomcat, i.e. data and artifact repository is not part of the container. Hence we need to setup Database and various Folders first. You will also need to download FlexDeploy Tomcat distribution for database scripts and plugins.

In this step, we will setup application and repository folder, then copy plugins from download zip in to necessary folder.

Code Block
# adjust folder location as necessary for your Docker Host
mkdir -p /scratch/DockerVolume/flexdeploy
chmod -R 777 /scratch/DockerVolume
cd /scratch/DockerVolume
mkdir application
mkdir repository
cd application
mkdir plugins
cp ~/Tomcat_Complete-5.3.0.0/application/plugins/*.jar .
# ready with docker volume now

Image Removed

Step 2 - Setup FlexDeploy Database

Setup database as described in Installation Instructions - Database Tier.

Step 3 - Pull Docker Image

First let's pull docker image flexdeploy/fd_tcat_53. Adjust image version as necessary.

Code Block
docker pull flexdeploy/fd_tcat_53:5.3.0.0

Step 4 - Run Docker Container

Now let's run FlexDeploy docker image. Adjust image version as necessary.

This particular image contains only FlexDeploy with Tomcat, i.e. data and artifact repository is not part of the container. So we need to pass various details to docker run command.

Run command example below uses port number 8004 for access to FlexDeploy application, which maps to 8080 port inside docker container. The database is referenced using dbtype (mysql, oracle, or postgres), FLEX_DB_URL environment variable and FD_ADMIN_PWD is password for fd_admin user on your database (setup done in Step 2). Adjust Port Numbers, URL, Password, Docker Volume Folder, Timezone as appropriate for your docker host.

Code Block
docker run --name flexdeploy53 -p 8004:8080 -e FLEX_DB_URL="jdbc:oracle:thin:@129.213.91.244:1521:xe" -e FD_ADMIN_PWD="welcome1" -e TZ=America/Chicago -e dbtype=oracle|postgres|mysql -v /scratch/DockerVolume/flexdeploy:/home/oracle flexdeploy/fd_tcat_53:5.3.0.0
Tip
titleExample JDBC URL (FLEX_DB_URL)

Now you can look at logs and other details in docker volume folder. For example,

Image Removed

Tip

If necessary, make sure to open port 8004 for access from outside docker host.

Now you can launch FlexDeploy using http://<docker host>:8004/flexdeploy.

As always when you first launch FlexDeploy, you will need to complete Registration process.

Image Removed

Once you complete registration, you are ready to use FlexDeploy.

fd_tcat_postgres_53 / tutorials

...

Tip

This documentation is for FlexDeploy 6.0.0.x. If you are using different version, please go to home page and select appropriate FlexDeploy version documentation.

You must have Docker Engine installed. See https://docs.docker.com/get-docker/ for information on how to do that.

If running Docker Desktop, please adjust your memory configuration so that 4 gb will be available to the container running the fd_tcat_postgres  image.

Start command session to the Docker host and make sure you can run docker commands. If necessary, sudo to root or other user.Image Removed

...

Here are main steps for this type of docker image.

  1. Pull docker image

  2. Start container using specific image.

Step 1 - Pull Docker Image

First let's pull docker image flexdeploy/fd_tcat_xe_52. Adjust image name (if you are using Postgres or a tutorial image) and version as necessary.postgres.

Code Block
docker pull flexdeploy/fd_tcat_xe_52:5.3.0.0
or
docker pull flexdeploy/fd_tcat_postgres_52:5.3.0.0
or
docker pull <tutorial image>

...

Step 2 - Run Docker Container

Now let's run the FlexDeploy docker image. Adjust image name (if you are using tutorial image) and version as necessary.

...

.

...

This particular image contains Oracle XE PostgreSQL DB and FlexDeploy with Tomcat, i.e. data and artifact repository is all part of the container. Data is persistent in the container.

Run command example below uses port number 8000 for access to FlexDeploy application, which maps to 8080 port inside docker container. Oracle XE is PostgreSQL is included as part of this image and it's port 1521 5432 is also accessible on docker host. Adjust port numbers, Timezone as appropriate for your docker host.

Code Block
docker run --name flexdeploy53_xe -p 1521:1521 -p 8000:8080 --shm-size=2gb -e TZ=$(date +%Z) flexdeploy/ebs-tutorial:5.3.0.0
or
docker run --name flexdeploy53_xe -p 1521:1521 -p 8000:8080 --shm-size=2gb -e TZ=America/Chicago flexdeploy/ebs-tutorial:5.3.0.0
2.2 fd_tcat_postgres_53

This particular image contains PostgreSQL DB and FlexDeploy with Tomcat, i.e. data and artifact repository is all part of the container. Data is persistent in the container.

Run command example below uses port number 8000 for access to FlexDeploy application, which maps to 8080 port inside docker container. PostgreSQL is included as part of this image and it's port 5432 is also accessible on docker host. Adjust port numbers, Timezone as appropriate for your docker host.

Since this is just for a demo or POC we are going to just use the latest version. If you’d like you can specify with something like this for the image name: flexdeploy/fd_tcat_postgres:6.0.0.0

Code Block
docker run --name flexdeploy53flexdeploy56_postgres -p 5432:5432 -p 8000:8080 -e TZ=$(date +%Z) flexdeploy/fd_tcat_postgres_53:5.3.0.0
or
docker run --name flexdeploy53flexdeploy56_postgres -p 5432:5432 -p 8000:8080 -e TZ=America/Chicago flexdeploy/fd_tcat_postgres_53:5.3.0.0

...

After some time, you can close command session that started FlexDeploy docker container. If you use Ctrl + C, then container will exit, just close session window.

...

Tip

If necessary, make sure to open port 8000 for access from outside docker host.

As always when you first launch FlexDeploy, you will need to complete Registration process.

...

Once you complete registration, you are ready to use FlexDeploy.

Now that you have installed FlexDeploy, let's get start with configuration. You can do this in matter of minutes by using the Blueprints concept, which is very simple configuration wizard for most common usecasesuse cases.