Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 1.67 KB

DOCKER.md

File metadata and controls

55 lines (34 loc) · 1.67 KB

Use CFM software in Docker

Notes regarding the use of Docker for the Composer & Fabric Manager (CFM) Software Suite.

Obtain released docker image

A ready to use docker image for the cfm-service, the cli tool and the webui is released with the github package feature. One can pull the image from the command line:

docker pull ghcr.io/seagate/cfm

If desired, the user can add :vX.X.X to the end of the command to obtain an older CFM release version.

Start the CFM service and its webUI

To enable the webui launching during cfm-service startup, the user must provide the -webui flag in the command below.

docker run --restart unless-stopped --network=host --name <user-defined-container-name> --detach ghcr.io/seagate/cfm -webui -verbosity 4

By default, the cfm-service will be hosted at port 8080 and the webui will be hosted at port 3000. The user could change the port by input argument -Port and/or -webuiPort. The webui only works with --network=host mode.

View cfm-service logs

The cfm-service runtime logs can be viewed using

docker logs --follow <user-defined-container-name>

Stop and restart cfm-service

docker restart <user-defined-container-name>

Excute CLI tool

The user can start a cfm docker container to use the cli tool to interact with the running cfm-service.

docker run --network=host --entrypoint "/cfm/cfm-cli"  cfm <args>

NOTE: Use <args> = "-h" for help

Customization

The developer could use the DockerFile as a reference to build a new docker image with local changes

docker build --no-cache -t <user-defined-container-name> -f docker/Dockerfile .