2de73c24abc2d0723e384a84c1f7bec4ea6dac80
[joid.git] / docs / release / scenarios / os-nosdn-lxd-ha / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) <optionally add copywriters name>
4
5
6 Abstract
7 ========
8
9 This document compiles the release notes for the Danube release of
10 OPNFV when using JOID as a deployment tool with LXD container hypervisor.
11
12 Introduction
13 ============
14
15 These notes provides release information for the use of joid as deployment
16 tool for the Danube release of OPNFV with LXD hypervisor for containers
17 scenario.
18
19 The goal of the Danube release and this JOID based deployment process is
20 to establish a lab ready platform accelerating further development
21 of the OPNFV infrastructure.
22
23 Carefully follow the installation-instructions which guides a user to deploy
24 OPNFV using JOID which is based on MAAS and Juju.
25
26 Summary
27 =======
28
29     LXD is a lightweight container hypervisor for full system containers,
30 unlike Docker and Rocket which is for application containers. This means that
31 the container will look and feel like a regular VM – but will act like a
32 container. LXD uses the same container technology found in the Linux kernel
33 (cgroups, namespaces, LSM, etc).
34
35 Danube release with the JOID deployment with LXD hypervisor will establish an
36 OPNFV target system on a Pharos compliant lab infrastructure.
37 The current definition of an OPNFV target system is and OpenStack Newton combined
38 with LXD Hypervisor.
39
40     The system is deployed with OpenStack High Availability (HA) for most OpenStack services.
41
42     User has following choices to make to do the deployment.
43
44     - Openstack      -- Newton
45     - Type           -- HA, nonHA, tip (stable git branch of respective openstack)
46     - Feature        -- LXD (container hypervisor)
47
48 NOTE: Detailed information on how to install in your lab can be find in installation guide
49 command to deploy lxd feature is:
50
51 #LXD deployment with HA Openstack
52 ./deploy.sh -o newton -f lxd -t ha -l custom -s nosdn
53
54 #LXD deployment with no HA Openstack
55 ./deploy.sh -o newton -f lxd -t nonha -l custom -s nosdn
56
57 Using LXD with Openstack
58 ========================
59
60 Once you have finished installinf the JOID with LXD container hypervisor you can use the
61 following to uplod your lxd image to the glance server that LXD can use.
62 In order to do that you simply have to do the following:
63
64 wget -O xenial-server-cloudimg-amd64-root.tar.gz \
65 https://cloud-images.ubuntu.com/xenial/current/xenial-server-cloudimg-amd64-root.tar.gz
66
67 glance image-create --name="Xenial LXC x86_64" --visibility=public --container-format=bare \
68 --disk-format=root-tar --property architecture="x86_64" xenial-server-cloudimg-amd64-root.tar.gz
69
70 After you upload the image to glance then you will be ready to go. If you have any questions
71 please don’t hesitate to ask on the LXC mailing, #lxcontainers IRC channel on freenode
72
73
74 Release Data
75 ============
76
77 +--------------------------------------+--------------------------------------+
78 | **Project**                          | JOID                                 |
79 |                                      |                                      |
80 +--------------------------------------+--------------------------------------+
81 | **Repo/tag**                         | gerrit.opnfv.org/gerrit/joid.git     |
82 |                                      | stable/danube                        |
83 +--------------------------------------+--------------------------------------+
84 | **Release designation**              | Danube release                       |
85 |                                      |                                      |
86 +--------------------------------------+--------------------------------------+
87 | **Release date**                     | April 01 2017                        |
88 |                                      |                                      |
89 +--------------------------------------+--------------------------------------+
90 | **Purpose of the delivery**          | Danube release                       |
91 |                                      |                                      |
92 +--------------------------------------+--------------------------------------+
93
94 Deliverables
95 ------------
96
97 Software deliverables
98 ~~~~~~~~~~~~~~~~~~~~~
99 `JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=summary>`_
100
101 Known Limitations, Issues and Workarounds
102 =========================================
103
104 Known issues
105 ------------
106
107 **JIRA TICKETS:**
108
109 +--------------------------------------+--------------------------------------+
110 | **JIRA REFERENCE**                   | **SLOGAN**                           |
111 |                                      |                                      |
112 +--------------------------------------+--------------------------------------+
113 | JIRA: YARDSTICK-325                  | Provide raw format yardstick vm image|
114 |                                      | for nova-lxd scenario(OPNFV)         |
115 +--------------------------------------+--------------------------------------+
116 | JIRA:                                |                                      |
117 +--------------------------------------+--------------------------------------+
118
119
120 Scenario Releases
121 =================
122 Name:      joid-os-nosdn-lxd-ha
123 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-ha-baremetal-daily-danube/
124 Notes:
125
126 Name:      joid-os-nosdn-lxd-noha
127 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-danube/
128 Notes:
129
130 References
131 ==========
132 LXD
133 ---
134 - `JUJU LXD charm <https://jujucharms.com/lxd/xenial/2>`_
135 - `LXD hypervisor <https://help.ubuntu.com/lts/serverguide/lxd.html>`_
136 - `LXD Story <http://insights.ubuntu.com/2016/03/14/the-lxd-2-0-story-prologue/>`_
137
138 Juju
139 ----
140 - `Juju Charm store <https://jujucharms.com/>`_
141 - `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_
142
143 MAAS
144 ----
145 - `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_
146 - `MAAS API documents <http://maas.ubuntu.com/docs/>`_
147
148 JOID
149 ----
150 - `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_
151 - `OPNFV JOID Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_
152
153 OpenStack
154 ---------
155 - `OpenStack Newton Release artifacts <http://www.openstack.org/software/newton>`_
156 - `OpenStack documentation <http://docs.openstack.org>`_
157