path: root/doc/book-enea-nfv-access-cmc-example-usecases/doc/128t_vnf_router.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="vnf_router_cmc_uc">
  <title>128T VNF Router Example Use-case</title>

  <para>The 128T Networking Platform (128T) natively provides network-based
  security, control, and insight across data centers, wide-area networks
  (WAN), and edge locations for enterprises, service providers, and cloud
  companies alike.</para>

  <section id="preq_128_router">
    <title>Prerequisites</title>

    <para>The following are needed for this example use case:</para>

    <itemizedlist spacing="compact">
      <listitem>
        <para>1 in band management port for device management.</para>
      </listitem>

      <listitem>
        <para>1 in band management port for 128T VNF.</para>
      </listitem>

      <listitem>
        <para>1 WAN interface for 128T.</para>
      </listitem>

      <listitem>
        <para>1 LAN interface for 128T.</para>
      </listitem>
    </itemizedlist>
  </section>

  <section id="vnf_router_cmc">
    <title>128T VNF Router</title>

    <figure>
      <title>128T VNF Router Setup Overview</title>

      <mediaobject>
        <imageobject>
          <imagedata contentwidth="600" fileref="images/kontron_me1100.png" />
        </imageobject>
      </mediaobject>
    </figure>

    <section id="uc_setup_cmc_router">
      <title>Use-case Setup</title>

      <para><emphasis role="bold">Configuring Network Interfaces on uCPE
      devices:</emphasis><orderedlist spacing="compact">
          <listitem>
            <para>Log into the uCPE Manager with both username and password
            values: <literal>admin</literal>.</para>
          </listitem>

          <listitem>
            <para>Add the Kontron me1100 uCPE device into the uCPE Manager:
            <literal>Devices -&gt; Manage -&gt; Add</literal>.</para>

            <para>Fill in the required fields with the following data:</para>

            <table>
              <title>Device Details</title>

              <tgroup cols="2">
                <colspec align="left" />

                <colspec colwidth="2*" />

                <colspec colwidth="5*" />

                <thead>
                  <row>
                    <entry align="center">Field</entry>

                    <entry align="center">Value</entry>
                  </row>
                </thead>

                <tbody>
                  <row>
                    <entry>Type</entry>

                    <entry>Enea universal CPE</entry>
                  </row>

                  <row>
                    <entry>Release</entry>

                    <entry>1.0</entry>
                  </row>

                  <row>
                    <entry>Name</entry>

                    <entry>me1100</entry>
                  </row>

                  <row>
                    <entry>IP/DNS Address</entry>

                    <entry>&lt;unspecified&gt;<note>
                        <para>Please do not add the IP, it will be updated
                        automatically by new communication protocol.</para>
                      </note></entry>
                  </row>

                  <row>
                    <entry>Description</entry>

                    <entry>Kontron Target 1</entry>
                  </row>

                  <row>
                    <entry>Device ID</entry>

                    <entry>The value of the Device ID must be the same as the
                    one used during the NFV Access installation.</entry>
                  </row>

                  <row>
                    <entry>SSH Port</entry>

                    <entry>830</entry>
                  </row>

                  <row>
                    <entry>SSH User Name</entry>

                    <entry>root</entry>
                  </row>

                  <row>
                    <entry>Password</entry>

                    <entry>null</entry>
                  </row>

                  <row condition="hidden">
                    <entry>OK</entry>

                    <entry>Green status indicates connection with uCPE device
                    was established.</entry>
                  </row>
                </tbody>
              </tgroup>
            </table>
          </listitem>

          <listitem>
            <para>Add the device on the map: Right-Click on <literal>Map -&gt;
            Place Device -&gt; me1100</literal>.</para>
          </listitem>

          <listitem>
            <para>Configure the virtualization infrastructure for 128T VNF by
            creating three OVS bridges and a host interface.</para>

            <para>Select the me1100 device then: <literal>Configuration -&gt;
            OpenVSwitch -&gt; Bridges -&gt; Add</literal>. Fill in the
            required fields for each bridge with the following data from each
            table:</para>

            <table>
              <title>ibm_br Bridge Details</title>

              <tgroup cols="2">
                <colspec align="left" />

                <colspec colwidth="2*" />

                <colspec colwidth="5*" />

                <thead>
                  <row>
                    <entry align="center">Field</entry>

                    <entry align="center">Value</entry>
                  </row>
                </thead>

                <tbody>
                  <row condition="hidden">
                    <entry>id</entry>

                    <entry>&lt;autogenerated - do not change&gt;</entry>
                  </row>

                  <row>
                    <entry>Name</entry>

                    <entry><literal>ibm_br</literal></entry>
                  </row>

                  <row>
                    <entry>ovs-bridge-type</entry>

                    <entry>inbandMgmt</entry>
                  </row>

                  <row condition="hidden">
                    <entry>mgmt-address</entry>

                    <entry>Provide the IP address of the uCPE Manager machine
                    (E.g. 172.24.3.109).</entry>
                  </row>

                  <row condition="hidden">
                    <entry>mgmt-port</entry>

                    <entry>830</entry>
                  </row>

                  <row>
                    <entry>Create</entry>

                    <entry><para>The system will automatically select the
                    physical interface that has access to the uCPE
                    Manager.</para></entry>
                  </row>
                </tbody>
              </tgroup>
            </table>

            <table>
              <title>vnf_mgmt_br Bridge Details</title>

              <tgroup cols="2">
                <colspec align="left" />

                <colspec colwidth="2*" />

                <colspec colwidth="5*" />

                <thead>
                  <row>
                    <entry align="center">Field</entry>

                    <entry align="center">Value</entry>
                  </row>
                </thead>

                <tbody>
                  <row condition="hidden">
                    <entry>id</entry>

                    <entry>&lt;autogenerated - do not change&gt;</entry>
                  </row>

                  <row>
                    <entry>Name</entry>

                    <entry><literal>vnf_mgmt_br</literal></entry>
                  </row>

                  <row>
                    <entry>ovs-bridge-type</entry>

                    <entry>vnfMgmt</entry>
                  </row>

                  <row>
                    <entry>vnf-mgmt-address</entry>

                    <entry>10.0.0.1</entry>
                  </row>

                  <row>
                    <entry>Create</entry>

                    <entry></entry>
                  </row>
                </tbody>
              </tgroup>
            </table>

            <table>
              <title>lan_br Bridge Details</title>

              <tgroup cols="2">
                <colspec align="left" />

                <colspec colwidth="2*" />

                <colspec colwidth="5*" />

                <thead>
                  <row>
                    <entry align="center">Field</entry>

                    <entry align="center">Value</entry>
                  </row>
                </thead>

                <tbody>
                  <row condition="hidden">
                    <entry>id</entry>

                    <entry>&lt;autogenerated - do not change&gt;</entry>
                  </row>

                  <row>
                    <entry>Name</entry>

                    <entry><literal>lan_br</literal></entry>
                  </row>

                  <row>
                    <entry>ovs-bridge-type</entry>

                    <entry>dataPlane</entry>
                  </row>

                  <row>
                    <entry>sub-type</entry>

                    <entry>communication</entry>
                  </row>

                  <row>
                    <entry>+</entry>

                    <entry>Name: enp4s0f1 OK</entry>
                  </row>

                  <row>
                    <entry>Create</entry>

                    <entry></entry>
                  </row>
                </tbody>
              </tgroup>
            </table>

            <para>Add the Host Interface by selecting the
            <literal>me1100</literal> device, then <literal>Configuration
            -&gt; External Interface -&gt; Configuration -&gt; Add</literal>.
            Fill in the required fields with the following data:</para>

            <table>
              <title>Host Interface Details</title>

              <tgroup cols="2">
                <colspec align="left" />

                <colspec colwidth="2*" />

                <colspec colwidth="5*" />

                <thead>
                  <row>
                    <entry align="center">Field</entry>

                    <entry align="center">Value</entry>
                  </row>
                </thead>

                <tbody>
                  <row>
                    <entry>Source</entry>

                    <entry><literal>enp4s0f1</literal>. The only interface
                    available for LAN connection.</entry>
                  </row>

                  <row>
                    <entry>type</entry>

                    <entry>dpdk</entry>
                  </row>

                  <row>
                    <entry>networking-type</entry>

                    <entry>dpdk</entry>
                  </row>

                  <row>
                    <entry>dpdk-type</entry>

                    <entry>vfio-pci</entry>
                  </row>

                  <row>
                    <entry>Create</entry>

                    <entry>&lt;interface enp4s0f1 ready to be used in a LAN
                    bridge.&gt;</entry>
                  </row>
                </tbody>
              </tgroup>
            </table>
          </listitem>
        </orderedlist></para>

      <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>

      <para>Onboard the VM Image through <literal>VNF -&gt; Descriptors -&gt;
      On-board -&gt; VM Image</literal>, and fill in the required fields with
      the following values:</para>

      <table>
        <title>VM Image Details</title>

        <tgroup cols="2">
          <colspec align="left" />

          <colspec colwidth="2*" />

          <colspec colwidth="5*" />

          <thead>
            <row>
              <entry align="center">Field</entry>

              <entry align="center">Value</entry>
            </row>
          </thead>

          <tbody>
            <row>
              <entry>VM image file</entry>

              <entry><literal>centos_128t_with_ci.qcow2</literal></entry>
            </row>

            <row>
              <entry>Image format</entry>

              <entry>QCOW2</entry>
            </row>

            <row>
              <entry>VNF Type Name</entry>

              <entry>128T</entry>
            </row>

            <row>
              <entry>Description</entry>

              <entry>128T Router</entry>
            </row>

            <row>
              <entry>Version</entry>

              <entry>1.0</entry>
            </row>

            <row>
              <entry>Memory in MB</entry>

              <entry>8192. More memory can be allocated if required
              (&lt;28672).</entry>
            </row>

            <row>
              <entry>Num. of CPUs</entry>

              <entry>2. More CPUs can be reserved if required
              (&lt;15).</entry>
            </row>

            <row>
              <entry>Interfaces -&gt; +</entry>

              <entry>Name: mgmt</entry>
            </row>

            <row>
              <entry>Interfaces -&gt; +</entry>

              <entry>Name: wan</entry>
            </row>

            <row>
              <entry>Interfaces -&gt; +</entry>

              <entry>Name: lan</entry>
            </row>

            <row>
              <entry>Cloud Init -&gt; Cloud-Init Datasource</entry>

              <entry>ISO</entry>
            </row>

            <row>
              <entry>Cloud Init -&gt; Cloud-Init Disk Type</entry>

              <entry>cdrom</entry>
            </row>

            <row>
              <entry>Properties -&gt; +</entry>

              <entry>Name: vnfMgmtIpAddress. Value: 10.0.0.2</entry>
            </row>

            <row>
              <entry>Properties -&gt; +</entry>

              <entry>Name: internalMgmtPort. Value: 443</entry>
            </row>

            <row>
              <entry>Properties -&gt; +</entry>

              <entry>Name: externalMgmtPort. Value: 60001</entry>
            </row>

            <row>
              <entry>Onboard</entry>

              <entry>&lt;Wait for message: VNF package onboarded
              successfully&gt;</entry>
            </row>

            <row>
              <entry>Close</entry>

              <entry></entry>
            </row>
          </tbody>
        </tgroup>
      </table>

      <note>
        <itemizedlist>
          <listitem>
            <para>HTTPS access (443) can be changed with another type of
            access. Please consult official 128T documentation and make sure
            the 128T VNF is configured to accept another type of connection
            before changing the port number.</para>
          </listitem>

          <listitem>
            <para><literal>externalMgmtPort</literal> (60001) represents the
            external port on which the user can access the VNF management
            interface via HTTPS. Another port can be selected if needed. There
            are no other changes required or components affected by this
            change.</para>
          </listitem>

          <listitem>
            <para><literal>vnfMgmtIpAddress</literal> (10.0.0.2) represents
            the IP address of the management interface of the 128T VNF.
            Changing this value requires an update to the 128T configuration
            to match the new IP address.</para>
          </listitem>
        </itemizedlist>
      </note>

      <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para>

      <para>Instantiate the 128T VNF by selecting the me1100 device, then
      <literal>VNF -&gt; Instances -&gt; Add</literal>.</para>

      <para>Fill in the required fields with the following values:</para>

      <table>
        <title>128T VNF Instantiation</title>

        <tgroup cols="2">
          <colspec align="left" />

          <colspec colwidth="2*" />

          <colspec colwidth="5*" />

          <thead>
            <row>
              <entry align="center">Field</entry>

              <entry align="center">Value</entry>
            </row>
          </thead>

          <tbody>
            <row>
              <entry>Name</entry>

              <entry>128T_me1100_1</entry>
            </row>

            <row>
              <entry>VNF Type</entry>

              <entry>128T</entry>
            </row>

            <row>
              <entry>VNFD Version</entry>

              <entry>1.0</entry>
            </row>

            <row>
              <entry>Flavour</entry>

              <entry>Canonical</entry>
            </row>

            <row>
              <entry>uCPE Device</entry>

              <entry>me1100</entry>
            </row>

            <row>
              <entry>Cloud Init File</entry>

              <entry><literal>centos_128t_internet_ci.iso</literal></entry>
            </row>

            <row>
              <entry>Domain Update Script</entry>

              <entry></entry>
            </row>

            <row>
              <entry>Interfaces</entry>

              <entry></entry>
            </row>

            <row>
              <entry>ID</entry>

              <entry>IF Name</entry>
            </row>

            <row>
              <entry>mgmt (dpdk)</entry>

              <entry>Bridge: vnf_mgmt_br</entry>
            </row>

            <row>
              <entry>wan (dpdk)</entry>

              <entry>Bridge: ibm_br</entry>
            </row>

            <row>
              <entry>lan (dpdk)</entry>

              <entry>Bridge: lan_br</entry>
            </row>

            <row>
              <entry>Create</entry>

              <entry></entry>
            </row>
          </tbody>
        </tgroup>
      </table>
    </section>

    <section id="uc_test_cmc_router">
      <title>Testing the Use-case</title>

      <para>In order to access the web interface of the 128T VNF, open a
      browser from a machine connected on the same network with the WAN port
      of the me1100 uCPE device and browse to:
      <literal>https://&lt;public_me1100_WAN_IP&gt;:60001</literal>. Log in
      using the following credentials:</para>

      <itemizedlist>
        <listitem>
          <para>Username: admin</para>
        </listitem>

        <listitem>
          <para>Password: 128Tadmin</para>
        </listitem>
      </itemizedlist>

      <para>In order to validate the data path, connect a test machine to the
      LAN physical port, assign the static IP and a route:<programlisting>&gt; ifconfig eth3 192.168.64.2 netmask 255.255.255.0
