94835a2715
* spelling: another * spelling: autopilot * spelling: beginning * spelling: circonus * spelling: default * spelling: definition * spelling: distance * spelling: encountered * spelling: enterprise * spelling: expands * spelling: exits * spelling: formatting * spelling: health * spelling: hierarchy * spelling: imposed * spelling: independence * spelling: inspect * spelling: last * spelling: latest * spelling: client * spelling: message * spelling: minimum * spelling: notify * spelling: nonexistent * spelling: operator * spelling: payload * spelling: preceded * spelling: prepared * spelling: programmatically * spelling: required * spelling: reconcile * spelling: responses * spelling: request * spelling: response * spelling: results * spelling: retrieve * spelling: service * spelling: significantly * spelling: specifies * spelling: supported * spelling: synchronization * spelling: synchronous * spelling: themselves * spelling: unexpected * spelling: validations * spelling: value |
||
|---|---|---|
| .. | ||
| javascripts | ||
| scripts | ||
| static | ||
| styles | ||
| tests | ||
| GNUmakefile | ||
| Gemfile | ||
| Gemfile.lock | ||
| README.md | ||
| index.html | ||
| 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 datacenters, 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 ../pkg/web_ui folder will contain the files you should use for deployment.
Acknowledgments
Cog icon by useiconic.com from the Noun Project
Compiling the UI into the Go binary
The UI is compiled and shipped with the Consul go binary. The generated bindata
file lives in the command/agent/bindata_assetfs.go file and is checked into
source control. This is useful so that not every Consul developer needs to set
up bundler etc. To re-generate the file, first follow the compilation steps
above to build the UI assets into the pkg/web_ui folder. With that done, from the
root of the Consul repo, run:
$ make static-assets
The file will now be refreshed with the current UI data. You can now rebuild the
Consul binary normally with make bin or make dev, and see the updated UI
after re-launching Consul.