Build FWD Using Docker¶

Build FWD Using Docker

Introduction¶

At this point, you have a working bash shell, Docker is installed and you have a working dbash.sh and fbash.sh helper scripts available.

The Docker development image launched with dbash.sh does not include a version of FWD inside it. The fbash.sh does. With either, you can download and build the FWD project locally (on your Docker host).

This section assumes that you want to checkout and build FWD from a repository. If you prefer a pre-built image, see Using a FWD Docker Image section, where a pre-built FWD image can be used. You can also build this FWD Docker image yourself locally (and optionally push to your own repository). See Build FWD Using Docker section for those details.

Within the Development Docker image there is a repository (/opt/repos) with projects stored so they can be retrieved locally. In a dbash.sh container, you can see the below directories:

/opt/repos/fwd/trunk
/opt/repos/hotel_chui
/opt/repos/hotel_gui
/opt/repos/skeleton
/opt/repos/possenet
/opt/repos/ade_tools_12_8_4

There are helpful tools to handle the bzr commands for source control:

fwd_checkout.sh - Checkout FWD branch and optionally build
fwd_build.sh - Perform a build of FWD
fwd_update.sh - Update FWD branch and optionally build
fwd_reset.sh - Revert a FWD branch and optionally build

Initial Branch Checkout¶

The revisions of the internal repository's projects will be current as of the time the latest Docker development image (basedev_ubuntu_24.04) was created. If you have a Golden Code xfer.goldencode.com ID, you can check out the most recent version from there using built-in tools. If you are internal to GCD, you can use the ~/secure mount to devsrv01.

Regardless, you should setup a project directory for the build:

mkdir -p ~/projects/fwd
cd ~/projects/fwd

The bzr commands can be issued directly from within dbash.sh Development image, or using the fwd_checkout.sh helper. Show usage Hide usage

Usage: /usr/local/bin/fwd_checkout.sh [-ds] [-b <branch>] [-u <user>] [--internal_repo] [-t <targetdir>] [--build]

Perform a new checkout of fwd

Where:
       -d = dryrun (just display commands)
       -b = specify a branch other than trunk.
       -u = Use this user, instead of rfb when checking code out.
       -s = Use ~/secure/code mount point for code location. Default is xfer.goldencode.com
       -t = Checkout location (def=trunk or branch name)
       --internal_repo = Use internal repo "/opt/repos/fwd/" for checkout
       --build = Perform a build after the checkout

 -? or -h or --help = show usage.

Repository Checkout¶

Issue these commands by either passing them to dbash.sh in the -c "<cmdline>" option, or simply enter the container with dbash.sh and run them. These examples assume the latter.

Check out the trunk Bazaar repository in the base image with:

bzr co /opt/repos/fwd/trunk

If you want to specify a location to checkout to, pass it to bzr:

bzr co /opt/repos/fwd/trunk mytrunk

or use the helper:

fwd_checkout.sh --internal_repo -t mytrunk

If you have a Golden Code provided xfer account (for example, "ges"), you can retrieve the latest revision of trunk with:

fwd_checkout.sh -u ges

Those users who are internal to Golden Code can include the -s option, and the ~/secure mount point will be used:

fwd_checkout.sh -s

For any of the commands above, a different branch other than trunk can be specified with the -b <branch> option. The internal repository only contains trunk, so this option is only valid when using an xfer or internal repository.

fwd_checkout.sh -u ges -b 9866c

NOTE: To use a special branch it will have to have been setup by Golden Code on the xfer.goldencode.com server in the /opt/fwd/<branch> directory.

SSH Error¶

If you are encountering an SSH error that looks like this while checking out the branch:

ssh: Could not resolve hostname xfer.goldencode.com: Temporary failure in name resolution
ConnectionReset reading response for b'BzrDir.open_2.1', retrying
ssh: Could not resolve hostname xfer.goldencode.com: Temporary failure in name resolution
brz: ERROR: Connection closed: Unexpected end of message. Please check connectivity and permissions, and report a bug if problems persist. 
ERROR: Failed to checkout trunk. Check that it is present at bzr+ssh://<user>@xfer.goldencode.com/opt/fwd/trunk.

A possible fix for that is to exit the Docker container and restart the Docker service:

exit
sudo systemctl restart docker

