diff options
| author | Miruna Paun <Miruna.Paun@enea.com> | 2019-06-26 12:02:07 +0200 |
|---|---|---|
| committer | Miruna Paun <Miruna.Paun@enea.com> | 2019-07-02 10:37:29 +0200 |
| commit | 9217ccdf15ee0920c183b5e3e68c6dc7aca2734b (patch) | |
| tree | 2858fc32ef293085badf848963f1695155362adb | |
| parent | 5421fa28adf9a340043e3efcaa3bc828d040f956 (diff) | |
| download | nfv-access-documentation-9217ccdf15ee0920c183b5e3e68c6dc7aca2734b.tar.gz | |
Removed references to Portal and Solution in ENA docs where appropriate.
Change-Id: Idcc466e9c2f4faaeaa5696cb4c24f595b87cab98
17 files changed, 274 insertions, 283 deletions
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml index c2b86f4..58b4650 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml | |||
| @@ -26,7 +26,7 @@ | |||
| 26 | 26 | ||
| 27 | <xi:include href="automation_framework_test_harness.xml" | 27 | <xi:include href="automation_framework_test_harness.xml" |
| 28 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 28 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
| 29 | 29 | ||
| 30 | <xi:include href="troubleshooting_guide.xml" | 30 | <xi:include href="troubleshooting_guide.xml" |
| 31 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 31 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
| 32 | 32 | ||
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml index bbfccd7..2fecf5b 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml | |||
| @@ -2,9 +2,9 @@ | |||
| 2 | <chapter id="components"> | 2 | <chapter id="components"> |
| 3 | <title>Components</title> | 3 | <title>Components</title> |
| 4 | 4 | ||
| 5 | <para>An overview of the Enea NFV Access Run Time Platform and the uCPE Manager in | 5 | <para>An overview of the Enea NFV Access Run Time Platform and the uCPE |
| 6 | cooperation with the Automation Framework and Test Harness, will be | 6 | Manager in cooperation with the Automation Framework and Test Harness, will |
| 7 | presented in detail.</para> | 7 | be presented in detail.</para> |
| 8 | 8 | ||
| 9 | <figure> | 9 | <figure> |
| 10 | <title>Component Overview</title> | 10 | <title>Component Overview</title> |
| @@ -20,8 +20,8 @@ | |||
| 20 | <section id="enfva_runtime_plt"> | 20 | <section id="enfva_runtime_plt"> |
| 21 | <title>Enea NFV Access</title> | 21 | <title>Enea NFV Access</title> |
| 22 | 22 | ||
| 23 | <para>The Enea NFV Access is comprised of the Enea NFV Access | 23 | <para>The Enea NFV Access is comprised of the Enea NFV Access Run time |
| 24 | Run time Platform and the Enea uCPE Manager.</para> | 24 | Platform and the Enea uCPE Manager.</para> |
| 25 | 25 | ||
| 26 | <section id="eucpe_manager"> | 26 | <section id="eucpe_manager"> |
| 27 | <title>Enea uCPE Manager</title> | 27 | <title>Enea uCPE Manager</title> |
| @@ -39,9 +39,9 @@ | |||
| 39 | <section id="ena_plat"> | 39 | <section id="ena_plat"> |
| 40 | <title>Enea NFV Access Run time Platform</title> | 40 | <title>Enea NFV Access Run time Platform</title> |
| 41 | 41 | ||
| 42 | <para>One or more uCPE devices running the NFV Access Run Time Platform are | 42 | <para>One or more uCPE devices running the NFV Access Run Time Platform |
| 43 | required as hosts running the VNF(s). The uCPE device is known to the uCPE Manager | 43 | are required as hosts running the VNF(s). The uCPE device is known to |
| 44 | as the "VcpeAgent" device module.</para> | 44 | the uCPE Manager as the "VcpeAgent" device module.</para> |
| 45 | 45 | ||
| 46 | <para>Adding a VcpeAgent device can be done via one of two | 46 | <para>Adding a VcpeAgent device can be done via one of two |
| 47 | methods:</para> | 47 | methods:</para> |
| @@ -86,7 +86,7 @@ | |||
| 86 | <para>The Test Harness (TH) provides a way for driving configuration with | 86 | <para>The Test Harness (TH) provides a way for driving configuration with |
| 87 | Ansible Playbooks, by running the python modules from the Automation | 87 | Ansible Playbooks, by running the python modules from the Automation |
| 88 | Framework (AF) and by direct connection over SSH to the boards that run | 88 | Framework (AF) and by direct connection over SSH to the boards that run |
| 89 | the Enea NFV Access solution.</para> | 89 | Enea NFV Access.</para> |
| 90 | 90 | ||
| 91 | <para>The Test Harness includes an automated test suite that | 91 | <para>The Test Harness includes an automated test suite that |
| 92 | contains:</para> | 92 | contains:</para> |
| @@ -94,8 +94,8 @@ | |||
| 94 | <itemizedlist> | 94 | <itemizedlist> |
| 95 | <listitem> | 95 | <listitem> |
| 96 | <para>VNF, Device and Network Smoke Test Cases. A sample test suite | 96 | <para>VNF, Device and Network Smoke Test Cases. A sample test suite |
| 97 | that acts as basic smoke tests for the Enea NFV Access and | 97 | that acts as basic smoke tests for the Enea NFV Access and also as a |
| 98 | also as a sanity-check test suite for the AF and TH.</para> | 98 | sanity-check test suite for the AF and TH.</para> |
| 99 | </listitem> | 99 | </listitem> |
| 100 | 100 | ||
| 101 | <listitem> | 101 | <listitem> |
| @@ -115,4 +115,4 @@ | |||
| 115 | chapter "Sample Test Cases" from the Enea NFV Access System Test | 115 | chapter "Sample Test Cases" from the Enea NFV Access System Test |
| 116 | Specification document.</para> | 116 | Specification document.</para> |
| 117 | </section> | 117 | </section> |
| 118 | </chapter> | 118 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml index b3386b8..34c9308 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml | |||
| @@ -101,9 +101,12 @@ | |||
| 101 | <para>Enea NFV Access Run Time Platform installed.</para> | 101 | <para>Enea NFV Access Run Time Platform installed.</para> |
| 102 | 102 | ||
| 103 | <note> | 103 | <note> |
| 104 | <para>For information on how to install Enea NFV Access | 104 | <para>For information on how to install Enea NFV Access refer to |
| 105 | refer to "Getting Started with Enea NFV Access" from the | 105 | <olink targetdoc="book_enea_nfv_access_getting_started" |
| 106 | Enea NFV Access Getting Started manual.</para> | 106 | targetptr="plat-release-content">Getting Started with Enea NFV Access |
| 107 | in <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
| 108 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
| 109 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>.</para> | ||
| 107 | </note> | 110 | </note> |
| 108 | </listitem> | 111 | </listitem> |
| 109 | </itemizedlist><figure> | 112 | </itemizedlist><figure> |
| @@ -118,8 +121,8 @@ | |||
| 118 | </mediaobject> | 121 | </mediaobject> |
| 119 | </figure></para> | 122 | </figure></para> |
| 120 | 123 | ||
| 121 | <para><emphasis role="bold">Changes to 1<superscript>st</superscript> | 124 | <para><emphasis role="bold">Changes to 1<superscript>st</superscript> uCPE |
| 122 | uCPE device</emphasis></para> | 125 | device</emphasis></para> |
| 123 | 126 | ||
| 124 | <itemizedlist> | 127 | <itemizedlist> |
| 125 | <listitem> | 128 | <listitem> |
| @@ -127,8 +130,8 @@ | |||
| 127 | </listitem> | 130 | </listitem> |
| 128 | 131 | ||
| 129 | <listitem> | 132 | <listitem> |
| 130 | <para>1 Physical connection back to back with the | 133 | <para>1 Physical connection back to back with the |
| 131 | 2<superscript>nd</superscript> uCPE device.</para> | 134 | 2<superscript>nd</superscript> uCPE device.</para> |
| 132 | </listitem> | 135 | </listitem> |
| 133 | </itemizedlist> | 136 | </itemizedlist> |
| 134 | 137 | ||
| @@ -155,10 +158,12 @@ | |||
| 155 | <para>Enea NFV Access installed.</para> | 158 | <para>Enea NFV Access installed.</para> |
| 156 | 159 | ||
| 157 | <note> | 160 | <note> |
| 158 | <para>For information on how to install Enea NFV Access<remark>the | 161 | <para>For information on how to install Enea NFV Access, refer to |
| 159 | solution or the platform?</remark>, refer to "Getting Started with | 162 | <olink targetdoc="book_enea_nfv_access_getting_started" |
| 160 | Enea NFV Access" from the Enea NFV Access Getting Started | 163 | targetptr="plat-release-content">Getting Started with Enea NFV |
| 161 | manual.</para> | 164 | Access<xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
| 165 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
| 166 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>.</para> | ||
| 162 | </note> | 167 | </note> |
| 163 | </listitem> | 168 | </listitem> |
| 164 | </itemizedlist></para> | 169 | </itemizedlist></para> |
| @@ -167,9 +172,9 @@ | |||
| 167 | <section id="initial_setup"> | 172 | <section id="initial_setup"> |
| 168 | <title>Installation and Initial Setup</title> | 173 | <title>Installation and Initial Setup</title> |
| 169 | 174 | ||
| 170 | <para>Download <filename>nfvaccess22_af-th.zip</filename> from the Enea | 175 | <para>Unzip the <filename>nfvaccess22_af-th.zip</filename> archive file, |
| 171 | Portal and unzip it on the a supported host machine. Henceforth, the | 176 | provided by Enea, on a supported host machine. The directory in which the |
| 172 | directory in which the ZIP archive has been unpacked will be denoted as | 177 | archive has been unpacked will be denoted as |
| 173 | <literal><AF-TH-installdir></literal>.</para> | 178 | <literal><AF-TH-installdir></literal>.</para> |
| 174 | 179 | ||
| 175 | <para>Enter the <literal><AF-TH-install-dir></literal> directory and | 180 | <para>Enter the <literal><AF-TH-install-dir></literal> directory and |
| @@ -197,10 +202,10 @@ | |||
| 197 | 202 | ||
| 198 | <listitem> | 203 | <listitem> |
| 199 | <para>Run the <filename>setupuCPEManager.yml</filename> Ansible | 204 | <para>Run the <filename>setupuCPEManager.yml</filename> Ansible |
| 200 | Playbook with the JSON config path as parameter: <programlisting>ansible-playbook playbooks/setupuCPEManager.yml -e\ | 205 | Playbook with the JSON config path as parameter: <programlisting>ansible-playbook playbooks/setupuCPEManager.yml -e\ |
| 201 | "@uCPEM_config/<config_name>.json"</programlisting></para> | 206 | "@uCPEM_config/<config_name>.json"</programlisting></para> |
| 202 | 207 | ||
| 203 | <para><emphasis role="bold">Example</emphasis> <programlisting>ansible-playbook playbooks/setupuCPEManager.yml -e\ | 208 | <para><emphasis role="bold">Example</emphasis> <programlisting>ansible-playbook playbooks/setupuCPEManager.yml -e\ |
| 204 | "@uCPEM_config/ucpem01.json"</programlisting></para> | 209 | "@uCPEM_config/ucpem01.json"</programlisting></para> |
| 205 | </listitem> | 210 | </listitem> |
| 206 | </orderedlist> | 211 | </orderedlist> |
| @@ -219,4 +224,4 @@ | |||
| 219 | <filename>setupuCPEManager.yml</filename> playbook with the corresponding | 224 | <filename>setupuCPEManager.yml</filename> playbook with the corresponding |
| 220 | JSON config for the new uCPE Manager instance.</para> | 225 | JSON config for the new uCPE Manager instance.</para> |
| 221 | </section> | 226 | </section> |
| 222 | </chapter> | 227 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml index 045ceef..1c85cfc 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml | |||
| @@ -44,13 +44,6 @@ | |||
| 44 | <entry>Enea NFV Access (with ODM) Runtime Platform and Enea uCPE | 44 | <entry>Enea NFV Access (with ODM) Runtime Platform and Enea uCPE |
| 45 | Manager.</entry> | 45 | Manager.</entry> |
| 46 | </row> | 46 | </row> |
| 47 | |||
| 48 | <row> | ||
| 49 | <entry>Enea Portal</entry> | ||
| 50 | |||
| 51 | <entry><ulink | ||
| 52 | url="https://portal.enea.com">https://portal.enea.com</ulink></entry> | ||
| 53 | </row> | ||
| 54 | </tbody> | 47 | </tbody> |
| 55 | </tgroup> | 48 | </tgroup> |
| 56 | </table> | 49 | </table> |
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/book.xml b/doc/book-enea-nfv-access-example-usecases/doc/book.xml index 0f69570..5071e01 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/book.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/book.xml | |||
| @@ -17,19 +17,19 @@ | |||
| 17 | 17 | ||
| 18 | <xi:include href="introduction.xml" | 18 | <xi:include href="introduction.xml" |
| 19 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 19 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
| 20 | 20 | ||
| 21 | <xi:include href="clav_vnf_examples.xml" | 21 | <xi:include href="clav_vnf_examples.xml" |
| 22 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 22 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
| 23 | 23 | ||
| 24 | <xi:include href="enea_vnf_examples.xml" | 24 | <xi:include href="enea_vnf_examples.xml" |
| 25 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 25 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
| 26 | 26 | ||
| 27 | <xi:include href="forti_vnf_examples.xml" | 27 | <xi:include href="forti_vnf_examples.xml" |
| 28 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 28 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
| 29 | 29 | ||
| 30 | <xi:include href="inband_management.xml" | 30 | <xi:include href="inband_management.xml" |
| 31 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 31 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
| 32 | 32 | ||
| 33 | <xi:include href="vnf_chaining.xml" | 33 | <xi:include href="vnf_chaining.xml" |
| 34 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 34 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
| 35 | </book> | 35 | </book> |
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml index a73c5e8..570ea7a 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml | |||
| @@ -19,8 +19,9 @@ | |||
| 19 | </listitem> | 19 | </listitem> |
| 20 | 20 | ||
| 21 | <listitem> | 21 | <listitem> |
| 22 | <para>License for the Clavister VNF (needed as Cloud-Init content in the Cloud-Init tab). | 22 | <para>License for the Clavister VNF (needed as Cloud-Init content in |
| 23 | This file is available through the VNF provider.</para> | 23 | the Cloud-Init tab). This file is available through the VNF |
| 24 | provider.</para> | ||
| 24 | </listitem> | 25 | </listitem> |
| 25 | </itemizedlist> | 26 | </itemizedlist> |
| 26 | </section> | 27 | </section> |
| @@ -45,19 +46,22 @@ | |||
| 45 | <section id="clav_vnf_setup_1"> | 46 | <section id="clav_vnf_setup_1"> |
| 46 | <title>uCPE device Setup</title> | 47 | <title>uCPE device Setup</title> |
| 47 | 48 | ||
| 48 | <para><emphasis role="bold">Configure Network interfaces on the uCPE devices:</emphasis></para> | 49 | <para><emphasis role="bold">Configure Network interfaces on the uCPE |
| 50 | devices:</emphasis></para> | ||
| 49 | 51 | ||
| 50 | <orderedlist> | 52 | <orderedlist> |
| 51 | <listitem> | 53 | <listitem> |
| 52 | <para>From the uCPE Manager select uCPE device 1, then access <literal>Configuration</literal> | 54 | <para>From the uCPE Manager select uCPE device 1, then access |
| 53 | -> <literal>OpenVSwitch</literal> -> <literal>Host Interfaces</literal> -> | 55 | <literal>Configuration</literal> -> |
| 54 | <literal>Add.</literal></para> | 56 | <literal>OpenVSwitch</literal> -> <literal>Host |
| 57 | Interfaces</literal> -> <literal>Add.</literal></para> | ||
| 55 | </listitem> | 58 | </listitem> |
| 56 | 59 | ||
| 57 | <listitem> | 60 | <listitem> |
| 58 | <para>Select the network interface that will be used to connect to uCPE device 2. | 61 | <para>Select the network interface that will be used to connect to |
| 59 | Configure it for DPDK, and click <literal>Create</literal> to send the configuration | 62 | uCPE device 2. Configure it for DPDK, and click |
| 60 | to that uCPE device.</para> | 63 | <literal>Create</literal> to send the configuration to that uCPE |
| 64 | device.</para> | ||
| 61 | </listitem> | 65 | </listitem> |
| 62 | 66 | ||
| 63 | <listitem> | 67 | <listitem> |
| @@ -67,13 +71,13 @@ | |||
| 67 | </listitem> | 71 | </listitem> |
| 68 | 72 | ||
| 69 | <listitem> | 73 | <listitem> |
| 70 | <para>Once the bridge creation popup appears, fill-in the required fields and add the | 74 | <para>Once the bridge creation popup appears, fill-in the required |
| 71 | physical interface.</para> | 75 | fields and add the physical interface.</para> |
| 72 | </listitem> | 76 | </listitem> |
| 73 | 77 | ||
| 74 | <listitem> | 78 | <listitem> |
| 75 | <para>Repeat the steps above on uCPE device 2, using one DPDK interface and creating | 79 | <para>Repeat the steps above on uCPE device 2, using one DPDK |
| 76 | another OVS bridge.</para> | 80 | interface and creating another OVS bridge.</para> |
| 77 | </listitem> | 81 | </listitem> |
| 78 | </orderedlist> | 82 | </orderedlist> |
| 79 | </section> | 83 | </section> |
| @@ -83,8 +87,9 @@ | |||
| 83 | 87 | ||
| 84 | <orderedlist> | 88 | <orderedlist> |
| 85 | <listitem> | 89 | <listitem> |
| 86 | <para>Select <literal>VNF</literal> -> <literal>Descriptor</literal> -> | 90 | <para>Select <literal>VNF</literal> -> |
| 87 | <literal>On-board</literal>.</para> | 91 | <literal>Descriptor</literal> -> |
| 92 | <literal>On-board</literal>.</para> | ||
| 88 | </listitem> | 93 | </listitem> |
| 89 | 94 | ||
| 90 | <listitem> | 95 | <listitem> |
| @@ -92,12 +97,14 @@ | |||
| 92 | </listitem> | 97 | </listitem> |
| 93 | 98 | ||
| 94 | <listitem> | 99 | <listitem> |
| 95 | <para>Provide the path to the qcow image by selecting <literal>Browse</literal> | 100 | <para>Provide the path to the qcow image by selecting |
| 96 | from <literal>VM image file</literal> option.</para> | 101 | <literal>Browse</literal> from <literal>VM image file</literal> |
| 102 | option.</para> | ||
| 97 | </listitem> | 103 | </listitem> |
| 98 | 104 | ||
| 99 | <listitem> | 105 | <listitem> |
| 100 | <para>Fill the required fields below and press <literal>Onboard</literal>:</para> | 106 | <para>Fill the required fields below and press |
| 107 | <literal>Onboard</literal>:</para> | ||
| 101 | 108 | ||
| 102 | <itemizedlist spacing="compact"> | 109 | <itemizedlist spacing="compact"> |
| 103 | <listitem> | 110 | <listitem> |
| @@ -119,56 +126,61 @@ | |||
| 119 | <section id="instance_vnfs_clav"> | 126 | <section id="instance_vnfs_clav"> |
| 120 | <title>Instantiate the VNFs</title> | 127 | <title>Instantiate the VNFs</title> |
| 121 | 128 | ||
| 122 | <para><emphasis role="bold">A) Instantiate the Clavister VNF on uCPE device 1:</emphasis></para> | 129 | <para><emphasis role="bold">A) Instantiate the Clavister VNF on uCPE |
| 130 | device 1:</emphasis></para> | ||
| 123 | 131 | ||
| 124 | <orderedlist> | 132 | <orderedlist> |
| 125 | <listitem> | 133 | <listitem> |
| 126 | <para>Select uCPE device 1, then from the top toolbar: <literal>VNF</literal> -> | 134 | <para>Select uCPE device 1, then from the top toolbar: |
| 127 | <literal>Instances</literal> -> <literal>Add</literal>.</para> | 135 | <literal>VNF</literal> -> <literal>Instances</literal> -> |
| 136 | <literal>Add</literal>.</para> | ||
| 128 | </listitem> | 137 | </listitem> |
| 129 | 138 | ||
| 130 | <listitem> | 139 | <listitem> |
| 131 | <para>Fill in the required information about the Clavister VNF, (the default network | 140 | <para>Fill in the required information about the Clavister VNF, (the |
| 132 | configuration can be used) and select <literal>Create</literal>.</para> | 141 | default network configuration can be used) and select |
| 142 | <literal>Create</literal>.</para> | ||
| 133 | </listitem> | 143 | </listitem> |
| 134 | </orderedlist> | 144 | </orderedlist> |
| 135 | 145 | ||
| 136 | <para><emphasis role="bold">B) Instantiate two Enea VNFs (one as the client and one as the | 146 | <para><emphasis role="bold">B) Instantiate two Enea VNFs (one as the |
| 137 | server) on uCPE device 2:</emphasis></para> | 147 | client and one as the server) on uCPE device 2:</emphasis></para> |
| 138 | 148 | ||
| 139 | <orderedlist> | 149 | <orderedlist> |
| 140 | <listitem> | 150 | <listitem> |
| 141 | <para>Select uCPE device 2, then from the top toolbar: <literal>VNF</literal> -> | 151 | <para>Select uCPE device 2, then from the top toolbar: |
| 142 | <literal>Instances</literal> -> <literal>Add</literal>.</para> | 152 | <literal>VNF</literal> -> <literal>Instances</literal> -> |
| 153 | <literal>Add</literal>.</para> | ||
| 143 | </listitem> | 154 | </listitem> |
| 144 | 155 | ||
| 145 | <listitem> | 156 | <listitem> |
| 146 | <para>In the new <literal>VNF Instance</literal> window, select the Enea VNF from the | 157 | <para>In the new <literal>VNF Instance</literal> window, select the |
| 147 | dropdown menu, configure it to act as a server by unchecking the <literal>Client mode | 158 | Enea VNF from the dropdown menu, configure it to act as a server by |
| 148 | IPerf</literal> box, and then click <literal>Create</literal>.</para> | 159 | unchecking the <literal>Client mode IPerf</literal> box, and then |
| 160 | click <literal>Create</literal>.</para> | ||
| 149 | </listitem> | 161 | </listitem> |
| 150 | 162 | ||
| 151 | <listitem> | 163 | <listitem> |
| 152 | <para>Select <literal>Add</literal> once more, enable the <literal>Client mode | 164 | <para>Select <literal>Add</literal> once more, enable the |
| 153 | IPerf</literal> checkbox this time, and click <literal>Create</literal> to instantiate | 165 | <literal>Client mode IPerf</literal> checkbox this time, and click |
| 154 | the second <literal>iPerf VNF</literal> as a client, and to run it in client mode.</para> | 166 | <literal>Create</literal> to instantiate the second <literal>iPerf |
| 167 | VNF</literal> as a client, and to run it in client mode.</para> | ||
| 155 | </listitem> | 168 | </listitem> |
| 156 | 169 | ||
| 157 | <listitem> | 170 | <listitem> |
| 158 | <para>In order to check that traffic is forwarded between the two VNFs, connect to the | 171 | <para>In order to check that traffic is forwarded between the two |
| 159 | iPerf VNF client console: <literal>SSH</literal> -> <literal>user</literal> (root) | 172 | VNFs, connect to the iPerf VNF client console: |
| 160 | -> <literal>Connect</literal> and run the following:</para> | 173 | <literal>SSH</literal> -> <literal>user</literal> (root) -> |
| 161 | 174 | <literal>Connect</literal> and run the following:</para> | |
| 162 | <programlisting> | 175 | |
| 163 | virsh list | 176 | <programlisting>virsh list |
| 164 | virsh console | 177 | virsh console |
| 165 | root@qemux86-64:~# iperf3 -c 192.168.10.10 | 178 | root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting> |
| 166 | </programlisting> | ||
| 167 | </listitem> | 179 | </listitem> |
| 168 | </orderedlist> | 180 | </orderedlist> |
| 169 | </section> | 181 | </section> |
| 170 | </section> | 182 | </section> |
| 171 | 183 | ||
| 172 | <section id="clav_example_sriov"> | 184 | <section id="clav_example_sriov"> |
| 173 | <title>Clavister VNF using SR-IOV</title> | 185 | <title>Clavister VNF using SR-IOV</title> |
| 174 | 186 | ||
| @@ -210,8 +222,9 @@ | |||
| 210 | </listitem> | 222 | </listitem> |
| 211 | 223 | ||
| 212 | <listitem> | 224 | <listitem> |
| 213 | <para>Instantiate the Clavister VNF on uCPE device 2: <literal>VNF</literal> | 225 | <para>Instantiate the Clavister VNF on uCPE device 2: |
| 214 | -> <literal>Instances</literal> -> <literal>Add</literal>.</para> | 226 | <literal>VNF</literal> -> <literal>Instances</literal> -> |
| 227 | <literal>Add</literal>.</para> | ||
| 215 | </listitem> | 228 | </listitem> |
| 216 | 229 | ||
| 217 | <listitem> | 230 | <listitem> |
| @@ -251,16 +264,12 @@ | |||
| 251 | <para>In order to check that traffic is forwarded between the VNFs, | 264 | <para>In order to check that traffic is forwarded between the VNFs, |
| 252 | connect to the iPerf VNF client console by using: | 265 | connect to the iPerf VNF client console by using: |
| 253 | <literal>SSH</literal> -> <literal>user</literal> (root) | 266 | <literal>SSH</literal> -> <literal>user</literal> (root) |
| 254 | -><literal>Connect</literal> and run the following | 267 | -><literal>Connect</literal> and run the following commands: |
| 255 | commands: | 268 | <programlisting>virsh list |
| 256 | <programlisting> | 269 | virsh console |
| 257 | virsh list | 270 | root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting></para> |
| 258 | virsh console | ||
| 259 | root@qemux86-64:~# iperf3 -c 192.168.10.10 | ||
| 260 | </programlisting> | ||
| 261 | </para> | ||
| 262 | </listitem> | 271 | </listitem> |
| 263 | </orderedlist> | 272 | </orderedlist> |
| 264 | </section> | 273 | </section> |
| 265 | </section> | 274 | </section> |
| 266 | </chapter> | 275 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/enea_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/enea_vnf_examples.xml index f2d7910..ac4347c 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/enea_vnf_examples.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/enea_vnf_examples.xml | |||
| @@ -5,19 +5,19 @@ | |||
| 5 | <section id="prere_enea_vnf"> | 5 | <section id="prere_enea_vnf"> |
| 6 | <title>Prerequisites</title> | 6 | <title>Prerequisites</title> |
| 7 | 7 | ||
| 8 | <para>The following file(s) are needed for this example use-case: | 8 | <para>The following file(s) are needed for this example use-case: |
| 9 | <literal>enea-nfv-access-vnf-qemux86-64.qcow2</literal>. This image is | 9 | <literal>enea-nfv-access-vnf-qemux86-64.qcow2</literal>. This image is |
| 10 | provided with your release.</para> | 10 | provided with your release.</para> |
| 11 | </section> | 11 | </section> |
| 12 | 12 | ||
| 13 | <section id="enea_vnf"> | 13 | <section id="enea_vnf"> |
| 14 | <title>TestPMD VNF</title> | 14 | <title>TestPMD VNF</title> |
| 15 | 15 | ||
| 16 | <para>In this use-case, <literal>uCPE device 1</literal> will run pktgen | 16 | <para>In this use-case, <literal>uCPE device 1</literal> will run pktgen |
| 17 | (the DPDK application) and <literal>uCPE device 2</literal> will onboard | 17 | (the DPDK application) and <literal>uCPE device 2</literal> will onboard |
| 18 | and instantiate two VNFs. One VNF will run <literal>testpmd_fwd</literal>, | 18 | and instantiate two VNFs. One VNF will run <literal>testpmd_fwd</literal>, |
| 19 | forwarding traffic, and the other will run <literal>testpmd_term</literal> | 19 | forwarding traffic, and the other will run <literal>testpmd_term</literal> |
| 20 | which will terminate traffic.</para> | 20 | which will terminate traffic.</para> |
| 21 | 21 | ||
| 22 | <figure> | 22 | <figure> |
| 23 | <title>Enea VNF Example Overview</title> | 23 | <title>Enea VNF Example Overview</title> |
| @@ -33,13 +33,13 @@ | |||
| 33 | <section id="enea_vnf_setup"> | 33 | <section id="enea_vnf_setup"> |
| 34 | <title>Example Setup</title> | 34 | <title>Example Setup</title> |
| 35 | 35 | ||
| 36 | <para><emphasis role="bold">Configure the Network interface on uCPE | 36 | <para><emphasis role="bold">Configure the Network interface on uCPE |
| 37 | devices 1 and 2:</emphasis></para> | 37 | devices 1 and 2:</emphasis></para> |
| 38 | 38 | ||
| 39 | <orderedlist> | 39 | <orderedlist> |
| 40 | <listitem> | 40 | <listitem> |
| 41 | <para>Bind the host interfaces to the DPDK by selecting uCPE device 1 | 41 | <para>Bind the host interfaces to the DPDK by selecting uCPE device |
| 42 | first, then accessing <literal>Configuration</literal> -> | 42 | 1 first, then accessing <literal>Configuration</literal> -> |
| 43 | <literal>OpenVSwitch</literal> -> <literal>Host | 43 | <literal>OpenVSwitch</literal> -> <literal>Host |
| 44 | Interfaces</literal> -> <literal>Add</literal>.</para> | 44 | Interfaces</literal> -> <literal>Add</literal>.</para> |
| 45 | </listitem> | 45 | </listitem> |
| @@ -62,26 +62,29 @@ | |||
| 62 | <para><emphasis role="bold">Create an Open vSwitch bridge on uCPE device | 62 | <para><emphasis role="bold">Create an Open vSwitch bridge on uCPE device |
| 63 | 1:</emphasis></para> | 63 | 1:</emphasis></para> |
| 64 | 64 | ||
| 65 | <para>Create an Open vSwitch bridge (<literal>ovsbr0</literal>) on uCPE | 65 | <para>Create an Open vSwitch bridge (<literal>ovsbr0</literal>) on uCPE |
| 66 | device 1, that uses one DPDK interface:</para> | 66 | device 1, that uses one DPDK interface:</para> |
| 67 | 67 | ||
| 68 | <orderedlist> | 68 | <orderedlist> |
| 69 | <listitem><para>Click the <literal>Add</literal> button from the | 69 | <listitem> |
| 70 | Bridges tab.</para> | 70 | <para>Click the <literal>Add</literal> button from the Bridges |
| 71 | </listitem> | 71 | tab.</para> |
| 72 | 72 | </listitem> | |
| 73 | <listitem><para>Select uCPE device 1, then access | 73 | |
| 74 | <literal>Configuration</literal> -><literal>OpenVSwitch</literal> | 74 | <listitem> |
| 75 | -><literal>Bridges</literal>.</para> | 75 | <para>Select uCPE device 1, then access |
| 76 | </listitem> | 76 | <literal>Configuration</literal> -><literal>OpenVSwitch</literal> |
| 77 | </orderedlist> | 77 | -><literal>Bridges</literal>.</para> |
| 78 | </listitem> | ||
| 79 | </orderedlist> | ||
| 78 | 80 | ||
| 79 | <para><emphasis role="bold">Onboard the Enea VNF:</emphasis></para> | 81 | <para><emphasis role="bold">Onboard the Enea VNF:</emphasis></para> |
| 80 | 82 | ||
| 81 | <orderedlist> | 83 | <orderedlist> |
| 82 | <listitem> | 84 | <listitem> |
| 83 | <para>Select <literal>VNF</literal> -><literal>Descriptor</literal> | 85 | <para>Select <literal>VNF</literal> |
| 84 | -> <literal>On-board</literal>.</para> | 86 | -><literal>Descriptor</literal> -> |
| 87 | <literal>On-board</literal>.</para> | ||
| 85 | </listitem> | 88 | </listitem> |
| 86 | 89 | ||
| 87 | <listitem> | 90 | <listitem> |
| @@ -89,13 +92,14 @@ | |||
| 89 | </listitem> | 92 | </listitem> |
| 90 | 93 | ||
| 91 | <listitem> | 94 | <listitem> |
| 92 | <para>Provide the path to the qcow image by selecting <literal>Browse | 95 | <para>Provide the path to the qcow image by selecting |
| 93 | </literal> from the <literal>VM image file</literal> option.</para> | 96 | <literal>Browse </literal> from the <literal>VM image file</literal> |
| 97 | option.</para> | ||
| 94 | </listitem> | 98 | </listitem> |
| 95 | 99 | ||
| 96 | <listitem> | 100 | <listitem> |
| 97 | <para>Fill the required fields below and press <literal>Onboard</literal>: | 101 | <para>Fill the required fields below and press |
| 98 | </para> | 102 | <literal>Onboard</literal>:</para> |
| 99 | 103 | ||
| 100 | <itemizedlist spacing="compact"> | 104 | <itemizedlist spacing="compact"> |
| 101 | <listitem> | 105 | <listitem> |
| @@ -113,16 +117,18 @@ | |||
| 113 | </listitem> | 117 | </listitem> |
| 114 | </orderedlist> | 118 | </orderedlist> |
| 115 | 119 | ||
| 116 | <para><emphasis role="bold">Instantiate two VNFs on uCPE device 2:</emphasis></para> | 120 | <para><emphasis role="bold">Instantiate two VNFs on uCPE device |
| 121 | 2:</emphasis></para> | ||
| 117 | 122 | ||
| 118 | <orderedlist> | 123 | <orderedlist> |
| 119 | <listitem> | 124 | <listitem> |
| 120 | <para>Select uCPE device 2, then access <literal>VNF</literal> -> | 125 | <para>Select uCPE device 2, then access <literal>VNF</literal> -> |
| 121 | <literal>Instances</literal> -> <literal>Add</literal>.</para> | 126 | <literal>Instances</literal> -> <literal>Add</literal>.</para> |
| 122 | </listitem> | 127 | </listitem> |
| 123 | 128 | ||
| 124 | <listitem> | 129 | <listitem> |
| 125 | <para>Fill-in the required fields and click <literal>Create</literal>.</para> | 130 | <para>Fill-in the required fields and click |
| 131 | <literal>Create</literal>.</para> | ||
| 126 | </listitem> | 132 | </listitem> |
| 127 | 133 | ||
| 128 | <listitem> | 134 | <listitem> |
| @@ -160,15 +166,14 @@ | |||
| 160 | </listitem> | 166 | </listitem> |
| 161 | 167 | ||
| 162 | <listitem> | 168 | <listitem> |
| 163 | <para>Start pktgen on uCPE device 1. Connect to the device by selecting | 169 | <para>Start pktgen on uCPE device 1. Connect to the device by |
| 164 | it first, then access <literal>SSH</literal> -> <literal>user</literal> | 170 | selecting it first, then access <literal>SSH</literal> -> |
| 165 | (root) and perform the following:</para> | 171 | <literal>user</literal> (root) and perform the following:</para> |
| 166 | 172 | ||
| 167 | <programlisting> | 173 | <programlisting>cd /usr/share/apps/pktgen/ |
| 168 | cd /usr/share/apps/pktgen/ | 174 | ./pktgen -c 0x7 -n 4 --proc-type auto --socket-mem 256 -w 0000:05:00.3 -- \ |
| 169 | ./pktgen -c 0x7 -n 4 --proc-type auto --socket-mem 256 -w 0000:05:00.3 -- \ | 175 | -P -m "[1:2].0" |
| 170 | -P -m "[1:2].0" | 176 | Pktgen:/> start 0</programlisting> |
| 171 | Pktgen:/> start 0</programlisting> | ||
| 172 | 177 | ||
| 173 | <note> | 178 | <note> |
| 174 | <para>The PCI address <0000:05:00.3> used in this example | 179 | <para>The PCI address <0000:05:00.3> used in this example |
| @@ -183,11 +188,10 @@ | |||
| 183 | statistics, by selecting the uCPE device first, then accessing | 188 | statistics, by selecting the uCPE device first, then accessing |
| 184 | <literal>SSH</literal> -> <literal>user</literal> (root):</para> | 189 | <literal>SSH</literal> -> <literal>user</literal> (root):</para> |
| 185 | 190 | ||
| 186 | <programlisting> | 191 | <programlisting>Virsh list |
| 187 | Virsh list | 192 | Virsh console 1 |
| 188 | Virsh console 1 | 193 | # Qemux86-64 login: root |
| 189 | # Qemux86-64 login: root | 194 | tail -f /var/log/testpmd-out</programlisting> |
| 190 | tail -f /var/log/testpmd-out</programlisting> | ||
| 191 | 195 | ||
| 192 | <figure> | 196 | <figure> |
| 193 | <title>Traffic Statistics</title> | 197 | <title>Traffic Statistics</title> |
| @@ -280,4 +284,4 @@ Run: tail -f /opt/testpmd-out</programlisting> | |||
| 280 | </orderedlist> | 284 | </orderedlist> |
| 281 | </section> | 285 | </section> |
| 282 | </section> | 286 | </section> |
| 283 | </chapter> | 287 | </chapter> \ No newline at end of file |
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 cc158fe..8174aa1 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 | |||
| @@ -7,11 +7,14 @@ | |||
| 7 | appliances. The virtual appliances can be integrated in Firewall or SD-WAN | 7 | appliances. The virtual appliances can be integrated in Firewall or SD-WAN |
| 8 | solution development.</para> | 8 | solution development.</para> |
| 9 | 9 | ||
| 10 | <para>Enea provides a prepared VNF bundle for download from the Enea Portal, | 10 | <section id="forti_firewall_prereq"> |
| 11 | for usage with the Enea NFV Access product. The prepared VNF bundle includes | 11 | <title>Prerequisites</title> |
| 12 | the FortiGate VNF image as well as a VNF Descriptor and other onboarding | 12 | |
| 13 | related configuration files. The VNF Descriptor provided configures a setup, | 13 | <para>Enea provides a prepared VNF bundle for usage with the Enea |
| 14 | which requires the following resources:</para> | 14 | NFV Access product. The bundle includes the FortiGate VNF image as well |
| 15 | as a VNF Descriptor and other onboarding related configuration files. | ||
| 16 | The VNF Descriptor provided configures a setup, which requires the | ||
| 17 | following resources:</para> | ||
| 15 | 18 | ||
| 16 | <itemizedlist> | 19 | <itemizedlist> |
| 17 | <listitem> | 20 | <listitem> |
| @@ -29,19 +32,20 @@ | |||
| 29 | 32 | ||
| 30 | <para>The VNF Descriptor represents one specific setup, suitable for usage | 33 | <para>The VNF Descriptor represents one specific setup, suitable for usage |
| 31 | with the Firewall and SD-WAN VPN instructions in this guide. Alternative VNF | 34 | with the Firewall and SD-WAN VPN instructions in this guide. Alternative VNF |
| 32 | Descriptor configurations may be needed to support other configurations | 35 | Descriptor configurations may be needed to support other setups |
| 33 | required by the customer.</para> | 36 | desired by the customer.</para> |
| 34 | 37 | ||
| 35 | <para>Enea can offer assistance and provide alternative VNF Descriptor | 38 | <para>Enea can offer assistance and provide alternative VNF Descriptor |
| 36 | configurations.</para> | 39 | configurations.</para> |
| 37 | 40 | ||
| 38 | <note> | 41 | <note> |
| 39 | <para>While the prepared FortiGate bundle is available through the Enea Portal, | 42 | <para>While the prepared FortiGate bundle is available from Enea, |
| 40 | additional content needs to be received from Fortinet directly. The | 43 | additional content needs to acquired directly from Fortinet. The |
| 41 | FortiGate VNF license as well as any FortiGate specific documentation | 44 | FortiGate VNF license file as well as any FortiGate specific documentation |
| 42 | shall be requested from the local Fortinet sales representatives in your | 45 | is available from the local Fortinet sales representatives in your |
| 43 | region, before FortiGate can be used.</para> | 46 | region, and must be requested before FortiGate can be used.</para> |
| 44 | </note> | 47 | </note> |
| 48 | </section> | ||
| 45 | 49 | ||
| 46 | <section id="fortigate_firewall"> | 50 | <section id="fortigate_firewall"> |
| 47 | <title>FortiGate VNF as a Firewall</title> | 51 | <title>FortiGate VNF as a Firewall</title> |
| @@ -53,8 +57,7 @@ | |||
| 53 | networks, and provides security ratings to adopt security best | 57 | networks, and provides security ratings to adopt security best |
| 54 | practices.</para> | 58 | practices.</para> |
| 55 | 59 | ||
| 56 | <para>An example firewall configuration for the FortiGate VNF is provided | 60 | <para>Enea provides an example of a simple base firewall configuration for the FortiGate VNF.</para> |
| 57 | in the Enea Portal. It is a simple firewall base configuration.</para> | ||
| 58 | 61 | ||
| 59 | <table> | 62 | <table> |
| 60 | <title>FortiGate VNF Example Configuration</title> | 63 | <title>FortiGate VNF Example Configuration</title> |
| @@ -227,16 +230,12 @@ | |||
| 227 | <entrytbl cols="1"> | 230 | <entrytbl cols="1"> |
| 228 | <tbody> | 231 | <tbody> |
| 229 | <row> | 232 | <row> |
| 230 | <entry>Download the FortiGate VNF Bundle from the Enea Portal | 233 | <entry>Copy the FortiGate VNF Bundle provided by Enea to the Lab Machine file system.</entry> |
| 231 | to the Lab Machine file system. Please see the Download | ||
| 232 | Chapter for more details.</entry> | ||
| 233 | </row> | 234 | </row> |
| 234 | 235 | ||
| 235 | <row> | 236 | <row> |
| 236 | <entry>Download FortiGate configuration examples from the | 237 | <entry>Copy the FortiGate configuration examples from Enea to the Lab Machine file system. Unpack the configuration |
| 237 | Enea Portal to the Lab Machine file system. Please check the | 238 | examples onto the Lab Machine.</entry> |
| 238 | Download Chapter for more details. Unpack the configuration | ||
| 239 | examples on the Lab Machine.</entry> | ||
| 240 | </row> | 239 | </row> |
| 241 | 240 | ||
| 242 | <row> | 241 | <row> |
| @@ -337,7 +336,7 @@ | |||
| 337 | <para>Create one Open vSwitch bridge for each firewall network | 336 | <para>Create one Open vSwitch bridge for each firewall network |
| 338 | connection (WAN, LAN1 and LAN2), by selecting: | 337 | connection (WAN, LAN1 and LAN2), by selecting: |
| 339 | <literal>Configuration</literal> -> | 338 | <literal>Configuration</literal> -> |
| 340 | <literal>OpenVSwitch</literal> -> <literal>Bridges</literal> -> <literal>Add</literal>. | 339 | <literal>OpenVSwitch</literal> -> <literal>Bridges</literal> -> <literal>Add</literal>. |
| 341 | A popup like the following should appear:</para> | 340 | A popup like the following should appear:</para> |
| 342 | 341 | ||
| 343 | <figure> | 342 | <figure> |
| @@ -381,7 +380,7 @@ | |||
| 381 | </listitem> | 380 | </listitem> |
| 382 | 381 | ||
| 383 | <listitem> | 382 | <listitem> |
| 384 | <para>Click <literal>Browse</literal> to view selections, and choose the | 383 | <para>Click <literal>Browse</literal> to view selections, and choose the |
| 385 | <literal>Fortigate.zip</literal> file, before clicking <literal>Send</literal>.</para> | 384 | <literal>Fortigate.zip</literal> file, before clicking <literal>Send</literal>.</para> |
| 386 | </listitem> | 385 | </listitem> |
| 387 | </orderedlist> | 386 | </orderedlist> |
| @@ -464,7 +463,7 @@ | |||
| 464 | <row> | 463 | <row> |
| 465 | <entry align="left">Configuration file</entry> | 464 | <entry align="left">Configuration file</entry> |
| 466 | 465 | ||
| 467 | <entry align="left">Firewall example configuration file provided by Enea | 466 | <entry align="left">Firewall example configuration file provided by Enea |
| 468 | (<filename>FGVM080000136187_20180828_0353_basic_fw.conf | 467 | (<filename>FGVM080000136187_20180828_0353_basic_fw.conf |
| 469 | </filename>).</entry> | 468 | </filename>).</entry> |
| 470 | </row> | 469 | </row> |
| @@ -472,7 +471,7 @@ | |||
| 472 | <row> | 471 | <row> |
| 473 | <entry align="left">Port1 - WAN</entry> | 472 | <entry align="left">Port1 - WAN</entry> |
| 474 | 473 | ||
| 475 | <entry align="left">Set the External Interface type to Dpdk and connect it to the | 474 | <entry align="left">Set the External Interface type to Dpdk and connect it to the |
| 476 | <literal>wanmgrbr</literal> ovs bridge.</entry> | 475 | <literal>wanmgrbr</literal> ovs bridge.</entry> |
| 477 | </row> | 476 | </row> |
| 478 | 477 | ||
| @@ -497,12 +496,12 @@ | |||
| 497 | 496 | ||
| 498 | <para><emphasis role="bold">Testing the FortiGate Firewall</emphasis></para> | 497 | <para><emphasis role="bold">Testing the FortiGate Firewall</emphasis></para> |
| 499 | 498 | ||
| 500 | <para>Connect the Test Machine on the LAN interface<remark>which lan interface?</remark> | 499 | <para>Connect the Test Machine on the LAN interface<remark>which lan interface?</remark> |
| 501 | and access the internet from the Test Machine to use the firewall on the uCPE device.</para> | 500 | and access the internet from the Test Machine to use the firewall on the uCPE device.</para> |
| 502 | 501 | ||
| 503 | <note> | 502 | <note> |
| 504 | <para>The connected Test Machine can be a laptop or a uCPE device. It must have one | 503 | <para>The connected Test Machine can be a laptop or a uCPE device. It must have one |
| 505 | interface configured to get a dynamic IP from a DHCP server. The | 504 | interface configured to get a dynamic IP from a DHCP server. The |
| 506 | <literal>dhclient <interface></literal> command can be used to | 505 | <literal>dhclient <interface></literal> command can be used to |
| 507 | request an IP address. The received IP must be in the 172.16.1.2 - | 506 | request an IP address. The received IP must be in the 172.16.1.2 - |
| 508 | 172.16.1.255 range.</para> | 507 | 172.16.1.255 range.</para> |
| @@ -519,25 +518,25 @@ | |||
| 519 | </mediaobject> | 518 | </mediaobject> |
| 520 | </figure> | 519 | </figure> |
| 521 | 520 | ||
| 522 | <para>In the example above<remark>what example exactly, in the overview picture or?</remark>, | 521 | <para>In the example above<remark>what example exactly, in the overview picture or?</remark>, |
| 523 | the FortiGate VNF management interface is accessible through the WAN interface. The | 522 | the FortiGate VNF management interface is accessible through the WAN interface. The |
| 524 | WAN IP address can be used from a web browser on the Lab Machine to access the | 523 | WAN IP address can be used from a web browser on the Lab Machine to access the |
| 525 | Fortigate VNF Management Web UI. Please check the Fortigate VNF web management section | 524 | Fortigate VNF Management Web UI. Please check the Fortigate VNF web management section |
| 526 | for more information.<remark>Note to self: An olink is needed to this section in this book, | 525 | for more information.<remark>Note to self: An olink is needed to this section in this book, |
| 527 | use fortigate_webmg as the ID.</remark></para> | 526 | use fortigate_webmg as the ID.</remark></para> |
| 528 | 527 | ||
| 529 | <para>In another example, the firewall can be setup to use bridges as | 528 | <para>In another example, the firewall can be setup to use bridges as |
| 530 | connection points for the Fortigate VNF. It is possible to replace these | 529 | connection points for the Fortigate VNF. It is possible to replace these |
| 531 | OVS-DPDK bridges with SR-IOV connection points. Please check the network | 530 | OVS-DPDK bridges with SR-IOV connection points. Please check the network |
| 532 | configuration chapter on how to configure an interface for SR-IOV.<remark>An olink | 531 | configuration chapter on how to configure an interface for SR-IOV.<remark>An olink |
| 533 | is needed but I can't add it without clarifying which chapter do you refer to?</remark></para> | 532 | is needed but I can't add it without clarifying which chapter do you refer to?</remark></para> |
| 534 | 533 | ||
| 535 | <para>It was previously assumed that three physical interfaces are | 534 | <para>It was previously assumed that three physical interfaces are |
| 536 | available for VNF connection. In the case of a firewall setup only two physical interfaces | 535 | available for VNF connection. In the case of a firewall setup only two physical interfaces |
| 537 | are needed for the data path (one for WAN and one for LAN).</para><remark>Is this the meaning you | 536 | are needed for the data path (one for WAN and one for LAN).</para><remark>Is this the meaning you |
| 538 | intented to convey in this sentence?</remark> | 537 | intented to convey in this sentence?</remark> |
| 539 | 538 | ||
| 540 | <para>In the example below only two interfaces will be configured as DPDK, with two | 539 | <para>In the example below only two interfaces will be configured as DPDK, with two |
| 541 | bridges created, one for each type of connection.</para> | 540 | bridges created, one for each type of connection.</para> |
| 542 | 541 | ||
| 543 | <para>Please note that at VNF instantiation instead of assigning distinct bridges for each | 542 | <para>Please note that at VNF instantiation instead of assigning distinct bridges for each |
| @@ -585,7 +584,7 @@ | |||
| 585 | </listitem> | 584 | </listitem> |
| 586 | 585 | ||
| 587 | <listitem> | 586 | <listitem> |
| 588 | <para>To access Fortigate CLI, use <literal>admin</literal> as the user, | 587 | <para>To access Fortigate CLI, use <literal>admin</literal> as the user, |
| 589 | leaving the password blank/empty, and press enter.</para> | 588 | leaving the password blank/empty, and press enter.</para> |
| 590 | 589 | ||
| 591 | <para>Use the CLI command <literal>get system interface</literal> to | 590 | <para>Use the CLI command <literal>get system interface</literal> to |
| @@ -679,7 +678,7 @@ | |||
| 679 | applied to WAN connections. It connects enterprise networks, including | 678 | applied to WAN connections. It connects enterprise networks, including |
| 680 | branch offices and data centers, over large geographic distances.</para> | 679 | branch offices and data centers, over large geographic distances.</para> |
| 681 | 680 | ||
| 682 | <para>SD-WAN decouples the network from the management plane, detaching | 681 | <para>SD-WAN decouples the network from the management plane, detaching |
| 683 | traffic management and monitoring functions from hardware. Most forms | 682 | traffic management and monitoring functions from hardware. Most forms |
| 684 | of SD-WAN technology create a virtual overlay that is transport-agnostic, | 683 | of SD-WAN technology create a virtual overlay that is transport-agnostic, |
| 685 | i.e. it abstracts underlying private or public WAN connections. With an | 684 | i.e. it abstracts underlying private or public WAN connections. With an |
| @@ -694,7 +693,7 @@ | |||
| 694 | 693 | ||
| 695 | <note> | 694 | <note> |
| 696 | <para>Example SD-WAN configurations for the FortiGate VNF are provided | 695 | <para>Example SD-WAN configurations for the FortiGate VNF are provided |
| 697 | in the Enea Portal.</para> | 696 | by Enea.</para> |
| 698 | </note> | 697 | </note> |
| 699 | 698 | ||
| 700 | <table> | 699 | <table> |
| @@ -928,14 +927,12 @@ | |||
| 928 | <entrytbl cols="1"> | 927 | <entrytbl cols="1"> |
| 929 | <tbody> | 928 | <tbody> |
| 930 | <row> | 929 | <row> |
| 931 | <entry>FortiGate VNF Bundle downloaded from the Enea Portal | 930 | <entry>FortiGate VNF Bundle copied from Enea to the Lab Machine file system.</entry> |
| 932 | to the Lab Machine file system.</entry> | ||
| 933 | </row> | 931 | </row> |
| 934 | 932 | ||
| 935 | <row> | 933 | <row> |
| 936 | <entry>FortiGate configuration examples downloaded from the Enea | 934 | <entry>FortiGate configuration examples from Enea, copied to the Lab Machine file system. Unpack the configuration |
| 937 | Portal to the Lab Machine file system. Unpack the configuration | 935 | examples specific for SD-WAN onto the Lab Machine.</entry> |
| 938 | examples specific for SD-WAN on the Lab Machine.</entry> | ||
| 939 | </row> | 936 | </row> |
| 940 | 937 | ||
| 941 | <row> | 938 | <row> |
| @@ -1009,7 +1006,7 @@ | |||
| 1009 | </mediaobject> | 1006 | </mediaobject> |
| 1010 | </figure> | 1007 | </figure> |
| 1011 | 1008 | ||
| 1012 | <para>Repeat this step for the other two interfaces. The result of a successful binding | 1009 | <para>Repeat this step for the other two interfaces. The result of a successful binding |
| 1013 | should look like the following:</para> | 1010 | should look like the following:</para> |
| 1014 | 1011 | ||
| 1015 | <figure> | 1012 | <figure> |
| @@ -1026,8 +1023,8 @@ | |||
| 1026 | 1023 | ||
| 1027 | <listitem> | 1024 | <listitem> |
| 1028 | <para>Create an Open vSwitch bridge for each SD-WAN network connection | 1025 | <para>Create an Open vSwitch bridge for each SD-WAN network connection |
| 1029 | (VNF management, WAN and LAN) by selecting the uCPE device then: | 1026 | (VNF management, WAN and LAN) by selecting the uCPE device then: |
| 1030 | <literal>Configuration</literal> -> <literal>OpenvSwitch</literal> -> | 1027 | <literal>Configuration</literal> -> <literal>OpenvSwitch</literal> -> |
| 1031 | <literal>Bridges</literal> -> <literal>Add</literal>. A popup will appear:</para> | 1028 | <literal>Bridges</literal> -> <literal>Add</literal>. A popup will appear:</para> |
| 1032 | 1029 | ||
| 1033 | <figure> | 1030 | <figure> |
| @@ -1106,14 +1103,14 @@ | |||
| 1106 | 1103 | ||
| 1107 | <para><emphasis role="bold">Instantiating the FortiGate | 1104 | <para><emphasis role="bold">Instantiating the FortiGate |
| 1108 | VNF</emphasis></para> | 1105 | VNF</emphasis></para> |
| 1109 | 1106 | ||
| 1110 | <note><para>Download locally the valid license files for the Fortigate VNF from | 1107 | <note><para>Download locally the valid license files for the Fortigate VNF from |
| 1111 | Fortinet and the configuration file provided by Enea as examples.</para> | 1108 | Fortinet and the configuration file provided by Enea as examples.</para> |
| 1112 | </note> | 1109 | </note> |
| 1113 | 1110 | ||
| 1114 | <orderedlist> | 1111 | <orderedlist> |
| 1115 | <listitem> | 1112 | <listitem> |
| 1116 | <para>Select a uCPE device on the map, then from the top toolbar click | 1113 | <para>Select a uCPE device on the map, then from the top toolbar click |
| 1117 | <literal>VNF</literal> -> <literal>Instances</literal> -> <literal>Add</literal>:</para> | 1114 | <literal>VNF</literal> -> <literal>Instances</literal> -> <literal>Add</literal>:</para> |
| 1118 | 1115 | ||
| 1119 | <figure> | 1116 | <figure> |
| @@ -1192,7 +1189,7 @@ | |||
| 1192 | <row> | 1189 | <row> |
| 1193 | <entry>Configuration file(s)</entry> | 1190 | <entry>Configuration file(s)</entry> |
| 1194 | 1191 | ||
| 1195 | <entry>SD-WAN example configuration files provided by Enea: | 1192 | <entry>SD-WAN example configuration files provided by Enea: |
| 1196 | <literal>FGVM080000136187_20180215_0708_sdwan1.conf</literal> | 1193 | <literal>FGVM080000136187_20180215_0708_sdwan1.conf</literal> |
| 1197 | <literal>FGVM080000136188_20180215_0708_sdwan2.conf</literal></entry> | 1194 | <literal>FGVM080000136188_20180215_0708_sdwan2.conf</literal></entry> |
| 1198 | </row> | 1195 | </row> |
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 3aea4f5..a15b7d5 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 | |||
| @@ -31,7 +31,7 @@ | |||
| 31 | </listitem> | 31 | </listitem> |
| 32 | </itemizedlist> | 32 | </itemizedlist> |
| 33 | 33 | ||
| 34 | <para>For prerequisites and further details, please see <xref linkend="inband_management" /> | 34 | <para>For prerequisites and further details, please see <xref linkend="inband_management" /> |
| 35 | and <xref linkend="vnf_fortigate" /><remark>Are these references still valid?</remark>.</para> | 35 | and <xref linkend="vnf_fortigate" /><remark>Are these references still valid?</remark>.</para> |
| 36 | 36 | ||
| 37 | <section id="mg_activation"> | 37 | <section id="mg_activation"> |
| @@ -261,7 +261,7 @@ | |||
| 261 | </listitem> | 261 | </listitem> |
| 262 | </itemizedlist> | 262 | </itemizedlist> |
| 263 | 263 | ||
| 264 | <para>If you have access from the uCPE Manager to the device as shown above, this | 264 | <para>If you have access from the uCPE Manager to the device as shown above, this |
| 265 | demonstrates that device management traffic passes through the In-band | 265 | demonstrates that device management traffic passes through the In-band |
| 266 | management WAN bridge successfully.</para> | 266 | management WAN bridge successfully.</para> |
| 267 | 267 | ||
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/introduction.xml b/doc/book-enea-nfv-access-example-usecases/doc/introduction.xml index 208cd0e..91e15aa 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/introduction.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/introduction.xml | |||
| @@ -2,16 +2,16 @@ | |||
| 2 | <chapter id="intro"> | 2 | <chapter id="intro"> |
| 3 | <title>Introduction</title> | 3 | <title>Introduction</title> |
| 4 | 4 | ||
| 5 | <para>This document describes several example use-cases concerning uCPE device | 5 | <para>This document describes several example use-cases concerning uCPE device |
| 6 | network interface configuration, onboarding and instantiation of certain VNFs, | 6 | network interface configuration, onboarding and instantiation of certain VNFs, |
| 7 | VNF chaining, and In-band management.</para> | 7 | VNF chaining, and In-band management.</para> |
| 8 | 8 | ||
| 9 | <note><para>Before running any example make sure the uCPE device(s) have been | 9 | <note><para>Before running any example make sure the uCPE device(s) have been |
| 10 | added to the uCPE Manager and placed on the map.</para> | 10 | added to the uCPE Manager and placed on the map.</para> |
| 11 | </note> | 11 | </note> |
| 12 | 12 | ||
| 13 | <para>For detailed information on how to add a device to the uCPE Manager, how | 13 | <para>For detailed information on how to add a device to the uCPE Manager, how |
| 14 | to configure the network interfaces to use DPDK, PCI-passthrough or SR-IOV drivers, | 14 | to configure the network interfaces to use DPDK, PCI-passthrough or SR-IOV drivers, |
| 15 | or VNF configuration, please refer to the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 15 | or VNF configuration, please refer to the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
| 16 | xmlns:xi="http://www.w3.org/2001/XInclude" | 16 | xmlns:xi="http://www.w3.org/2001/XInclude" |
| 17 | xpointer="element(book_enea_nfv_access_getting_started/1)" /> Manual.</para> | 17 | xpointer="element(book_enea_nfv_access_getting_started/1)" /> Manual.</para> |
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml b/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml index 412af4a..90bf566 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml | |||
| @@ -28,7 +28,7 @@ | |||
| 28 | <mediaobject> | 28 | <mediaobject> |
| 29 | <imageobject> | 29 | <imageobject> |
| 30 | <imagedata align="center" fileref="images/example_setup.png" | 30 | <imagedata align="center" fileref="images/example_setup.png" |
| 31 | scale="90" /> | 31 | scale="88" /> |
| 32 | </imageobject> | 32 | </imageobject> |
| 33 | </mediaobject> | 33 | </mediaobject> |
| 34 | </figure> | 34 | </figure> |
| @@ -52,19 +52,16 @@ | |||
| 52 | </listitem> | 52 | </listitem> |
| 53 | 53 | ||
| 54 | <listitem> | 54 | <listitem> |
| 55 | <para>Fortigate VNF image. This VNF can be downloaded from <ulink | 55 | <para>Fortigate VNF image. This image is provided by Enea.</para> |
| 56 | url="https://portal.enea.com/">Enea portal</ulink>.</para> | ||
| 57 | </listitem> | 56 | </listitem> |
| 58 | 57 | ||
| 59 | <listitem> | 58 | <listitem> |
| 60 | <para>vSRX-domain-update-script. This file can be downloaded from | 59 | <para>vSRX-domain-update-script. This file is provided by Enea.</para> |
| 61 | <ulink url="https://portal.enea.com/">Enea portal</ulink>.</para> | ||
| 62 | </listitem> | 60 | </listitem> |
| 63 | 61 | ||
| 64 | <listitem> | 62 | <listitem> |
| 65 | <para>FortiFW-Site<x>.conf as Cloud-Init files. This file can be | 63 | <para>FortiFW-Site<x>.conf as the Cloud-Init file(s). This file |
| 66 | downloaded from <ulink url="https://portal.enea.com/">Enea | 64 | is provided by Enea.</para> |
| 67 | portal</ulink>.</para> | ||
| 68 | </listitem> | 65 | </listitem> |
| 69 | 66 | ||
| 70 | <listitem> | 67 | <listitem> |
| @@ -292,8 +289,10 @@ | |||
| 292 | <para>Before testing LAN to LAN connectivity, preliminary tests of service | 289 | <para>Before testing LAN to LAN connectivity, preliminary tests of service |
| 293 | can be run to ensure everything was set up properly.</para> | 290 | can be run to ensure everything was set up properly.</para> |
| 294 | 291 | ||
| 295 | <para>Before testing LAN to LAN connectivity, one can run preliminary tests of service to ensure everything was | 292 | <para>Before testing LAN to LAN connectivity, one can run preliminary |
| 296 | set-up properly. For instance, by connecting to vSRX CLI (any site), one can test IKE security associations:</para> | 293 | tests of service to ensure everything was set-up properly. For instance, |
| 294 | by connecting to vSRX CLI (any site), one can test IKE security | ||
| 295 | associations:</para> | ||
| 297 | 296 | ||
| 298 | <programlisting>root@Atom-C3000:~ # cli</programlisting> | 297 | <programlisting>root@Atom-C3000:~ # cli</programlisting> |
| 299 | 298 | ||
| @@ -373,7 +372,7 @@ disable type: physical netflow-sampler: disable sflow-sampler: disable | |||
| 373 | be checked (from Site1) as such:</para> | 372 | be checked (from Site1) as such:</para> |
| 374 | 373 | ||
| 375 | <programlisting>root@atom-c3000:~# ping 172.10.10.2 | 374 | <programlisting>root@atom-c3000:~# ping 172.10.10.2 |
| 376 | PING 172.10.10.1 (172.10.10.2): 56 data bytes | 375 | PING 172.10.10.1 (172.10.10.2): 56 data bytes |
| 377 | ...</programlisting> | 376 | ...</programlisting> |
| 378 | </section> | 377 | </section> |
| 379 | 378 | ||
| @@ -397,4 +396,4 @@ PING 172.10.10.1 (172.10.10.2): 56 data bytes | |||
| 397 | </listitem> | 396 | </listitem> |
| 398 | </itemizedlist> | 397 | </itemizedlist> |
| 399 | </section> | 398 | </section> |
| 400 | </chapter> | 399 | </chapter> \ No newline at end of file |
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 9b28c88..7a30f28 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 | |||
| @@ -207,7 +207,7 @@ rootfs_destination=</programlisting></para> | |||
| 207 | 207 | ||
| 208 | <orderedlist> | 208 | <orderedlist> |
| 209 | <listitem> | 209 | <listitem> |
| 210 | <para>Download the HDDIMG file from the download portal onto a | 210 | <para>Copy the HDDIMG image file provided by Enea, onto a |
| 211 | development machine (Linux or Windows with Cygwin support).</para> | 211 | development machine (Linux or Windows with Cygwin support).</para> |
| 212 | </listitem> | 212 | </listitem> |
| 213 | 213 | ||
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 e2e9802..c6a4f04 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml | |||
| @@ -16,12 +16,12 @@ | |||
| 16 | 16 | ||
| 17 | <para>Enea NFV Access for universal Customer Premise Equipment (uCPE) is a | 17 | <para>Enea NFV Access for universal Customer Premise Equipment (uCPE) is a |
| 18 | virtualization and management platform, which allows end-users to introduce, | 18 | virtualization and management platform, which allows end-users to introduce, |
| 19 | instantiate, and run third-party VNFs onto their systems. The solution is | 19 | instantiate, and run third-party VNFs onto their systems. It is comprised of |
| 20 | comprised of two major components working in close cooperation:</para> | 20 | two major components working in close cooperation:</para> |
| 21 | 21 | ||
| 22 | <itemizedlist> | 22 | <itemizedlist> |
| 23 | <listitem> | 23 | <listitem> |
| 24 | <para>The Enea NFV Access Run Time Platform, which acts as the host for | 24 | <para>The Enea NFV Access Run-Time Platform, which acts as the host for |
| 25 | Virtualized Network Functions (VNFs) and provides management over | 25 | Virtualized Network Functions (VNFs) and provides management over |
| 26 | NETCONF.</para> | 26 | NETCONF.</para> |
| 27 | </listitem> | 27 | </listitem> |
| @@ -92,4 +92,4 @@ | |||
| 92 | </listitem> | 92 | </listitem> |
| 93 | </itemizedlist> | 93 | </itemizedlist> |
| 94 | </section> | 94 | </section> |
| 95 | </chapter> | 95 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-release-info/doc/about_release.xml b/doc/book-enea-nfv-access-release-info/doc/about_release.xml index e24ae38..d179765 100644 --- a/doc/book-enea-nfv-access-release-info/doc/about_release.xml +++ b/doc/book-enea-nfv-access-release-info/doc/about_release.xml | |||
| @@ -142,7 +142,7 @@ | |||
| 142 | Access release content.</para> | 142 | Access release content.</para> |
| 143 | </listitem> | 143 | </listitem> |
| 144 | 144 | ||
| 145 | <listitem> | 145 | <listitem condition="hidden"> |
| 146 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 146 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
| 147 | xmlns:xi="http://www.w3.org/2001/XInclude" | 147 | xmlns:xi="http://www.w3.org/2001/XInclude" |
| 148 | xpointer="element(book_enea_nfv_access_reference_guide_intel/1)" />. | 148 | xpointer="element(book_enea_nfv_access_reference_guide_intel/1)" />. |
| @@ -153,8 +153,8 @@ | |||
| 153 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 153 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
| 154 | xmlns:xi="http://www.w3.org/2001/XInclude" | 154 | xmlns:xi="http://www.w3.org/2001/XInclude" |
| 155 | xpointer="element(book_enea_nfv_access_getting_started/1)" />. | 155 | xpointer="element(book_enea_nfv_access_getting_started/1)" />. |
| 156 | Describes how to install the uCPE Manager, the NFV Access platform and | 156 | Describes how to install the uCPE Manager, the NFV Access Run-Time |
| 157 | Device Management.</para> | 157 | platform and Device Management.</para> |
| 158 | </listitem> | 158 | </listitem> |
| 159 | 159 | ||
| 160 | <listitem> | 160 | <listitem> |
| @@ -165,7 +165,7 @@ | |||
| 165 | various VNFs.</para> | 165 | various VNFs.</para> |
| 166 | </listitem> | 166 | </listitem> |
| 167 | 167 | ||
| 168 | <listitem> | 168 | <listitem condition="hidden"> |
| 169 | <para>Enea NFV Access VNF Onboarding Guide. Describes the process of | 169 | <para>Enea NFV Access VNF Onboarding Guide. Describes the process of |
| 170 | onboarding a new VNF onto the uCPE Manager.</para> | 170 | onboarding a new VNF onto the uCPE Manager.</para> |
| 171 | </listitem> | 171 | </listitem> |
| @@ -186,14 +186,15 @@ | |||
| 186 | 186 | ||
| 187 | <listitem> | 187 | <listitem> |
| 188 | <para>Enea NFV Access Automation Framework and Test Harness User | 188 | <para>Enea NFV Access Automation Framework and Test Harness User |
| 189 | Guide. Describes the Automation Framework and Test Harness for the | 189 | Guide. Describes the Automation Framework and Test Harness for Enea |
| 190 | Enea NFV Access Solution and provides instructions regarding the | 190 | NFV Access and provides instructions regarding the necessary steps to |
| 191 | necessary steps to run these software tools.</para> | 191 | run these software tools.</para> |
| 192 | </listitem> | 192 | </listitem> |
| 193 | 193 | ||
| 194 | <listitem condition="hidden"> | 194 | <listitem> |
| 195 | <para>Enea NFV Access System Test Specification.</para> | 195 | <para>Enea NFV Access System Test Specification. Describes a sample |
| 196 | Test Suite for System Testing of Enea NFV Access.</para> | ||
| 196 | </listitem> | 197 | </listitem> |
| 197 | </itemizedlist> | 198 | </itemizedlist> |
| 198 | </section> | 199 | </section> |
| 199 | </chapter> | 200 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml b/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml index 4975ca3..9eecd3c 100644 --- a/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml +++ b/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml | |||
| @@ -5,11 +5,10 @@ | |||
| 5 | <title>Getting Enea NFV Access</title> | 5 | <title>Getting Enea NFV Access</title> |
| 6 | 6 | ||
| 7 | <para>Enea NFV Access releases and updates are available as binaries ready | 7 | <para>Enea NFV Access releases and updates are available as binaries ready |
| 8 | for download from the <ulink url="https://portal.enea.com">Enea Download | 8 | for download.</para> |
| 9 | Portal</ulink>.</para> | ||
| 10 | 9 | ||
| 11 | <para><emphasis role="bold">Downloading Enea NFV Access</emphasis></para> | 10 | <para><emphasis role="bold">Downloading Enea NFV Access</emphasis></para> |
| 12 | 11 | <remark>Does the content below need to be revised to no longer make reference or mention to Enea Portal?</remark> | |
| 13 | <orderedlist> | 12 | <orderedlist> |
| 14 | <listitem> | 13 | <listitem> |
| 15 | <para>Log in to the link above using the credentials provided by | 14 | <para>Log in to the link above using the credentials provided by |
diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml b/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml index 7df9acc..f89f8bd 100644 --- a/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml +++ b/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml | |||
| @@ -2,18 +2,10 @@ | |||
| 2 | <chapter id="overview_sts"> | 2 | <chapter id="overview_sts"> |
| 3 | <title>Overview</title> | 3 | <title>Overview</title> |
| 4 | 4 | ||
| 5 | <para>This document specifies a Sample Test Suite for System Testing of the | 5 | <para>The scope of this document is to describe the Test Harness (TH) sample |
| 6 | Enea NFV Access Solution. It also provides information regarding the | 6 | test cases for System Testing of Enea NFV Access. Furthermore, this document |
| 7 | necessary steps to run these tests.</para> | 7 | shall also describe the necessary environment setup to run these tests |
| 8 | 8 | successfully.</para> | |
| 9 | <section id="scope"> | ||
| 10 | <title>Scope</title> | ||
| 11 | |||
| 12 | <para>The scope of this document is to describe the Test Harness (TH) | ||
| 13 | sample test cases for System Testing of the Enea NFV Access Solution. | ||
| 14 | Furthermore, this document shall also describe the necessary environment | ||
| 15 | setup to run these tests successfully.</para> | ||
| 16 | </section> | ||
| 17 | 9 | ||
| 18 | <section id="def_acro_sts"> | 10 | <section id="def_acro_sts"> |
| 19 | <title>Definitions and Acronyms</title> | 11 | <title>Definitions and Acronyms</title> |
| @@ -34,17 +26,10 @@ | |||
| 34 | 26 | ||
| 35 | <tbody> | 27 | <tbody> |
| 36 | <row> | 28 | <row> |
| 37 | <entry>Enea NFV Access Solution</entry> | 29 | <entry>Enea NFV Access</entry> |
| 38 | |||
| 39 | <entry>Enea NFV Access (with ODM) Runtime Platform and Enea uCPE | ||
| 40 | Manager.</entry> | ||
| 41 | </row> | ||
| 42 | |||
| 43 | <row> | ||
| 44 | <entry>Enea Portal</entry> | ||
| 45 | 30 | ||
| 46 | <entry><ulink | 31 | <entry>The Enea NFV Access (with ODM) Run-time Platform and the |
| 47 | url="https://portal.enea.com">https://portal.enea.com</ulink></entry> | 32 | Enea uCPE Manager.</entry> |
| 48 | </row> | 33 | </row> |
| 49 | </tbody> | 34 | </tbody> |
| 50 | </tgroup> | 35 | </tgroup> |
diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml index 50907ca..ec2e592 100644 --- a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml +++ b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml | |||
| @@ -9,8 +9,8 @@ | |||
| 9 | <title>VNF, Device and Network Smoke Test Cases</title> | 9 | <title>VNF, Device and Network Smoke Test Cases</title> |
| 10 | 10 | ||
| 11 | <para>The following is an automated test suite that acts as basic smoke | 11 | <para>The following is an automated test suite that acts as basic smoke |
| 12 | tests for the Enea NFV Access Solution and as a sanity-check test suite | 12 | tests for Enea NFV Access, and as a sanity-check test suite for the AF and |
| 13 | for the AF and TH.</para> | 13 | TH.</para> |
| 14 | 14 | ||
| 15 | <section id="onb_vnf_image"> | 15 | <section id="onb_vnf_image"> |
| 16 | <title>VNF - Onboard_VNF_Image</title> | 16 | <title>VNF - Onboard_VNF_Image</title> |
| @@ -322,8 +322,8 @@ bridge=<Bridge-name>"</programlisting></para> | |||
| 322 | <title>VNF Deployment and Lifecycle</title> | 322 | <title>VNF Deployment and Lifecycle</title> |
| 323 | 323 | ||
| 324 | <para>The following details the automated suite that handles the testing | 324 | <para>The following details the automated suite that handles the testing |
| 325 | of the instantiation, lifecycle and destruction of a VNF for the Enea NFV | 325 | of the instantiation, lifecycle and destruction of a VNF for Enea NFV |
| 326 | Access Solution.</para> | 326 | Access.</para> |
| 327 | 327 | ||
| 328 | <section id="inst_vnfi"> | 328 | <section id="inst_vnfi"> |
| 329 | <title>Instantiate_VNFI</title> | 329 | <title>Instantiate_VNFI</title> |
| @@ -467,10 +467,9 @@ Invalid VNF Instance control command specified - <Command></programlisting | |||
| 467 | </orderedlist> | 467 | </orderedlist> |
| 468 | 468 | ||
| 469 | <para>For more information please refer to "FortiGate VNF as a Firewall" | 469 | <para>For more information please refer to "FortiGate VNF as a Firewall" |
| 470 | chapter from the "Enea NFV Access Example Use-cases" manual.<note> | 470 | chapter from the "Enea NFV Access Example Use-cases" manual. <note> |
| 471 | <para>The license and configuration files for the FortiGate VNF are | 471 | <para>The license and configuration files for the FortiGate VNF are |
| 472 | not included in the TH and should be obtained from the user's Enea | 472 | not included in the TH and should be obtained from Enea.</para> |
| 473 | Portal account.</para> | ||
| 474 | </note></para> | 473 | </note></para> |
| 475 | 474 | ||
| 476 | <section id="fortigate_fw_instance"> | 475 | <section id="fortigate_fw_instance"> |
| @@ -542,15 +541,15 @@ ansible_user=root ansible_pass=root</programlisting></para> | |||
| 542 | 541 | ||
| 543 | <listitem> | 542 | <listitem> |
| 544 | <para>Download the FortiGate VNF Firewall basic configuration from | 543 | <para>Download the FortiGate VNF Firewall basic configuration from |
| 545 | the Enea Portal, copy it into the | 544 | Enea, copy it into the |
| 546 | <filename><AF-TH-install-dir>/vnf_config/fortigateImage</filename> | 545 | <filename><AF-TH-install-dir>/vnf_config/fortigateImage</filename> |
| 547 | directory and rename it to<filename> | 546 | directory and rename it to<filename> |
| 548 | fortigateFW.conf</filename>.</para> | 547 | fortigateFW.conf</filename>.</para> |
| 549 | </listitem> | 548 | </listitem> |
| 550 | 549 | ||
| 551 | <listitem> | 550 | <listitem> |
| 552 | <para>Retrieve the FortiGate VNF license from Fortinet or the Enea | 551 | <para>Retrieve the FortiGate VNF license from Fortinet or Enea, |
| 553 | Portal, copy it into the | 552 | copy it into the |
| 554 | <literal><AF-TH-install-dir>/vnf_config/fortigateImage</literal> | 553 | <literal><AF-TH-install-dir>/vnf_config/fortigateImage</literal> |
| 555 | directory and rename it to | 554 | directory and rename it to |
| 556 | <filename>fortigateLicense.lic</filename>.</para> | 555 | <filename>fortigateLicense.lic</filename>.</para> |
| @@ -636,15 +635,15 @@ FortigateFWInstance tested successfully!</programlisting></para> | |||
| 636 | 635 | ||
| 637 | <listitem> | 636 | <listitem> |
| 638 | <para>Download the FortiGate VNF Firewall basic configuration from | 637 | <para>Download the FortiGate VNF Firewall basic configuration from |
| 639 | the Enea Portal, copy it into the | 638 | Enea, copy it into the |
| 640 | <literal><AF-TH-install-dir>/vnf_config/fortigateImage</literal> | 639 | <literal><AF-TH-install-dir>/vnf_config/fortigateImage</literal> |
| 641 | directory and rename it to | 640 | directory and rename it to |
| 642 | <filename>fortigateFW.conf</filename>.</para> | 641 | <filename>fortigateFW.conf</filename>.</para> |
| 643 | </listitem> | 642 | </listitem> |
| 644 | 643 | ||
| 645 | <listitem> | 644 | <listitem> |
| 646 | <para>Retrieve the FortiGate VNF license file from Fortinet or the | 645 | <para>Retrieve the FortiGate VNF license file from Fortinet or |
| 647 | Enea Portal, copy it into the | 646 | Enea, copy it into the |
| 648 | <literal><AF-TH-install-dir>/vnf_config/fortigateImage</literal> | 647 | <literal><AF-TH-install-dir>/vnf_config/fortigateImage</literal> |
| 649 | directory and rename it to | 648 | directory and rename it to |
| 650 | <filename>fortigateLicense.lic</filename>.</para> | 649 | <filename>fortigateLicense.lic</filename>.</para> |
| @@ -796,33 +795,33 @@ ansible_pass=root</programlisting></para> | |||
| 796 | </listitem> | 795 | </listitem> |
| 797 | 796 | ||
| 798 | <listitem> | 797 | <listitem> |
| 799 | <para>Download the FortiGate VNF Firewall basic configuration files | 798 | <para>Retrieve the FortiGate VNF Firewall basic configuration files |
| 800 | from the Enea Portal (<filename>FortiFW-Site1.conf</filename> and | 799 | from Enea (<filename>FortiFW-Site1.conf</filename> and |
| 801 | <filename>FortiFW-Site2.conf</filename>), and copy them into the | 800 | <filename>FortiFW-Site2.conf</filename>), and copy them into the |
| 802 | <literal><AF-TH-install-dir>/vnf_config/fortigateFWImage</literal> | 801 | <literal><AF-TH-install-dir>/vnf_config/fortigateFWImage</literal> |
| 803 | directory.</para> | 802 | directory.</para> |
| 804 | </listitem> | 803 | </listitem> |
| 805 | 804 | ||
| 806 | <listitem> | 805 | <listitem> |
| 807 | <para>Retrieve the FortiGate VNF license from Fortinet or the Enea | 806 | <para>Retrieve the FortiGate VNF license from Fortinet or Enea, copy |
| 808 | Portal, copy it into the | 807 | it into the |
| 809 | <literal><AF-TH-install-dir>/vnf_config/fortigateFWImage</literal> | 808 | <literal><AF-TH-install-dir>/vnf_config/fortigateFWImage</literal> |
| 810 | directory and rename it to | 809 | directory and rename it to |
| 811 | <filename>fortigateLicense.lic</filename>.</para> | 810 | <filename>fortigateLicense.lic</filename>.</para> |
| 812 | </listitem> | 811 | </listitem> |
| 813 | 812 | ||
| 814 | <listitem> | 813 | <listitem> |
| 815 | <para>Download the Juniper vSRX basic configuration files from the | 814 | <para>Retrieve the Juniper vSRX basic configuration files from Enea |
| 816 | Enea Portal (<filename>vSRX-Site1.iso</filename> and | 815 | (<filename>vSRX-Site1.iso</filename> and |
| 817 | <filename>vSRX-Site2.iso</filename>), and copy them into the | 816 | <filename>vSRX-Site2.iso</filename>), and copy them into the |
| 818 | <literal><AF-TH-install-dir>/vnf_config/junipervSRXImage</literal> | 817 | <literal><AF-TH-install-dir>/vnf_config/junipervSRXImage</literal> |
| 819 | directory.</para> | 818 | directory.</para> |
| 820 | </listitem> | 819 | </listitem> |
| 821 | 820 | ||
| 822 | <listitem> | 821 | <listitem> |
| 823 | <para>Download <filename>vSRX-domain-update-script</filename> from | 822 | <para>Retrieve <filename>vSRX-domain-update-script</filename> from |
| 824 | the Enea Portal and copy it into the | 823 | Enea and copy it into the <literal>junipervSRXImage</literal> |
| 825 | <literal>junipervSRXImage</literal> directory.</para> | 824 | directory.</para> |
| 826 | 825 | ||
| 827 | <para>Please refer to the "VNF Chaining Example Use-case" chapter | 826 | <para>Please refer to the "VNF Chaining Example Use-case" chapter |
| 828 | from the Enea NFV Access Example Use-cases manual for additional | 827 | from the Enea NFV Access Example Use-cases manual for additional |
