diff --git a/docs/index.rst b/docs/index.rst index 174b65b..6e56025 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,6 +18,7 @@ GitHub repository: https://github.com/hjacobs/kube-ops-view user-guide multiple-clusters access-control + ui-options diff --git a/docs/ui-options.rst b/docs/ui-options.rst new file mode 100644 index 0000000..25d8a3b --- /dev/null +++ b/docs/ui-options.rst @@ -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.