diff options
| -rw-r--r-- | docs/index.rst | 22 | ||||
| -rw-r--r-- | tox.ini | 2 |
2 files changed, 23 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..127f0b0e --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,22 @@ +MultiCloud Kubernetes Plugin +============================ + +This plugin is a part of the MultiCloud component in ONAP. +It will allow ONAP to deploy/manage VM and container based VNFs +over cloud regions that support Kubernetes as the orchestrator. + +Kubernetes Reference Deployment +=============================== + +The Kubernetes Reference Deployment(KRD) provides an +automated mechanism to install and configure the Kubernetes +services required for the MultiCloud Kubernetes plugin. + +Table of contents +----------------- + +.. toctree:: + :maxdepth: 3 + + Project Architecture <krd_architecture> + Sample Commands <sampleCommands> @@ -22,4 +22,4 @@ commands = bash -c "find {toxinidir} -not -path {toxinidir}/.tox/\* \ [testenv:docs] deps = sphinx -commands = sphinx-build -W -b html docs/src docs/build/html +commands = sphinx-build -W -b html docs docs/build/html |