diff options
| -rw-r--r-- | docs/release/configguide/configguide.rst | 30 | ||||
| -rw-r--r-- | docs/release/configguide/installerconfig.rst | 36 | ||||
| -rw-r--r-- | docs/release/installation/appendices.rst | 2 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 93 | ||||
| -rw-r--r-- | docs/release/scenarios/k8-ovn-lb-noha/index.rst | 16 | ||||
| -rw-r--r-- | docs/release/scenarios/k8-ovn-lb-noha/release-notes.rst | 175 | ||||
| -rw-r--r-- | docs/release/userguide/userguide.rst | 4 |
7 files changed, 274 insertions, 82 deletions
diff --git a/docs/release/configguide/configguide.rst b/docs/release/configguide/configguide.rst index ae1c793c..b9c27f34 100644 --- a/docs/release/configguide/configguide.rst +++ b/docs/release/configguide/configguide.rst @@ -1,27 +1,27 @@ JOID Configuration ================== -Scenario 1: ODL L2 ------------------- +Scenario 1: Nosdn +----------------- -*./deploy.sh -o newton -s odl -t ha -l custom -f none -d xenial -m openstack* +*./deploy.sh -o ocata -s nosdn -t ha -l custom -f none -d xenial -m openstack* -Scenario 2: Nosdn ------------------ +Scenario 2: Kubernetes core +--------------------------- -*./deploy.sh -o newton -s nosdn -t ha -l custom -f none -d xenial -m openstack* +*./deploy.sh -l custom -f none -m kubernetes* -Scenario 3: ONOS nofeature --------------------------- +Scenario 3: Kubernetes Load Balancer +------------------------------------ -*./deploy.sh -o newton -s onos -t ha -l custom -f none -d xenial -m openstack* +*./deploy.sh -l custom -f lb -m kubernetes* -Scenario 4: ONOS with SFC ------------------- +Scenario 4: Kubernetes with OVN +------------------------------- -*./deploy.sh -o newton -s onos -t ha -l custom -f none -d xenial -m openstack* +*./deploy.sh -s ovn -l custom -f lb -m kubernetes* -Scenario 5: Kubernetes core ---------------------------- +Scenario 5: Openstack with Opencontrail +--------------------------------------- -*./deploy.sh -l custom -f none -m kubernetes* +*./deploy.sh -o ocata -s ocl -t ha -l custom -f none -d xenial -m openstack* diff --git a/docs/release/configguide/installerconfig.rst b/docs/release/configguide/installerconfig.rst index 94ee56fe..aee4ce25 100644 --- a/docs/release/configguide/installerconfig.rst +++ b/docs/release/configguide/installerconfig.rst @@ -252,29 +252,28 @@ OPNFV Install NOTE: Possible options are as follows: choose which sdn controller to use. - [-s <nosdn|odl|opencontrail|onos>] + [-s|--sdn <nosdn|odl|opencontrail>] nosdn: openvswitch only and no other SDN. odl: OpenDayLight Boron version. opencontrail: OpenContrail SDN. - onos: ONOS framework as SDN. Mode of Openstack deployed. - [-t <noha|ha|tip>] + [-t|--type <noha|ha|tip>] noha: NO HA mode of Openstack ha: HA mode of openstack. Wihch version of Openstack deployed. - [-o <Newton|Mitaka>] + [-o|--openstack <ocata|newton>] + Ocata: Ocata version of openstack. Newton: Newton version of openstack. - Mitaka: Mitaka version of openstack. Where to deploy - [-l <custom | default>] etc... + [-l|--lab <custom | default>] etc... custom: For bare metal deployment where labconfig.yaml provided externally and not part of JOID. default: For virtual deployment where installation will be done on KVM created using 03-maasdeploy.sh what feature to deploy. Comma seperated list - [-f <lxd|dvr|sfc|dpdk|ipv6|none>] + [-f|--feature <lxd|dvr|sfc|dpdk|ipv6|none>] none: no special feature will be enabled. ipv6: ipv6 will be enabled for tenant in openstack. lxd: With this feature hypervisor will be LXD rather than KVM. @@ -283,14 +282,24 @@ what feature to deploy. Comma seperated list sfc: Will enable sfc feature only supported with onos deployment. which Ubuntu distro to use. - [ -d <trusty|xenial> ] + [ -d|--distro <xenial> ] Which model to deploy JOID introduces the various model to deploy apart from openstack for docker based container workloads. -[-m <openstack|kubernetes>] +[-m|--model <openstack|kubernetes>] openstack: Openstack which will be used for KVM/LXD container based workloads. kubernetes: Kubernes model will be used for docker based workloads. +Deploy MAAS or not? +[--maasinstall <0|1>] + 0: Do not deploy MAAS + 1: Deploy MAAS first. + +Lab Config file location +[--labfile <labconfig.yaml file>] + location of the file labconfig.yaml if no valid location then virtual MAAS would be deployed. + + OPNFV Scenarios in JOID Following OPNFV scenarios can be deployed using JOID. Seperate yaml bundle will be created to deploy the individual scenario. @@ -300,10 +309,11 @@ os-nosdn-nofeature-noha Joid os-odl_l2-nofeature-ha Joid Floating ips are not working on this deployment. 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 -k8-nosdn-nofeature-noha Joid No support from Functest and Yardstick -k8-nosdn-lb-noha Joid No support from Functest and Yardstick +os-ocl-nofeature-ha OCL Keystone V2 has been used. +os-ocl-nofeature-noha OCL Keystone V2 has been used. +k8-nosdn-nofeature-noha Joid No support from Functest. +k8-nosdn-lb-noha Joid No support from Functest. +k8-ovn-lb-noha OVN No support from Functest. Is the deployment done successfully? ------------------------------------ diff --git a/docs/release/installation/appendices.rst b/docs/release/installation/appendices.rst index 0746cf8c..441b1753 100644 --- a/docs/release/installation/appendices.rst +++ b/docs/release/installation/appendices.rst @@ -2,7 +2,7 @@ Appendices -========= +========== Appendix A: Single Node Deployment diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index aff95d4b..8a58e612 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -6,16 +6,16 @@ Abstract ======== -This document compiles the release notes for the Danube release of +This document compiles the release notes for the Euphrates release of OPNFV when using JOID as a deployment tool. Introduction ============ These notes provides release information for the use of joid as deployment -tool for the Danube release of OPNFV. +tool for the Euphrates release of OPNFV. -The goal of the Danube release and this JOID based deployment process is +The goal of the Euphrates release and this JOID based deployment process is to establish a lab ready platform accelerating further development of the OPNFV infrastructure. @@ -25,11 +25,11 @@ OPNFV using JOID which is based on MAAS and Juju. Summary ======= -The Danube release with the JOID deployment toolchain will establish an OPNFV target system on a Pharos compliant lab infrastructure. +The Euphrates release with the JOID deployment toolchain will establish an OPNFV target system on a Pharos compliant lab infrastructure. The current definition of an OPNFV target system is and OpenStack Newton combined with OpenDaylight Boron. The system is deployed with OpenStack High Availability (HA) for most OpenStack services. -Ceph storage is used as Cinder backend, and is the only supported storage for Danube. Ceph is setup as 3 OSDs and 3 Monitors, one radosgw. +Ceph storage is used as Cinder backend, and is the only supported storage for Euphrates. Ceph is setup as 3 OSDs and 3 Monitors, one radosgw. User has following choices to make to do the deployment. @@ -54,15 +54,15 @@ Release Data | | | +--------------------------------------+--------------------------------------+ | **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git | -| | stable/danube | +| | stable/euphrates | +--------------------------------------+--------------------------------------+ -| **Release designation** | Denbue release | +| **Release designation** | Euphrates release | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | March 31 2017 | +| **Release date** | October 24 2017 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Danube release | +| **Purpose of the delivery** | Euphrates release | | | | +--------------------------------------+--------------------------------------+ @@ -86,14 +86,14 @@ Version change Module version change ~~~~~~~~~~~~~~~~~~~~~ - - Danube release with the JOID deployment toolchain. - - OpenStack (Newton release) - - OpenDaylight (Boron release) + - Euphrates release with the JOID deployment toolchain. + - OpenStack (Ocata release) + - Kubernetes 1.7 - Ubuntu 16.04 LTS Document version change ~~~~~~~~~~~~~~~~~~~~~~~ -- OPNFV Installation instructions for the Danube release using JOID deployment +- OPNFV Installation instructions for the Euphrates release using JOID deployment toolchain - ver. 1.0.0 - OPNFV Release Notes with the JOID deployment toolchain - ver. 1.0.0 (this document) @@ -108,8 +108,6 @@ Feature additions +--------------------------------------+--------------------------------------+ | JIRA: JOID-1 | use Juju and Ubuntu to deploy OPNFV | +--------------------------------------+--------------------------------------+ -| JIRA: JOID-103 | OpenDaylight Carbon Support | -+--------------------------------------+--------------------------------------+ | JIRA: JOID-100 | MAAS 2.x support | +--------------------------------------+--------------------------------------+ | JIRA: JOID-101 | Juju 2.x support | @@ -118,12 +116,11 @@ Feature additions +--------------------------------------+--------------------------------------+ | JIRA: JOID-106 | Kubernetes on Baremetal | +--------------------------------------+--------------------------------------+ -| JIRA: JOID-108 | integrate load balancer | -| | Kubernetes on Baremetal | +| JIRA: JOID-102 | Enable OpenStack Ocata | +--------------------------------------+--------------------------------------+ -| JIRA: JOID-110 | Enable VM console in Horizon | +| | Enable OpenContrail | +--------------------------------------+--------------------------------------+ -| JIRA: JOID-102 | Enable OpenStack Newton | +| | Enable OVN for Kubernetes | +--------------------------------------+--------------------------------------+ Bug corrections @@ -162,7 +159,7 @@ Known issues +--------------------------------------+--------------------------------------+ | JIRA: | floating ip are not working for ODL. | +--------------------------------------+--------------------------------------+ -| JIRA: | No functest and yardstick support. | +| JIRA: | No functest support for Kubernetes. | +--------------------------------------+--------------------------------------+ @@ -171,54 +168,44 @@ Workarounds See JIRA: <link> -Test Result -=========== -Danube test result using JOID as deployment tool. -- `https://build.opnfv.org/ci/view/joid/job/functest-joid-baremetal-daily-colorado/>`_ -- `https://build.opnfv.org/ci/view/joid/job/yardstick-joid-baremetal-daily-colorado/>`_ - Scenario Releases ================= Name: joid-os-nosdn-nofeature-ha -Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-nofeature-ha-baremetal-daily-colorado/ -Notes: - -Name: joid-os-odl-nofeature-ha -Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-odl_l2-nofeature-ha-baremetal-daily-colorado/ +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-nofeature-ha-baremetal-daily-euphrates/ Notes: 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-euphrates/ Notes: -Name: joid-os-onos-nofeature-ha -Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-onos-nofeature-ha-baremetal-daily-colorado/ +Name: joid-os-nosdn-lxd-noha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-euphrates/ Notes: -Name: joid-os-onos-sfc-ha -Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-onos-sfc-ha-baremetal-daily-colorado/ +Name: joid-os-nosdn-nofeature-noha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-nofeature-noha-baremetal-daily-euphrates/ 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/ +Name: joid-k8-nosdn-lb-noha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-k8-nosdn-lb-noha-baremetal-daily-euphrates/ Notes: -Name: joid-os-nosdn-nofeature-noha -Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-os-nosdn-nofeature-noha-baremetal-daily-colorado/ +Name: joid-k8-ovn-lb-noha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-k8-ovn-lb-noha-baremetal-daily-euphrates/ Notes: -Name: joid-k8-nosdn-nofeature-noha -Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-deploy-baremetal-daily-master/1833/console/ +Name: joid-os-ocl-nofeature-ha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-ocl-nofeature-ha-baremetal-daily-euphrates/ Notes: -Name: joid-k8-nosdn-lb-noha -Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-os-nosdn-nofeature-noha-baremetal-daily-colorado/ +Name: joid-os-ocl-nofeature-noha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-ocl-nofeature-noha-baremetal-daily-euphrates/ Notes: References ========== -For more information on the OPNFV Danube release, please visit -- `OPNFV Danube release <http://www.opnfv.org/danube>`_ +For more information on the OPNFV Euphrates release, please visit +- `OPNFV Euphrates release <http://www.opnfv.org/euphrates>`_ Juju ---- @@ -233,16 +220,22 @@ 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/Danube+Release+Notes>`_ -- `OPNFV JOID Install Guide <https://wiki.opnfv.org/display/joid/Danube+installation+Guide>`_ +- `OPNFV Release Notes <http://docs.opnfv.org/en/stable-danube/submodules/joid/docs/release/release-notes/release-notes.html>`_ +- `OPNFV JOID Install Guide <http://docs.opnfv.org/en/latest/submodules/joid/docs/release/installation/index.html>`_ OpenStack --------- -- `OpenStack Newton Release artifacts <http://www.openstack.org/software/newton>`_ +- `OpenStack Newton Release artifacts <http://www.openstack.org/software/ocata>`_ - `OpenStack documentation <http://docs.openstack.org>`_ OpenDaylight ------------ - `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ +Opencontrail +------------ +- `http://www.opencontrail.org/opencontrail-quick-start-guide/`_ + +Kubernetes +------------ +- `https://kubernetes.io/`_ diff --git a/docs/release/scenarios/k8-ovn-lb-noha/index.rst b/docs/release/scenarios/k8-ovn-lb-noha/index.rst new file mode 100644 index 00000000..548a0bb0 --- /dev/null +++ b/docs/release/scenarios/k8-ovn-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-ovn-lb-noha/release-notes.rst b/docs/release/scenarios/k8-ovn-lb-noha/release-notes.rst new file mode 100644 index 00000000..f4d40308 --- /dev/null +++ b/docs/release/scenarios/k8-ovn-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 Euphrates 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 Euphrates release of OPNFV for Kubernets and load balancer +scenario. + +The goal of the Euphrates 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, Ovn) + 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. + +Euphrates 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/euphrates | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Euphrates release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | March 31 2017 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Euphrates 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 functest for | +| | Kubernetes scenarios (OPNFV) | ++--------------------------------------+--------------------------------------+ +| JIRA: | | ++--------------------------------------+--------------------------------------+ + + +Scenario Releases +================= +Name: joid-k8-ovn-lb-noha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-k8-ovn-lb-noha-baremetal-daily-euphrates/ +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/userguide/userguide.rst b/docs/release/userguide/userguide.rst index 7ef9d631..04bceed8 100644 --- a/docs/release/userguide/userguide.rst +++ b/docs/release/userguide/userguide.rst @@ -1,7 +1,7 @@ Introduction ============ -This document will explain how to install OPNFV Danube with JOID including installing JOID, configuring JOID for your environment, and deploying OPNFV with different SDN solutions in HA, or non-HA mode. Prerequisites include +This document will explain how to install OPNFV Euphrates with JOID including installing JOID, configuring JOID for your environment, and deploying OPNFV with different SDN solutions in HA, or non-HA mode. Prerequisites include - An Ubuntu 16.04 LTS Server Jumphost - Minimum 2 Networks per Pharos requirement @@ -656,9 +656,7 @@ This section creates a private network for the instances. Please change accordin :: neutron router-create demo-router - neutron router-interface-add demo-router demo-subnet - neutron router-gateway-set demo-router ext-net This section creates a router and connects this router to the two networks we just created. |