Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Transfer CFT Docker

Transfer CFT 3.10 Docker image

Before you begin

This document assumes a basic understanding of core Docker concepts such as containers, container images, and basic Docker commands. If needed, see Get started with Docker for a primer on container basics.

Prerequisites

  • Docker version 17.11 or higher

How to use the Transfer CFT Dockerfile

The Dockerfile contains all commands required to assemble a Transfer CFT image.

Dockerfile parameters

The following parameters can be set in the Dockerfile. Use these parameters to customize the Transfer CFT image and service. All values are transmitted to Transfer CFT using environment variables.

Parameter Values Description
CFT_FQDN <string> Host address of the local server.
CFT_INSTANCE_ID <string> Name of the Transfer CFT instance.
CFT_INSTANCE_GROUP <string> The Transfer CFT instance's group.
CFT_ENVIRONMENT <string> An environment name to identify the environment in which this Transfer CFT instance is deployed (e.g., Production, Pre-Production, Staging, UAT, QA, Test, Dev, Playground, etc.).
CFT_CATALOG_SIZE <number> Catalog size.
CFT_COM_SIZE <number> Communication file size.
CFT_PESIT_PORT <number> Port number of the PeSIT protocol called PESITANY.
CFT_PESITSSL_PORT <number> Port number of the PeSIT protocol called PESITSSL.
CFT_SFTP_PORT <number> Port number of the SFTP protocol.
CFT_COMS_PORT <number> Port number of the synchronous communication media called COMS.
CFT_COPILOT_PORT <number> The Transfer CFT UI server port that listens for incoming SOAP web-service connections.
CFT_COPILOT_CG_PORT <number> The Transfer CFT UI server port that listens for incoming Central Governance connections.
CFT_COPILOT_CG_PORT_EXPOSED <number> The Transfer CFT UI server port that listens for incoming Central Governance connections from outside the container. Set this parameter if the exposed port differs from CFT_COPILOT_CG_PORT.
CFT_RESTAPI_PORT <number> The Transfer CFT UI REST API server port.
CFT_CG_ENABLE "YES"/"NO" Connectivity with Central Governance.
CFT_CG_HOST <string> Host address of the Central Governance server.
CFT_CG_PORT <number> Listening port of the Central Governance server.
CFT_CG_SHARED_SECRET <string> Shared secret needed to register with the Central Governance server.
CFT_CG_POLICY <string> Central Governance configuration policy to apply at Transfer CFT registration.
CFT_CG_PERIODICITY <number> Central Governance interval between notifications.
CFT_CG_AGENT_NAME <string> Central Governance agent name.
CFT_JVM <number> Amount of memory that the Secure Relay JVM can use.
CFT_KEY <string> A command that returns the Transfer CFT license key.
CFT_CFTDIRRUNTIME <string> Location of the Transfer CFT runtime.
CFT_CLOUD_BACKUP_ENABLE "YES"/"NO" Enable/disable CFT cloud backup.
CFT_CLOUD_BACKUP_FILE <string> The cloud path to the backup file. Use one of the following formats, starting with s3:// followed by the items in the order listed:
s3://bucket.region/pathname
    ◦ The bucket name
    ◦ A period (.)
    ◦ The region
    ◦ The pathname
s3://http[s]://endpoint[:port]/bucket/pathname
    ◦ http:// or https:// for secure communication
    ◦ The endpoint, which can be an IP address or the server's hostname
    ◦ A colon (:) and port number, if not using the default (80 for HTTP, 443 for HTTPS)
    ◦ A slash (/)
    ◦ The bucket name
    ◦ The pathname

The pathname can reference either a standalone filename or a full directory path, for example: folder1/folder2/backup_cft01.

You can embed environment variables in the pathname using the %env:XYZ% syntax, for example: %env:CFT_INSTANCE_GROUP%/%env:CFT_INSTANCE_ID%.
CFT_CLOUD_BACKUP_S3_ACCESS_KEY_ID <string> A command that returns the S3 Access key ID, a 20‑character alphanumeric identifier used to authenticate requests to S3. This parameter is optional when running the container on AWS with an instance profile that grants read/write permissions to the target S3 bucket.
CFT_CLOUD_BACKUP_S3_SECRET_ACCESS_KEY <string> A command that returns the S3 Secret access key, a 40-character sequence. This parameter is optional when running the container on AWS with an instance profile that grants read/write permissions to the target S3 bucket.
CFT_CLOUD_BACKUP_TMPDIR <string> The temporary directory used for Transfer CFT cloud backup.
CFT_CLOUD_BACKUP_DELAY <number> Delay in seconds between synchronizations. The default value is "5".
CFT_CLOUD_BACKUP_WITH_CATALOG "YES"/"NO" Includes the Transfer CFT catalog in the backup. The default value is "NO".
CFT_CLOUD_BACKUP_ARCHIVE_PASSWORD <string> Archive encryption password.

How to build the Docker image

1. Build the Docker image from your Dockerfile

1.1. Build using a local Transfer CFT package

  1. Download the Transfer CFT product package from Axway Support.

The Dockerfile is compatible with Transfer CFT 3.6 SP1 version and higher.

From the Axway Support, download the latest package for linux-x86-64.

  1. Build the Docker image from your Dockerfile.

From the folder where the Dockerfile is located, using the downloaded package as INSTALL_KIT build argument, run the command:

docker build --build-arg INSTALL_KIT=Transfer_CFT_3.10.2206_Update_d2269df442_linux-x86-64.zip -t axway/cft:3.10.2206 .

1.2. Build using a Transfer CFT package stored on your own HTTP server

  1. Download the Transfer CFT product package from Axway Support.

The Dockerfile is compatible with Transfer CFT 3.6 SP1 version and higher.

From the Axway Support, download the latest package for linux-x86-64 and make it available in your network.

  1. Build the Docker image from your Dockerfile.

From the folder where the Dockerfile is located, run the command:

docker build --build-arg URL_BASE=https://network.package.location/ -t axway/cft:3.10.2206 .

2. Check that the Docker image is successfully created

Run the command:

docker images --filter reference=axway/cft

You should get an output like:

REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
axway/cft             3.10.2206           26fe6e1aa1fb        4 days ago          381MB

Copyright

Copyright (c) 2022 Axway Software SA and its affiliates.

License

All files in this repository are licensed by Axway Software SA and its affiliates under the Apache License, Version 2.0, available at http://www.apache.org/licenses/.