boonisz/cachet-url-monitor-dc

Docker-compose for cachet web service with cachet-url-monitor plugin

This docker-compose permits to run:

• a cachet instance to display component status and metrics
• the cachet plugin cachet-url-monitor to automatically check components and update status and metrics

Both dockers are launch in a private docker network (172.0.3.0/24 by default). This permits to isolate them. Cachet will be reachable on 172.0.3.2:8000.

Install

Requirements

• git
• docker
• docker-compose

First time

1. Update submodule for cachet and monitor

   git submodule init
   git submodule update
   

2. Build the docker-compose:

   docker-compose build
   

3. Launch cachet (this should not work):

   docker-compose up cachet
   

4. Get the APP_KEY and add it in .env file

5. Re-launch Cachet (in detached mode this time):

   docker-compose up -d cachet
   

6. Configuration via the web interface (172.0.3.2:8000). If you don't now for drivers, use APC(u) and Synchronous.

7. Connect to Cachet and create components and metrics used by the monitor

8. Get the token of the user (in 172.0.3.2:8000/dashboard/user)

9. Modify on the monitor configuration file monitor-config.yml:

   • the api_url
   • the token

10. Start the monitor:

    docker-compose up -d monitor
    

Notes

• The first launch is not easy. The Cachet server need an encryption key generated by the Cachet container. Also, the monitor need a token (to modify the status) that is generated once the Cachet server is launched. Once the APP_KEY and the token is filled, services can be manage normally with the docker-compose commands (up, down...)
• One can use, mtakaki docker containers. This repo build the monitor docker, this permits to use it other architecture (like ARM with a Raspberry Pi).
• Data is saved in data folder.

TODO

• Wait that Cachet API is ready before launching the monitor
• Fill the BDD with monitor configuration
• Use .env to gather parameters
• Change the queue system (something else than sync)

cachet-url-monitor-dc's Issues

docker-compose build error

Hello!
I'm trying to run your web service in docker but i got error:
ERROR: Named volume "monitor-config.yml:/usr/src/app/config/config.yml:rw" is used in service "monitor" but no declaration was found in the volumes section.
My folder structure:
├── cachet
│   ├── CHANGELOG.md
│   ├── conf
│   │   ├── nginx.conf
│   │   ├── nginx-site.conf
│   │   ├── php-fpm-pool.conf
│   │   └── supervisord.conf
│   ├── CONTRIBUTING.md
│   ├── docker-compose.yml
│   ├── Dockerfile
│   ├── entrypoint.sh
│   ├── LICENSE
│   ├── Makefile
│   ├── openshift
│   │   ├── cachethd-dc.yaml
│   │   └── README.md
│   ├── README.md
│   ├── release-helper.sh
│   └── test
│   ├── docker-compose-mysql.yml
│   ├── docker-compose-sqlite.yml
│   ├── docker_helpers.bash
│   ├── lib
│   │   ├── batslib.bash
│   │   └── output.bash
│   ├── test.full.bats
│   ├── test_helpers.bash
│   ├── test.mysql.bats
│   └── test.sqlite.bats
├── cachet-url-monitor
│   ├── cachet_url_monitor
│   │   ├── client.py
│   │   ├── configuration.py
│   │   ├── exceptions.py
│   │   ├── expectation.py
│   │   ├── init.py
│   │   ├── latency_unit.py
│   │   ├── plugins
│   │   │   ├── init.py
│   │   │   └── token_provider.py
│   │   ├── scheduler.py
│   │   ├── status.py
│   │   └── webhook.py
│   ├── config.yml
│   ├── dev_requirements.txt
│   ├── Dockerfile
│   ├── LICENSE
│   ├── README.md
│   ├── requirements.txt
│   ├── setup.cfg
│   ├── setup.py
│   ├── tests
│   │   ├── configs
│   │   │   ├── config_invalid_type.yml
│   │   │   ├── config_multiple_urls.yml
│   │   │   ├── config_webhooks.yml
│   │   │   └── config.yml
│   │   ├── plugins
│   │   │   └── test_token_provider.py
│   │   ├── test_client.py
│   │   ├── test_configuration.py
│   │   ├── test_expectation.py
│   │   ├── test_latency_unit.py
│   │   └── test_scheduler.py
│   └── tox.ini
├── docker-compose.yml
├── monitor-config.yml
└── README.md