summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorjoehuang <joehuang@huawei.com>2016-09-20 05:20:31 -0400
committerjoehuang <joehuang@huawei.com>2016-09-20 05:27:44 -0400
commit3f7394289faa2945e8f36d008cfb7dacf06279d6 (patch)
treede4c58563b7db1ebb33122ae1b4367b640e801eb /docs
parentb50a7a8c4d2f4a1e63b7dce077f9d3f726661a15 (diff)
Cherry Pick the update from the master branch to stable/colorado branch
These patches should be cherry picked to colorado branch: https://gerrit.opnfv.org/gerrit/#/c/20077/ https://gerrit.opnfv.org/gerrit/#/c/20635/ https://gerrit.opnfv.org/gerrit/#/c/19833/ https://gerrit.opnfv.org/gerrit/#/c/19587/ But because the structure of the folder was changed in https://gerrit.opnfv.org/gerrit/#/c/19833/ cherry pick using gerrit will lead to merge conflict, has to update the colorado branch through this patch. Change-Id: I971eb28520b47b14de52a761269518b959c6921c Signed-off-by: joehuang <joehuang@huawei.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/configurationguide/configuration.options.render.rst27
-rw-r--r--docs/installationprocedure/abstract.rst7
-rw-r--r--docs/installationprocedure/index.rst5
-rw-r--r--docs/installationprocedure/multisite.configuration.rst (renamed from docs/configurationguide/multisite-configuration-guide.rst)0
-rw-r--r--docs/installationprocedure/multisite.kingbird.configuration.rst (renamed from docs/configurationguide/multisite.kingbird.configuration.description.rst)1
-rw-r--r--docs/installationprocedure/multisite.kingbird.installation.rst (renamed from docs/installationprocedure/multisite.kingbird.installation.instruction.rst)10
-rw-r--r--docs/releasenotes/index.rst (renamed from docs/configurationguide/index.rst)10
-rw-r--r--docs/releasenotes/multisite.release.notes.rst14
-rw-r--r--docs/requirements/VNF_high_availability_across_VIM.rst5
-rw-r--r--docs/requirements/multisite-identity-service-management.rst6
-rw-r--r--docs/requirements/multisite-vnf-gr-requirement.rst5
-rw-r--r--docs/userguide/index.rst4
-rw-r--r--docs/userguide/multisite.admin.usage.rst (renamed from docs/userguide/multisite-admin-user-guide.rst)0
-rw-r--r--docs/userguide/multisite.kingbird.usage.rst (renamed from docs/userguide/multisite.kingbird.user.guide.rst)1
14 files changed, 38 insertions, 57 deletions
diff --git a/docs/configurationguide/configuration.options.render.rst b/docs/configurationguide/configuration.options.render.rst
deleted file mode 100644
index f1dc11a..0000000
--- a/docs/configurationguide/configuration.options.render.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
-
-=====================
-Configuration Options
-=====================
-
-OPNFV provides a variety of virtual infrastructure deployments called scenarios designed to
-host Virtualised Network Functions(VNFs). Each scenario provide specific capabilities and/or
-components aimed to solve specific problems for the deployment of VNF's. A scenario may include
-components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario will include
-different source components or configurations.
-
-OPNFV Scenarios
-===============
-
-Each OPNFV scenario provides unique features and capabilities, it is important to understand
-your target platform capabilities before installing and configuring your target scenario.
-This configuration guide outlines how to install and configure components in order to enable
-the features you require.
-
-.. include:: ../scenario/scenariomatrix.rst
-
-This document will describe how to install and configure your target OPNFV scenarios.
-Remember to check the associated validation procedures section following your installation for
-details of the use cases and tests that have been run.
diff --git a/docs/installationprocedure/abstract.rst b/docs/installationprocedure/abstract.rst
deleted file mode 100644
index 550a809..0000000
--- a/docs/installationprocedure/abstract.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-
-This document will give the user instructions on how to deploy
-available scenarios verified for the Colorado release of OPNFV
-platform.
diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
index bc51b95..746f819 100644
--- a/docs/installationprocedure/index.rst
+++ b/docs/installationprocedure/index.rst
@@ -13,6 +13,7 @@ Colorado 1.0
:maxdepth: 2
abstract.rst
- multisite.kingbird.installation.instruction.rst
- scenario.release.notes.rst
+ multisite.kingbird.installation.rst
+ multisite.configuration.rst
+ multisite.kingbird.configuration.rst
diff --git a/docs/configurationguide/multisite-configuration-guide.rst b/docs/installationprocedure/multisite.configuration.rst
index c005e8d..c005e8d 100644
--- a/docs/configurationguide/multisite-configuration-guide.rst
+++ b/docs/installationprocedure/multisite.configuration.rst
diff --git a/docs/configurationguide/multisite.kingbird.configuration.description.rst b/docs/installationprocedure/multisite.kingbird.configuration.rst
index d003019..7eb6106 100644
--- a/docs/configurationguide/multisite.kingbird.configuration.description.rst
+++ b/docs/installationprocedure/multisite.kingbird.configuration.rst
@@ -1,6 +1,5 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV
Configuration of Multisite.Kingbird
diff --git a/docs/installationprocedure/multisite.kingbird.installation.instruction.rst b/docs/installationprocedure/multisite.kingbird.installation.rst
index 8ef3f06..11a516a 100644
--- a/docs/installationprocedure/multisite.kingbird.installation.instruction.rst
+++ b/docs/installationprocedure/multisite.kingbird.installation.rst
@@ -1,11 +1,17 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV
===========================================
-Multisite.Kingbird installation instruction
+Multisite Kingbird installation instruction
===========================================
+Abstract
+--------
+This document will give the user instructions on how to deploy
+available scenarios verified for the Colorado release of OPNFV
+platform.
+
+
Preparing the installation
--------------------------
Kingbird is centralized synchronization service for multi-region OpenStack
diff --git a/docs/configurationguide/index.rst b/docs/releasenotes/index.rst
index 791d94d..df1e186 100644
--- a/docs/configurationguide/index.rst
+++ b/docs/releasenotes/index.rst
@@ -1,12 +1,12 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-*****************************
-Multisite Configuration Guide
-*****************************
+**************************
+Multisite Release Notes
+**************************
.. toctree::
:numbered:
- :maxdepth: 2
+ :maxdepth: 4
- multisite.kingbird.configuration.description.rst
+ multisite.release.notes.rst
diff --git a/docs/releasenotes/multisite.release.notes.rst b/docs/releasenotes/multisite.release.notes.rst
new file mode 100644
index 0000000..d90a064
--- /dev/null
+++ b/docs/releasenotes/multisite.release.notes.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Release Notes of Multisite project
+==================================
+
+Multisite is to identify the requirements and gaps for the VIM(OpenStack)
+to support multi-site NFV cloud.
+
+The documentation of requirements, installation, configuration and usage
+guide for multi-site and Kingbird are provided.
+
+It's the first release for Kingbird service, known bugs are registered at
+https://bugs.launchpad.net/kingbird.
diff --git a/docs/requirements/VNF_high_availability_across_VIM.rst b/docs/requirements/VNF_high_availability_across_VIM.rst
index 1a7d41b..6c2e9f1 100644
--- a/docs/requirements/VNF_high_availability_across_VIM.rst
+++ b/docs/requirements/VNF_high_availability_across_VIM.rst
@@ -1,6 +1,5 @@
-This work is licensed under a Creative Commons Attribution 3.0 Unported License.
-http://creativecommons.org/licenses/by/3.0/legalcode
-
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
=======================================
VNF high availability across VIM
diff --git a/docs/requirements/multisite-identity-service-management.rst b/docs/requirements/multisite-identity-service-management.rst
index b411c28..ad2cea1 100644
--- a/docs/requirements/multisite-identity-service-management.rst
+++ b/docs/requirements/multisite-identity-service-management.rst
@@ -1,7 +1,5 @@
-This work is licensed under a Creative Commons Attribution 3.0 Unported
-License.
-http://creativecommons.org/licenses/by/3.0/legalcode
-
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
=======================================
Multisite identity service management
diff --git a/docs/requirements/multisite-vnf-gr-requirement.rst b/docs/requirements/multisite-vnf-gr-requirement.rst
index 7e67cd0..e88ed9c 100644
--- a/docs/requirements/multisite-vnf-gr-requirement.rst
+++ b/docs/requirements/multisite-vnf-gr-requirement.rst
@@ -1,6 +1,5 @@
-This work is licensed under a Creative Commons Attribution 3.0 Unported License.
-http://creativecommons.org/licenses/by/3.0/legalcode
-
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
=========================================
Multisite VNF Geo site disaster recovery
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 1429b33..25de482 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -9,5 +9,5 @@ Multisite Admin User Guide
:numbered:
:maxdepth: 4
- multisite-admin-user-guide.rst
- multisite.kingbird.user.guide.rst
+ multisite.admin.usage.rst
+ multisite.kingbird.usage.rst
diff --git a/docs/userguide/multisite-admin-user-guide.rst b/docs/userguide/multisite.admin.usage.rst
index 41f23c0..41f23c0 100644
--- a/docs/userguide/multisite-admin-user-guide.rst
+++ b/docs/userguide/multisite.admin.usage.rst
diff --git a/docs/userguide/multisite.kingbird.user.guide.rst b/docs/userguide/multisite.kingbird.usage.rst
index 6ae3881..c5bb3eb 100644
--- a/docs/userguide/multisite.kingbird.user.guide.rst
+++ b/docs/userguide/multisite.kingbird.usage.rst
@@ -1,6 +1,5 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV
=============================
Multisite.Kingbird user guide