luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity
open-consul/ui
History
Jack Pearkes 0b9847ab96 ui: more fixes around the readme 2014-04-30 23:44:31 -04:00
..
javascripts ui: refresh node list after create 2014-04-30 23:44:31 -04:00
static ui: experiment with the vertical line 2014-04-30 23:44:29 -04:00
styles ui: button default focus states 2014-04-30 23:44:31 -04:00
tests ui: add base ember 2014-04-30 23:43:55 -04:00
Makefile ui: fix makefile 2014-04-30 23:44:30 -04:00
README.md ui: more fixes around the readme 2014-04-30 23:44:31 -04:00
index.html ui: button default focus states 2014-04-30 23:44:31 -04: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 directoy, 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.

The UI is built with SASS CSS, so you'll need to compile that through the associated makefile, as well as installing the sass gem.

gem install sass

One-time stylesheet compilation:

make build

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 directoy, 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 .