initial stub docs

docs/.gitignore

@@ -0,0 +1 @@
+_build/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = KubernetesOperationalView
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/access-control.rst

@@ -0,0 +1,19 @@
+==============
+Access Control
+==============
+
+Kube Ops View supports protecting the UI via the OAuth Authorization Code Grant flow.
+
+TODO: how to configure
+
+Screen Tokens
+=============
+
+Screen tokens allow non-human access to the UI to support permanent dashboards on TV screens.
+
+On your local machine: authenticate via OAuth redirect flow and go to /screen-tokens to create a new token.
+Write down the screen token on a piece of paper.
+
+Go to the TV screen and enter /screen/$TOKEN in the location bar.
+
+TODO: how do screen tokens work?

docs/conf.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Kubernetes Operational View documentation build configuration file, created by
+# sphinx-quickstart on Tue Jan 10 21:54:00 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Kubernetes Operational View'
+copyright = '2017, Henning Jacobs'
+author = 'Henning Jacobs'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+try:
+    import sphinx_rtd_theme
+
+    html_theme = "sphinx_rtd_theme"
+
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+except:
+    pass
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'KubernetesOperationalViewdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'KubernetesOperationalView.tex', 'Kubernetes Operational View Documentation',
+     'Henning Jacobs', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'kubernetesoperationalview', 'Kubernetes Operational View Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'KubernetesOperationalView', 'Kubernetes Operational View Documentation',
+     author, 'KubernetesOperationalView', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/getting-started.rst

@@ -0,0 +1,20 @@
+===============
+Getting Started
+===============
+
+You can find example Kubernetes manifests for deployment in the deploy folder. It should be as simple as:
+
+.. code-block:: bash
+
+    $ git clone git@github.com:hjacobs/kube-ops-view.git
+    $ kubectl apply -f kube-ops-view/deploy
+
+Afterwards you can open "kube-ops-view" via the kubectl proxy:
+
+.. code-block:: bash
+
+    $ kubectl proxy
+
+Now direct your browser to http://localhost:8001/api/v1/proxy/namespaces/default/services/kube-ops-view/
+
+

docs/index.rst

@@ -0,0 +1,28 @@
+.. Kubernetes Operational View documentation master file, created by
+   sphinx-quickstart on Tue Jan 10 21:54:00 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Kubernetes Operational View's documentation!
+=======================================================
+
+The goal of Kubernetes Operational View is to provide a common operational picture for multiple Kubernetes clusters.
+
+GitHub repository: https://github.com/hjacobs/kube-ops-view
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   getting-started
+   multiple-clusters
+   access-control
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/multiple-clusters.rst

@@ -0,0 +1,7 @@
+=================
+Multiple Clusters
+=================
+
+Set the ``CLUSTERS`` environment variable to a comma separated list of Kubernetes API server URLs.
+
+TODO: how to configure authentication, registry, ..