summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/FAQ/faq.rst8
-rw-r--r--docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst6
-rw-r--r--docs/FAQ/index.rst2
-rw-r--r--docs/installationprocedure/bmdeploy.rst2
-rw-r--r--docs/installationprocedure/installation.instruction.rst7
-rw-r--r--docs/installationprocedure/introduction.rst2
-rw-r--r--docs/installationprocedure/references.rst4
-rw-r--r--docs/releasenotes/index.rst (renamed from docs/release-notes/index.rst)10
-rw-r--r--docs/releasenotes/release-notes.rst (renamed from docs/release-notes/release-notes.rst)56
9 files changed, 53 insertions, 44 deletions
diff --git a/docs/FAQ/faq.rst b/docs/FAQ/faq.rst
index 4697d537..feae4142 100644
--- a/docs/FAQ/faq.rst
+++ b/docs/FAQ/faq.rst
@@ -68,7 +68,7 @@ The public virtual IP is configured in "compass4nfv/deploy/conf/network_cfg.yaml
How to access BM nodes after deployment
=======================================
-1. First you should login Compass VM via ssh command on JumpHost by default user/pass root/root.
+1. First you should login Compass VM via ssh command on Jumphost by default user/pass root/root.
The default login IP of Compass VM is configured in "compass4nfv/deploy/conf/base.conf", defined as below:
.. code-block:: bash
@@ -99,7 +99,7 @@ which are configured in "compass4nfv/deploy/conf/base.conf", defined as below:
+---+VM+--+ | +-------------+
+--------------------+ |
| | | +-------------+
- | JumpHost | | | |
+ | Jumphost | | | |
| | +----------+ host3 |
+--------------------+ | |
+-------------+
@@ -111,8 +111,8 @@ Where is OpenStack RC file
It is located /opt/admin-openrc.sh in each BM node as default. Please source it first if you want to use
OpenStack CLI.
-How to recovery network connection after jumpserver reboot
-==========================================================
+How to recovery network connection after Jumphost reboot
+========================================================
.. code-block:: bash
diff --git a/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst b/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst
index 37db1aed..f12d38d0 100644
--- a/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst
+++ b/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst
@@ -1,10 +1,10 @@
.. two dots create a comment. please leave this logo at the top of each of your rst files.
-How to deploy while jumphost cannot access internet
+How to deploy while Jumphost cannot access internet
===================================================
-If your jumphost cannot access internet, don't worry, you can definitely deploy compass without internet access.
+If your Jumphost cannot access internet, don't worry, you can definitely deploy compass without internet access.
-You can download compass.iso first from OPNFV artifacts repository (http://artifacts.opnfv.org/, search compass4nfv and select an appropriate ISO file) via wget or curl. Then copy the compass.iso and the compass4nfv repository to your jumphost and editor the ISO_URL to your local path.
+You can download compass.iso first from OPNFV artifacts repository (http://artifacts.opnfv.org/, search compass4nfv and select an appropriate ISO file) via wget or curl. Then copy the compass.iso and the compass4nfv repository to your Jumphost and editor the ISO_URL to your local path.
After that you can deploy compass without internet access.
diff --git a/docs/FAQ/index.rst b/docs/FAQ/index.rst
index d152895a..7b349d0e 100644
--- a/docs/FAQ/index.rst
+++ b/docs/FAQ/index.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
=========================================================
-OPNFV(Brahmaputra) Compass4nfv Frequently Asked Questions
+OPNFV(Colorado) Compass4nfv Frequently Asked Questions
=========================================================
Contents:
diff --git a/docs/installationprocedure/bmdeploy.rst b/docs/installationprocedure/bmdeploy.rst
index d08a8f8a..6ec70fa4 100644
--- a/docs/installationprocedure/bmdeploy.rst
+++ b/docs/installationprocedure/bmdeploy.rst
@@ -243,7 +243,7 @@ E.g.
.. code-block:: bash
- ########## Hardware Deploy Jumpserver PXE NIC ##########
+ ########## Hardware Deploy Jumphost PXE NIC ##########
# you need comment out it when virtual deploy
export INSTALL_NIC=eth1
diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst
index 9e552494..87c8a55c 100644
--- a/docs/installationprocedure/installation.instruction.rst
+++ b/docs/installationprocedure/installation.instruction.rst
@@ -36,13 +36,12 @@ The stable release ISO can be retrieved via `OPNFV software download page <https
The daily build ISO can be retrieved via OPNFV artifacts repository:
-http://artifacts.opnfv.org/
+http://artifacts.opnfv.org/compass4nfv.html
NOTE: Search the keyword "compass4nfv/Colorado" to locate the ISO image.
E.g.
-compass4nfv/colorado/opnfv-2016-01-16_15-03-18.iso
-compass4nfv/colorado/opnfv-2016-01-16_15-03-18.properties
+compass4nfv/colorado/opnfv-2016-09-18_08-15-13.iso
The name of iso image includes the time of iso building, you can get the daily
ISO according the building time.
@@ -57,7 +56,7 @@ To retrieve the repository of Compass4nfv on Jumphost use the following command:
- git clone https://gerrit.opnfv.org/gerrit/compass4nfv
-NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN root DIRECTORY(Include subfolders).
+NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN ROOT DIRECTORY(INCLUDE SUBFOLDERS).
To get stable /colorado release, you can use the following command:
diff --git a/docs/installationprocedure/introduction.rst b/docs/installationprocedure/introduction.rst
index d1c581e2..835a5788 100644
--- a/docs/installationprocedure/introduction.rst
+++ b/docs/installationprocedure/introduction.rst
@@ -5,7 +5,7 @@
Abstract
========
-This document describes how to install the Brahmaputra release of OPNFV when
+This document describes how to install the Colorado release of OPNFV when
using Compass4nfv as a deployment tool covering it's limitations, dependencies
and required system resources.
diff --git a/docs/installationprocedure/references.rst b/docs/installationprocedure/references.rst
index 467bf08d..69ca4e7b 100644
--- a/docs/installationprocedure/references.rst
+++ b/docs/installationprocedure/references.rst
@@ -14,10 +14,12 @@ OPNFV
`OPNFV Compass4nfv project page <https://wiki.opnfv.org/compass4nfv>`_
+`OPNFV Compass4nfv release notes <http://artifacts.opnfv.org/compass4nfv/colorado/docs/release-notes/index.html>`_
+
OpenStack
---------
-`OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+`OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
`OpenStack documentation <http://docs.openstack.org>`_
diff --git a/docs/release-notes/index.rst b/docs/releasenotes/index.rst
index 763280a5..e10b8372 100644
--- a/docs/release-notes/index.rst
+++ b/docs/releasenotes/index.rst
@@ -1,15 +1,13 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
.. http://creativecommons.org/licenses/by/4.0
-============================================
-OPNFV((Colorado) Compass4nfv Release Notes
-============================================
-
-Contents:
+=========================================
+OPNFV Colorado: Compass4nfv Release Notes
+=========================================
.. toctree::
:numbered:
- :maxdepth: 4
+ :maxdepth: 3
release-notes.rst
diff --git a/docs/release-notes/release-notes.rst b/docs/releasenotes/release-notes.rst
index fa8b5f0c..ff8ec500 100644
--- a/docs/release-notes/release-notes.rst
+++ b/docs/releasenotes/release-notes.rst
@@ -2,10 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
-=============================================================================================
-Release Note for the Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool
-=============================================================================================
-
+Release Note for the Colorado release of OPNFV when using Compass4nfv as a deployment tool.
Abstract
========
@@ -34,7 +31,7 @@ Release Data
| **Release designation** | Colorado.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | 2016.2.25 |
+| **Release date** | September 22 2016 |
| | |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery** | OPNFV Colorado release |
@@ -65,21 +62,21 @@ Version change
Module version change
~~~~~~~~~~~~~~~~~~~~~
-This is the first release of compass4nfv as a deployment toolchain in OPNFV, the following
+This is the Colorado release of compass4nfv as a deployment toolchain in OPNFV, the following
upstream components supported with this release.
- Ubuntu 14.04.3
- - Openstack (Liberty release)
+ - Openstack (Mitaka release)
- - Opendaylight (Beryllium rc1 release)
+ - Opendaylight (Beryllium SR2 release)
- - ONOS (Emu release)
+ - ONOS (Goldeneye release)
Document version change
~~~~~~~~~~~~~~~~~~~~~~~
-None due to first release, and you can see document :ref:`document-label`.
+Adjusted the document structure, and you can see document at `OPNFV(Colorado) Compass4nfv installation instructions <http://artifacts.opnfv.org/compass4nfv/docs/configguide/index.html>`_.
Reason for new version
----------------------
@@ -91,13 +88,13 @@ Feature additions
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+-----------------------------------------+
-| JIRA: COMPASS-34 | Support OpenStack Liberty deployment |
+| JIRA: COMPASS-438 | Add A Task Of ONOS-SFC |
| | |
+--------------------------------------+-----------------------------------------+
-| JIRA: COMPASS-307 | Integration OpenDaylight Beryllium |
+| JIRA: COMPASS-443 | Add MOON in Compass |
| | |
+--------------------------------------+-----------------------------------------+
-| | |
+| JIRA: COMPASS-444 | Add Xenial-mitaka ODL Support |
| | |
+--------------------------------------+-----------------------------------------+
@@ -111,7 +108,7 @@ Bug corrections
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| JIRA: | |
+| JIRA: COMPASS-459 | PXE boot may have NO SIGNAL |
| | |
+--------------------------------------+--------------------------------------+
@@ -122,9 +119,27 @@ Known Limitations, Issues and Workarounds
System Limitations
------------------
+**Max number of blades:** 1 Jumphost, 3 Controllers, 20 Compute blades
+
+**Min number of blades:** 1 Jumphost, 1 Controller, 1 Compute blade
+
+**Storage:** Ceph is the only supported storage configuration
+
+**Min Jumphost requirements:** At least 16GB of RAM, 16 core CPU
+
Known issues
------------
++---------------+----------------------------------------------+
+| **Scenario** | **Issue** |
++---------------+----------------------------------------------+
+| MOON | First ODL test FAILS because ODL/Openstack |
+| | federation done in moon is partial. Only |
+| | MD-SAL is federated (not AD-SAL) |
++---------------+----------------------------------------------+
+| | |
++---------------+----------------------------------------------+
+
**JIRA TICKETS:**
+--------------------------------------+--------------------------------------+
@@ -138,17 +153,12 @@ Known issues
Workarounds
-----------
-See JIRA: <link>
+`See JIRA <https://jira.opnfv.org/issues/?jql=project%20%3D%20COMPASS%20AND%20labels%20%3D%20C-1.0-Workaround>`_
Test Result
===========
-The Brahmaputra release with the Compass4nfv deployment toolchain has undergone QA test
+The Colorado release with the Compass4nfv deployment toolchain has undergone QA test
runs with the following results:
- - `Functest test result <http://artifacts.opnfv.org/functest/docs/results/overview.html>`_
- - `Yardstick test result <http://testresults.opnfv.org/grafana/>`_
-
-References
-==========
-For more information on the OPNFV Brahmaputra release, please visit
-http://www.opnfv.org/brahmaputra
+ - `Functest test result <http://testresults.opnfv.org/reporting/functest/release/colorado/index-status-compass.html>`_
+ - `Yardstick test result <http://testresults.opnfv.org/reporting/yardstick/release/colorado/index-status-compass.html>`_