Added documention for LXD scenarios. 41/22241/1
authorNarinder Gupta <narinder.gupta@canonical.com>
Wed, 21 Sep 2016 15:35:26 +0000 (10:35 -0500)
committerNarinder Gupta <narinder.gupta@canonical.com>
Wed, 21 Sep 2016 15:59:49 +0000 (15:59 +0000)
Change-Id: I3633e980103633e3079c52b411b70165a3ff74b0
Signed-off-by: Narinder Gupta <narinder.gupta@canonical.com>
(cherry picked from commit 4e0cd86da483138d11bd92846bf73a25a0f61571)

docs/installationprocedure/installationprocedure.rst
docs/scenarios/os-nosdn-lxd-ha/index.rst [new file with mode: 0644]
docs/scenarios/os-nosdn-lxd-ha/release-notes.rst [new file with mode: 0644]
docs/scenarios/os-nosdn-lxd-noha/index.rst [new file with mode: 0644]
docs/scenarios/os-nosdn-lxd-noha/release-notes.rst [new file with mode: 0644]

index 68a1595..c4c8046 100644 (file)
@@ -107,9 +107,6 @@ If enabling first time then follow it further.
 - copy labconfig.yaml from pod6 to pod7
 *cp joid/labconfig/intel/pod5/\* joid/labconfig/intel/pod7/*
 
 - copy labconfig.yaml from pod6 to pod7
 *cp joid/labconfig/intel/pod5/\* joid/labconfig/intel/pod7/*
 
-4 files will get copied: 
-labconfig.yaml
-
 labconfig.yaml file
 ===================
 
 labconfig.yaml file
 ===================
 
@@ -225,8 +222,8 @@ opnfv:
       ipaddress: 10.2.117.92
       vlan:*
 
       ipaddress: 10.2.117.92
       vlan:*
 
-NOTE: If you are using VLAN tagged network then make sure you modify the case $1 section under Enable vlan interface with maas appropriately. 
+NOTE: If you are using VLAN tagged network then make sure you modify the case $1 section under Enable vlan interface with maas appropriately.
+
 *'intelpod7' )
     maas refresh
     enableautomodebyname eth2 AUTO "10.4.9.0/24" compute || true
 *'intelpod7' )
     maas refresh
     enableautomodebyname eth2 AUTO "10.4.9.0/24" compute || true
@@ -271,7 +268,7 @@ Mode of Openstack deployed.
   [-t <nonha|ha|tip>]
   nonha: NO HA mode of Openstack
   ha: HA mode of openstack.
   [-t <nonha|ha|tip>]
   nonha: NO HA mode of Openstack
   ha: HA mode of openstack.
-  
+
 Wihch version of Openstack deployed.
   [-o <liberty|Mitaka>]
   liberty: Liberty version of openstack.
 Wihch version of Openstack deployed.
   [-o <liberty|Mitaka>]
   liberty: Liberty version of openstack.
@@ -302,13 +299,13 @@ OPNFV Scenarios in JOID
 Following OPNFV scenarios can be deployed using JOID. Seperate yaml bundle will be created to deploy the individual scenario.
 
 Scenario                Owner          Known Issues
 Following OPNFV scenarios can be deployed using JOID. Seperate yaml bundle will be created to deploy the individual scenario.
 
 Scenario                Owner          Known Issues
-os-nosdn-nofeature-ha   Joid    
-os-nosdn-nofeature-noha         Joid    
-os-odl_l2-nofeature-ha  Joid    
+os-nosdn-nofeature-ha   Joid
+os-nosdn-nofeature-noha         Joid
+os-odl_l2-nofeature-ha  Joid
 os-nosdn-lxd-ha          Joid           Yardstick team is working to support.
 os-nosdn-lxd-noha        Joid           Yardstick team is working to support.
 os-nosdn-lxd-ha          Joid           Yardstick team is working to support.
 os-nosdn-lxd-noha        Joid           Yardstick team is working to support.
-os-onos-nofeature-ha    ONOSFW  
-os-onos-sfc-ha          ONOSFW  
+os-onos-nofeature-ha    ONOSFW
+os-onos-sfc-ha          ONOSFW
 
 ------------
 Troubleshoot
 
 ------------
 Troubleshoot
diff --git a/docs/scenarios/os-nosdn-lxd-ha/index.rst b/docs/scenarios/os-nosdn-lxd-ha/index.rst
new file mode 100644 (file)
index 0000000..8180fbb
--- /dev/null
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+======================
+JOID LXD Release Notes
+======================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   release-notes.rst
+
diff --git a/docs/scenarios/os-nosdn-lxd-ha/release-notes.rst b/docs/scenarios/os-nosdn-lxd-ha/release-notes.rst
new file mode 100644 (file)
index 0000000..780804f
--- /dev/null
@@ -0,0 +1,159 @@
+.. 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>
+
+
+Abstract
+========
+
+This document compiles the release notes for the Colorado release of
+OPNFV when using JOID as a deployment tool with LXD container hypervisor.
+
+Introduction
+============
+
+These notes provides release information for the use of joid as deployment
+tool for the Colorado release of OPNFV with LXD hypervisor for containers
+scenario.
+
+The goal of the Colorado release and this JOID based deployment process is
+to establish a lab ready platform accelerating further development
+of the OPNFV infrastructure.
+
+Carefully follow the installation-instructions which guides a user to deploy
+OPNFV using JOID which is based on MAAS and Juju.
+
+Summary
+=======
+
+    LXD is a lightweight container hypervisor for full system containers,
+unlike Docker and Rocket which is for application containers. This means that
+the container will look and feel like a regular VM – but will act like a
+container. LXD uses the same container technology found in the Linux kernel
+(cgroups, namespaces, LSM, etc).
+
+Colorado release with the JOID deployment with LXD hypervisor will establish an
+OPNFV target system on a Pharos compliant lab infrastructure.
+The current definition of an OPNFV target system is and OpenStack Mitaka combined
+with LXD Hypervisor.
+
+    The system is deployed with OpenStack High Availability (HA) for most OpenStack services.
+
+    User has following choices to make to do the deployment.
+
+    - Openstack      -- Mitaka
+    - Type           -- HA, nonHA, tip (stable git branch of respective openstack)
+    - Feature        -- LXD (container hypervisor)
+
+NOTE: Detailed information on how to install in your lab can be find in installation guide
+command to deploy lxd feature is:
+
+#LXD deployment with HA Openstack
+./deploy.sh -o mitaka -f lxd -t ha -l custom -s nosdn
+
+#LXD deployment with no HA Openstack
+./deploy.sh -o mitaka -f lxd -t nonha -l custom -s nosdn
+
+Using LXD with Openstack
+========================
+
+Once you have finished installinf the JOID with LXD container hypervisor you can use the
+following to uplod your lxd image to the glance server that LXD can use.
+In order to do that you simply have to do the following:
+
+wget -O xenial-server-cloudimg-amd64-root.tar.gz \
+https://cloud-images.ubuntu.com/xenial/current/xenial-server-cloudimg-amd64-root.tar.gz
+
+glance image-create --name="Xenial LXC x86_64" --visibility=public --container-format=bare \
+--disk-format=root-tar --property architecture="x86_64" xenial-server-cloudimg-amd64-root.tar.gz
+
+After you upload the image to glance then you will be ready to go. If you have any questions
+please don’t hesitate to ask on the LXC mailing, #lxcontainers IRC channel on freenode
+
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | JOID                                 |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/tag**                         | gerrit.opnfv.org/gerrit/joid.git     |
+|                                      | stable/colorado                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | Colorado release                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | September 22 2016                    |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | Colorado release                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Deliverables
+------------
+
+Software deliverables
+~~~~~~~~~~~~~~~~~~~~~
+`JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=summary>`_
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+Known issues
+------------
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| JIRA: YARDSTICK-325                  | Provide raw format yardstick vm image|
+|                                      | for nova-lxd scenario(OPNFV)         |
++--------------------------------------+--------------------------------------+
+| JIRA:                                |                                      |
++--------------------------------------+--------------------------------------+
+
+
+Scenario Releases
+=================
+Name:      joid-os-nosdn-lxd-ha
+Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-ha-baremetal-daily-colorado/
+Notes:
+
+Name:      joid-os-nosdn-lxd-noha
+Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-colorado/
+Notes:
+
+References
+==========
+LXD
+---
+- `JUJU LXD charm <https://jujucharms.com/lxd/xenial/2>`_
+- `LXD hypervisor <https://help.ubuntu.com/lts/serverguide/lxd.html>`_
+- `LXD Story <http://insights.ubuntu.com/2016/03/14/the-lxd-2-0-story-prologue/>`_
+
+Juju
+----
+- `Juju Charm store <https://jujucharms.com/>`_
+- `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_
+
+MAAS
+----
+- `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_
+- `MAAS API documents <http://maas.ubuntu.com/docs/>`_
+
+JOID
+----
+- `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_
+- `OPNFV JOID User Guide <https://wiki.opnfv.org/joid/b_userguide>`_
+- `OPNFV Release Notes <https://wiki.opnfv.org/display/joid/Colorado+Release+Notes>`_
+- `OPNFV JOID Install Guide <https://wiki.opnfv.org/display/joid/Colorado+installation+Guide>`_
+
+OpenStack
+---------
+- `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
+- `OpenStack documentation <http://docs.openstack.org>`_
+
diff --git a/docs/scenarios/os-nosdn-lxd-noha/index.rst b/docs/scenarios/os-nosdn-lxd-noha/index.rst
new file mode 100644 (file)
index 0000000..8180fbb
--- /dev/null
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+======================
+JOID LXD Release Notes
+======================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   release-notes.rst
+
diff --git a/docs/scenarios/os-nosdn-lxd-noha/release-notes.rst b/docs/scenarios/os-nosdn-lxd-noha/release-notes.rst
new file mode 100644 (file)
index 0000000..780804f
--- /dev/null
@@ -0,0 +1,159 @@
+.. 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>
+
+
+Abstract
+========
+
+This document compiles the release notes for the Colorado release of
+OPNFV when using JOID as a deployment tool with LXD container hypervisor.
+
+Introduction
+============
+
+These notes provides release information for the use of joid as deployment
+tool for the Colorado release of OPNFV with LXD hypervisor for containers
+scenario.
+
+The goal of the Colorado release and this JOID based deployment process is
+to establish a lab ready platform accelerating further development
+of the OPNFV infrastructure.
+
+Carefully follow the installation-instructions which guides a user to deploy
+OPNFV using JOID which is based on MAAS and Juju.
+
+Summary
+=======
+
+    LXD is a lightweight container hypervisor for full system containers,
+unlike Docker and Rocket which is for application containers. This means that
+the container will look and feel like a regular VM – but will act like a
+container. LXD uses the same container technology found in the Linux kernel
+(cgroups, namespaces, LSM, etc).
+
+Colorado release with the JOID deployment with LXD hypervisor will establish an
+OPNFV target system on a Pharos compliant lab infrastructure.
+The current definition of an OPNFV target system is and OpenStack Mitaka combined
+with LXD Hypervisor.
+
+    The system is deployed with OpenStack High Availability (HA) for most OpenStack services.
+
+    User has following choices to make to do the deployment.
+
+    - Openstack      -- Mitaka
+    - Type           -- HA, nonHA, tip (stable git branch of respective openstack)
+    - Feature        -- LXD (container hypervisor)
+
+NOTE: Detailed information on how to install in your lab can be find in installation guide
+command to deploy lxd feature is:
+
+#LXD deployment with HA Openstack
+./deploy.sh -o mitaka -f lxd -t ha -l custom -s nosdn
+
+#LXD deployment with no HA Openstack
+./deploy.sh -o mitaka -f lxd -t nonha -l custom -s nosdn
+
+Using LXD with Openstack
+========================
+
+Once you have finished installinf the JOID with LXD container hypervisor you can use the
+following to uplod your lxd image to the glance server that LXD can use.
+In order to do that you simply have to do the following:
+
+wget -O xenial-server-cloudimg-amd64-root.tar.gz \
+https://cloud-images.ubuntu.com/xenial/current/xenial-server-cloudimg-amd64-root.tar.gz
+
+glance image-create --name="Xenial LXC x86_64" --visibility=public --container-format=bare \
+--disk-format=root-tar --property architecture="x86_64" xenial-server-cloudimg-amd64-root.tar.gz
+
+After you upload the image to glance then you will be ready to go. If you have any questions
+please don’t hesitate to ask on the LXC mailing, #lxcontainers IRC channel on freenode
+
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | JOID                                 |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/tag**                         | gerrit.opnfv.org/gerrit/joid.git     |
+|                                      | stable/colorado                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | Colorado release                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | September 22 2016                    |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | Colorado release                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Deliverables
+------------
+
+Software deliverables
+~~~~~~~~~~~~~~~~~~~~~
+`JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=summary>`_
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+Known issues
+------------
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| JIRA: YARDSTICK-325                  | Provide raw format yardstick vm image|
+|                                      | for nova-lxd scenario(OPNFV)         |
++--------------------------------------+--------------------------------------+
+| JIRA:                                |                                      |
++--------------------------------------+--------------------------------------+
+
+
+Scenario Releases
+=================
+Name:      joid-os-nosdn-lxd-ha
+Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-ha-baremetal-daily-colorado/
+Notes:
+
+Name:      joid-os-nosdn-lxd-noha
+Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-colorado/
+Notes:
+
+References
+==========
+LXD
+---
+- `JUJU LXD charm <https://jujucharms.com/lxd/xenial/2>`_
+- `LXD hypervisor <https://help.ubuntu.com/lts/serverguide/lxd.html>`_
+- `LXD Story <http://insights.ubuntu.com/2016/03/14/the-lxd-2-0-story-prologue/>`_
+
+Juju
+----
+- `Juju Charm store <https://jujucharms.com/>`_
+- `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_
+
+MAAS
+----
+- `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_
+- `MAAS API documents <http://maas.ubuntu.com/docs/>`_
+
+JOID
+----
+- `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_
+- `OPNFV JOID User Guide <https://wiki.opnfv.org/joid/b_userguide>`_
+- `OPNFV Release Notes <https://wiki.opnfv.org/display/joid/Colorado+Release+Notes>`_
+- `OPNFV JOID Install Guide <https://wiki.opnfv.org/display/joid/Colorado+installation+Guide>`_
+
+OpenStack
+---------
+- `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
+- `OpenStack documentation <http://docs.openstack.org>`_
+