&gt; ip route add default via 192.168.64.1  dev eth3
&gt; ping 8.8.8.8</programlisting>For data path validation, it may be required
      to generate a new cloud-init image to match your network configuration.
      Please check Appendix A: How to create 128T cloud-init iso image (day-0
      configuration), for more details.</para>
    </section>

    <section id="cleanup_cmcone">
      <title>Use-case Clean-up</title>

      <para>In order to remove the setup created previously all components
      need to be deleted in reverse order:</para>

      <orderedlist>
        <listitem>
          <para>Select the me1100 uCPE device -&gt; VNF -&gt; Instances -&gt;
          128T -&gt; Delete.</para>
        </listitem>

        <listitem>
          <para>Select the me1100 uCPE device -&gt; Configuration -&gt;
          OpenVSwitch -&gt; Bridges. Select all bridges -&gt; Delete.</para>
        </listitem>

        <listitem>
          <para>Select the me1100 uCPE device -&gt; Configuration -&gt;
          OpenVSwitch -&gt; Host Interfaces. Select all interfaces -&gt;
          Delete.</para>
        </listitem>

        <listitem>
          <para>VNF -&gt; Descriptors, select all bundles -&gt;
          Offboard.</para>
        </listitem>
      </orderedlist>
    </section>
  </section>
</chapter>