Skip to content
Vigie

Web page

The server serves a page at / for a person who wants to check what Vigie serves. It follows the light or dark theme of the browser.

The Vigie page listing three services. default and db read their endpoints from a file, localhost from DNS. Each row shows the source and the default port of the service next to its endpoints, some with a weight.
The Vigie page listing three services. default and db read their endpoints from a file, localhost from DNS. Each row shows the source and the default port of the service next to its endpoints, some with a weight.

Columns

Section titled “Columns”
ColumnShows
ServiceThe name of the service. It links to /services?service_name=<name>, the JSON answer.
SourceWhere a service reads its endpoints, one of dns, file, url or kubernetes. See Services and sources.The kind of source and where it reads, see Source.
Default portThe port an endpoint takes when its source gives none, set by default_port of the service. See Configuration.The default_port of the service.
EndpointsOne IP address and port that a service gives, with its load balancing weight. See HTTP API.Each endpoint as ip:port, IPv6 addresses in brackets, with its weight when it’s above 0.

The page fetches the endpoints of every service from /services when it loads, the answer the clients read, cache included. ReloadReading the configuration file again to replace the services, on SIGHUP or POST /reload. See Reload the services. the page to see them again. A service whose source fails shows the error of /services in red, and one without any endpoint shows no endpoint.

The services listed are the ones the server answers for. After a reload, the page lists the new services.

Source

Section titled “Source”
KindShown as
dns ip, dns srv, dns txtThe name looked up, the full SRVA DNS record giving the host, port and weight of one instance of a service. See Read endpoints from DNS. name for SRV, such as _http._tcp.api.example.com, followed by @<resolver> when the service sets one.
fileThe path of the file.
urlThe URL, without its user and password. The basic_auth credentials aren’t shown either.
kubernetes<namespace>/<service>, followed by :<port_name> when the service sets one. The kubeconfig path isn’t shown.

The page shows no secret of the configuration, but it does show the names, paths and addresses of your sources, and needs no authentication unless server.basic_auth is set. Keep the port of Vigie on a network you trust, or require a password. With server.basic_auth, the browser asks for a username and password before showing the page.