diff --git a/content/eaas/appliance/_index.md b/content/eaas/appliance/_index.md index 60dc23c7..709ca909 100644 --- a/content/eaas/appliance/_index.md +++ b/content/eaas/appliance/_index.md @@ -26,8 +26,8 @@ Due to the high overhead cost of making HTTP requests, the amount of entropy tha **Max API throughput:** | 256 bit keys per request| Requests per second |---|---| -|512|~4,800| -|1|~8,000| +|512|~7,200| +|1|~12,000| **Max Entropy card output:** ~1,500 Mb/s @@ -47,6 +47,58 @@ The root path (“/”) returns a UI that displays various metrics, and health r Client applications can request a configurable amount of entropy from the entropy API, which is served from the “/api/v1/” route. The complete spec for the API can be found below. +--- +# Appliance Administration UI + +Upon opening the UI, you should see the following landing page: + + + +Each QRNG card installed on the appliance will have its own entry in the table, sorted by card ID. + +The current state of the card can be determined by a quick glance at the "Status" column. Possible states are as follows: + +|State|Explanation| +|---|---| +|{{< badge "active" >}}|The card is healthy and streaming entropy.| +|{{< badge "pending" >}}|The card is in a temporary calibration state; this will resolve into either *Active* or *Error*.| +|{{< badge "error" >}}|The card is reporting an error; the error message can be found in details section.| + +Clicking on a card will expand the row and show more detail: + + + +If the card is in an {{< badge "error" >}} state, the number of errors and the error messages will be enumerated at the bottom of the details section. + +If the card is {{< badge "pending" >}}, a "Status Message" field will provide more information. This typically only happens on startup while the initial NIST test suite runs -- upon success, the card will move into an {{< badge "active" >}} state and begin streaming entropy. + +*Note that the badge in the "Status" section here is the same as in the card row entry.* + +At the bottom right of the UI, there is a link to download a compressed bundle of server logs: + + + +Note that this may take up to 30 seconds depending on the size of the logfiles, so do not navigate away from the page while the collection is in progress. Logfile processing is indicated by the presence of an animated spinner. + +--- + +# TLS Configuration + +To enable TLS on the appliance, replace the following two files with your own public and private certs, respectively: + +- /etc/ssl/certs/public.crt +- /etc/ssl/private/private.key + +Then, restart *nginx* for the new certs to take effect: + +- systemctl restart nginx + +You can test this new configuration by running: + +- nginx -t + +*Note that these operations must be done as sudo user.* + --- # OpenAPI spec diff --git a/content/eaas/appliance/images/card_details.png b/content/eaas/appliance/images/card_details.png new file mode 100644 index 00000000..81574460 Binary files /dev/null and b/content/eaas/appliance/images/card_details.png differ diff --git a/content/eaas/appliance/images/download_logs.png b/content/eaas/appliance/images/download_logs.png new file mode 100644 index 00000000..03ed277b Binary files /dev/null and b/content/eaas/appliance/images/download_logs.png differ diff --git a/content/eaas/appliance/images/full_page.png b/content/eaas/appliance/images/full_page.png new file mode 100644 index 00000000..2c0ff56b Binary files /dev/null and b/content/eaas/appliance/images/full_page.png differ diff --git a/content/eaas/appliance/images/status_table.png b/content/eaas/appliance/images/status_table.png new file mode 100644 index 00000000..7507d13b Binary files /dev/null and b/content/eaas/appliance/images/status_table.png differ diff --git a/docs/404.html b/docs/404.html index a68570b3..07b1f441 100644 --- a/docs/404.html +++ b/docs/404.html @@ -9,15 +9,15 @@