diff --git a/doc/build/latex/fuel-plugin-xenserver.pdf b/doc/build/latex/fuel-plugin-xenserver.pdf index ca8d14a..bfba801 100644 Binary files a/doc/build/latex/fuel-plugin-xenserver.pdf and b/doc/build/latex/fuel-plugin-xenserver.pdf differ diff --git a/doc/source/guide.rst b/doc/source/guide.rst index 8667370..d877948 100644 --- a/doc/source/guide.rst +++ b/doc/source/guide.rst @@ -58,9 +58,9 @@ Select Environment .. image:: _static/HIMN_dialog.jpg :width: 100% -#. Add new VMs to the new environment according to `Fuel User Guide `_ and configure them properly. A typical topology of 3 controller nodes + 3 compute nodes + 1 storage node is recommended. +#. Add new VMs to the new environment according to `Fuel User Guide `_ and configure them properly. A typical topology of 3 controller nodes + 3 compute nodes + 1 storage node is recommended. -#. Go to Settings tab and "Compute" section. You need to input the common access credentials to all XenServers that previously are used to create new VMs. +#. Go to Settings tab and "Compute" section. You need to input the common access credentials to all XenServers that previously are used to create new VMs. You can also provide a SSH private key for communication between the compute node and the XenServer host during installation, or leave it blank then an RSA keypair will be automatically generated. .. image:: _static/fmsetting00.png :width: 100% @@ -71,9 +71,9 @@ Select Environment Finish environment configuration -------------------------------- -#. Run `network verification check `_ +#. Run `network verification check `_ -#. Press `Deploy button `_ to once you are done with environment configuration. +#. Press `Deploy button `_ to once you are done with environment configuration. #. After deployment is done, you will see in Horizon that all hypervisors are xen. diff --git a/doc/source/index.rst b/doc/source/index.rst index 791bc70..2bfa153 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -28,6 +28,7 @@ guide .. include:: terms.rst .. include:: installation.rst .. include:: guide.rst +.. include:: troubleshooting.rst Further reading diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 5017b83..3b4d2b2 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -14,7 +14,7 @@ To install the XenServer Fuel plugin: [root@home ~]# scp fuel-plugin-xenserver-3.1-3.1.0-1.noarch.rpm root@fuel:/tmp #. Log into Fuel Master node and install the plugin using the - `Fuel CLI `_: + `Fuel CLI `_: :: @@ -39,4 +39,4 @@ Add Management Network tool #. Re-start XenCenter -.. _Fuel Plugins Catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/ +.. _Fuel Plugins Catalog: https://www.mirantis.com/validated-solution-integrations/fuel-plugins/ diff --git a/doc/source/test-plan.rst b/doc/source/test-plan.rst index cf146a0..4fdab0b 100644 --- a/doc/source/test-plan.rst +++ b/doc/source/test-plan.rst @@ -61,6 +61,9 @@ be used by Neutron for VM traffic. .. image:: _static/topology00.png :width: 80% +For the hardware configuration see Mirantis OpenStack Planning Guide at +https://docs.mirantis.com/openstack/fuel/fuel-8.0/mos-planning-guide.html + Product compatibility matrix ---------------------------- @@ -118,19 +121,15 @@ Install XenServer Fuel Plugin and the new OpenStack release is registered. * - Steps - - | ``[root@fuel-master ~]# fuel plugins`` + | ``fuel plugins --install /tmp/fuel-plugin-xenserver-3.1-3.1.0-1.noarch.rpm`` + | ``fuel plugins`` | ``id | name | version | package_version`` - | ``9 | fuel-plugin-xenserver | 3.0.0 | 3.0.0`` + | ``1 | fuel-plugin-xenserver | 3.1.0 | 4.0.0`` * - Expected Result - | ``fuel plugins`` | ``id | name | version | package_version`` - | ``2 | fuel-plugin-xenserver | 3.0.0 | 3.0.0`` - | ``fuel rel`` - | ``id | name | state | operating_system | version`` - | ``2 | Liberty on Ubuntu 14.04 | available | Ubuntu | liberty-8.0`` - | ``3 | Liberty+Citrix XenServer on Ubuntu 14.04 | available | Ubuntu | liberty-8.0`` - | ``1 | Liberty on CentOS 6.5 | unavailable | CentOS | liberty-8.0`` + | ``1 | fuel-plugin-xenserver | 3.1.0 | 4.0.0`` Prepare Nodes ------------- @@ -224,11 +223,11 @@ Create an OpenStack environment with XenServer Fuel Plugin * - Steps - #. Create new OpenStack environment Fuel Web UI and select - “Liberty+Citrix XenServer on Ubuntu 14.04” in the OpenStack release + “Liberty on Ubuntu 14.04” in the OpenStack release dropdown list - #. Hypervisor is default to QEMU, Network is default to “Neutron with - VLAN segmentation” and Storage is default to Cinder. Other options - are disabled. + #. Check off QEMU and check on XenServer, Network is default to “Neutron + with VLAN segmentation” and Storage is default to Cinder. Other + options are disabled. #. In Nodes Tab, add all 3 Controller Nodes, 3 Compute Nodes and 1 Storage Node. #. Select all Compute Nodes and click “Configure Interfaces”, drag @@ -242,7 +241,7 @@ Create an OpenStack environment with XenServer Fuel Plugin interfaces previous set and make sure network range will not be conflicting with other systems in the same lab. Then click “Verify Networks” button. - #. In the Settings Tab under the side tab “Others”, input the + #. In the Settings Tab under the side tab “Compute”, input the credential applied to all your XenServer hosts. #. Click “Deploy Changes” button * - Expected Result @@ -375,6 +374,29 @@ Modifying env with enabled plugin (removing/adding controller nodes) running” fail. “Some nova services have not been started.. Please refer to OpenStack logs for more details.” +Create mirror and update (setup) of core repos +--------------------------------------------------- + +.. tabularcolumns:: |p{3cm}|p{13cm}| + +.. list-table:: + :header-rows: 0 + + * - Test Case ID + - create_mirror_update_core_repos + * - Description + - Fuel create mirror and update (setup) of core repos + * - Steps + - + #. Create a new environment + #. Launch the following command on the Fuel Master node: ``fuel-createmirror -M`` + #. Launch the following command on the Fuel Master node: ``fuel --env node --node-id --tasks setup_repositories`` + #. Check with fuel nodes command that all nodes are remain in ready status. + #. Deploy the new environment + #. Run Health Check + * - Expected Result + - Plugin is still enabled and configured in the Fuel Web UI. Health Checks are passed. + Uninstall of plugin with deployed environment --------------------------------------------- @@ -389,7 +411,7 @@ Uninstall of plugin with deployed environment - Verify XenServer Fuel Plugin cannot be uninstalled before all dependant environments are removed. * - Steps - - ``fuel plugins --remove fuel-plugin-xenserver==3.0.0`` + - ``fuel plugins --remove fuel-plugin-xenserver==3.1.0`` * - Expected Result - 400 Client Error: Bad Request (Can't delete plugin which is enabled for some environment.) @@ -408,19 +430,15 @@ Uninstall of plugin - Verify XenServer Fuel Plugin can be uninstalled as well as XenServer OpenStack release after all dependant environments are removed. * - Steps - - | ``fuel plugins --remove fuel-plugin-xenserver==3.0.0`` - | ``fuel rel`` - | ``id | name | state | operating_system | version`` - | ``2 | Liberty on Ubuntu 14.04 | available | Ubuntu | liberty-8.0`` - | ``3 | Liberty+Citrix XenServer on Ubuntu 14.04 | available | Ubuntu | liberty-8.0`` - | ``1 | Liberty on CentOS 6.5 | unavailable | CentOS | liberty-8.0`` + - | ``fuel plugins --remove fuel-plugin-xenserver==3.1.0`` + | ``fuel plugins`` * - Expected Result - - Both of plugin and release are removed. + - Plugin is removed. Appendix ======== -* XenServer Fuel Plugin GitHub: https://git.openstack.org/openstack/fuel-plugin-xenserver +* XenServer Fuel Plugin Repository: https://git.openstack.org/cgit/openstack/fuel-plugin-xenserver * XenCenter HIMN Plugin GitHub: https://github.com/citrix-openstack/xencenter-himn-plugin * Plugin download server: http://ca.downloads.xensource.com/OpenStack/Plugins/ @@ -445,4 +463,8 @@ Revision history * - 3.0 - 22.03.2016 - John Hua (john.hua@citrix.com) - - Revised for Fuel 8.0 \ No newline at end of file + - Revised for Fuel 8.0 + * - 3.1 + - 22.03.2016 + - John Hua (john.hua@citrix.com) + - Revised for plugin 3.1.0 \ No newline at end of file diff --git a/doc/source/test-report.rst b/doc/source/test-report.rst index 1979ede..b145b58 100644 --- a/doc/source/test-report.rst +++ b/doc/source/test-report.rst @@ -30,12 +30,16 @@ Revision history - 19.04.2016 - John Hua(john.hua@citrix.com) - Rewrite in RST + * - 3.2 + - 12.05.2016 + - John Hua(john.hua@citrix.com) + - Revised for plugin 3.1.0 Document purpose ================ This document provides test run results for the XenServer Fuel Plugin version -3.0.0 on Mirantis OpenStack 8.0. +3.1.0 on Mirantis OpenStack 8.0. Test environment ================ @@ -85,7 +89,7 @@ System Testing * - Parameter - Value * - Total quantity of executed test cases - - 12 + - 13 * - Total quantity of not executed test cases - 0 * - Quantity of automated test cases @@ -172,12 +176,18 @@ Detailed test run results required services are running” fail. “Some nova services have not been started.. Please refer to OpenStack logs for more details.” * - 11 - - Uninstall of plugin with deployed environment + - Create mirror and update (setup) of core repos - Yes - - - * - 12 + - Uninstall of plugin with deployed environment + - Yes + - + - + - + * - 13 - Uninstall of plugin - Yes - @@ -185,7 +195,7 @@ Detailed test run results - * - Total - - - 12 + - 13 - 0 - 0 - diff --git a/doc/source/troubleshooting.rst b/doc/source/troubleshooting.rst new file mode 100644 index 0000000..21d61d9 --- /dev/null +++ b/doc/source/troubleshooting.rst @@ -0,0 +1,21 @@ +Troubleshooting +=============== + +#. Logging + + In addition to the Astute log, XenServer Fuel Plugin has its own log under + /var/log/fuel-plugin-xenserver on all Compute and Controller nodes. + + Besides HIMN tool mentioned in Installation Guide also has its own log + under ``%LOCALAPPDATA%/Temp/XCHIMN.log``. + + You can upload issued logs to https://cis.citrix.com or send to support if + they are requested. `Writing Good Bug Reports for XenServer`_ might be a + good reference to follow. + +#. XenServer hotfixes + + If you are using XenServer 6.5, please install SP1 and all hotfixes before + attempting to deploy. + +.. _Writing Good Bug Reports for XenServer: https://www.citrix.com/blogs/2012/07/16/writing-good-bug-reports-for-xenserver/ diff --git a/doc/test-plan.pdf b/doc/test-plan.pdf index 6ba9312..2c3de3e 100644 Binary files a/doc/test-plan.pdf and b/doc/test-plan.pdf differ diff --git a/doc/test-report.pdf b/doc/test-report.pdf index 58228ab..5a574e9 100644 Binary files a/doc/test-report.pdf and b/doc/test-report.pdf differ