Index

Building FATE Images

This document provides guidance on how to build Docker images for FATE from source code.

If you are a user of FATE, you usually DO NOT need to build FATE from source code. Instead, you can use the pre-built docker images for each release of FATE. It saves time and greatly simplifies the deployment process of FATE. Refer to KubeFATE for more details.

Prerequisites

To build the Docker images of FATE components, the host must meet the following requirements:

1. A Linux host
2. Docker 18+
3. The host can access the Internet.

Building images of FATE

Configuration

To reduce the size of images, a few base images are created first. Other images are then built on top of the base images. They are described as follows: - base images: contain the minimum dependencies of components of FATE. - component images contain a specific component of FATE, it is built on the top of base image

Before building the image, you can configure the .env file and set it as your own image PREFIX and TAG.

When images are built, base images have the naming format as follows:

<PREFIX>/<image_name>:<BASE_TAG>

and component images have the below naming format:

<PREFIX>/<image_name>:<TAG>

PREFIX: the namespace on the registry's server, it will be used to compose the image name.
BASE_TAG: tag used for base images.
TAG: tag used for component images.

A sample of .env is as follows:

PREFIX=federatedai
BASE_TAG=${version}-release
TAG=${version}-release

NOTE: If the FATE images will be pushed to a registry server, the above configuration assumes the use of Docker Hub. If a local registry (e.g. Harbor) is used for storing images, change the PREFIX as follows:

PREFIX=<ip_address_of_registry>/federatedai

Running the build script

After configuring .env, use the following command to build all images:

$ bash build_cluster_docker.sh all

The command creates the base images and then the component images. After the command finishes, all images of FATE should be created. Use docker images to check the newly generated images:

REPOSITORY                            TAG  
federatedai/eggroll                   <TAG>
federatedai/fateboard                 <TAG>
federatedai/python                    <TAG>
federatedai/base-image                <TAG>

Pushing images to a registry (optional)

To share the docker images with multiple nodes, images can be pushed to a registry (such as Docker Hub or Harbor registry).

Log in to the registry first:

# for Docker Hub
$ docker login -u username 

or

# for Harbor or other local registry
$ docker login -u username <URL_of_Registry>

Next, push images to the registry. Make sure that the PREFIX setting in .env points to the correct registry service:

$ bash build_cluster_docker.sh push

Package the docker images for offline deployment (optional)

Some environemts may not have access to the Internet. In this case, FATE's docker images can be packaged and copied to these environments for offline deployment.

On the machine with all FATE docker images available, use the following commands to export and package images:

# Pull mysql first if you don't have those images in your machine.
$ docker pull mysql
$ docker save $(docker images | grep -E "mysql" | awk '{print $1":"$2}') -o third-party.images.tar.gz
$ docker save $(docker images | grep federatedai| grep -v -E "base|builder" | awk '{print $1":"$2}') -o fate.images.tar.gz

Two tar files should be generated fate.images.tar.gz and third-party.images.tar.gz . The formmer one contains all FATE images while the latter has the dependent third party images (mysql).

Copy the two tar files to the targeted deployment machine which is not connected to the Internet. Log in to the machine and use the following command to load the images:

$ docker load -i third-party.images.tar.gz
$ docker load -i fate.images.tar.gz

Now the machine has all FATE images and is ready for deployment.

Deployment

To use docker images to deploy FATE by Docker Compose or Kubernetes, please refer to KubeFATE for more details.

---

Last update: 2022-01-27