Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan-M committed Jan 23, 2017
1 parent c8b6acf commit fb5cb77
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 9 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2015 Zalando SE
Copyright 2017 Zalando SE

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
8 changes: 7 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ Features
* Supports desktop and mobile notifications via Firebase Cloud Messaging
* More on connectivity here: `Check commands <https://docs.zmon.io/en/latest/user/check-commands.html>`_

Local demo using Docker Compose
===============================

Inside the `compose<https://github.com/zalando/zmon/tree/master/compose>`_ folder you will find a description to run ZMON locally.

Deployment
==========

Expand Down Expand Up @@ -77,7 +82,8 @@ Optional components

`Metric cache <https://github.com/zalando/zmon-metric-cache>`_ Fast special purpose cache for REST API metric data for ZMON's REST metrics/cloud UI

Start Demo Using Vagrant

Vagrant Box (deprecated)
========================

Install a recent Vagrant_ version (at least 1.7.4) and simply do:
Expand Down
20 changes: 13 additions & 7 deletions compose/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
Usage
=====
Starting ZMON using Docker Compose
==================================

This will run all the components locally:

```
docker-compose -f zmon-compose.yaml up
```

Once things are up run:
Once things are up run once:

```
./inject.sh
# script calling the zmon cli
./inject.sh
```

This will insert some example entities, alerts and checks.

Now open: `ZMON(localhost) <https://localhost:8443>`_

Issues
======

KairosDB may need a restart if it does not come up - health check only works first time.
KairosDB may need a restart if it does not come up - health seems to only work the first time.

```
docker restart compose_kairosdb_1
```

Requires
--------
Requirements
============

* docker-compose version 1.10+
* docker 1.13

Install from: https://docs.docker.com/compose/install/

0 comments on commit fb5cb77

Please sign in to comment.