From 0a59875e3871e09e1df358beff601d1d00d6f965 Mon Sep 17 00:00:00 2001 From: Scott Howe Date: Tue, 16 Jul 2024 10:37:21 -0600 Subject: [PATCH] docs: update docker cmds to match granite setup guide (#17) --- docs/DOCKER.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/DOCKER.md b/docs/DOCKER.md index 2fe919e..7daef1f 100644 --- a/docs/DOCKER.md +++ b/docs/DOCKER.md @@ -17,15 +17,23 @@ If desired, the user can add `:vX.X.X` to the end of the command to obtain an ol To enable the webui launching during cfm-service startup, the user must provide the `-webui` flag in the command below. ```bash -docker run --network=host --name --detach ghcr.io/seagate/cfm -webui -verbosity 4 +docker run --restart unless-stopped --network=host --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 + +```bash +docker logs --follow +``` + ## Stop and restart cfm-service ```bash -docker restart +docker restart ``` ## Excute CLI tool @@ -36,12 +44,12 @@ The user can start a cfm docker container to use the cli tool to interact with t docker run --network=host --entrypoint "/cfm/cfm-cli" cfm ``` +NOTE: Use \ = "-h" for help + ## Customization The developer could use the [DockerFile](../docker/Dockerfile) as a reference to build a new docker image with local changes ```bash -docker build --no-cache -t -f docker/Dockerfile . +docker build --no-cache -t -f docker/Dockerfile . ``` - -#TODO: cxl-host