Merge "Upload gap-analysis documentation"

5 files changed, 114 insertions, 0 deletions

diff --git a/docs/development/gapanalysis/gap-analysis-kubernetes-v1.5.rst b/docs/development/gapanalysis/gap-analysis-kubernetes-v1.5.rst
new file mode 100644
index 0000000..bff5372
--- /dev/null
+++ b/docs/development/gapanalysis/gap-analysis-kubernetes-v1.5.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.http://creativecommons.org/licenses/by/4.0
+.. (c) Xuan Jia (China Mobile)
+
+================================================
+OpenRetriever Gap Analysis with Kubernetes v1.5
+================================================
+
+This section provides users with OpenRetriever gap analysis regarding feature
+requirement with Kubernetes Official Release. The following table lists the use
+cases / feature requirements of container integrated functionality, and its gap
+analysis with Kubernetes Official Release.
+
+.. table::
+  :class: longtable
+
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Use Case / Requirement                                     |Supported in v1.5  |Notes                                                               |
+  +===========================================================+===================+====================================================================+
+  |Manage conainter and virtual machine in the same platform. |No                 |Kubernetes only manage containers. For this part, we need to setup a|
+  |                                                           |                   |platform to manage containers and virtual machine together          |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |TBD                                                        |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
diff --git a/docs/development/gapanalysis/gap-analysis-openstack-mitaka.rst b/docs/development/gapanalysis/gap-analysis-openstack-mitaka.rst
new file mode 100644
index 0000000..9fa906b
--- /dev/null
+++ b/docs/development/gapanalysis/gap-analysis-openstack-mitaka.rst
@@ -0,0 +1,30 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License. http://creativecommons.org/licenses/by/4.0
+.. (c) Xuan Jia (China Mobile)
+
+================================================
+OpenRetriever Gap Analysis with OpenStack Mitaka
+================================================
+This section provides users with OpenRetriever gap analysis regarding feature
+requirement with Openstack Mitaka Official Release. The following table lists
+the use cases / feature requirements of container integrated functionality, and
+its gap analysis with Openstack Mitaka Official Release.
+
+.. table::
+  :class: longtable
+
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Use Case / Requirement                                     |Supported in Mitaka|Notes                                                               |
+  +===========================================================+===================+====================================================================+
+  |Manage conainter and virtual machine in the same platform. |No                 |Magnum could provide container environment, but it can't manage     |
+  |                                                           |                   |container application. We need a tool to manage applications, no    |
+  |                                                           |                   |matter where it is running on container or virutal machine.         |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Container private registry store container images.         |No                 |Container images need to store in container private registry. The   |
+  |                                                           |                   |image could be stored in Openstack Cinder or single virtual machine.|
+  |                                                           |                   |No matter what, it can fetech container images in this container    |
+  |                                                           |                   |environment.                                                        |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Kuryr need to support MACVLAN and IPVLAN                   |No                 |MACVLAN and IPVLAN could get better network performance. In Ocata,  |
+  |                                                           |                   |it will support.                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
diff --git a/docs/development/gapanalysis/gap-analysis-opnfv-installer.rst b/docs/development/gapanalysis/gap-analysis-opnfv-installer.rst
new file mode 100644
index 0000000..f1c047b
--- /dev/null
+++ b/docs/development/gapanalysis/gap-analysis-opnfv-installer.rst
@@ -0,0 +1,32 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License. http://creativecommons.org/licenses/by/4.0
+.. (c) Xuan Jia (China Mobile)
+
+===============================================
+OpenRetriever Gap Analysis with OPNFV Installer
+===============================================
+This section provides users with OpenRetriever gap analysis regarding feature
+requirement with OPNFV Installer in Danube Official Release. The following
+table lists the use cases / feature requirements of container integrated
+functionality, and its gap analysis with OPNFV Installer in Danube Official
+Release. OPNFV installer should support them.
+
+.. table::
+  :class: longtable
+
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Use Case / Requirement                                     |Supported in Danube|Notes                                                               |
+  +===========================================================+===================+====================================================================+
+  |Use Openstack Magnum to install container environment      |No                 |Magnum is supported in Openstack Official Release, but it's not     |
+  |                                                           |                   |supported in OPNFV Installer. Magnum is the place where container   |
+  |                                                           |                   |can be installed in OPNFV.                                          |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Use Openstack Ironic to supervise bare metal machine       |No                 |Container could be installed in bare metal machine. Ironic provides |
+  |                                                           |                   |bare metal machine, work with Magnum together to setup a container  |
+  |                                                           |                   |environment, be installed in OPNFV.                                 |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Use Openstack Kuryr to provide network for container       |No                 |Container has its own network solution. Container needs to connect  |
+  |                                                           |                   |with virtual machines, and Kuryr which use Neutron provides network |
+  |                                                           |                   |service is the best choice now.                                     |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+
diff --git a/docs/development/gapanalysis/index.rst b/docs/development/gapanalysis/index.rst
new file mode 100644
index 0000000..339b154
--- /dev/null
+++ b/docs/development/gapanalysis/index.rst
@@ -0,0 +1,22 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License. http://creativecommons.org/licenses/by/4.0
+.. (c) Xuan Jia (China Mobile)
+
+==========================
+OpenRetriever Gap Analysis
+==========================
+
+:Project: OpenRetriever, https://wiki.opnfv.org/display/openretriever
+
+:Editors: Xuan Jia (China Mobile)
+:Authors: Xuan Jia (China Mobile)
+
+:Abstract: This document provides the users with top-down gap analysis regarding
+           OpenRetriever feature requirements with OPNFV Installer, OpenStack
+           Official Release and Kubernetes Official Release.
+
+.. toctree::
+   maxdepth:2
+   gap-analysis-opnfv-installer.rst
+   gap-analysis-openstack-mitaka.rst
+   gap-analysis-kubernetes-v1.5.rst
diff --git a/scripts/README b/scripts/README
new file mode 100644
index 0000000..4b6c0e1
--- /dev/null
+++ b/scripts/README
@@ -0,0 +1,6 @@
+This directory will give a common ansible scripts to setup a container enviroment in OpenStack. 
+(1) Container in virtual machine
+(2) Container in bare metal machine
+(3) Container could connect with container and virtual machine.
+(4) Container and virtual machine management platform.
+