add status indicator doc

This commit is contained in:
Bradley Cicenas 2019-01-24 12:50:59 +00:00
parent 70bd2ae3a3
commit 7b4d4db049
3 changed files with 19 additions and 1 deletions

View File

@ -1,4 +1,4 @@
# connectors
# Connectors
`ctop` comes with the below native connectors, enabled via the `--connector` option.

BIN
_docs/img/status.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.4 KiB

18
_docs/status.md Normal file
View File

@ -0,0 +1,18 @@
# Status Indicator
The `ctop` grid view provides a compact status indicator to convey container state
<p align="center"><img width="200px" src="img/status.png" alt="ctop"/></p>
Appearance | Description
--- | ---
red | container is stopped
green | container is running
two vertical bars (▮▮) | container is paused
If the container is configured with a health check, a `+` will appear next to the indicator
Appearance | Description
--- | ---
red | health check in failed state
yellow | health check in starting state
green | health check in OK state