2.8 KiB
| layout | page_title | sidebar_current | description |
|---|---|---|---|
| intro | Web UI | gettingstarted-ui | Consul comes with support for a beautiful, functional web UI out of the box. This UI can be used for viewing all services and nodes, viewing all health checks and their current status, and for reading and setting key/value data. The UI automatically supports multi-datacenter. |
Consul Web UI
Consul comes with support for a beautiful, functional web UI. The UI can be used for viewing all services and nodes, viewing all health checks and their current status, and for reading and setting key/value data. The UI automatically supports multi-datacenter.
There are two options for running a web UI for Consul. The first option is self-hosting and using the open-source UI, the second option is using Atlas by HashiCorp to host the dashboard for you.
Atlas-hosted Dashboard
To setup the Atlas UI for Consul, you must add two fields to your configuration — the name of your Atlas infrastructure and your Atlas token. Below is an example configuration:
$ consul agent -atlas=ATLAS_USERNAME/demo -atlas-token="ATLAS_TOKEN"
To get an Atlas username and token, create an account here and replace the respective values in your Consul configuration with your credentials.
You can view a live demo of the Atlas UI here.
A screenshot of one page of the demo is shown below so you can get an idea of what the web UI is like.
Self-hosted Dashboard
To set up the self-hosted UI,
download the web UI package
and unzip it to a directory somewhere on the server where the Consul agent
is also being run. Then append the -ui-dir to the consul agent
command pointing to the directory where you unzipped the UI (the
directory with the index.html file):
$ consul agent -ui-dir /path/to/ui
...
The UI is available at the /ui path on the same port as the HTTP API.
By default this is http://localhost:8500/ui.
-datacenter.
You can view a live demo of the Consul Web UI here.
While the live demo is able to access data from all datacenters, we've also setup demo endpoints in the specific datacenters: AMS2 (Amsterdam), SFO1 (San Francisco), and NYC3 (New York).
A screenshot of one page of the demo is shown below so you can get an idea of what the web UI is like. Click the screenshot for the full size.