Build FWD¶

Given the above checkout retrieving the requested branch to your ./projects/fwd directory, you can perform a build with the dbash.sh Development container using fwd_build.sh helper. Show usage Hide usage

Usage: /usr/local/bin/fwd_build.sh [-d]

Perform a build of FWD

Where:
       -d = dryrun (just display commands)

 -? or -h or --help = show usage.

cd trunk
fwd_build.sh

This will start the build of the current branch in the trunk directory. Note: There is a --build option to fwd_checkout.sh that will proceed with the build after the checkout is performed. Show gradle command Hide gradle command

./gradlew all sheet:war archive

This will leave ~/projects/fwd/trunk with a usable FWD version for development in your environment.

Existing Branch Update¶

If you already have the branch in place, you can update that branch to a later revision using fwd_update.sh helper. Show usage Hide usage

Usage: /usr/local/bin/fwd_update.sh [-d] [--build]

Perform an update of a fwd checkout

Where:
       -d = dryrun (just display commands)
       --build = Perform a build after the update

 -? or -h or --help = show usage.

From bash:

cd fwd/trunk
dbash.sh -c "fwd_update.sh --build"

This will update the branch and start the build.

Reset a Branch¶

If you have been making modifications to FWD, and want to restore the branch, you can use the fwd_reset.sh helper. Show usage Hide usage

/usr/local/bin/fwd_reset.sh [-d] [--build]

Perform a reset (revert and clean-tree) of a fwd checkout

Where:
       -d = dryrun (just display commands)
       --build = Perform a build after the reset

 -? or -h or --help = show usage.

From bash:

cd fwd/trunk
dbash.sh -c "fwd_reset.sh --build"

This will revert and clean-tree of the branch and start the build.

Create a FWD Docker Image¶

It can be useful to create your own FWD Docker Images for runtime use. The tools required are part of the FWD project in the ./tools/docker directory. There is a Dockerfile and a bash script to help use the Dockerfile to build the image. The helper tools mentioned in Build FWD Using Docker will create the distribution images necessary to build FWD Docker images. These are created by the "archive" target to gradlew. The tools cannot be run from within a Docker container.

Creating the Image¶

The ./docker/docker_build.sh in the tools directory will create up to 4 sets of images using the distribution archives:

The main runtime image, which can be used for either client or, server without a database. It may or may not include PostGreSQL client (based on PostGreSQL being requested).
The server runtime image, which is used for a server that supports a database. This is only created if PostgreSQL is requested.
Development versions of the above which can be used for application conversion (if the --build-dev option is included).

The PostGreSQL versions that are supported are 14, 15, 16, and 17. The default is 17.

The images will consists of:

Based off base_ubuntu_24.04 image (and basedev_ubuntu_24.04 if --build-dev is included), which is created from the container project. See Building and Using Docker Images for details (TODO: needs updates).
Optional PostGreSQL client
FWD convert distribution ZIP file contents placed in the /opt/fwd-convert directory in the image. A /opt/fwd symlink is created to this location, and the FWD_LIB environment variable is defined for scripts to easily locate the FWD libraries.
FWD spawner files placed in the /opt/spawner directory from the spawner distribution ZIP. The postbuild.sh is allowed to run as sudo without prompting via the postbuild_admin file added to the /etc/sudoers.d/ directory.
- spawn
- postbuild.sh
- aspectjrt-1.9.23.jar
- p2j.jar

Show usage Hide usage

Usage: docker_build.sh [-d <dist>] [-pt] [--latest] [--build-dev] [--target_repo=<target_repo>] [--from_repo=<from_repo>] [--from_tag=<from_tag>] [--pg=<14|15|16|17|all|comma-list>] [--progress_plain] [--no_cache]

Build the FWD Docker runtime images from the dist images. Tag appropriately, and optionally push.

Where:
   -d <dist> = location of distribution images (default=/home/rfb/projects/fwd/9709e/dist)
   -p push image to repository
   -t just display commands (test)
   --latest tag as 'latest' as well
   --build-dev Include development image builds
   --pg=<versions> Include PostgreSQL client in image(s) and build PostgreSQL server image(s). Examples: 17, 14,15,16,17, or all (all=14-17)
   --target_repo=<target_repo> if pushing, push built images to specified repository (default=goldencode)
   --from_repo=<from_repo> specify a repo to pull base images from (including build) ('.' indicates local) (default=.)
   --from_tag=<from_tag> specify a tagged base images to use (default=latest)
   --progress_plain Don't use buildkit so docker build has more details.
   --no_cache Don't use any cached layers.

   -? or -h or --help = show usage.

