diff options
| -rw-r--r-- | doc/book-enea-nfv-access-example-usecases/doc/inband_management.xml | 271 |
1 files changed, 129 insertions, 142 deletions
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/inband_management.xml b/doc/book-enea-nfv-access-example-usecases/doc/inband_management.xml index f557cbc..4a5cd06 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/inband_management.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/inband_management.xml | |||
| @@ -5,13 +5,13 @@ | |||
| 5 | <para>In the case of an NFV Access device installed on a network with | 5 | <para>In the case of an NFV Access device installed on a network with |
| 6 | limited access, In-band management can be a solution to manage the device | 6 | limited access, In-band management can be a solution to manage the device |
| 7 | and to pass data traffic (through only one physical interface). This example | 7 | and to pass data traffic (through only one physical interface). This example |
| 8 | use-case will show how to enable the In-band management on the NFV Access | 8 | use-case will show how to enable In-band management on the NFV Access |
| 9 | device and to access a VNF on the same physical interface.</para> | 9 | device and to access a VNF on the same physical interface.</para> |
| 10 | 10 | ||
| 11 | <section id="inband_mg_uc_preq"> | 11 | <section id="inband_mg_uc_preq"> |
| 12 | <title>Prerequisites</title> | 12 | <title>Prerequisites</title> |
| 13 | 13 | ||
| 14 | <para>This use-case requires the following network configuration:</para> | 14 | <para>System requirements for the uCPE device:</para> |
| 15 | 15 | ||
| 16 | <itemizedlist> | 16 | <itemizedlist> |
| 17 | <listitem> | 17 | <listitem> |
| @@ -23,6 +23,39 @@ | |||
| 23 | </listitem> | 23 | </listitem> |
| 24 | </itemizedlist> | 24 | </itemizedlist> |
| 25 | 25 | ||
| 26 | <note> | ||
| 27 | <para>No other physical port for In-band management can be used. | ||
| 28 | <remark>FIXME: What does this mean?</remark></para> | ||
| 29 | </note> | ||
| 30 | |||
| 31 | <para>The following files are needed for this example use case:</para> | ||
| 32 | |||
| 33 | <itemizedlist> | ||
| 34 | <listitem> | ||
| 35 | <para>FortiGate VNF image. This file is provided by the local Fortinet | ||
| 36 | sales representatives in your region.</para> | ||
| 37 | </listitem> | ||
| 38 | |||
| 39 | <listitem> | ||
| 40 | <para>FortiGate VNF license file. This file is provided by the local | ||
| 41 | Fortinet sales representatives in your region.</para> | ||
| 42 | </listitem> | ||
| 43 | |||
| 44 | <listitem> | ||
| 45 | <para>FortiGate specific documentation. This is provided by the local | ||
| 46 | Fortinet sales representatives in your region.</para> | ||
| 47 | </listitem> | ||
| 48 | |||
| 49 | <listitem> | ||
| 50 | <para>FortiGate configuration example files. These files are provided | ||
| 51 | with your Enea NFV Access release.</para> | ||
| 52 | </listitem> | ||
| 53 | </itemizedlist> | ||
| 54 | </section> | ||
| 55 | |||
| 56 | <section id="inband_mg_fortivnf_uc"> | ||
| 57 | <title>In-band Management Activation</title> | ||
| 58 | |||
| 26 | <para>In-band management activation is done by creating a special bridge | 59 | <para>In-band management activation is done by creating a special bridge |
| 27 | which manages all traffic from the WAN interface. The active physical port | 60 | which manages all traffic from the WAN interface. The active physical port |
| 28 | of the device (used by the device manager to communicate with the uCPE | 61 | of the device (used by the device manager to communicate with the uCPE |
| @@ -31,18 +64,11 @@ | |||
| 31 | <para>Once the In-band management bridge is activated, communication to | 64 | <para>Once the In-band management bridge is activated, communication to |
| 32 | the uCPE Manager will be reactivated, passing through the bridge.</para> | 65 | the uCPE Manager will be reactivated, passing through the bridge.</para> |
| 33 | 66 | ||
| 34 | <note> | 67 | <para>For further details, please see <olink targetdoc="book_enea_nfv_access_getting_started" |
| 35 | <para>No other physical port for In-band management can be used.</para> | 68 | targetptr="in_band_managemen">in_band_managemen in <xi:include |
| 36 | </note> | 69 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
| 37 | 70 | xmlns:xi="http://www.w3.org/2001/XInclude" | |
| 38 | <para>For further details, please see <xref | 71 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>.</para> |
| 39 | linkend="vnf_fortigate" /><remark>Are these references still | ||
| 40 | valid?</remark>.</para> | ||
| 41 | </section> | ||
| 42 | |||
| 43 | <section id="inband_mg_fortivnf_uc"> | ||
| 44 | <title>In-band management activation for FortiGate VNF | ||
| 45 | Instantiation</title> | ||
| 46 | 72 | ||
| 47 | <figure> | 73 | <figure> |
| 48 | <title>NFV Access In-band management solution setup</title> | 74 | <title>NFV Access In-band management solution setup</title> |
| @@ -50,7 +76,7 @@ | |||
| 50 | <mediaobject> | 76 | <mediaobject> |
| 51 | <imageobject> | 77 | <imageobject> |
| 52 | <imagedata align="center" fileref="images/uc_ibm_solution_test.png" | 78 | <imagedata align="center" fileref="images/uc_ibm_solution_test.png" |
| 53 | scale="55" /> | 79 | contentwidth="600" /> |
| 54 | </imageobject> | 80 | </imageobject> |
| 55 | </mediaobject> | 81 | </mediaobject> |
| 56 | </figure> | 82 | </figure> |
| @@ -58,156 +84,117 @@ | |||
| 58 | <section id="inband_examuc_setup"> | 84 | <section id="inband_examuc_setup"> |
| 59 | <title>Use-case Setup</title> | 85 | <title>Use-case Setup</title> |
| 60 | 86 | ||
| 61 | <para><emphasis role="bold">Configuring Network Interfaces on uCPE | 87 | <para><emphasis role="bold">Network Configuration:</emphasis></para> |
| 62 | devices:</emphasis></para> | ||
| 63 | 88 | ||
| 64 | <orderedlist> | 89 | <orderedlist> |
| 65 | <listitem> | 90 | <listitem> |
| 66 | <para>Create an In-band management WAN Bridge:</para> | 91 | <para>Create an In-band management WAN Bridge (set |
| 67 | 92 | <literal>dpdkWan</literal> as the bridge type).</para> | |
| 68 | <itemizedlist spacing="compact"> | ||
| 69 | <listitem> | ||
| 70 | <para>Select the <literal>Device</literal> menu.</para> | ||
| 71 | </listitem> | ||
| 72 | |||
| 73 | <listitem> | ||
| 74 | <para>In the Configuration tab select | ||
| 75 | <literal>OpenVSwitch.</literal></para> | ||
| 76 | </listitem> | ||
| 77 | |||
| 78 | <listitem> | ||
| 79 | <para>Select <literal>Bridges</literal> and click | ||
| 80 | <literal>Add</literal>.</para> | ||
| 81 | </listitem> | ||
| 82 | |||
| 83 | <listitem> | ||
| 84 | <para>Use <literal>dpdkWAN</literal> as the | ||
| 85 | <literal>ovs-bridge-type</literal>.</para> | ||
| 86 | </listitem> | ||
| 87 | </itemizedlist> | ||
| 88 | </listitem> | 93 | </listitem> |
| 89 | 94 | ||
| 90 | <listitem> | 95 | <listitem> |
| 91 | <para>Bind the physical port which will be used for LAN access to | 96 | <para>Bind the physical network interface that will be used for LAN |
| 92 | <literal>dpdk</literal>:</para> | 97 | access to the <literal>DPDK</literal>.</para> |
| 93 | |||
| 94 | <itemizedlist spacing="compact"> | ||
| 95 | <listitem> | ||
| 96 | <para>Select the <literal>Device</literal> menu.</para> | ||
| 97 | </listitem> | ||
| 98 | |||
| 99 | <listitem> | ||
| 100 | <para>In the Configuration tab select | ||
| 101 | <literal>OpenVSwitch</literal>.</para> | ||
| 102 | </listitem> | ||
| 103 | |||
| 104 | <listitem> | ||
| 105 | <para>Select the <literal>Host Interfaces</literal> menu and | ||
| 106 | click <literal>Add</literal>.</para> | ||
| 107 | </listitem> | ||
| 108 | |||
| 109 | <listitem> | ||
| 110 | <para>Use <literal>dpdk</literal> as the | ||
| 111 | <literal>ovs-bridge-type</literal>.</para> | ||
| 112 | </listitem> | ||
| 113 | </itemizedlist> | ||
| 114 | </listitem> | 98 | </listitem> |
| 115 | 99 | ||
| 116 | <listitem> | 100 | <listitem> |
| 117 | <para>Create a LAN Bridge:</para> | 101 | <para>Create a LAN Bridge and attach the DPDK LAN interface.</para> |
| 118 | |||
| 119 | <itemizedlist spacing="compact"> | ||
| 120 | <listitem> | ||
| 121 | <para>Select the <literal>Device</literal>.</para> | ||
| 122 | </listitem> | ||
| 123 | |||
| 124 | <listitem> | ||
| 125 | <para>In the Configuration menu select | ||
| 126 | <literal>OpenVSwitch</literal>.</para> | ||
| 127 | </listitem> | ||
| 128 | |||
| 129 | <listitem> | ||
| 130 | <para>Open the <literal>Bridges</literal> menu and click | ||
| 131 | <literal>Add</literal>.</para> | ||
| 132 | </listitem> | ||
| 133 | </itemizedlist> | ||
| 134 | |||
| 135 | <para>At this step the following bridges should exist:</para> | ||
| 136 | |||
| 137 | <figure> | ||
| 138 | <title>Bridges</title> | ||
| 139 | |||
| 140 | <mediaobject> | ||
| 141 | <imageobject> | ||
| 142 | <imagedata align="center" fileref="images/uc_ibm_br2.png" | ||
| 143 | scale="65" /> | ||
| 144 | </imageobject> | ||
| 145 | </mediaobject> | ||
| 146 | </figure> | ||
| 147 | |||
| 148 | <note> | ||
| 149 | <para>The WAN port of the very first VNF instantiated on the | ||
| 150 | device must be connected to the | ||
| 151 | <literal>ibm-wan-br</literal>bridge. All other VNFs must be | ||
| 152 | connected in chain with the first VNF.</para> | ||
| 153 | </note> | ||
| 154 | </listitem> | 102 | </listitem> |
| 155 | </orderedlist> | 103 | </orderedlist> |
| 156 | 104 | ||
| 157 | <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para> | 105 | <note> |
| 106 | <para>The WAN port of the very first VNF instantiated on the device | ||
| 107 | must be connected to the <literal>WAN</literal> bridge. All other VNFs | ||
| 108 | must be connected in chain with the first VNF.</para> | ||
| 109 | </note> | ||
| 158 | 110 | ||
| 159 | <orderedlist> | 111 | <para><emphasis role="bold">Onboarding the VNF:</emphasis></para> |
| 160 | <listitem> | ||
| 161 | <para>Select the <literal>Device</literal>.</para> | ||
| 162 | </listitem> | ||
| 163 | 112 | ||
| 164 | <listitem> | 113 | <para>See onboarding parameters in <xref linkend="fortigate_firewall_uc_1" />.</para> |
| 165 | <para>Select the <literal>VNF</literal> menu.</para> | ||
| 166 | </listitem> | ||
| 167 | 114 | ||
| 168 | <listitem> | 115 | <para><emphasis role="bold">Instantiating the VNF:</emphasis></para> |
| 169 | <para>In the <literal>Descriptors</literal> menu, choose the | ||
| 170 | <literal>VNF Package</literal> option.</para> | ||
| 171 | </listitem> | ||
| 172 | 116 | ||
| 173 | <listitem> | 117 | <para>Instantiate the FortiGate VNF by filling the required fields with |
| 174 | <para>Browse and select the Fortigate bundle you require, before | 118 | the following values:</para> |
| 175 | pressing the <literal>Send</literal> button.</para> | ||
| 176 | </listitem> | ||
| 177 | </orderedlist> | ||
| 178 | 119 | ||
| 179 | <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para> | 120 | <table> |
| 121 | <title>Instantiation Requirements</title> | ||
| 180 | 122 | ||
| 181 | <orderedlist> | 123 | <tgroup cols="2"> |
| 182 | <listitem> | 124 | <colspec align="center" colwidth="1*" /> |
| 183 | <para>Select the <literal>Device</literal>.</para> | ||
| 184 | </listitem> | ||
| 185 | 125 | ||
| 186 | <listitem> | 126 | <colspec align="center" colwidth="4*" /> |
| 187 | <para>Select the <literal>VNF</literal> menu.</para> | ||
| 188 | </listitem> | ||
| 189 | 127 | ||
| 190 | <listitem> | 128 | <thead> |
| 191 | <para>Choose the <literal>Instances</literal> option, select the VNF | 129 | <row> |
| 192 | configuration you desire and press <literal>Add</literal>.</para> | 130 | <entry align="center">Field</entry> |
| 193 | </listitem> | ||
| 194 | 131 | ||
| 195 | <listitem> | 132 | <entry align="center">Description</entry> |
| 196 | <para>Browse and select the Fortigate bundle you require, before | 133 | </row> |
| 197 | pressing the <literal>Send</literal> button.</para> | 134 | </thead> |
| 198 | </listitem> | 135 | |
| 199 | </orderedlist> | 136 | <tbody> |
| 137 | <row> | ||
| 138 | <entry align="left">Name</entry> | ||
| 139 | |||
| 140 | <entry align="left">Name of the VM which will be created on the | ||
| 141 | uCPE device.</entry> | ||
| 142 | </row> | ||
| 143 | |||
| 144 | <row> | ||
| 145 | <entry align="left">VNF Type</entry> | ||
| 146 | |||
| 147 | <entry align="left">Name of the onboarded VNF.</entry> | ||
| 148 | </row> | ||
| 149 | |||
| 150 | <row> | ||
| 151 | <entry align="left">uCPE Device</entry> | ||
| 152 | |||
| 153 | <entry align="left">Select the uCPE device where the VNF will be | ||
| 154 | instantiated.</entry> | ||
| 155 | </row> | ||
| 156 | |||
| 157 | <row> | ||
| 158 | <entry align="left">License file</entry> | ||
| 159 | |||
| 160 | <entry align="left">The FortiGate license file provided by | ||
| 161 | Fortinet.</entry> | ||
| 162 | </row> | ||
| 163 | |||
| 164 | <row> | ||
| 165 | <entry align="left">Configuration file</entry> | ||
| 166 | |||
| 167 | <entry align="left">The Firewall example configuration file provided | ||
| 168 | by Enea | ||
| 169 | (<filename>FGVM080000136187_20180828_0353_basic_fw.conf</filename>).</entry> | ||
| 170 | </row> | ||
| 171 | |||
| 172 | <row> | ||
| 173 | <entry align="left">Port1 - WAN</entry> | ||
| 174 | |||
| 175 | <entry align="left">Set the <literal>External Interface</literal> type to | ||
| 176 | <literal>DPDK</literal> and connect it to the <literal>ibm-wan-br</literal> ovs | ||
| 177 | bridge.</entry> | ||
| 178 | </row> | ||
| 179 | |||
| 180 | <row> | ||
| 181 | <entry align="left">Port2 - LAN1</entry> | ||
| 182 | |||
| 183 | <entry align="left">Set the <literal>Incoming Interface</literal> type to | ||
| 184 | <literal>DPDK</literal> and connect it to the <literal>lan-br</literal> ovs | ||
| 185 | bridge.</entry> | ||
| 186 | </row> | ||
| 200 | 187 | ||
| 201 | <figure> | 188 | <row> |
| 202 | <title>Instantiate the FortiGate VNF</title> | 189 | <entry align="left">Port3 - LAN2</entry> |
| 203 | 190 | ||
| 204 | <mediaobject> | 191 | <entry align="left">Set the <literal>Outgoing Interface</literal> type to |
| 205 | <imageobject> | 192 | <literal>DPDK</literal> and connect it to the <literal>lan-br</literal> ovs |
| 206 | <imagedata align="center" | 193 | bridge.</entry> |
| 207 | fileref="images/uc_ibm_fg_instantiation.png" scale="65" /> | 194 | </row> |
| 208 | </imageobject> | 195 | </tbody> |
| 209 | </mediaobject> | 196 | </tgroup> |
| 210 | </figure> | 197 | </table> |
| 211 | </section> | 198 | </section> |
| 212 | 199 | ||
| 213 | <section id="test_fortvnf_inband"> | 200 | <section id="test_fortvnf_inband"> |
