Skip to content
This repository has been archived by the owner on Sep 9, 2020. It is now read-only.

Update docs to reference new web UI feature with image example. #38

Merged
merged 1 commit into from
Sep 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/web_ui_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions docs/configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ The Sherpa server can be configured by supplying either CLI flags or using envir
* `--policy-engine-strict-checking-enabled` (bool: true) - When enabled, all scaling activities must pass through policy checks.
* `--storage-consul-enabled` (bool: false) - Use Consul as a storage backend when using the API policy engine.
* `--storage-consul-path` (string: "sherpa/policies/") - The Consul KV path that will be used to store policies.
* `--telemetry-statsd-address` (string: "") - Specifies the address of a statsd server to forward metrics to
* `--telemetry-statsite-address` (string: "") - Specifies the address of a statsite server to forward metrics data to
* `--telemetry-statsd-address` (string: "") - Specifies the address of a statsd server to forward metrics to.
* `--telemetry-statsite-address` (string: "") - Specifies the address of a statsite server to forward metrics data to.
* `--tls-cert-key-path` (string: "") - Path to the TLS certificate key for the Sherpa server.
* `--tls-cert-path (string: "")` - Path to the TLS certificate for the Sherpa server.
* `--tls-cert-path` (string: "") - Path to the TLS certificate for the Sherpa server.
* `--ui` (bool: false) - Run the Sherpa user interface.

### Environment Variables

Expand Down
5 changes: 5 additions & 0 deletions docs/guides/ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Sherpa UI

The Sherpa UI provides an easy visualise overview of scaling activates which have taken place. It is namespaced under /ui, but visiting the root of the Sherpa server in your browser will redirect you to the Web UI.

![web ui](../assets/web_ui_overview.png "Web UI Overview")