diff options
| -rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml | 6 | ||||
| -rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml | 2 | ||||
| -rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | 9 | ||||
| -rwxr-xr-x | doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement.png | bin | 32679 -> 67969 bytes | |||
| -rwxr-xr-x | doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement2.png | bin | 34722 -> 54137 bytes | |||
| -rwxr-xr-x | doc/book-enea-nfv-access-getting-started/doc/images/sriov_interface_type.png | bin | 5269 -> 14802 bytes | |||
| -rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml | 130 | ||||
| -rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/introduction.xml | 8 |
8 files changed, 91 insertions, 64 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml index 3b7c5f8..6115af0 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml | |||
| @@ -146,11 +146,11 @@ | |||
| 146 | </listitem> | 146 | </listitem> |
| 147 | 147 | ||
| 148 | <listitem> | 148 | <listitem> |
| 149 | <para>Type: dpdk, sr-iov</para> | 149 | <para>Type: dpdk</para> |
| 150 | </listitem> | 150 | </listitem> |
| 151 | 151 | ||
| 152 | <listitem> | 152 | <listitem> |
| 153 | <para>Networking-type: dpdk, SR-IOV</para> | 153 | <para>Networking-type: dpdk</para> |
| 154 | </listitem> | 154 | </listitem> |
| 155 | 155 | ||
| 156 | <listitem> | 156 | <listitem> |
| @@ -284,7 +284,7 @@ | |||
| 284 | <para>During the automatic installation process when the | 284 | <para>During the automatic installation process when the |
| 285 | <literal>Automatic install</literal> step is reached, enter the option | 285 | <literal>Automatic install</literal> step is reached, enter the option |
| 286 | menu <literal>Customize kernel parameters</literal> and set the | 286 | menu <literal>Customize kernel parameters</literal> and set the |
| 287 | <literal>uCPE Manager IP</literal> address. Please check <xref | 287 | <literal>uCPE Manager IP address</literal>. Please check <xref |
| 288 | linkend="install_ena_stick" />, step 7 for how to set the uCPE Manager IP | 288 | linkend="install_ena_stick" />, step 7 for how to set the uCPE Manager IP |
| 289 | address at boot time. The Device ID will be listed in the installer under | 289 | address at boot time. The Device ID will be listed in the installer under |
| 290 | the <literal>Customize kernel parameters</literal> menu.</para> | 290 | the <literal>Customize kernel parameters</literal> menu.</para> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml index d340e56..72c5570 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml | |||
| @@ -374,7 +374,7 @@ sdb 8:0 0 111.8G 0 disk | |||
| 374 | <note> | 374 | <note> |
| 375 | <para>Modifying any of the Default parameters (e.g Core | 375 | <para>Modifying any of the Default parameters (e.g Core |
| 376 | isolation, 1G huge page count, etc.) will automatically update | 376 | isolation, 1G huge page count, etc.) will automatically update |
| 377 | the kernel paramters string. Updating the Custom | 377 | the kernel parameters string. Updating the Custom |
| 378 | parameters within the kernel string directly will override any | 378 | parameters within the kernel string directly will override any |
| 379 | values set previously for the Default parameters.</para> | 379 | values set previously for the Default parameters.</para> |
| 380 | </note> | 380 | </note> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml index 2644f8a..9bee9e6 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | |||
| @@ -87,8 +87,7 @@ | |||
| 87 | </listitem> | 87 | </listitem> |
| 88 | 88 | ||
| 89 | <listitem> | 89 | <listitem> |
| 90 | <para>Download the NFV Access images archive(s) from the portal: | 90 | <para>Download the NFV Access images archive(s) from the portal:<filename>Enea_NFV_Access_[release_version][release_date].zip</filename>.</para> |
| 91 | <filename>Enea_NFV_Access_[release_version][release_date].zip</filename>.</para> | ||
| 92 | </listitem> | 91 | </listitem> |
| 93 | </orderedlist> | 92 | </orderedlist> |
| 94 | </section> | 93 | </section> |
| @@ -124,10 +123,10 @@ | |||
| 124 | 123 | ||
| 125 | <para>Verify that the installation has succeeded:</para> | 124 | <para>Verify that the installation has succeeded:</para> |
| 126 | 125 | ||
| 127 | <itemizedlist> | 126 | <orderedlist> |
| 128 | <listitem> | 127 | <listitem> |
| 129 | <para>Point your browser to the server machine running the uCPE | 128 | <para>Point your browser to the server machine running the uCPE |
| 130 | Manger: <literal>https://localhost</literal>.</para> | 129 | Manager: <literal>https://localhost</literal>.</para> |
| 131 | </listitem> | 130 | </listitem> |
| 132 | 131 | ||
| 133 | <listitem> | 132 | <listitem> |
| @@ -135,6 +134,6 @@ | |||
| 135 | role="bold">admin</emphasis> and password: <emphasis | 134 | role="bold">admin</emphasis> and password: <emphasis |
| 136 | role="bold">admin</emphasis>.</para> | 135 | role="bold">admin</emphasis>.</para> |
| 137 | </listitem> | 136 | </listitem> |
| 138 | </itemizedlist> | 137 | </orderedlist> |
| 139 | </section> | 138 | </section> |
| 140 | </chapter> | 139 | </chapter> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement.png b/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement.png index 5d3a505..9bb98a2 100755 --- a/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement.png +++ b/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement.png | |||
| Binary files differ | |||
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement2.png b/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement2.png index b6ea8b3..f1c5c91 100755 --- a/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement2.png +++ b/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement2.png | |||
| Binary files differ | |||
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/sriov_interface_type.png b/doc/book-enea-nfv-access-getting-started/doc/images/sriov_interface_type.png index 0a0e5d9..fbbe289 100755 --- a/doc/book-enea-nfv-access-getting-started/doc/images/sriov_interface_type.png +++ b/doc/book-enea-nfv-access-getting-started/doc/images/sriov_interface_type.png | |||
| Binary files differ | |||
diff --git a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml b/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml index 358ed44..da6b2ee 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml | |||
| @@ -8,15 +8,19 @@ | |||
| 8 | network devices, over the same network used by the traffic being | 8 | network devices, over the same network used by the traffic being |
| 9 | filtered.</para> | 9 | filtered.</para> |
| 10 | 10 | ||
| 11 | <para>In some situations, In-band Management can represent a significant | 11 | <para>In some situations, In-Band Management is the only option available to |
| 12 | risk to the administrator if certain precautions are not taken. These risks | 12 | both control and configure the device, while also allowing for data-path |
| 13 | center predominantly around the use of unencrypted communications channels. | 13 | traffic to pass over the same physical interface. In-band Management can |
| 14 | In other cases, In-Band Management is the only option available to both | 14 | represent a significant risk to the administrator if certain precautions are |
| 15 | control and configure the device, while also allowing for data-path traffic | 15 | not taken. These risks center predominantly around the use of unencrypted |
| 16 | to pass over the same physical interface. This use-case is required on a | 16 | communications channels. However this use case (i.e. all traffic going over |
| 17 | setup with a poor infrastructure configuration. The main requirement for | 17 | the same physical interface) is required on a setup with a poor |
| 18 | this use-case solution is to have all traffic pass through a defined WAN | 18 | infrastructure configuration.</para> |
| 19 | physical port. Three types of traffic are mentioned:</para> | 19 | |
| 20 | <para>The main requirement for this use case solution is to have all traffic | ||
| 21 | pass through a defined WAN physical port.</para> | ||
| 22 | |||
| 23 | <para>Three types of traffic are mentioned:</para> | ||
| 20 | 24 | ||
| 21 | <itemizedlist> | 25 | <itemizedlist> |
| 22 | <listitem> | 26 | <listitem> |
| @@ -25,35 +29,41 @@ | |||
| 25 | </listitem> | 29 | </listitem> |
| 26 | 30 | ||
| 27 | <listitem> | 31 | <listitem> |
| 28 | <para>VNFs configuration - like enabling or disabling features of VNF | 32 | <para>VNF(s) configuration - enabling or disabling features of a VNF. |
| 29 | like enabling/disabling firewall or VPN setup.</para> | 33 | E.g. enabling/disabling the firewall or VPN setup.</para> |
| 30 | </listitem> | 34 | </listitem> |
| 31 | 35 | ||
| 32 | <listitem> | 36 | <listitem> |
| 33 | <para>Data-path - all the other traffic that is not used in control | 37 | <para>Data-path - all the other traffic that is not used in the control |
| 34 | plane and needs to reach a LAN network. </para> | 38 | plane and needs to reach a LAN network.</para> |
| 35 | </listitem> | 39 | </listitem> |
| 36 | </itemizedlist> | 40 | </itemizedlist> |
| 37 | 41 | ||
| 38 | <para>For use-cases where latency is very important, it is recommended to | 42 | <note> |
| 39 | use out-of-band management with a dedicated physical interface for the | 43 | <para>For use-cases where latency is very important, it is recommended to |
| 40 | data-path.</para> | 44 | use out-of-band management with a dedicated physical interface for the |
| 41 | 45 | data-path.</para> | |
| 42 | <para>Enea solution for in-band management is based on Open vSwitch bridge | 46 | </note> |
| 43 | which controll all the traffic passing the WAN physical port. NFV Access | 47 | |
| 44 | assume that the activate connection with uCPE Manager is the one to be used | 48 | <para>The solution provided by Enea for In-band management is based upon |
| 45 | for in-band management. Physical port used by activate connection willbe | 49 | Open vSwitch bridges which control all traffic passing through the WAN |
| 46 | attached to the in-band management WAN bridge. The communication with uCPE | 50 | physical port. Note that the NFV Access platform will assume that the |
| 47 | Manager should not be affected in the sense it is re-stablished | 51 | activated connection with the uCPE Manager should be used for In-band |
| 48 | automatically after in-band management activation.</para> | 52 | management. The physical port used by the active connection will be attached |
| 49 | 53 | to the In-band management WAN bridge. Communication with the uCPE Manager | |
| 50 | <para>All network traffic except the one from uCPE Manager will be sent | 54 | should not be affected, it is reestablished automatically after In-band |
| 51 | towards VNF or dropped in case there is no VNF instantiated on the NFV | 55 | management activation.</para> |
| 52 | Access device. The VNF connected to WAN bridge must be configured for | 56 | |
| 53 | in-band management since the traffic from VNF manager and data-path will be | 57 | <para>All network traffic, with the exception of any received from the uCPE |
| 54 | sent to only one port(WAN) of the VNF. Only one VNF must be connected to the | 58 | Manager, will be sent towards the VNF or dropped if there is no VNF |
| 55 | in-band management WAN bridge. Please make sure the VNF accept in-band | 59 | instantiated on the NFV Access device. The VNF connected to the WAN bridge |
| 56 | management.</para> | 60 | must be configured for In-band management since traffic from the VNF manager |
| 61 | and data-path will be sent to only to one port (WAN) of the VNF.</para> | ||
| 62 | |||
| 63 | <note> | ||
| 64 | <para>Only one VNF must be connected to the In-band management WAN bridge. | ||
| 65 | Please make sure the VNF accepts in-band management.</para> | ||
| 66 | </note> | ||
| 57 | 67 | ||
| 58 | <figure> | 68 | <figure> |
| 59 | <title>Enea In-band Management solution</title> | 69 | <title>Enea In-band Management solution</title> |
| @@ -67,17 +77,18 @@ | |||
| 67 | </figure> | 77 | </figure> |
| 68 | 78 | ||
| 69 | <table> | 79 | <table> |
| 70 | <title>Setup Prerequisites:</title> | 80 | <title>Setup Prerequisites</title> |
| 71 | 81 | ||
| 72 | <tgroup cols="2"> | 82 | <tgroup cols="2"> |
| 73 | <colspec align="left" colwidth="2*" /> | 83 | <colspec align="left" colwidth="2*" /> |
| 84 | |||
| 74 | <colspec align="left" colwidth="4*" /> | 85 | <colspec align="left" colwidth="4*" /> |
| 75 | 86 | ||
| 76 | <tbody> | 87 | <tbody> |
| 77 | <row> | 88 | <row> |
| 78 | <entry>WAN port</entry> | 89 | <entry>WAN port</entry> |
| 79 | 90 | ||
| 80 | <entry>physical port supported by DPDK</entry> | 91 | <entry>Physical port supported by DPDK</entry> |
| 81 | </row> | 92 | </row> |
| 82 | 93 | ||
| 83 | <row> | 94 | <row> |
| @@ -90,30 +101,47 @@ | |||
| 90 | <row> | 101 | <row> |
| 91 | <entry>uCPE Manager</entry> | 102 | <entry>uCPE Manager</entry> |
| 92 | 103 | ||
| 93 | <entry>uCPE Manager IP address must be public(accesible for targets) | 104 | <entry>uCPE Manager IP address must be public (accessible for target) |
| 94 | and static</entry> | 105 | and static</entry> |
| 95 | </row> | 106 | </row> |
| 96 | </tbody> | 107 | </tbody> |
| 97 | </tgroup> | 108 | </tgroup> |
| 98 | </table> | 109 | </table> |
| 99 | 110 | ||
| 100 | <para>In order to activate in-band management from uCPE Manager follow the | 111 | <para><emphasis role="bold">How to activate In-band Management from the uCPE |
| 101 | next steps: <select the device> -> Configuration -> OpenVSwitch | 112 | Manager</emphasis></para> |
| 102 | -> Bridges -> Add</para> | 113 | |
| 114 | <orderedlist> | ||
| 115 | <listitem> | ||
| 116 | <para>Select the device.</para> | ||
| 117 | </listitem> | ||
| 118 | |||
| 119 | <listitem> | ||
| 120 | <para>Select Configuration.</para> | ||
| 121 | </listitem> | ||
| 122 | |||
| 123 | <listitem> | ||
| 124 | <para>Click OpenvSwitch.</para> | ||
| 125 | </listitem> | ||
| 126 | |||
| 127 | <listitem> | ||
| 128 | <para> Select the Bridges option, then click Add.</para> | ||
| 129 | </listitem> | ||
| 130 | </orderedlist> | ||
| 103 | 131 | ||
| 104 | <table> | 132 | <table> |
| 105 | <title>In-band management WAN DPDK bridge configuration</title> | 133 | <title>In-band management WAN DPDK bridge configuration</title> |
| 106 | 134 | ||
| 107 | <tgroup cols="2"> | 135 | <tgroup cols="2"> |
| 108 | <colspec align="left" colwidth="2*" /> | 136 | <colspec align="left" colwidth="2*" /> |
| 109 | <colspec align="left" colwidth="4*" /> | 137 | |
| 138 | <colspec align="left" colwidth="4*" /> | ||
| 110 | 139 | ||
| 111 | <tbody> | 140 | <tbody> |
| 112 | <row> | 141 | <row> |
| 113 | <entry>name</entry> | 142 | <entry>name</entry> |
| 114 | 143 | ||
| 115 | <entry><provide a name for the WAN bridge ex: | 144 | <entry>Provide a name for the WAN bridge e.g. "ibm-wan-br"</entry> |
| 116 | "ibm-wan-br"></entry> | ||
| 117 | </row> | 145 | </row> |
| 118 | 146 | ||
| 119 | <row> | 147 | <row> |
| @@ -125,7 +153,7 @@ | |||
| 125 | <row> | 153 | <row> |
| 126 | <entry>mgmt-address</entry> | 154 | <entry>mgmt-address</entry> |
| 127 | 155 | ||
| 128 | <entry>IPv4 <add IP address of uCPE Manager machine></entry> | 156 | <entry>IPv4 (add IP address of uCPE Manager machine)</entry> |
| 129 | </row> | 157 | </row> |
| 130 | 158 | ||
| 131 | <row> | 159 | <row> |
| @@ -137,11 +165,11 @@ | |||
| 137 | </tgroup> | 165 | </tgroup> |
| 138 | </table> | 166 | </table> |
| 139 | 167 | ||
| 140 | <para>At this point the connection between device and uCPE Manager will be | 168 | <para>The connection between the device and uCPE Manager will be recreated |
| 141 | re-created and all traffic pass through the new bridge(ibm-wan-br). User | 169 | and all traffic will pass through the new bridge (ibm-wan-br). The user |
| 142 | should be able to continue device configuration. The WAN port of the very | 170 | should be able to continue device configuration. The WAN port of the very |
| 143 | first instantiated VNF must be connected to the ibm-wan-br and it should | 171 | first instantiated VNF must be connected to ibm-wan-br and it should receive |
| 144 | receive the same IP address with the WAN interfaces of the device. </para> | 172 | the same IP address as the WAN interfaces of the device.</para> |
| 145 | 173 | ||
| 146 | <figure> | 174 | <figure> |
| 147 | <title>Enea In-band Management solution</title> | 175 | <title>Enea In-band Management solution</title> |
| @@ -154,11 +182,11 @@ | |||
| 154 | </mediaobject> | 182 | </mediaobject> |
| 155 | </figure> | 183 | </figure> |
| 156 | 184 | ||
| 157 | <para>The VNF can be reached on the same IP as of the device(ex. | 185 | <para>The VNF can be reached on the same IP address as the device, e.g. |
| 158 | https://<WAN_IP>).</para> | 186 | <literal> https://<WAN_IP></literal>.</para> |
| 159 | 187 | ||
| 160 | <note> | 188 | <note> |
| 161 | <para>In-band management bridge must be re-created in case uCPE Manager IP | 189 | <para>The In-band management bridge must be recreated each time the uCPE |
| 162 | is changed!</para> | 190 | Manager IP is changed.</para> |
| 163 | </note> | 191 | </note> |
| 164 | </chapter> | 192 | </chapter> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml index 3d8474b..46159d1 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml | |||
| @@ -102,10 +102,10 @@ | |||
| 102 | </listitem> | 102 | </listitem> |
| 103 | </itemizedlist> | 103 | </itemizedlist> |
| 104 | 104 | ||
| 105 | <para>For additional information about the features provided in Enea NFV | 105 | <para>For additional information about features provided in Enea NFV |
| 106 | Access, refer to the Reference Guide <remark>make this into an olink | 106 | Access, refer to the <olink targetdoc= |
| 107 | reference to the Ref Guide once the olink is updated with it's new book | 107 | "book_enea_nfv_access_reference_guide_intel">Enea NFV Access Reference Guide</olink> |
| 108 | ID.</remark>provided with your release. For how to install and run Enea | 108 | provided with your release. For how to install and run Enea |
| 109 | NFV Access on supported devices, please refer to <xref | 109 | NFV Access on supported devices, please refer to <xref |
| 110 | linkend="plat-release-content"> | 110 | linkend="plat-release-content"> |
| 111 | Chapter 4, Getting Started with Enea NFV Access</xref>.</para> | 111 | Chapter 4, Getting Started with Enea NFV Access</xref>.</para> |
