open-consul

History

Jack Pearkes 48eaada3ae ui: add nodeShow test		2014-06-10 16:36:06 -04:00
..
dist
javascripts	ui: show session name if there is one	2014-06-09 14:59:06 -04:00
scripts	ui: remove components from compile	2014-06-05 16:28:28 -04:00
static
styles	ui: fix padding on panel bodies to align	2014-06-09 12:01:17 -04:00
tests	ui: add nodeShow test	2014-06-10 16:36:06 -04:00
Gemfile
Gemfile.lock
index.html	ui: show session name if there is one	2014-06-09 14:59:06 -04:00
Makefile
README.md	Minor Typo	2014-05-29 15:15:13 -04:00
style-guide.html

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 .

Releasing

make dist

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