From 6b685c3cc9bea959053aed08a894931701df8cbb Mon Sep 17 00:00:00 2001
From: Sona Sarmadi <sona.sarmadi@enea.com>
Date: Mon, 28 Oct 2019 14:36:03 +0100
Subject: ExampleUseCases: fortigate VNF interfaces order
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The Fortigate SD-WAN use case assumes that interfaces
are added in the order listed below:
• Port1 - VNF Mgr: Set the type to DPDK and connect it to the vnfmgrbr bridge.
• Port2 - WAN: Set the type to DPDK and connect it to the wanbr bridge.
• Port3 - LAN: Set the type to DPDK and connect it to the lanbr bridge.

The example doesn't work if we add interfaces in other order.

Change-Id: I151472bbc04d3c6cfe5375a932db5ee7ee831a6a
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
---
 .../doc/forti_vnf_examples.xml                     | 77 +++++++++++++++++++---
 1 file changed, 68 insertions(+), 9 deletions(-)

(limited to 'doc/book-enea-nfv-access-example-usecases')

diff --git a/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml
index fcb8c87..06b1701 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml
@@ -32,13 +32,14 @@
       <para>VNF image:</para>
 
       <listitem>
-        <para>FortiGate VNF. Please contact Fortinet to get a VNF image and its license file.</para>
+        <para>FortiGate VNF. Please contact Fortinet to get a VNF image and
+        its license file.</para>
       </listitem>
     </itemizedlist>
 
     <itemizedlist>
-      <para>VNF Configuration files, provided with your Enea 
-        NFV Access release:</para>
+      <para>VNF Configuration files, provided with your Enea NFV Access
+      release:</para>
 
       <listitem>
         <para><filename>fortigate-basic-fw.conf</filename>.</para>
@@ -54,8 +55,8 @@
     <title>FortiGate VNF as a Firewall</title>
 
     <para>Enea provides an example of a simple basic firewall configuration
-    for the FortiGate VNF. FortiGate In-Band Management is a
-    feature used for running FortiGate Management traffic over WAN.</para>
+    for the FortiGate VNF. FortiGate In-Band Management is a feature used for
+    running FortiGate Management traffic over WAN.</para>
 
     <para>Instructions on how to alter the default configuration are provided
     in section <olink targetdoc="book_enea_nfv_access_example_usecases"
@@ -320,11 +321,69 @@
         </listitem>
       </itemizedlist>
 
-      <para><emphasis role="bold">Onboarding the FortiGate
-      VNF</emphasis>:</para>
+      <para><emphasis role="bold">Onboarding the VNF</emphasis>:</para>
+
+      <para>Onboard the FortiGate VNF by filling the required fields with the
+      following values:</para>
+
+      <itemizedlist spacing="compact">
+        <listitem>
+          <para><emphasis role="bold">VM Image File</emphasis>: Provide the
+          path to the FortiGate VNF qcow2 image.</para>
+        </listitem>
+
+        <listitem>
+          <para><emphasis role="bold">Memory in MB</emphasis>: 1024</para>
+        </listitem>
+
+        <listitem>
+          <para><emphasis role="bold">Num of CPUs</emphasis>: 1</para>
+        </listitem>
+
+        <listitem>
+          <para><emphasis role="bold">Storage in GB</emphasis>: 20</para>
+        </listitem>
 
-      <para>See the onboarding parameters detailed in the previous use-case
-      above.</para>
+        <listitem>
+          <para><emphasis role="bold">Interfaces</emphasis>: Add 3 interfaces
+          in the same order as listed below:</para>
+
+          <itemizedlist spacing="compact">
+            <listitem>
+              <para><emphasis role="bold">vnfmgr</emphasis>: to connect it to
+              the <literal>vnfmgrbr</literal> bridge.</para>
+            </listitem>
+
+            <listitem>
+              <para><emphasis role="bold">wan:</emphasis> to connect it to the
+              <literal>wanbr</literal> bridge.</para>
+            </listitem>
+
+            <listitem>
+              <para><emphasis role="bold">lan:</emphasis> to connect it to the
+              <literal>lanbr</literal> bridge.</para>
+            </listitem>
+          </itemizedlist>
+        </listitem>
+
+        <listitem>
+          <para><emphasis role="bold">Cloud-init Datasource</emphasis>:
+          ConfigDrive</para>
+        </listitem>
+
+        <listitem>
+          <para><emphasis role="bold">Cloud-init Disk Type</emphasis>:
+          cdrom</para>
+        </listitem>
+
+        <listitem>
+          <para><emphasis role="bold">Cloud-init content file</emphasis>: Add
+          a license file entry.</para>
+        </listitem>
+      </itemizedlist>
+      
+      <note><para>The order of the interfaces that need to be added must be exactly 
+        as listed above or else onboarding and in turn instantiation will fail.</para></note>
 
       <para><emphasis role="bold">Instantiating the FortiGate
       VNF</emphasis>:</para>
-- 
cgit v1.2.3-54-g00ecf