diff --git a/_data/toc.yaml b/_data/toc.yaml index 267336e9e3..c0c9c85aba 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -859,6 +859,8 @@ toc: title: start - path: /compose/reference/stop/ title: stop + - path: /compose/reference/top + title: top - path: /compose/reference/unpause/ title: unpause - path: /compose/reference/up/ diff --git a/compose/reference/index.md b/compose/reference/index.md index d8812dc6fe..04b9f3b3f3 100644 --- a/compose/reference/index.md +++ b/compose/reference/index.md @@ -8,10 +8,12 @@ The following pages describe the usage information for the [docker-compose](over * [docker-compose](overview.md) * [build](build.md) +* [bundle](bundle.md) * [config](config.md) * [create](create.md) * [down](down.md) * [events](events.md) +* [exec](exec.md) * [help](help.md) * [kill](kill.md) * [logs](logs.md) @@ -19,12 +21,14 @@ The following pages describe the usage information for the [docker-compose](over * [port](port.md) * [ps](ps.md) * [pull](pull.md) +* [push](push.md) * [restart](restart.md) * [rm](rm.md) * [run](run.md) * [scale](scale.md) * [start](start.md) * [stop](stop.md) +* [top](top.md) * [unpause](unpause.md) * [up](up.md) diff --git a/compose/reference/overview.md b/compose/reference/overview.md index f155bb5e4f..ca57b16027 100644 --- a/compose/reference/overview.md +++ b/compose/reference/overview.md @@ -14,7 +14,7 @@ command line. Define and run multi-container applications with Docker. Usage: - docker-compose [-f=...] [options] [COMMAND] [ARGS...] + docker-compose [-f ...] [options] [COMMAND] [ARGS...] docker-compose -h|--help Options: @@ -35,23 +35,27 @@ Options: Commands: build Build or rebuild services + bundle Generate a Docker bundle from the Compose file config Validate and view the compose file create Create services down Stop and remove containers, networks, images, and volumes events Receive real time events from containers + exec Execute a command in a running container help Get help on a command kill Kill containers logs View output from containers pause Pause services port Print the public port for a port binding ps List containers - pull Pulls service images + pull Pull service images + push Push service images restart Restart services rm Remove stopped containers run Run a one-off command scale Set number of containers for a service start Start services stop Stop services + top Display the running processes unpause Unpause services up Create and start containers version Show the Docker-Compose version information diff --git a/compose/reference/top.md b/compose/reference/top.md new file mode 100644 index 0000000000..106347e341 --- /dev/null +++ b/compose/reference/top.md @@ -0,0 +1,25 @@ +--- +description: Displays the running processes. +keywords: fig, composition, compose, docker, orchestration, cli, top +title: docker-compose top +--- + +```none +Usage: top [SERVICE...] + +``` + +Displays the running processes. + +```bash +$ docker-compose top +compose_service_a_1 +PID USER TIME COMMAND +---------------------------- +4060 root 0:00 top + +compose_service_b_1 +PID USER TIME COMMAND +---------------------------- +4115 root 0:00 top +``` \ No newline at end of file