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

Commit

Permalink
#108 document UI options
Browse files Browse the repository at this point in the history
  • Loading branch information
hjacobs committed Jan 24, 2017
1 parent 244fd90 commit e564f43
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ GitHub repository: https://github.com/hjacobs/kube-ops-view
user-guide
multiple-clusters
access-control
ui-options



Expand Down
16 changes: 16 additions & 0 deletions docs/ui-options.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
==========
UI Options
==========

Kubernetes Operational View has a few options to change the UI behavior.
All these options are passed in the URL's fragment identifier (starting with ``#``) in the format of key/value pairs separated by semicolons.

Example URL: ``https://kube-ops-view.example.org/#dashboard=true;reload=600``


``dashboard``
Enable dashboard mode which hides the menu bar.
``reload``
Reload the whole page after X seconds. This is useful for unattended TV screens running 24x7 to mitigate JavaScript memory leaks and browser crashes.
``clusters``
Comma separated list of cluster IDs to show.

0 comments on commit e564f43

Please sign in to comment.