1. Run commands from the tools directory of your branch. Branch 9709e used as an example.

cd ~/projects/fwd/9709e/tools

2. Create 2 images and tag them "latest", include PostGreSQL 14

./docker/docker_build.sh --pg=14 --latest --from_repo=goldencode --build-dev

This will result in the below images being created (4 pairs of images, 2 tags per image):

REPOSITORY                                      TAG                                          IMAGE ID       CREATED         SIZE
fwddev_4.0_ubuntu_24.04_pg14_jdk17              9709e_16611                                  25e2d50e1d2a   3 minutes ago   7.7GB
fwddev_4.0_ubuntu_24.04_pg14_jdk17              9709e_latest                                 25e2d50e1d2a   3 minutes ago   7.7GB
fwddev_4.0_ubuntu_24.04_jdk17                   9709e_16611                                  093cc5fe7162   5 minutes ago   7.49GB
fwddev_4.0_ubuntu_24.04_jdk17                   9709e_latest                                 093cc5fe7162   5 minutes ago   7.49GB
fwd_4.0_ubuntu_24.04_pg14_jdk17                 9709e_16611                                  f0d00f0c5923   4 minutes ago   6.19GB
fwd_4.0_ubuntu_24.04_pg14_jdk17                 9709e_latest                                 f0d00f0c5923   4 minutes ago   6.19GB
fwd_4.0_ubuntu_24.04_jdk17                      9709e_16611                                  0c93d67188cf   6 minutes ago   5.98GB
fwd_4.0_ubuntu_24.04_jdk17                      9709e_latest                                 0c93d67188cf   6 minutes ago   5.98GB

The "jdk17" was found to have been the JDK used to build the distribution images, so the jdk17 images are created. This is done automatically by interrogating the p2j.jar file within the distribution ZIP file. Also, since --pg=14 was specified, the images with _pg14 in the name contain PG14 server, and the ones without have the PG14 client.

These images are now stored locally, and can be used with fbash.sh as mentioned in Using a FWD Docker Image. Include the -l option so the local image is used: fbash.sh -l --tag 9709e_latest

For reference, Show Dockerfile Hide Dockerfile

#
# Module   : fwd_4.0_ubuntu_Dockerfile
# Abstract : Dockerfile build script for the FWD container
#
# Copyright (c) 2022-2026, Golden Code Development Corporation.
#
# -#- -I- --Date-- ------------------------------Description----------------------------------
# 001 RFB 20250828 Initial version.
#     RFB 20250828 Put step back in for brain-dead scripts that look for import.sh in /opt/fwd.
#                  Renumbered steps, and updated header.
#     RFB 20250909 Add support for passing which parts of FWD to include in the image.
# 002 RFB 20260120 Optionally include PG client when part of build args.
#     RFB 20260127 Need to include the custom locale creations when requested.
#     RFB 20260128 Custom locales are part of the base images, and not needed here.
# 003 RFB 20260212 Renamed this file to not have an Ubuntu version in it. Also, use
#                  base_ubuntu_24.04 as the default image.

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You may find a copy of the GNU Affero GPL version 3 at the following
# location: https://www.gnu.org/licenses/agpl-3.0.en.html
#
# Additional terms under GNU Affero GPL version 3 section 7:
#
#   Under Section 7 of the GNU Affero GPL version 3, the following additional
#   terms apply to the works covered under the License.  These additional terms
#   are non-permissive additional terms allowed under Section 7 of the GNU
#   Affero GPL version 3 and may not be removed by you.
#
#   0. Attribution Requirement.
#
#     You must preserve all legal notices or author attributions in the covered
#     work or Appropriate Legal Notices displayed by works containing the covered
#     work.  You may not remove from the covered work any author or developer
#     credit already included within the covered work.
#
#   1. No License To Use Trademarks.
#
#     This license does not grant any license or rights to use the trademarks
#     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
#     of Golden Code Development Corporation. You are not authorized to use the
#     name Golden Code, FWD, or the names of any author or contributor, for
#     publicity purposes without written authorization.
#
#   2. No Misrepresentation of Affiliation.
#
#     You may not represent yourself as Golden Code Development Corporation or FWD.
#
#     You may not represent yourself for publicity purposes as associated with
#     Golden Code Development Corporation, FWD, or any author or contributor to
#     the covered work, without written authorization.
#
#   3. No Misrepresentation of Source or Origin.
#
#     You may not represent the covered work as solely your work.  All modified
#     versions of the covered work must be marked in a reasonable way to make it
#     clear that the modified work is not originating from Golden Code Development
#     Corporation or FWD.  All modified versions must contain the notices of
#     attribution required in this license.

