README.md 3.25 KB
Newer Older
1
[![Coverage Status](https://coveralls.io/repos/github/ChessCorp/docker-ascii-map/badge.svg?branch=master)](https://coveralls.io/github/ChessCorp/docker-ascii-map?branch=master)
2
[![Build Status](https://travis-ci.org/ChessCorp/docker-ascii-map.svg?branch=master)](https://travis-ci.org/ChessCorp/docker-ascii-map)
3
[![PyPI version](https://badge.fury.io/py/docker-ascii-map.svg)](https://badge.fury.io/py/docker-ascii-map)
4

5
# docker-ascii-map
6 7 8 9
A set of python scripts displaying the local docker containers structure and status on an ascii map.

## Requirements

10
* python 3.5
11 12
* docker-py

13 14 15 16 17 18 19
## Install

You can install this tool from PyPI:

```
alcibiade@mobydick:~$ sudo pip3 install docker-ascii-map
Collecting docker-ascii-map
20
  Downloading docker-ascii-map-0.3.tar.gz
21 22
Installing collected packages: docker-ascii-map
  Running setup.py install for docker-ascii-map ... done
23
Successfully installed docker-ascii-map-0.3
24 25 26

```

27 28
## Usage

29 30 31
Below is a sample of a host running several applications on multiple networks. 
A container is routing traffic to these networks from the host.

32
```
33
alcibiade@mobydick:~/docker-ascii-map$ docker-ascii-map.py
34 35 36
 
                                                   +- chesscorp_default ----------------+
                                                   | [✓] chesscorp_web_1                |
37 38
80 ]------------  [✓] frontend_httpd_1 ------+-----|     chesscorp/chess-club           |
                      httpd:2.4              |     | [✓] chesscorp_database_1           |
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
                                             |     |     postgres:9.5                   |
                                             |     | [✓] chesscorp_mail_1               |
                                             |     |     namshi/smtp                    |
                                             |     +------------------------------------+
                                             |     +- wordpress_default ----------------+
                                             |     | [✓] wordpress_web_1                |
                                             |     |     wordpress_web                  |
                                             +-----| [✓] wordpress_db_1                 |
                                                   |     mysql:5.7                      |
                                                   | [✓] wordpress_mail_1               |
                                                   |     namshi/smtp                    |
                                                   +------------------------------------+
                                                   +- mail_default ---------------------+
25 ]-----------------------------------------------+ [✓] mail_mailserver_1              |
                                                   |     tvial/docker-mailserver:latest |
                                                   +------------------------------------+
                                                   +- proxy_default --------------------+
                                                   | [❌] proxy_squid_1                  |
                                                   |     sameersbn/squid                |
                                                   +------------------------------------+
59 60

```