open-consul

History

Armon Dadgar 88b11fbdaf website: implicit -> explicit		2014-09-02 20:48:25 -07:00
..
dist	ui: ignore compiled js, dist	2014-05-01 11:22:30 -04:00
javascripts	ui: ambient dc failing checks	2014-08-25 12:40:53 -07:00
scripts	ui: add notification system	2014-08-22 17:22:06 -07:00
static	Add the logo favicon to the webui	2014-07-22 12:42:24 -04:00
styles	ui: use ACLs everywhere	2014-08-25 11:48:42 -07:00
tests	ui: add nodeShow test	2014-06-10 16:36:06 -04:00
Gemfile	ui: update ember, dist steps	2014-05-01 11:21:55 -04:00
Gemfile.lock	ui: update ember, dist steps	2014-05-01 11:21:55 -04:00
Makefile	ui: delete backup files	2014-05-01 12:45:15 -07:00
README.md	ui: update readme for dev confi	2014-08-22 17:21:27 -07:00
development_config.json	ui: add a development config	2014-08-22 17:21:20 -07:00
index.html	website: implicit -> explicit	2014-09-02 20:48:25 -07:00
style-guide.html	ui: add delete key functionality	2014-04-30 23:44:29 -04:00

README.md

Consul Web UI

This directory contains the Consul Web UI. Consul contains a built-in HTTP server that serves this directory, but any common HTTP server is capable of serving it.

It uses JavaScript and Ember to communicate with the Consul API. The basic features it provides are:

Service view. A list of your registered services, their health and the nodes they run on.
Node view. A list of your registered nodes, the services running on each and the health of the node.
Key/value view and update

It's aware of multiple data centers, so you can get a quick global overview before drilling into specific data-centers for detailed views.

The UI uses some internal undocumented HTTP APIs to optimize performance and usability.

Development

Improvements and bug fixes are welcome and encouraged for the Web UI.

You'll need sass to compile CSS stylesheets. Install that with bundler:

cd ui/
bundle

Reloading compilation for development:

make watch

Consul ships with an HTTP server for the API and UI. By default, when you run the agent, it is off. However, if you pass a -ui-dir flag with a path to this directory, you'll be able to access the UI via the Consul HTTP server address, which defaults to localhost:8500/ui.

An example of this command, from inside the ui/ directory, would be:

consul agent -bootstrap -server -data-dir /tmp/ -ui-dir .

Basic tests can be run by adding the ?test query parameter to the application.

When developing Consul, it's recommended that you use the included development configuration.

consul agent -config-file=development_config.json

Releasing

make dist

The dist folder will contain the files you should use for deployment.