Build and Deploy Docker* Images for MPS and RPS Locally

The Open AMT Cloud Toolkit's Management Presence Server (MPS) and Remote Provisioning Server (RPS) provide support for deploying the microservices as Docker* images, standardized packages containing an application's source code, libraries, environment, and dependencies.

Why Docker*?

A Docker container is the instantiation of a Docker image as a virtualized unit that separates the application from the environment. Docker containers start and run reliably, securely, and portably inside different environments, eliminating some of the usual problems that occur with software deployment on varying platforms.

Get more information about Docker images and containers at Docker resources.

Clone the MPS and RPS Repositories

To clone the repositories:

1. Open a Command Prompt or Terminal and navigate to a directory of your choice for development.

git clone https://github.com/open-amt-cloud-toolkit/mps.git

2. Repeat to clone the RPS repository to the same parent directory as MPS.

git clone https://github.com/open-amt-cloud-toolkit/rps.git

Warning

Do not nest a microservice directory inside another microservice directory. The source code contains relative paths. The correct directory structure appears below, where parent is your installation directory.

📦parent
 ┣ 📂mps
 ┗ 📂rps

Build the Docker Images

Build the MPS and RPS Docker images from their respective directories with the build -t command, giving the image a name and tag:

docker build . -t [name:tag]

Create name and tags that:

• Contain lowercase letters, digits, and separators (i.e., underscores, periods, and dashes).
• Do not end with a separator.
• Contain up to 128 characters.

Note

Building a fresh Docker image may take several minutes.

To build MPS:

1. Navigate to MPS folder and build the Docker image.

cd ../mps
docker build . -t mps:v1

Note

On completion, a security warning is normal during local setup with the default values for developer testing environments.

To build RPS:

2. Navigate to the RPS folder and build the Docker image.

cd ..
cd rps
docker build . -t rps:v1

Set the Environment Variables

To set the environment variables:

1. After building the new MPS and RPS images, navigate to the mps\scripts\docker-compose folder and copy the .env.template file to .env.

cd ..
cd mps/scripts/docker-compose

Windows

copy .env.template .env

Linux

cp .env.template .env

Note

Preserve the .env.template file.

This file is very important to maintain. Always copy to a new file.

2. Open the .env file in a text editor. Set the image-related environment variables within the .env file.

Change the following fields:

Field	Change to
RPS_IMAGE	rps:v1
MPS_IMAGE	mps:v1
MPS_COMMON_NAME	Your development system's IP address

Forgot the name and tag from the build?

The docker images command lists repository names, tags, image IDs, and sizes.

docker images

Run docker-compose

The environment file .env now contains the MPS and RPS environment variables to pass to the Docker engine.

1. Navigate to the the mps/scripts/docker-compose directory.

2. Run the docker-compose up command, which starts the containers. approximately 2-3 minutes to start the containers.

   docker-compose up
   

3. Important: While the docker-compose up command is running, you may see a pop-up ask for permission for Docker Desktop Filesharing. You must select Share It for the docker-compose up command to execute successfully. If the pop-up expires,docker-compose up will fail. You must run docker-compose down -v and then rerun docker-compose up to successfully start the containers.

Success

Important

Since the vault is running in a dev mode, you will not be able to restart the vault and maintain the secrets stored since they are not persisted. You will need to recreate profiles and configs again. Be sure and run docker-compose down -v when bringing down the stack so as to remove the volumes and start fresh upon docker-compose up. You may follow the guide here to run vault in production mode.

Next up

Login to RPS