diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/configguide/configguide.rst | 13 | ||||
| -rw-r--r-- | docs/release/configguide/installerconfig.rst | 420 | ||||
| -rw-r--r-- | docs/release/configguide/postinstall.rst | 44 | ||||
| -rw-r--r-- | docs/release/installation/installationprocedure.rst | 115 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 78 |
5 files changed, 370 insertions, 300 deletions
diff --git a/docs/release/configguide/configguide.rst b/docs/release/configguide/configguide.rst index c1137634..ae1c793c 100644 --- a/docs/release/configguide/configguide.rst +++ b/docs/release/configguide/configguide.rst @@ -4,19 +4,24 @@ JOID Configuration Scenario 1: ODL L2 ------------------ -*./deploy.sh -o mitaka -s odl -t ha -l custom -f none -d xenial* +*./deploy.sh -o newton -s odl -t ha -l custom -f none -d xenial -m openstack* Scenario 2: Nosdn ----------------- -*./deploy.sh -o mitaka -s nosdn -t ha -l custom -f none -d xenial* +*./deploy.sh -o newton -s nosdn -t ha -l custom -f none -d xenial -m openstack* Scenario 3: ONOS nofeature -------------------------- -*./deploy.sh -o mitaka -s onos -t ha -l custom -f none -d xenial* +*./deploy.sh -o newton -s onos -t ha -l custom -f none -d xenial -m openstack* Scenario 4: ONOS with SFC ------------------ -*./deploy.sh -o mitaka -s onos -t ha -l custom -f none -d xenial* +*./deploy.sh -o newton -s onos -t ha -l custom -f none -d xenial -m openstack* + +Scenario 5: Kubernetes core +--------------------------- + +*./deploy.sh -l custom -f none -m kubernetes* diff --git a/docs/release/configguide/installerconfig.rst b/docs/release/configguide/installerconfig.rst index d4346c0b..8239ab6d 100644 --- a/docs/release/configguide/installerconfig.rst +++ b/docs/release/configguide/installerconfig.rst @@ -2,20 +2,21 @@ JOID Configuration ================== - - Bare Metal Installations: -^^^^^^^^^^^^^^^^^^^^^^^^^ +========================= + Requirements as per Pharos: -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +=========================== + Networking: -^^^^^^^^^^^ +=========== + **Minimum 2 networks** -| ``1. First for Admin network with gateway to access external network`` -| ``2. Second for public network to consume by tenants for floating ips`` +| ``1. First for Admin/Management network with gateway to access external network`` +| ``2. Second for floating ip network to consume by tenants for floating ips`` -**NOTE: JOID support multiple isolated networks for data as well as storage. +**NOTE: JOID support multiple isolated networks for API, data as well as storage. Based on your network options for Openstack.** **Minimum 6 physical servers** @@ -26,264 +27,311 @@ Based on your network options for Openstack.** | `` CPU cores: 16`` | `` Memory: 32 GB`` | `` Hard Disk: 1(250 GB)`` -| `` NIC: eth0(Admin, Management), eth1 (external network)`` +| `` NIC: if0(Admin, Management), if1 (external network)`` -2. Control node servers (minimum 3): +2. Node servers (minimum 5): | `` Minimum H/W Spec`` | `` CPU cores: 16`` | `` Memory: 32 GB`` -| `` Hard Disk: 1(500 GB)`` -| `` NIC: eth0(Admin, Management), eth1 (external network)`` - -3. Compute node servers (minimum 2): +| `` Hard Disk: 2(1 TB preferred SSD) this includes the space for ceph as well`` +| `` NIC: if0 (Admin, Management), if1 (external network)`` -| `` Minimum H/W Spec`` -| `` CPU cores: 16`` -| `` Memory: 32 GB`` -| `` Hard Disk: 1(1 TB) this includes the space for ceph as well`` -| `` NIC: eth0(Admin, Management), eth1 (external network)`` **NOTE: Above configuration is minimum and for better performance and usage of the Openstack please consider higher spec for each nodes.** Make sure all servers are connected to top of rack switch and configured accordingly. No DHCP server should be up and configured. Only gateway at eth0 and eth1 network should be configure to access the network outside your lab. +------------------------ Jump node configuration: -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ -1. Install Ubuntu 14.04 LTS server version of OS on the nodes. +1. Install Ubuntu 16.04.1 LTS server version of OS on the first server. 2. Install the git and bridge-utils packages on the server and configure minimum two bridges on jump host: -brAdm and brPublic cat /etc/network/interfaces +brAdm and brExt cat /etc/network/interfaces | `` # The loopback network interface`` | `` auto lo`` | `` iface lo inet loopback`` -| `` iface eth0 inet manual`` +| `` iface if0 inet manual`` | `` auto brAdm `` | `` iface brAdm inet static`` -| `` address 10.4.1.1`` -| `` netmask 255.255.248.0`` -| `` network 10.4.0.0`` -| `` broadcast 10.4.7.255`` -| `` gateway 10.4.0.1`` -| `` # dns-* options are implemented by the resolvconf package, if installed`` -| `` dns-nameservers 10.4.0.2`` -| `` bridge_ports eth0`` -| `` auto brPublic`` -| `` iface brPublic inet static`` -| `` address 10.2.66.2`` +| `` address 10.5.1.1`` | `` netmask 255.255.255.0`` -| `` bridge_ports eth2`` +| `` bridge_ports if0`` +| `` iface if1 inet manual`` +| `` auto brExt`` +| `` iface brExt inet static`` +| `` address 10.5.15.1`` +| `` netmask 255.255.255.0`` +| `` bridge_ports if1`` -**NOTE: If you choose to use the separate network for management, data and +**NOTE: If you choose to use the separate network for management, pulic , data and storage then you need to create bridge for each interface. In case of VLAN tags use the appropriate network on jump-host depend upon VLAN ID on the interface.** Configure JOID for your lab -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +=========================== **Get the joid code from gerritt** -*git clone https://gerrit.opnfv.org/gerrit/p/joid.git* - -*cd joid/ci* - -**Enable MAAS** +*git clone https://gerrit.opnfv.org/gerrit/joid.git* -- Create a directory in maas/<company name>/<pod number>/ for example +**Enable MAAS (labconfig.yaml is must and base for MAAS installation and scenario deployment)** -*mkdir maas/intel/pod7/* +If you have already enabled maas for your environment and installed it then there is no need to enabled it again or install it. If you have patches from previous MAAS enablement then you can apply it here. +NOTE: If MAAS is pre installed without 03-maasdeploy.sh not supported. We strongly suggest to use 03-maaseploy.sh to deploy the MAAS and JuJu environment. -- Copy files from pod5 to pod7 +If enabling first time then follow it further. +- Create a directory in joid/labconfig/<company name>/<pod number>/ for example -*cp maas/intel/pod5/\* maas/intel/pod7/* +*mkdir joid/labconfig/intel/pod7/* -4 files will get copied: deployment.yaml environments.yaml -interfaces.host lxc-add-more-interfaces +- copy labconfig.yaml from pod6 to pod7 +*cp joid/labconfig/intel/pod5/\* joid/labconfig/intel/pod7/* -deployment.yaml file -^^^^^^^^^^^^^^^^^^^^ +labconfig.yaml file +=================== +------------- Prerequisite: -~~~~~~~~~~~~~ +------------- 1. Make sure Jump host node has been configured with bridges on each interface, so that appropriate MAAS and JUJU bootstrap VM can be created. For example if -you have three network admin, data and public then I would suggest to give names -like brAdm, brData and brPublic. -2. You have information about the node MAC address and power management details (IPMI IP, username, password) of the nodes used for control and compute node. +you have three network admin, data and floating ip then I would suggest to give names +like brAdm, brData and brExt etc. +2. You have information about the node MAC address and power management details (IPMI IP, username, password) of the nodes used for deployment. -modify deployment.yaml -^^^^^^^^^^^^^^^^^^^^^^ +--------------------- +modify labconfig.yaml +--------------------- This file has been used to configure your maas and bootstrap node in a VM. Comments in the file are self explanatory and we expect fill up the information according to match lab infrastructure information. Sample -deployment.yaml can be found at -https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=blob;f=ci/maas/intel/pod5/deployment.yaml - -modify joid/ci/01-deploybundle.sh -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -under section case $3 add the intelpod7 section and make sure you have -information provided correctly. Before example consider your network has -192.168.1.0/24 your default network. and eth1 is on public network which -will be used to assign the floating ip. - -| `` 'intelpod7' )`` -| `` # As per your lab vip address list be deafult uses 10.4.1.11 - 10.4.1.20`` -| `` sed -i -- 's/10.4.1.1/192.168.1.2/g' ./bundles.yaml`` -| `` # Choose the external port to go out from gateway to use.`` -| `` sed -i -- 's/# "ext-port": "eth1"/ "ext-port": "eth1"/g' ./bundles.yaml`` -| `` ;;`` - -NOTE: If you are using seprate data network then add this line below -also along with other changes. which represents network 10.4.9.0/24 will -be used for data network for openstack - -`` sed -i -- 's/#os-data-network: 10.4.8.0\/21/os-data-network: 10.4.9.0\/24/g' ./bundles.yaml`` - -modify joid/ci/02-maasdeploy.sh -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -under section case $1 add the intelpod7 section and make sure you have -information provided correctly. - -| `` 'intelpod7' )`` -| `` cp maas/intel/pod7/deployment.yaml ./deployment.yaml`` -| `` ;;`` - -NOTE: If you are using VLAN tags or more network for data and storage -then make sure you modify the case $1 section under Enable vlan -interface with maas appropriately. In the example below eth2 has been -used as separate data network for tenants in openstack with network -10.4.9.0/24 on compute and control nodes. - -| `` 'intelpod7' )`` -| `` maas refresh`` -| `` enableautomodebyname eth2 AUTO "10.4.9.0/24" compute || true`` -| `` enableautomodebyname eth2 AUTO "10.4.9.0/24" control || true`` -| `` ;;`` - - +labconfig.yaml can be found at +https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=blob;f=labconfig/intel/pod6/labconfig.yaml + +*lab: + location: intel + racks: + - rack: pod6 + nodes: + - name: rack-6-m1 + architecture: x86_64 + roles: [network,control] + nics: + - ifname: eth1 + spaces: [public] + mac: ["xx:xx:xx:xx:xx:xx"] + power: + type: ipmi + address: xx.xx.xx.xx + user: xxxx + pass: xxxx + - name: rack-6-m1 + architecture: x86_64 + roles: [network,control] + nics: + - ifname: eth1 + spaces: [public] + mac: ["xx:xx:xx:xx:xx:xx"] + power: + type: ipmi + address: xx.xx.xx.xx + user: xxxx + pass: xxxx + - name: rack-6-m1 + architecture: x86_64 + roles: [network,control] + nics: + - ifname: eth1 + spaces: [public] + mac: ["xx:xx:xx:xx:xx:xx"] + power: + type: ipmi + address: xx.xx.xx.xx + user: xxxx + pass: xxxx + - name: rack-6-m1 + architecture: x86_64 + roles: [network,control] + nics: + - ifname: eth1 + spaces: [public] + mac: ["xx:xx:xx:xx:xx:xx"] + power: + type: ipmi + address: xx.xx.xx.xx + user: xxxx + pass: xxxx + - name: rack-6-m1 + architecture: x86_64 + roles: [network,control] + nics: + - ifname: eth1 + spaces: [public] + mac: ["xx:xx:xx:xx:xx:xx"] + power: + type: ipmi + address: xx.xx.xx.xx + user: xxxx + pass: xxxx + floating-ip-range: 10.5.15.6,10.5.15.250,10.5.15.254,10.5.15.0/24 + ext-port: "eth1" + dns: 8.8.8.8 +opnfv: + release: d + distro: xenial + type: nonha + openstack: newton + sdncontroller: + - type: nosdn + storage: + - type: ceph + disk: /dev/sdb + feature: odl_l2 + spaces: + - type: floating + bridge: brEx + cidr: 10.5.15.0/24 + gateway: 10.5.15.254 + vlan: + - type: admin + bridge: brAdm + cidr: 10.5.1.0/24 + gateway: + vlan:* + +Deployment of OPNFV using JOID: +=============================== + +Once you have done the change in above section then run the following commands to do the automatic deployments. + +------------ MAAS Install -~~~~~~~~~~~~ +------------ After integrating the changes as mentioned above run the MAAS install. -Suppose you name the integration lab as intelpod7 then run the below -commands to start the MAAS deployment. +then run the below commands to start the MAAS deployment. -`` ./02-maasdeploy.sh intelpod7`` +`` ./03-maasdeploy.sh custom <absolute path of config>/labconfig.yaml `` +or +`` ./03-maasdeploy.sh custom http://<web site location>/labconfig.yaml `` -This will take approximately 40 minutes to couple hours depending on your +For deployment of Danbue release on KVM please use the following command. + +`` ./03-maasdeploy.sh default `` + +This will take approximately 20 minutes to couple hours depending on your environment. This script will do the following: -1. Create 2 VMs (KVM). -2. Install MAAS in one of the VMs. +1. Create 1 VMs (KVM) for Juju bootstrap. +2. Install MAAS on the jumphost. 3. Configure the MAAS to enlist and commission a VM for Juju bootstrap node. 4. Configure the MAAS to enlist and commission bare metal servers. +5. In case of virtual server deployments MAAS will create three more KVM servers and add those servers in MAAS fir deployment. When it's done, you should be able to view MAAS webpage (http://<MAAS IP>/MAAS) and see 1 bootstrap node and bare metal servers in the 'Ready' state on the nodes page. -Virtual deployment -~~~~~~~~~~~~~~~~~~ -By default, just running the script ./02-maasdeploy.sh will automatically create the KVM VMs on a single machine and configure everything for you. +------------- OPNFV Install ------------- -JOID allows you to deploy different combinations of OpenStack release and SDN solution in HA or non-HA mode. - -For OpenStack, it supports Juno and Liberty. For SDN, it supports Openvswitch, OpenContrail, OpenDayLight and ONOS. - -In addition to HA or non-HA mode, it also supports to deploy the latest from the development tree (tip). - - -The deploy.sh in the joid/ci directoy will do all the work for you. For example, the following deploy OpenStack Libery with OpenDayLight in a HA mode in the Intelpod7. - -| `` ./deploy.sh -o liberty -s odl -t ha -l intelpod7 -f none`` +| `` ./deploy.sh -o newton -s nosdn -t nonha -l custom -f none -d xenial -m openstack`` | `` `` -By default, the SDN is Openvswitch, non-HA, Liberty, Intelpod5, OPNFV Brahmaputra release and ODL_L2 for the OPNFV feature. - -Possible options for each choice are as follows: - -| `` [-s ``\ \ ``]`` -| `` nosdn: openvswitch only and no other SDN.`` -| `` odl: OpenDayLight Lithium version.`` -| `` opencontrail: OpenContrail SDN.`` -| `` onos: ONOS framework as SDN.`` -| `` `` -| `` [-t ``\ \ ``] `` -| `` nonha: NO HA mode of Openstack.`` -| `` ha: HA mode of openstack.`` -| `` tip: the tip of the development.`` -| `` `` -| `` [-o ``\ \ ``]`` -| `` juno: OpenStack Juno version.`` -| `` liberty: OpenStack Liberty version.`` -| `` `` -| `` [-l ``\ \ ``] etc...`` -| `` default: For virtual deployment where installation will be done on KVM created using ./02-maasdeploy.sh`` -| `` intelpod5: Install on bare metal OPNFV pod5 of Intel lab.`` -| `` intelpod6`` -| `` orangepod2`` -| `` ..`` -| `` (other pods)`` -| `` Note: if you make changes as per your pod above then please use your pod.`` -| `` `` -| `` [-f ``\ \ ``]`` -| `` none: no special feature will be enabled.`` -| `` ipv6: ipv6 will be enabled for tenant in openstack.`` -| `` `` - - -By default debug is enabled in script and error messages will be printed -on the SSH terminal where you are running the scripts. -It could take an hour to couple hours (max) to complete. +./deploy.sh -o newton -s nosdn -t nonha -l custom -f none -d xenial -m openstack + +NOTE: Possible options are as follows: + +choose which sdn controller to use. + [-s <nosdn|odl|opencontrail|onos>] + nosdn: openvswitch only and no other SDN. + odl: OpenDayLight Boron version. + opencontrail: OpenContrail SDN. + onos: ONOS framework as SDN. + +Mode of Openstack deployed. + [-t <nonha|ha|tip>] + nonha: NO HA mode of Openstack + ha: HA mode of openstack. + +Wihch version of Openstack deployed. + [-o <Newton|Mitaka>] + Newton: Newton version of openstack. + Mitaka: Mitaka version of openstack. + +Where to deploy + [-l <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>] + 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. + dvr: Will enable distributed virtual routing. + dpdk: Will enable DPDK feature. + sfc: Will enable sfc feature only supported with onos deployment. + +which Ubuntu distro to use. + [ -d <trusty|xenial> ] + +Which model to deploy +JOID introduces the various model to deploy apart from openstack for docker based container workloads. +[-m <openstack|kubernetes>] + openstack: Openstack which will be used for KVM/LXD container based workloads. + kubernetes: Kubernes model will be used for docker based workloads. + +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 +os-nosdn-nofeature-ha Joid +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-nonha Joid No support from Functest and Yardstick +k8-nosdn-lb-nonha Joid No support from Functest and Yardstick Is the deployment done successfully? ------------------------------------ -Once juju-deployer is complete, use juju status to verify that all deployed unit are in the ready state. +Once deploy.sh is complete, use juju status to verify that all deployed unit are in the ready state. -| `` juju status --format tabular`` +| `` juju status `` Find the Openstack-dashboard IP address from the *juju status* output, and see if you can log in via browser. The username and password is admin/openstack. -Optionall, see if you can log in Juju GUI. Juju GUI is on the Juju bootstrap node which is the second VM you define in the 02-maasdeploy.sh. The username and password is admin/admin. +Optionally, see if you can log in Juju GUI. Juju GUI is on the Juju bootstrap node which is the VM define using 03-maasdeploy.sh. The username and password deplayed at the end of deployment along with url. -If you deploy ODL, OpenContrail or ONOS, find the IP address of the web UI and login. Please refer to each SDN bundle.yaml for username/password. +If you deploy ODL, OpenContrail or ONOS, find the IP address of the web UI and login. Please refer to each SDN guides for username/password. +------------ Troubleshoot -~~~~~~~~~~~~ -To access to any deployed units, juju ssh for example to login into nova-compute unit and look for /var/log/juju/unit-<of interest> for more info. +------------ -| `` juju ssh nova-compute/0`` +By default debug is enabled in script and error messages will be printed on ssh terminal where you are running the scripts. -Example: - -| `` ubuntu@R4N4B1:~$ juju ssh nova-compute/0`` -| `` Warning: Permanently added '172.16.50.60' (ECDSA) to the list of known hosts.`` -| `` Warning: Permanently added '3-r4n3b1-compute.maas' (ECDSA) to the list of known hosts.`` -| `` Welcome to Ubuntu 14.04.1 LTS (GNU/Linux 3.13.0-77-generic x86_64)`` -| `` `` -| `` * Documentation: https://help.ubuntu.com/`` -| `` <skipped>`` -| `` Last login: Tue Feb 2 21:23:56 2016 from bootstrap.maas`` -| `` ubuntu@3-R4N3B1-compute:~$ sudo -i`` -| `` root@3-R4N3B1-compute:~# cd /var/log/juju/`` -| `` root@3-R4N3B1-compute:/var/log/juju# ls`` -| `` machine-2.log unit-ceilometer-agent-0.log unit-ceph-osd-0.log unit-neutron-contrail-0.log unit-nodes-compute-0.log unit-nova-compute-0.log unit-ntp-0.log`` -| `` root@3-R4N3B1-compute:/var/log/juju#`` +To Access of any control or compute nodes. +juju ssh <service name>/<instance id> +for example to login into openstack-dashboard container. -**By default juju will add the Ubuntu user keys for authentication into -the deployed server and only ssh access will be available.** +juju ssh openstack-dashboard/0 +juju ssh nova-compute/0 +juju ssh neutron-gateway/0 -Once you resolve the error, go back to the jump host to rerun the charm hook with: +All charm jog files are availble under /var/log/juju -| `` juju resolved --retry <unit>`` +By default juju will add the current user keys for authentication into the deployed server and only ssh access will be available. diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst index 7d7c753b..49388b16 100644 --- a/docs/release/configguide/postinstall.rst +++ b/docs/release/configguide/postinstall.rst @@ -3,21 +3,33 @@ JOID post installation procedures Configure OpenStack ------------------- -In each SDN directory, for example joid/ci/opencontrail, there is a folder -for Juju deployer where you can find the charm bundle yaml files that the -deploy.sh uses to deploy. - -In the same directory, there is **scripts** folder where you can find shell -scripts to help you configure the OpenStack cloud that you just deployed. These -scripts are created to help you configure a basic OpenStack Cloud to verify -the cloud. For more info on OpenStack Cloud configuration, please refer to the -OpenStack Cloud Administrator Guide on docs.openstack.org. Similarly, for -complete SDN configuration, please refer to the respective SDN adminstrator guide. - -Each SDN solution requires slightly different setup, please refer to the **README** -in each SDN folder. Most likely you will need to modify the **openstack.sh** -and **cloud-setup.sh** scripts for the floating IP range, private IP network, -and SSH keys. Please go through **openstack.sh**, **glance.sh** and -**cloud-setup.sh** and make changes as you see fit. + +openstack.sh under joid/ci used to configure the openstack after deployment + +./openstack.sh <nosdn> custom xenial newton + +Below commands are used to setup domain in heat. +juju run-action heat/0 domain-setup + +Upload cloud images and creates the sample network to test. + +joidjuju/get-cloud-images +joid/juju/joid-configure-openstack + + +Configure Kubernets +------------------- + +k8.sh under joid/ci would be used to show the kubernets workload and create +sample pods. + +./k8.sh + +Juju GUI +-------- + +Below command would be used to display Juju GUI url along with credentials. + +juju gui --show-credentials --no-browser diff --git a/docs/release/installation/installationprocedure.rst b/docs/release/installation/installationprocedure.rst index f5f4ece2..159741e0 100644 --- a/docs/release/installation/installationprocedure.rst +++ b/docs/release/installation/installationprocedure.rst @@ -43,22 +43,23 @@ Make sure all servers are connected to top of rack switch and config Jump node configuration: ------------------------ -1. Install Ubuntu 16.04.1 LTS server version of OS on the nodes. +1. Install Ubuntu 16.04.1 LTS server version of OS on the first server. 2. Install the git and bridge-utils packages on the server and configure minimum two bridges on jump host: -brAdm and brPublic cat /etc/network/interfaces +brAdm and brExt cat /etc/network/interfaces | `` # The loopback network interface`` | `` auto lo`` | `` iface lo inet loopback`` -| `` iface eth0 inet manual`` +| `` iface if0 inet manual`` | `` auto brAdm `` | `` iface brAdm inet static`` | `` address 10.5.1.1`` | `` netmask 255.255.255.0`` | `` bridge_ports if0`` -| `` auto brPublic`` -| `` iface brPublic inet static`` +| `` iface if1 inet manual`` +| `` auto brExt`` +| `` iface brExt inet static`` | `` address 10.5.15.1`` | `` netmask 255.255.255.0`` | `` bridge_ports if1`` @@ -79,20 +80,7 @@ Configure JOID for your lab If you have already enabled maas for your environment and installed it then there is no need to enabled it again or install it. If you have patches from previous MAAS enablement then you can apply it here. -NOTE: If MAAS is pre installed without 00-maasdeploy.sh then please do the following and skip rest of the step to enable MAAS. - -1. Copy MAAS API key and paste in ~/.juju/environments.yaml at appropriate place. -2. Run command cp ~/.juju/environments.yaml ./joid/ci/ -3. Generate labconfig.yaml for your lab and copy it to joid. - a. cp joid/labconfig/<company name>/<pod number>/labconfig.yaml joid/ci/ or - b. cp <newly generated labconfig.yaml> joid/ci -4. cd joid/ci -5. python genMAASConfig.py -l labconfig.yaml > deployment.yaml -6. python genDeploymentConfig.py -l labconfig.yaml > deployconfig.yaml -7. cp ./environments.yaml ~/.juju/ -8. cp ./deployment.yaml ~/.juju/ -9. cp ./labconfig.yaml ~/.juju/ -10. cp ./deployconfig.yaml ~/.juju/ +NOTE: If MAAS is pre installed without 03-maasdeploy.sh not supported. We strongly suggest to use 03-maaseploy.sh to deploy the MAAS and JuJu environment. If enabling first time then follow it further. - Create a directory in joid/labconfig/<company name>/<pod number>/ for example @@ -111,9 +99,9 @@ Prerequisite: 1. Make sure Jump host node has been configured with bridges on each interface, so that appropriate MAAS and JUJU bootstrap VM can be created. For example if -you have three network admin, data and public then I would suggest to give names -like brAdm, brData and brPublic. -2. You have information about the node MAC address and power management details (IPMI IP, username, password) of the nodes used for control and compute node. +you have three network admin, data and floating ip then I would suggest to give names +like brAdm, brData and brExt etc. +2. You have information about the node MAC address and power management details (IPMI IP, username, password) of the nodes used for deployment. --------------------- modify labconfig.yaml @@ -128,9 +116,9 @@ https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=blob;f=labconfig/intel/pod6/ *lab: location: intel racks: - - rack: pod5 + - rack: pod6 nodes: - - name: rack-5-m1 + - name: rack-6-m1 architecture: x86_64 roles: [network,control] nics: @@ -142,7 +130,7 @@ https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=blob;f=labconfig/intel/pod6/ address: xx.xx.xx.xx user: xxxx pass: xxxx - - name: rack-5-m1 + - name: rack-6-m1 architecture: x86_64 roles: [network,control] nics: @@ -154,7 +142,7 @@ https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=blob;f=labconfig/intel/pod6/ address: xx.xx.xx.xx user: xxxx pass: xxxx - - name: rack-5-m1 + - name: rack-6-m1 architecture: x86_64 roles: [network,control] nics: @@ -166,7 +154,7 @@ https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=blob;f=labconfig/intel/pod6/ address: xx.xx.xx.xx user: xxxx pass: xxxx - - name: rack-5-m1 + - name: rack-6-m1 architecture: x86_64 roles: [network,control] nics: @@ -178,7 +166,7 @@ https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=blob;f=labconfig/intel/pod6/ address: xx.xx.xx.xx user: xxxx pass: xxxx - - name: rack-5-m1 + - name: rack-6-m1 architecture: x86_64 roles: [network,control] nics: @@ -194,37 +182,28 @@ https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=blob;f=labconfig/intel/pod6/ ext-port: "eth1" dns: 8.8.8.8 opnfv: - release: c - distro: trusty + release: d + distro: xenial type: nonha - openstack: liberty + openstack: newton sdncontroller: - type: nosdn storage: - type: ceph - disk: /srv + disk: /dev/sdb feature: odl_l2 spaces: - - type: public - bridge: brPublic + - type: floating + bridge: brEx cidr: 10.5.15.0/24 gateway: 10.5.15.254 vlan: - - type: external - bridge: brExt - cidr: + - type: admin + bridge: brAdm + cidr: 10.5.1.0/24 gateway: - 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. - -*'intelpod7' ) - maas refresh - enableautomodebyname eth2 AUTO "10.4.9.0/24" compute || true - enableautomodebyname eth2 AUTO "10.4.9.0/24" control || true - ;;* - Deployment of OPNFV using JOID: =============================== @@ -237,26 +216,30 @@ MAAS Install After integrating the changes as mentioned above run the MAAS install. then run the below commands to start the MAAS deployment. -`` ./00-maasdeploy.sh custom <absolute path of config>/labconfig.yaml `` +`` ./03-maasdeploy.sh custom <absolute path of config>/labconfig.yaml `` or -`` ./00-maasdeploy.sh custom http://<web site location>/labconfig.yaml `` +`` ./03-maasdeploy.sh custom http://<web site location>/labconfig.yaml `` + +For deployment of Danbue release on KVM please use the following command. + +`` ./03-maasdeploy.sh default `` ------------- OPNFV Install ------------- -| `` ./deploy.sh -o mitaka -s odl -t ha -l custom -f none -d xenial`` +| `` ./deploy.sh -o newton -s nosdn -t nonha -l custom -f none -d xenial -m openstack`` | `` `` -./deploy.sh -o mitaka -s odl -t ha -l custom -f none -d xenial +./deploy.sh -o newton -s nosdn -t nonha -l custom -f none -d xenial -m openstack NOTE: Possible options are as follows: choose which sdn controller to use. [-s <nosdn|odl|opencontrail|onos>] nosdn: openvswitch only and no other SDN. - odl: OpenDayLight Lithium version. - opencontrail: OpenContrail SDN can be installed with Juno Openstack today. + odl: OpenDayLight Boron version. + opencontrail: OpenContrail SDN. onos: ONOS framework as SDN. Mode of Openstack deployed. @@ -265,18 +248,14 @@ Mode of Openstack deployed. ha: HA mode of openstack. Wihch version of Openstack deployed. - [-o <liberty|Mitaka>] - liberty: Liberty version of openstack. + [-o <Newton|Mitaka>] + Newton: Newton version of openstack. Mitaka: Mitaka version of openstack. Where to deploy - [-l <custom | default | intelpod5 >] etc... + [-l <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 ./00-maasdeploy.sh - intelpod5: Install on bare metal OPNFV pod5 of Intel lab. - intelpod6 - orangepod2 - custom + 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>] @@ -290,17 +269,25 @@ what feature to deploy. Comma seperated list which Ubuntu distro to use. [ -d <trusty|xenial> ] +Which model to deploy +JOID introduces the various model to deploy apart from openstack for docker based container workloads. +[-m <openstack|kubernetes>] + openstack: Openstack which will be used for KVM/LXD container based workloads. + kubernetes: Kubernes model will be used for docker based workloads. + 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 os-nosdn-nofeature-ha Joid os-nosdn-nofeature-noha Joid -os-odl_l2-nofeature-ha 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-nonha Joid No support from Functest and Yardstick +k8-nosdn-lb-nonha Joid No support from Functest and Yardstick ------------ Troubleshoot @@ -309,12 +296,14 @@ Troubleshoot By default debug is enabled in script and error messages will be printed on ssh terminal where you are running the scripts. To Access of any control or compute nodes. -juju ssh <service name> +juju ssh <service name>/<instance id> for example to login into openstack-dashboard container. juju ssh openstack-dashboard/0 juju ssh nova-compute/0 juju ssh neutron-gateway/0 -By default juju will add the Ubuntu user keys for authentication into the deployed server and only ssh access will be available. +All charm jog files are availble under /var/log/juju + +By default juju will add the current user keys for authentication into the deployed server and only ssh access will be available. diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 3d4f02a0..a0d79579 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 Colorado release of +This document compiles the release notes for the Denbue 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 Colorado release of OPNFV. +tool for the Denbue release of OPNFV. -The goal of the Colorado release and this JOID based deployment process is +The goal of the Denbue release and this JOID based deployment process is to establish a lab ready platform accelerating further development of the OPNFV infrastructure. @@ -25,21 +25,23 @@ OPNFV using JOID which is based on MAAS and Juju. Summary ======= - Colorado 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 Mitaka combined with OpenDaylight Beryllium. + Denbue 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 Colorado. Ceph is setup as 2 OSDs and 2 Monitors, one OSD+Mon per Compute node. +Ceph storage is used as Cinder backend, and is the only supported storage for Denbue. Ceph is setup as 3 OSDs and 3 Monitors, one radosgw. User has following choices to make to do the deployment. - - Openstack -- Mitaka + - Openstack -- Newton - Type -- HA, nonHA, tip (stable git branch of respective openstack) - SDN controller -- OpenDaylight, nosdn(Openvswitch), Onos, OpenContrail - - Feature -- IPV6, DVR(distributed virtual routing), SFC(service function chaining odl only), BGPVPN(odl only) + - Feature -- IPV6, DVR(distributed virtual routing), SFC(service function chaining odl only), BGPVPN(odl only), LB(Load Balancer for Kubernetes) + - Distro -- Xenial + - Model -- Openstack, Kubernetes - Documentation is built by Jenkins -- Jenkins deploys a Brahmaputra release with the JOID deployment toolchain baremetal, +- Jenkins deploys a Denbue release with the JOID deployment toolchain baremetal, which includes 3 control+network nodes, and 2 compute nodes. NOTE: Detailed information on how to install in your lab can be find in installation guide @@ -52,15 +54,15 @@ Release Data | | | +--------------------------------------+--------------------------------------+ | **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git | -| | stable/colorado | +| | stable/denbue | +--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado release | +| **Release designation** | Denbue release | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | September 22 2016 | +| **Release date** | March 22 2017 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Colorado release | +| **Purpose of the delivery** | Denbue release | | | | +--------------------------------------+--------------------------------------+ @@ -84,14 +86,14 @@ Version change Module version change ~~~~~~~~~~~~~~~~~~~~~ - Colorado release with the JOID deployment toolchain. - - OpenStack (Mitaka release) - - OpenDaylight (Beryllium release) + Denbue release with the JOID deployment toolchain. + - OpenStack (Newton release) + - OpenDaylight (Boron release) - Ubuntu 16.04 LTS Document version change ~~~~~~~~~~~~~~~~~~~~~~~ -- OPNFV Installation instructions for the Colorado release using JOID deployment +- OPNFV Installation instructions for the Denbue release using JOID deployment toolchain - ver. 1.0.0 - OPNFV Release Notes with the JOID deployment toolchain - ver. 1.0.0 (this document) @@ -106,13 +108,22 @@ Feature additions +--------------------------------------+--------------------------------------+ | JIRA: JOID-1 | use Juju and Ubuntu to deploy OPNFV | +--------------------------------------+--------------------------------------+ -| JIRA: JOID-76 | Integrate Aodh in JOID | +| JIRA: JOID-103 | OpenDaylight Carbon Support | +--------------------------------------+--------------------------------------+ -| JIRA: JOID-69 | OVS with DPDK | +| JIRA: JOID-100 | MAAS 2.x support | +--------------------------------------+--------------------------------------+ -| JIRA: JOID-68 | ONOS Goldeneye Support | +| JIRA: JOID-101 | Juju 2.x support | +--------------------------------------+--------------------------------------+ -| JIRA: JOID-61 | Mitaka OpenStack Support | +| JIRA: JOID-99 | jumphost support for 16.04 | ++--------------------------------------+--------------------------------------+ +| JIRA: JOID-106 | Kubernetes on Baremetal | ++--------------------------------------+--------------------------------------+ +| JIRA: JOID-108 | integrate load balancer | +| | Kubernetes on Baremetal | ++--------------------------------------+--------------------------------------+ +| JIRA: JOID-110 | Enable VM console in Horizon | ++--------------------------------------+--------------------------------------+ +| JIRA: JOID-102 | Enable OpenStack Newton | +--------------------------------------+--------------------------------------+ Bug corrections @@ -149,7 +160,9 @@ Known issues | JIRA: YARDSTICK-325 | Provide raw format yardstick vm image| | | for nova-lxd scenario(OPNFV) | +--------------------------------------+--------------------------------------+ -| JIRA: | | +| JIRA: | floating ip are not working for ODL. | ++--------------------------------------+--------------------------------------+ +| JIRA: | No functest and yardstick support. | +--------------------------------------+--------------------------------------+ @@ -160,7 +173,7 @@ See JIRA: <link> Test Result =========== -Colorado test result using JOID as deployment tool. +Denbue 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/>`_ @@ -194,15 +207,18 @@ 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/ Notes: -Name: applies to all HA scenarios +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/ +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/ Notes: -* 'COPPER-22 <https://jira.opnfv.org/browse/COPPER-22>`_: - Congress service HA deployment is not yet supported/verified. References ========== -For more information on the OPNFV Colorado release, please visit -- `OPNFV Colorado release <http://www.opnfv.org/colorado>`_ +For more information on the OPNFV Denbue release, please visit +- `OPNFV Denbue release <http://www.opnfv.org/colorado>`_ Juju ---- @@ -218,12 +234,12 @@ 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 Release Notes <https://wiki.opnfv.org/display/joid/Denbue+Release+Notes>`_ +- `OPNFV JOID Install Guide <https://wiki.opnfv.org/display/joid/Denbue+installation+Guide>`_ 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>`_ OpenDaylight |