# This builds a fwd 4.0 images based upon our customized ubuntu 22.04 image which contains all the artifacts required to perform conversions.
# It is utilized from the build_fwd.sh script, which will perform the build of FWD 4.0 and create the artifacts necessary for this image.

# Step 1/11
ARG BASE_UBUNTU=base_ubuntu_24.04
FROM ${BASE_UBUNTU}

ARG FWD_DIR
ARG DEPLOY_LIST=all

SHELL ["/bin/bash", "-c"]

ARG INSTALL_PG_CLIENT=false
ARG PG_VERSION=17

# Step 2/11
RUN set -eux; \
    if [ "$INSTALL_PG_CLIENT" = "true" ]; then \
       echo "INFO: Installing PostgreSQL client ${PG_VERSION}"; \
       if [ -n "${PG_VERSION:-}" ]; then \
          echo "INFO: Installing PostgreSQL client ${PG_VERSION}"; \
          wget -qO- https://www.postgresql.org/media/keys/ACCC4CF8.asc \
             | gpg --dearmor > /usr/share/keyrings/postgresql.gpg; \
          echo "deb [signed-by=/usr/share/keyrings/postgresql.gpg] \
             http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" \
             > /etc/apt/sources.list.d/pgdg.list; \
          apt-get update -qq; \
             DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
             postgresql-client-${PG_VERSION}; \
          rm -rf /var/lib/apt/lists/*; \
       else \
           echo "ERROR: PG_VERSION not set — skipping PostgreSQL client installation"; \
       fi \
    else \
        echo "INFO: PostgreSQL client disabled"; \
    fi

# prepare directory for fwd service account
ENV HOME=/home/fwd
# Step 3/11
WORKDIR ${HOME}

# Copy from the well-known place to a repo in the home directory
# Step 4/11
RUN mkdir /tmp/repo
# Step 5/11
COPY --chown=fwd:fwd ${FWD_DIR}/ /tmp/repo/

# Step 6/11
RUN (pushd /tmp/repo; ./deploy_fwd.sh /opt/fwd-deploy "$DEPLOY_LIST" -f; popd)

# Copy import tool so it shows up in /opt/fwd/import.sh
# Step 7/11
RUN if [[ ! -f "/opt/fwd-deploy/convert/import.sh" ]]; then \
      echo "Need to copy import.sh"; \
      pushd /tmp/repo; cp ./import.sh /opt/fwd-deploy/convert; popd \
      chown fwd:fwd /opt/fwd-deploy/convert/import.sh; \
      chmod 755 /opt/fwd-deploy/convert/import.sh; \
    else \
      echo "import.sh already in place"; \
    fi

# Step 8/11
RUN chown -R fwd:fwd /opt/fwd-deploy && \
    mkdir -p /opt/spawner && \
    chmod -R gou+rx /opt/spawner/ && \
    rm -fr /tmp/repo

ENV FWD_LIB=/opt/fwd
# Step 9/11
RUN ln -s /opt/fwd-deploy/convert ${FWD_LIB} && \
    echo "export FWD_LIB=${FWD_LIB}" > /etc/profile.d/11-fwd_lib.sh && \
    chmod 644 /etc/profile.d/11-fwd_lib.sh && \
    . /etc/profile.d/11-fwd_lib.sh

# Step 10/11
ADD repo/postbuild_admin /etc/sudoers.d/

USER fwd
# Step 11/11
WORKDIR /home/fwd

# End of this Dockerfile

Project

General

Profile

FWD

Wiki