Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: fix docker doc command variable name #42

Merged
merged 1 commit into from
Oct 15, 2024
Merged

doc: fix docker doc command variable name #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions docs/DOCKER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ 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 --restart unless-stopped --network=host --name <user-defined-container-name> --detach ghcr.io/seagate/cfm -webui -verbosity 4
docker run --restart unless-stopped --network=host --name <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.
Expand All @@ -27,21 +27,21 @@ By default, the cfm-service will be hosted at port 8080 and the webui will be ho
The cfm-service runtime logs can be viewed using

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

## Stop and restart cfm-service

```bash
docker restart <user-defined-container-name>
docker restart <container-name>
```

## Excute CLI tool

The user can interact with the running cfm docker container (running cfm-service) to utilize the cli tool.

```bash
docker exec -it <user-defined-container-name> ./cfm-cli <args>
docker exec -it <container-name> ./cfm-cli <args>
```

NOTE: cfm-cli \<args\> usage examples:
Expand All @@ -53,8 +53,15 @@ docker exec -it cfm-container ./cfm-cli list appliances

## Customization

The developer could use the [DockerFile](../docker/Dockerfile) as a reference to build a new docker image with local changes
The developer could use the [DockerFile](../docker/Dockerfile) as a reference to build a new docker image using a local [cfm](https://github.com/Seagate/cfm) clone...

```bash
docker build --no-cache -t <user-defined-container-name> -f docker/Dockerfile .
cd /path/to/local/cfm
docker build --no-cache -t <new-image-name> -f docker/Dockerfile .
```

...and then run those changes

```bash
docker run --restart unless-stopped --network=host --name <new-container-name> --detach <new-image-name> -webui -verbosity 4
```
Loading