summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/build-instruction.rst15
-rw-r--r--docs/img/fuelconsole1.pngbin0 -> 8269 bytes
-rw-r--r--docs/img/offloadingmodes.pngbin0 -> 23017 bytes
-rw-r--r--docs/installation-instruction.rst57
-rw-r--r--docs/release-notes.rst2
5 files changed, 65 insertions, 9 deletions
diff --git a/docs/build-instruction.rst b/docs/build-instruction.rst
index 2d66b7c00..380d28241 100644
--- a/docs/build-instruction.rst
+++ b/docs/build-instruction.rst
@@ -102,20 +102,27 @@ Clone the OPNFV code Git repository with your SSH key
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Now it is time to clone the code repository:
-$ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/fuel
+.. code-block:: bash
+
+ $ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/fuel
Now you should have the OPNFV fuel repository with the Fuel
directories stored locally on your build host.
Check out the Brahmaputra release:
-$ cd fuel
-$ git checkout brahmaputra.1.0
+
+.. code-block:: bash
+
+ $ cd fuel
+ $ git checkout brahmaputra.1.0
Clone the OPNFV code Git repository without a SSH key
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can also opt to clone the code repository without a SSH key:
-$ git clone https://gerrit.opnfv.org:29418/gerrit/fuel
+.. code-block:: bash
+
+ $ git clone https://gerrit.opnfv.org/gerrit/fuel
Make sure to checkout the release tag as described above.
diff --git a/docs/img/fuelconsole1.png b/docs/img/fuelconsole1.png
new file mode 100644
index 000000000..61703cab1
--- /dev/null
+++ b/docs/img/fuelconsole1.png
Binary files differ
diff --git a/docs/img/offloadingmodes.png b/docs/img/offloadingmodes.png
new file mode 100644
index 000000000..5b3cb17bc
--- /dev/null
+++ b/docs/img/offloadingmodes.png
Binary files differ
diff --git a/docs/installation-instruction.rst b/docs/installation-instruction.rst
index 787287a9b..d1036dd9e 100644
--- a/docs/installation-instruction.rst
+++ b/docs/installation-instruction.rst
@@ -51,9 +51,9 @@ Building the ISO image
Alternatively, you may build the Fuel .iso from source by cloning the
opnfv/fuel git repository. To retrieve the repository for the Brahmaputra release use the following command:
-$git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/fuel
+$ git clone https://gerrit.opnfv.org/gerrit/fuel
-Check-out the Brahmaputra release tag to set the branch to the
+Check-out the Brahmaputra release tag to set the HEAD to the
baseline required to replicate the Brahmaputra release:
$ git checkout brahmaputra.1.0
@@ -335,7 +335,7 @@ Create an OpenStack Environment
#. Select "additional services" you wish to install.
- - Check option "Install Celiometer (OpenStack Telemetry)" and press <Next>
+ - Check option "Install Ceilometer (OpenStack Telemetry)" and press <Next>
#. Create the new environment.
@@ -534,6 +534,55 @@ that can be used for installation / deployment of openstack.
- Click <Save Settings> at the bottom to Save your changes
+Target specific configuration
+-----------------------------
+
+#. Set up targets for provisioning with non-default "Offloading Modes"
+
+ Some target nodes may require additional configuration after they are
+ PXE booted (bootstrapped); the most frequent changes are in defaults
+ for ethernet devices' "Offloading Modes" settings (e.g. some targets'
+ ethernet drivers may strip VLAN traffic by default).
+
+ If your target ethernet drivers have wrong "Offloading Modes" defaults,
+ in "Configure interfaces" page (described above), expand affected
+ interface's "Offloading Modes" and [un]check the relevant settings
+ (see figure below):
+
+ .. figure:: img/offloadingmodes.png
+
+#. Set up targets for "Verify Networks" with non-default "Offloading Modes"
+
+ **NOTE**: Check *Reference 15* for an updated and comprehensive list of
+ known issues and/or limitations, including "Offloading Modes" not being
+ applied during "Verify Networks" step.
+
+ Setting custom "Offloading Modes" in Fuel GUI will only apply those settings
+ during provisiong and **not** during "Verify Networks", so if your targets
+ need this change, you have to apply "Offloading Modes" settings by hand
+ to bootstrapped nodes.
+
+ **E.g.**: Our driver has "rx-vlan-filter" default "on" (expected "off") on
+ the Openstack interface(s) "eth1", preventing VLAN traffic from passing
+ during "Verify Networks".
+
+ - From Fuel master console identify target nodes admin IPs (see figure below):
+
+ .. code-block:: bash
+
+ $ fuel nodes
+
+ .. figure:: img/fuelconsole1.png
+
+ - SSH into each of the target nodes and disable "rx-vlan-filter" on the
+ affected physical interface(s) allocated for OpenStack traffic (eth1):
+
+ .. code-block:: bash
+
+ $ ssh root@10.20.0.6 ethtool -K eth1 rx-vlan-filter off
+
+ - Repeat the step above for all affected nodes/interfaces in the POD.
+
Verify Networks
---------------
@@ -583,7 +632,7 @@ References
OPNFV
-----
-1) `OPNFV Home Page <www.opnfv.org>`_
+1) `OPNFV Home Page <http://www.opnfv.org>`_
2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 7d86edbf7..7339b596b 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -203,7 +203,7 @@ For more information on the OPNFV Brahmaputra release, please see:
OPNFV
-----
-1) `OPNFV Home Page <www.opnfv.org>`_
+1) `OPNFV Home Page <http://www.opnfv.org>`_
2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_