diff options
author | Narinder Gupta <narinder.gupta@canonical.com> | 2017-03-30 10:13:51 -0500 |
---|---|---|
committer | Narinder Gupta <narinder.gupta@canonical.com> | 2017-03-30 10:25:00 -0500 |
commit | afb9fa5913b63e8814365dadec249e12f0463e88 (patch) | |
tree | 22419957e8c914f64994803881752ccf0f4b1e41 /docs/release/scenarios | |
parent | 36a495e8d20149811d13f6ba944ecc30a393aed4 (diff) |
adding new scenraio documentation and updated the current one.
Change-Id: If5a7f2d2ffffd87cad4e4003ade01071b2ccd677
Signed-off-by: Narinder Gupta <narinder.gupta@canonical.com>
Diffstat (limited to 'docs/release/scenarios')
10 files changed, 728 insertions, 36 deletions
diff --git a/docs/release/scenarios/k8-nosdn-lb-noha/index.rst b/docs/release/scenarios/k8-nosdn-lb-noha/index.rst new file mode 100644 index 00000000..548a0bb0 --- /dev/null +++ b/docs/release/scenarios/k8-nosdn-lb-noha/index.rst @@ -0,0 +1,16 @@ +.. _k8-nosdn-lb-noha: + +.. 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 Kubernetes Release Notes +============================= + +.. toctree:: + :numbered: + :maxdepth: 4 + + release-notes.rst + diff --git a/docs/release/scenarios/k8-nosdn-lb-noha/release-notes.rst b/docs/release/scenarios/k8-nosdn-lb-noha/release-notes.rst new file mode 100644 index 00000000..a5ebd32d --- /dev/null +++ b/docs/release/scenarios/k8-nosdn-lb-noha/release-notes.rst @@ -0,0 +1,175 @@ +.. 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 Danube release of +OPNFV when using JOID as a deployment tool for Kubernets and load balancer. + +Introduction +============ + +These notes provides release information for the use of joid as deployment +tool for the Danube release of OPNFV for Kubernets and load balancer +scenario. + +The goal of the Danube release and this JOID based deployment process is +to establish a lab ready platform accelerating further development +of the OPNFV infrastructure for docker based workloads. + +Carefully follow the installation-instructions which guides a user to deploy +OPNFV using JOID which is based on MAAS and Juju. + +Summary +======= + +Kubernetes is an open-source system for automating deployment, scaling, and +management of containerized applications. + +This is a Kubernetes cluster that includes logging, monitoring, and operational +knowledge. It is comprised of the following components and features: + +Kubernetes (automated deployment, operations, and scaling) + TLS used for communication between nodes for security. + A CNI plugin (e.g., Flannel) + A load balancer for HA kubernetes-master (Experimental) + Optional Ingress Controller (on worker) + Optional Dashboard addon (on master) including Heapster for cluster monitoring + +EasyRSA + Performs the role of a certificate authority serving self signed certificates + to the requesting units of the cluster. + +Etcd (distributed key value store) + Minimum Three node cluster for reliability. + +Danube release with the JOID deployment with Kubernetes with load balancer will establish an +OPNFV target system on a Pharos compliant lab infrastructure. + +NOTE: Detailed information on how to install in your lab can be find in installation guide +command to deploy load balancer feature is: + +#Kubernetes deployment with Load Balancer +./deploy.sh -m kubernetes -f lb -l custom -s nosdn + +Using Kubernetes after Deployment +================================= + +Once you have finished installinf the JOID with Kubernetes with load balancer you can use the +following command to test the deployment. + +To deploy 5 replicas of the microbot web application inside the Kubernetes +cluster run the following command: + +juju run-action kubernetes-worker/0 microbot replicas=5 + +This action performs the following steps: + +It creates a deployment titled 'microbots' comprised of 5 replicas defined +during the run of the action. It also creates a service named 'microbots' +which binds an 'endpoint', using all 5 of the 'microbots' pods. +Finally, it will create an ingress resource, which points at a +xip.io domain to simulate a proper DNS service. + +Running the packaged example + +You can run a Juju action to create an example microbot web application: + +$ juju run-action kubernetes-worker/0 microbot replicas=3 +Action queued with id: db7cc72b-5f35-4a4d-877c-284c4b776eb8 + +$ juju show-action-output db7cc72b-5f35-4a4d-877c-284c4b776eb8 +results: + address: microbot.104.198.77.197.xip.io +status: completed +timing: + completed: 2016-09-26 20:42:42 +0000 UTC + enqueued: 2016-09-26 20:42:39 +0000 UTC + started: 2016-09-26 20:42:41 +0000 UTC +Note: Your FQDN will be different and contain the address of the cloud +instance. +At this point, you can inspect the cluster to observe the workload coming +online. + +Mor einformation on using Canonical distribution of kubernetes can be found +at https://jujucharms.com/canonical-kubernetes/ + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | JOID | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git | +| | stable/danube | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Danube release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | March 31 2017 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Danube release | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +------------ + +Software deliverables +~~~~~~~~~~~~~~~~~~~~~ +`JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git>`_ + +Known Limitations, Issues and Workarounds +========================================= + +Known issues +------------ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | No support for yardstick and functest| +| | for Kubernetes scenarios (OPNFV) | ++--------------------------------------+--------------------------------------+ +| JIRA: | | ++--------------------------------------+--------------------------------------+ + + +Scenario Releases +================= +Name: joid-k8-nosdn-lb-noha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-k8-nosdn-lb-noha-baremetal-daily-danube/ +Notes: + +References +========== + +Juju +---- +- `Juju Charm store <https://jujucharms.com/>`_ +- `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_ +- `Canonical Distibuytion of Kubernetes <https://jujucharms.com/canonical-kubernetes/>`_ + +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 Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_ + +Kubernetes +---------- +- `Kubernetes Release artifacts <https://get.k8s.io/>`_ +- `Kubernetes documentation <https://kubernetes.io/>`_ + diff --git a/docs/release/scenarios/k8-nosdn-nofeature-noha/index.rst b/docs/release/scenarios/k8-nosdn-nofeature-noha/index.rst new file mode 100644 index 00000000..b94d74f2 --- /dev/null +++ b/docs/release/scenarios/k8-nosdn-nofeature-noha/index.rst @@ -0,0 +1,16 @@ +.. _k8-nosdn-nofeature-noha: + +.. 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 Kubernetes Release Notes +============================= + +.. toctree:: + :numbered: + :maxdepth: 4 + + release-notes.rst + diff --git a/docs/release/scenarios/k8-nosdn-nofeature-noha/release-notes.rst b/docs/release/scenarios/k8-nosdn-nofeature-noha/release-notes.rst new file mode 100644 index 00000000..c9ad4364 --- /dev/null +++ b/docs/release/scenarios/k8-nosdn-nofeature-noha/release-notes.rst @@ -0,0 +1,173 @@ +.. 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 Danube release of +OPNFV when using JOID as a deployment tool for Kubernetes. + +Introduction +============ + +These notes provides release information for the use of joid as deployment +tool for the Danube release of OPNFV for Kubernetes scenario. + +The goal of the Danube release and this JOID based deployment process is +to establish a lab ready platform accelerating further development +of the OPNFV infrastructure for docker based workloads. + +Carefully follow the installation-instructions which guides a user to deploy +OPNFV using JOID which is based on MAAS and Juju. + +Summary +======= + +Kubernetes is an open-source system for automating deployment, scaling, and +management of containerized applications. + +This is a Kubernetes cluster that includes logging, monitoring, and operational +knowledge. It is comprised of the following components and features: + +Kubernetes (automated deployment, operations, and scaling) + TLS used for communication between nodes for security. + A CNI plugin (e.g., Flannel) + Optional Ingress Controller (on worker) + Optional Dashboard addon (on master) including Heapster for cluster monitoring + +EasyRSA + Performs the role of a certificate authority serving self signed certificates + to the requesting units of the cluster. + +Etcd (distributed key value store) + Minimum Three node cluster for reliability. + +Danube release with the JOID deployment with Kubernetes will establish an +OPNFV target system on a Pharos compliant lab infrastructure. + +NOTE: Detailed information on how to install in your lab can be find in installation guide +command to deploy lxd feature is: + +#Kubernetes deployment +./deploy.sh -m kubernetes -f none -l custom -s nosdn + +Using Kubernetes after Deployment +================================= + +Once you have finished installinf the JOID with Kubernetes you can use the +following command to test the deployment. + +To deploy 5 replicas of the microbot web application inside the Kubernetes +cluster run the following command: + +juju run-action kubernetes-worker/0 microbot replicas=5 + +This action performs the following steps: + +It creates a deployment titled 'microbots' comprised of 5 replicas defined +during the run of the action. It also creates a service named 'microbots' +which binds an 'endpoint', using all 5 of the 'microbots' pods. +Finally, it will create an ingress resource, which points at a +xip.io domain to simulate a proper DNS service. + +Running the packaged example + +You can run a Juju action to create an example microbot web application: + +$ juju run-action kubernetes-worker/0 microbot replicas=3 +Action queued with id: db7cc72b-5f35-4a4d-877c-284c4b776eb8 + +$ juju show-action-output db7cc72b-5f35-4a4d-877c-284c4b776eb8 +results: + address: microbot.104.198.77.197.xip.io +status: completed +timing: + completed: 2016-09-26 20:42:42 +0000 UTC + enqueued: 2016-09-26 20:42:39 +0000 UTC + started: 2016-09-26 20:42:41 +0000 UTC +Note: Your FQDN will be different and contain the address of the cloud +instance. +At this point, you can inspect the cluster to observe the workload coming +online. + +Mor einformation on using Canonical distribution of kubernetes can be found +at https://jujucharms.com/canonical-kubernetes/ + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | JOID | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git | +| | stable/danube | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Danube release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | March 31 2017 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Danube release | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +------------ + +Software deliverables +~~~~~~~~~~~~~~~~~~~~~ +`JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git>`_ + +Known Limitations, Issues and Workarounds +========================================= + +Known issues +------------ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | No support for yardstick and functest| +| | for Kubernetes scenarios (OPNFV) | ++--------------------------------------+--------------------------------------+ +| JIRA: | | ++--------------------------------------+--------------------------------------+ + + +Scenario Releases +================= +Name: joid-k8-nosdn-nofeature-noha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-k8-nosdn-nofeature-noha-baremetal-daily-danube/ +Notes: + +References +========== + +Juju +---- +- `Juju Charm store <https://jujucharms.com/>`_ +- `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_ +- `Canonical Distibuytion of Kubernetes <https://jujucharms.com/canonical-kubernetes/>`_ + +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 Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_ + +Kubernetes +---------- +- `Kubernetes Release artifacts <https://get.k8s.io/>`_ +- `Kubernetes documentation <https://kubernetes.io/>`_ + diff --git a/docs/release/scenarios/os-nosdn-lxd-ha/release-notes.rst b/docs/release/scenarios/os-nosdn-lxd-ha/release-notes.rst index 780804f3..2de73c24 100644 --- a/docs/release/scenarios/os-nosdn-lxd-ha/release-notes.rst +++ b/docs/release/scenarios/os-nosdn-lxd-ha/release-notes.rst @@ -6,17 +6,17 @@ Abstract ======== -This document compiles the release notes for the Colorado release of +This document compiles the release notes for the Danube 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 +tool for the Danube release of OPNFV with LXD hypervisor for containers scenario. -The goal of the Colorado release and this JOID based deployment process is +The goal of the Danube release and this JOID based deployment process is to establish a lab ready platform accelerating further development of the OPNFV infrastructure. @@ -32,16 +32,16 @@ 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 +Danube 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 +The current definition of an OPNFV target system is and OpenStack Newton 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 + - Openstack -- Newton - Type -- HA, nonHA, tip (stable git branch of respective openstack) - Feature -- LXD (container hypervisor) @@ -49,10 +49,10 @@ NOTE: Detailed information on how to install in your lab can be find in installa command to deploy lxd feature is: #LXD deployment with HA Openstack -./deploy.sh -o mitaka -f lxd -t ha -l custom -s nosdn +./deploy.sh -o newton -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 +./deploy.sh -o newton -f lxd -t nonha -l custom -s nosdn Using LXD with Openstack ======================== @@ -79,15 +79,15 @@ Release Data | | | +--------------------------------------+--------------------------------------+ | **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git | -| | stable/colorado | +| | stable/danube | +--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado release | +| **Release designation** | Danube release | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | September 22 2016 | +| **Release date** | April 01 2017 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Colorado release | +| **Purpose of the delivery** | Danube release | | | | +--------------------------------------+--------------------------------------+ @@ -120,11 +120,11 @@ Known issues 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/ +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-ha-baremetal-daily-danube/ 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/ +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-danube/ Notes: References @@ -148,12 +148,10 @@ MAAS 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>`_ +- `OPNFV JOID Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_ OpenStack --------- -- `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ +- `OpenStack Newton Release artifacts <http://www.openstack.org/software/newton>`_ - `OpenStack documentation <http://docs.openstack.org>`_ diff --git a/docs/release/scenarios/os-nosdn-lxd-noha/release-notes.rst b/docs/release/scenarios/os-nosdn-lxd-noha/release-notes.rst index 780804f3..2de73c24 100644 --- a/docs/release/scenarios/os-nosdn-lxd-noha/release-notes.rst +++ b/docs/release/scenarios/os-nosdn-lxd-noha/release-notes.rst @@ -6,17 +6,17 @@ Abstract ======== -This document compiles the release notes for the Colorado release of +This document compiles the release notes for the Danube 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 +tool for the Danube release of OPNFV with LXD hypervisor for containers scenario. -The goal of the Colorado release and this JOID based deployment process is +The goal of the Danube release and this JOID based deployment process is to establish a lab ready platform accelerating further development of the OPNFV infrastructure. @@ -32,16 +32,16 @@ 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 +Danube 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 +The current definition of an OPNFV target system is and OpenStack Newton 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 + - Openstack -- Newton - Type -- HA, nonHA, tip (stable git branch of respective openstack) - Feature -- LXD (container hypervisor) @@ -49,10 +49,10 @@ NOTE: Detailed information on how to install in your lab can be find in installa command to deploy lxd feature is: #LXD deployment with HA Openstack -./deploy.sh -o mitaka -f lxd -t ha -l custom -s nosdn +./deploy.sh -o newton -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 +./deploy.sh -o newton -f lxd -t nonha -l custom -s nosdn Using LXD with Openstack ======================== @@ -79,15 +79,15 @@ Release Data | | | +--------------------------------------+--------------------------------------+ | **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git | -| | stable/colorado | +| | stable/danube | +--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado release | +| **Release designation** | Danube release | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | September 22 2016 | +| **Release date** | April 01 2017 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Colorado release | +| **Purpose of the delivery** | Danube release | | | | +--------------------------------------+--------------------------------------+ @@ -120,11 +120,11 @@ Known issues 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/ +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-ha-baremetal-daily-danube/ 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/ +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-danube/ Notes: References @@ -148,12 +148,10 @@ MAAS 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>`_ +- `OPNFV JOID Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_ OpenStack --------- -- `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ +- `OpenStack Newton Release artifacts <http://www.openstack.org/software/newton>`_ - `OpenStack documentation <http://docs.openstack.org>`_ diff --git a/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst b/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst new file mode 100644 index 00000000..a77df392 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst @@ -0,0 +1,16 @@ +.. _os-nosdn-nofeature-ha: + +.. 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/release/scenarios/os-nosdn-nofeature-ha/release-notes.rst b/docs/release/scenarios/os-nosdn-nofeature-ha/release-notes.rst new file mode 100644 index 00000000..1b520ff9 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-nofeature-ha/release-notes.rst @@ -0,0 +1,142 @@ +.. 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 Danube release of +OPNFV when using JOID as a deployment tool with KVM hypervisor. + +Introduction +============ + +These notes provides release information for the use of joid as deployment +tool for the Danube release of OPNFV with KVM hypervisor for containers +scenario. + +The goal of the Danube 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 +======= + + KVM (for Kernel-based Virtual Machine) is a full virtualization solution +for Linux on x86 hardware containing virtualization extensions (Intel VT or AMD-V). +It consists of a loadable kernel module, kvm.ko, that provides the core +virtualization infrastructure and a processor specific module, kvm-intel.ko or kvm-amd.ko. + +Danube release with the JOID deployment with KVM hypervisor will establish an +OPNFV target system on a Pharos compliant lab infrastructure. + +The current definition of an OPNFV target system is and OpenStack Newton. + + The system is deployed with OpenStack High Availability (HA) for most OpenStack services. + + User has following choices to make to do the deployment. + + - Openstack -- Newton + - Type -- HA, nonHA, tip (stable git branch of respective openstack) + - Feature -- KVM (hypervisor) + +NOTE: Detailed information on how to install in your lab can be find in installation guide +command to deploy lxd feature is: + +#KVM deployment with HA Openstack +./deploy.sh -o newton -f none -t ha -l custom -s nosdn + +#LXD deployment with no HA Openstack +./deploy.sh -o newton -f none -t nonha -l custom -s nosdn + +Using Openstack +=============== + +admin-openrc file have been placed under ~/joid_config/ +Please source the same and use OpenStack API to do rest of the configuration. + + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | JOID | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git | +| | stable/danube | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Danube release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | April 01 2017 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Danube 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: | | ++--------------------------------------+--------------------------------------+ + + +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-danube/ +Notes: + +Name: joid-os-nosdn-lxd-noha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-danube/ +Notes: + +References +========== +KVM +--- +- `JUJU Openstack charm <https://jujucharms.com/openstack-telemetry/>`_ +- `KVM hypervisor <https://help.ubuntu.com/community/KVM/Installation>`_ + +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 Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_ + +OpenStack +--------- +- `OpenStack Newton Release artifacts <http://www.openstack.org/software/newton>`_ +- `OpenStack documentation <http://docs.openstack.org>`_ + diff --git a/docs/release/scenarios/os-nosdn-nofeature-noha/index.rst b/docs/release/scenarios/os-nosdn-nofeature-noha/index.rst new file mode 100644 index 00000000..7f7f65be --- /dev/null +++ b/docs/release/scenarios/os-nosdn-nofeature-noha/index.rst @@ -0,0 +1,16 @@ +.. _os-nosdn-nofeature-noha: + +.. 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/release/scenarios/os-nosdn-nofeature-noha/release-notes.rst b/docs/release/scenarios/os-nosdn-nofeature-noha/release-notes.rst new file mode 100644 index 00000000..1b520ff9 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-nofeature-noha/release-notes.rst @@ -0,0 +1,142 @@ +.. 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 Danube release of +OPNFV when using JOID as a deployment tool with KVM hypervisor. + +Introduction +============ + +These notes provides release information for the use of joid as deployment +tool for the Danube release of OPNFV with KVM hypervisor for containers +scenario. + +The goal of the Danube 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 +======= + + KVM (for Kernel-based Virtual Machine) is a full virtualization solution +for Linux on x86 hardware containing virtualization extensions (Intel VT or AMD-V). +It consists of a loadable kernel module, kvm.ko, that provides the core +virtualization infrastructure and a processor specific module, kvm-intel.ko or kvm-amd.ko. + +Danube release with the JOID deployment with KVM hypervisor will establish an +OPNFV target system on a Pharos compliant lab infrastructure. + +The current definition of an OPNFV target system is and OpenStack Newton. + + The system is deployed with OpenStack High Availability (HA) for most OpenStack services. + + User has following choices to make to do the deployment. + + - Openstack -- Newton + - Type -- HA, nonHA, tip (stable git branch of respective openstack) + - Feature -- KVM (hypervisor) + +NOTE: Detailed information on how to install in your lab can be find in installation guide +command to deploy lxd feature is: + +#KVM deployment with HA Openstack +./deploy.sh -o newton -f none -t ha -l custom -s nosdn + +#LXD deployment with no HA Openstack +./deploy.sh -o newton -f none -t nonha -l custom -s nosdn + +Using Openstack +=============== + +admin-openrc file have been placed under ~/joid_config/ +Please source the same and use OpenStack API to do rest of the configuration. + + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | JOID | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git | +| | stable/danube | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Danube release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | April 01 2017 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Danube 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: | | ++--------------------------------------+--------------------------------------+ + + +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-danube/ +Notes: + +Name: joid-os-nosdn-lxd-noha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-danube/ +Notes: + +References +========== +KVM +--- +- `JUJU Openstack charm <https://jujucharms.com/openstack-telemetry/>`_ +- `KVM hypervisor <https://help.ubuntu.com/community/KVM/Installation>`_ + +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 Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_ + +OpenStack +--------- +- `OpenStack Newton Release artifacts <http://www.openstack.org/software/newton>`_ +- `OpenStack documentation <http://docs.openstack.org>`_ + |