Sha256: 01435aae0226fb08ddd11428e4b929a2c4bb1bf6f83afc8601b3efab29552b2f

Contents?: true

Size: 1.67 KB

Versions: 5

Compression:

Stored size: 1.67 KB

Contents

# consul-ui

A simple HTML5 app that displays all services within Consul with AJAX requests.
It supports fitering based on tags and does not rely on Consul to display pages,
meaning that it can be scaled horizontally without any troubles with Consul.

## Usage

```shell
consul-templaterb -c http://localhost:8500 samples/consul-ui/*.erb
```

Where `http://localhost:8500` is the address of the Consul agent you want to use to
perform requests.

The content is statically created, so you can serve it using any HTTP server very easily.

For development, you might use `python -m SimpleHTTPServer` in order to server the result
on your browser.

### Generating index.html

By default, the command `consul-templaterb -c http://localhost:8500 samples/consul-ui/*.erb``
will generate sample/consul-ui/consul-services-ui.html file. If you want to use index.html instead
you might use the `--template samples/consul-ui/consul-services-ui.html:samples/consul-ui/index.html`
instead. Example:

```shell
consul-templaterb -c http://localhost:8500 \
  --template samples/consul-ui/consul-services-ui.html:samples/consul-ui/index.html \
  samples/consul-ui/consul_template.json.erb
```

Will generate index.html and consul_template.json in your directory, so you might serve it directly.

### Filtering services

This app supports the following environement variables:

* SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
* INSTANCE_MUST_TAG: Second level of filtering (optional, default to SERVICES_TAG_FILTER)
* INSTANCE_EXCLUDE_TAG: Exclude instances having the given tag (default: canary)
* EXCLUDE_SERVICES: comma-separated services to exclude (default: consul-agent-http,mesos-slave,mesos-agent-watcher)

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
consul-templaterb-1.4.0 samples/consul-ui/README.md
consul-templaterb-1.3.1 samples/consul-ui/README.md
consul-templaterb-1.3.0 samples/consul-ui/README.md
consul-templaterb-1.2.1 samples/consul-ui/README.md
consul-templaterb-1.2.0 samples/consul-ui/README.md