Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrismaille/cabrita
TUI dashboard for easy visualization of docker services
https://github.com/chrismaille/cabrita
dashboard docker docker-compose terminal tui
Last synced: about 1 month ago
JSON representation
TUI dashboard for easy visualization of docker services
- Host: GitHub
- URL: https://github.com/chrismaille/cabrita
- Owner: chrismaille
- Created: 2017-12-01T23:41:22.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2021-05-10T19:03:19.000Z (over 3 years ago)
- Last Synced: 2024-07-05T15:06:16.977Z (2 months ago)
- Topics: dashboard, docker, docker-compose, terminal, tui
- Language: Python
- Homepage: http://cabrita.readthedocs.io/
- Size: 379 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## Welcome to Cabrita's documentation!
[](https://cabrita.readthedocs.io/en/latest/?badge=latest)
[](https://www.codacy.com/app/chrismaille/cabrita?utm_source=github.com&utm_medium=referral&utm_content=chrismaille/cabrita&utm_campaign=Badge_Grade)
[](https://codeclimate.com/github/chrismaille/cabrita/maintainability)
[](https://github.com/psf/black)
[](https://github.com/pre-commit/pre-commit)
Cabrita is a Terminal Dashboard for docker services. You can easily
follow the status for your docker containers:
* Which services are running
* The ports used by each one
* The number of instances
* The git status for the source code inside them
* The container healthcheck status, if available
### Install
```shell
$ pip install cabrita
```
### Usage
Usage is very simple: just change directory where's your
`docker-compose.yml` is located and run:
```bash
$ cd /path/to/your/docker_compose
$ cab # or cabrita
```
[](https://asciinema.org/a/Z31bttxgBe4JhuyBPvLYomoqc)
You can also pass the full path for the `docker-compose.yml` files on
command line:
```bash
$ cab /path/to/docker-compose-file /path/to/docker-compose-override
```
### Customize Dashboard
To customize cabrita you can create a yaml file, to create and configure
_boxes_. You can select which docker containers will show in each box
and what info these boxes will show for each service inside them.
For example, copy and paste this yaml and save the `cabrita.yml` in the
same directory where your `docker-compose.yml` is located:
```yaml
version: 2
title: My Docker Project
background_color: grey # options: black, blue, cyan, grey, yellow, white
compose_files:
- ./docker-compose.yml
boxes:
main_box:
main: true
name: My Services
port_view: status # options: column, name, status
port_detail: internal # options: internal, external or both
show_revision: true # will show commit hash and git tag if available
watch_branch: origin/staging # check how ahead or behind you are regard this branch
django:
name: Django Apps
show_git: false
includes: # this box will show only services named in includes and categories options
- django
categories: # for each included service, add column for each category below
- worker
- redis
watchers:
ping: # ping watchers are using to ping informed address each n seconds.
google:
name: Check internet connectivity
address: https://www.google.com
message_on_success: UP
message_on_error: DOWN
```
Let's use our docker project located in `/sheep` folder. To start
cabrita with the new setup you can type:
```bash
# Start docker project services first
$ cd path/to/sheep
$ TEST_PROJECT_PATH=$(pwd) docker-compose up -d
# Then, you can call directy the app passing the yaml path:
$ cab --path cabrita.yml
# Or you can use the CABRITA_PATH environment variable:
$ export CABRITA_PATH=/path/to/cabrita.yml
$ cab
```
Your Dashboard will show like this:
### More Info
- For more advanced customization, please check the *tutorial*
- For the complete list of cabrita options, please check the *Cabrita
File Reference*