From b168db564d7f8efba1a9b079e1a03c43ebc7a188 Mon Sep 17 00:00:00 2001 From: Artem Savinov Date: Mon, 11 Jul 2016 12:59:22 +0300 Subject: [PATCH] Fixes in user guide Change-Id: I1d742e84aec8b8671a44249849d3eaa31276ac15 --- doc/user/source/build.rst | 14 +++++++++++--- doc/user/source/configuration.rst | 18 +++++++++--------- doc/user/source/installation.rst | 6 +++--- doc/user/source/limitations.rst | 7 +++---- doc/user/source/release-notes.rst | 3 +++ doc/user/source/usage.rst | 3 +++ 6 files changed, 32 insertions(+), 19 deletions(-) diff --git a/doc/user/source/build.rst b/doc/user/source/build.rst index 6a1fed0..fd55707 100644 --- a/doc/user/source/build.rst +++ b/doc/user/source/build.rst @@ -1,11 +1,11 @@ How to build the plugin from source =================================== -To build the plugin you first need to install fuel-plugin-builder_ 4.0.0 +To build the plugin you first need to install fuel-plugin-builder_ 4.1.0 .. code-block:: bash - $ pip install fuel-plugin-builder==4.0.0 + $ pip install fuel-plugin-builder==4.1.0 After that you can build the plugin: @@ -23,6 +23,14 @@ upstream fuel-library_ puppet modules that plugin use. It can be installed via $ gem install librarian-puppet +or if you are using ubuntu linux - you can install it from the repository: + +.. code-block:: bash + + $ apt-get install librarian-puppet + +and build plugin: + .. code-block:: bash $ fpb --build . @@ -34,7 +42,7 @@ upload to Fuel master node: $ ls nsxv-*.rpm - nsxv-2.0-2.0.0-1.noarch.rpm + nsxv-3.0-3.0.0-1.noarch.rpm .. _fuel-plugin-builder: https://pypi.python.org/pypi/fuel-plugin-builder/4.0.0 .. _librarian-puppet: http://librarian-puppet.com diff --git a/doc/user/source/configuration.rst b/doc/user/source/configuration.rst index 27dabb4..b6d3f5b 100644 --- a/doc/user/source/configuration.rst +++ b/doc/user/source/configuration.rst @@ -113,6 +113,15 @@ Plugin contains the following settings: deployed in active/standby pair on different ESXi hosts. Setting change on deployed cluster affects only new Edges. +#. Init metadata infrastructure -- If enabled, instance will attempt to + initialize the metadata infrastructure to access to metadata proxy service, + otherwise metadata proxy will not be deployed. + +#. Bypass metadata service certificate verification -- If enabled connection + metadata service will be listening HTTP port. Otherwise self-signed + certificate will be generated, installed into edge nodes and + nova-api-metadata, HTTPS will be enabled. + #. Which network will be used to access the nova-metadata -- select network through which nova-api-metadata service will be available for NSX edge nodes. Currently two options are available *Public* and *Management* @@ -131,15 +140,6 @@ Plugin contains the following settings: To enable Nova metadata service, the following settings must be set: -#. Init metadata infrastructure -- If enabled, instance will attempt to - initialize the metadata infrastructure to access to metadata proxy service, - otherwise metadata proxy will not be deployed. - -#. Bypass metadata service certificate verification -- If enabled connection - metadata service will be listening HTTP port. Otherwise self-signed - certificate will be generated, installed into edge nodes and - nova-api-metadata, HTTPS will be enabled. - #. Metadata allowed ports -- comma separated list of TCP port allowed access to the metadata proxy, in addition to 80, 443 and 8775. diff --git a/doc/user/source/installation.rst b/doc/user/source/installation.rst index d9a3c56..3bb7ab8 100644 --- a/doc/user/source/installation.rst +++ b/doc/user/source/installation.rst @@ -9,7 +9,7 @@ Installation .. code-block:: bash - [root@nailgun ~] fuel plugins --install nsxv-2.0-2.0.0-1.noarch.rpm + [root@nailgun ~] fuel plugins --install nsxv-3.0-3.0.0-1.noarch.rpm #. Verify that the plugin is installed successfully: @@ -19,7 +19,7 @@ Installation [root@nailgun ~] fuel plugins id | name | version | package_version ---|------|---------|---------------- - 1 | nsxv | 2.0.0 | 4.0.0 + 1 | nsxv | 3.0.0 | 4.0.0 After installation plugin can be used for new OpenStack clusters, it is not possible to enable plugin on deployed clusters. @@ -34,6 +34,6 @@ To uninstall plugin run following: .. code-block:: bash - [root@nailgun ~] fuel plugins --remove nsxv==2.0.0 + [root@nailgun ~] fuel plugins --remove nsxv==3.0.0 .. _Fuel plugin catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins diff --git a/doc/user/source/limitations.rst b/doc/user/source/limitations.rst index ea9f46f..0bdba49 100644 --- a/doc/user/source/limitations.rst +++ b/doc/user/source/limitations.rst @@ -1,14 +1,13 @@ Limitations =========== -Nested clusters are not supported +Vcenter cluster names must be unique within the data center --------------------------------- vCenter inventory allows user to form hierarchy by organizing vSphere entities into folders. Clusters by default are created on first level of hierarchy, then -they can be put into folders. Plugin supports clusters that are located on -first level of hierarchy, if you have cluster inside folder that you want to -use it for OpenStack you have to put it on first level of hierarchy. +they can be put into folders. Plugin supports the clusters that are located on +all levels of the hierarchy, thus cluster names must be unique. Incompatible roles are explicitly hidden ---------------------------------------- diff --git a/doc/user/source/release-notes.rst b/doc/user/source/release-notes.rst index fb9f858..abec7e4 100644 --- a/doc/user/source/release-notes.rst +++ b/doc/user/source/release-notes.rst @@ -12,6 +12,9 @@ Release notes for Fuel NSXv plugin 3.0.0: network. * LBaaS v2 support gets configured by default. * Troubleshooting section was added to plugin guide. + * The plugin supports searching vcenter clusters name across a given data center + hierarchy. + * Add new parameters that were added to Neutron NSX plugin during Mitaka release. Release notes for Fuel NSXv plugin 2.0.0: diff --git a/doc/user/source/usage.rst b/doc/user/source/usage.rst index 0591b88..eaab22f 100644 --- a/doc/user/source/usage.rst +++ b/doc/user/source/usage.rst @@ -37,6 +37,9 @@ Summarizing all of these we get 1554 bytes. Consider increasing MTU on network hardware up to 1600 bytes (default MTU value when you are configuring VXLAN on ESXi hosts during *Host Preparation* step). +To configure the jumbo frame please look recommendations from here: +https://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2093324 + Instances usage notes ---------------------