path: root/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml

<?xml version="1.0" encoding="UTF-8"?>
<chapter id="getting_started">
  <title>Getting Started with Enea Edge Automation</title>

  <section id="envrion">
    <title>Environment</title>

    <para>There are two scenarios for a proper setup:</para>

    <itemizedlist spacing="compact">
      <listitem>
        <para>Basic Setup</para>

        <figure>
          <title>Lab setup overview for Basic Setup</title>

          <mediaobject>
            <imageobject>
              <imagedata align="center" contentwidth="600"
                         fileref="images/environment_basicsetup.png" />
            </imageobject>
          </mediaobject>
        </figure>
      </listitem>

      <listitem>
        <para>Chained VNFs Service</para>

        <figure>
          <title>Lab Setup Overview for Chained VNFs Service</title>

          <mediaobject>
            <imageobject>
              <imagedata align="center" contentwidth="600"
                         fileref="images/ChainedVNFsService_setup.png" />
            </imageobject>
          </mediaobject>
        </figure>
      </listitem>
    </itemizedlist>

    <para>The following environment setup is needed for running the Enea Edge
    Automation tests:</para>

    <itemizedlist>
      <listitem>
        <para>Lab Network Requirements:</para>

        <itemizedlist spacing="compact">
          <listitem>
            <para>DHCP enabled</para>
          </listitem>

          <listitem>
            <para>Internet connectivity</para>
          </listitem>
        </itemizedlist>
      </listitem>

      <listitem>
        <para>Enea Edge Management Host Requirements:</para>

        <itemizedlist spacing="compact">
          <listitem>
            <para>CentOS 7 installed</para>
          </listitem>

          <listitem>
            <para>A connection to the Lab Network</para>
          </listitem>

          <listitem>
            <para>The Enea Edge Management application installed. For details,
            see <olink targetdoc="book_enea_edge_getting_started"
            targetptr="install_ucpe_mg">Installing the Enea Edge Management
            application in the <xi:include
            href="../../s_docbuild/olinkdb/pardoc-names.xml"
            xmlns:xi="http://www.w3.org/2001/XInclude"
            xpointer="element(book_enea_edge_getting_started/1)" /></olink>
            Manual.</para>
          </listitem>
        </itemizedlist>
      </listitem>

      <listitem>
        <para>uCPE device Requirements for Basic Setup:</para>

        <itemizedlist spacing="compact">
          <listitem>
            <para>Minimum of 4 Physical Network Devices</para>
          </listitem>

          <listitem>
            <para>4GB RAM and 4 cores (Intel C3000 or Xeon D)</para>
          </listitem>

          <listitem>
            <para>2 Physical connections to the Lab Network</para>
          </listitem>

          <listitem>
            <para>Enea Edge Runtime installed. For more details, see <olink
            targetdoc="book_enea_edge_getting_started"
            targetptr="prep_usb_ena">Preparing the USB stick for installation
            of the Enea Edge Runtime in the <xi:include
            href="../../s_docbuild/olinkdb/pardoc-names.xml"
            xmlns:xi="http://www.w3.org/2001/XInclude"
            xpointer="element(book_enea_edge_getting_started/1)" /></olink>
            Manual.</para>
          </listitem>
        </itemizedlist>
      </listitem>

      <listitem>
        <para>uCPE device 1 and 2 Requirements for Chained VNFs
        Service:</para>

        <itemizedlist spacing="compact">
          <listitem>
            <para>Minimum of 4 Physical Network Devices</para>
          </listitem>

          <listitem>
            <para>16GB RAM and 8 cores (Intel C3000 or Xeon D)</para>
          </listitem>

          <listitem>
            <para>2 Physical connections to the Lab Network</para>
          </listitem>

          <listitem>
            <para>1 Physical connection back to back between both uCPE
            devices</para>
          </listitem>

          <listitem>
            <para>Enea Edge Runtime installed</para>
          </listitem>
        </itemizedlist>
      </listitem>
    </itemizedlist>
  </section>

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

    <para>For the installation of the Enea Edge Automation a CentOS 7 host
    machine is needed with support for:</para>

    <itemizedlist>
      <listitem>
        <para>Python 3.6.8</para>
      </listitem>

      <listitem>
        <para>EPEL Repository</para>

        <programlisting>sudo yum install epel-release</programlisting>
      </listitem>

      <listitem>
        <para>PIP package manager</para>

        <programlisting>sudo yum -y install python-pip</programlisting>
      </listitem>

      <listitem>
        <para>Virtualenv tool</para>

        <programlisting>sudo pip install virtualenv</programlisting>
      </listitem>
    </itemizedlist>

    <note>
      <para>It is recommended to install Enea Edge Automation and the Enea
      Edge Management application on different machines.</para>
    </note>
  </section>

  <section id="initial_setup">
    <title>Installing the Enea Edge Automation</title>

    <para id="install_procedure"><emphasis role="bold">Installing the Enea
    Edge Automation</emphasis></para>

    <orderedlist>
      <listitem>
        <para>Log into the host machine</para>
      </listitem>

      <listitem>
        <para><programlisting>cd &lt;Automation-installdir&gt;</programlisting></para>
      </listitem>

      <listitem>
        <para>Extract the archive file</para>

        <programlisting>unzip Enea_Edge_Automation_&lt;version&gt;-build&lt;build_number&gt;.zip</programlisting>
      </listitem>

      <listitem>
        <para>Run the setup of virtual environment script:</para>

        <programlisting>source setup_env.sh</programlisting>
      </listitem>

      <listitem>
        <para>Configure the system. For more details, see <xref
        linkend="AFTH_cofig" />.</para>
      </listitem>
    </orderedlist>

    <note>
      <para>The steps are executed only once, for the initial setup of the
      environment.</para>
    </note>

    <para><emphasis role="bold">Setting up the environment for the Enea Edge
    Automation</emphasis></para>

    <orderedlist>
      <listitem>
        <para>Activate the Python virtual environment</para>

        <programlisting>source &lt;Automation-installdir&gt;/testHarness-venv/bin/activate</programlisting>
      </listitem>

      <listitem>
        <para>Optionally, check the History Information</para>

        <programlisting>vi &lt;Automation-installdir&gt;/CHANGELOG</programlisting>
      </listitem>

      <listitem>
        <para>Close the Python virtual environment</para>

        <programlisting>deactivate</programlisting>
      </listitem>
    </orderedlist>
  </section>

  <section id="upgrade_AF">
    <title>Upgrading the Enea Edge Automation</title>

    <para><emphasis role="bold">Upgrading the Enea Edge
    Automation</emphasis></para>

    <orderedlist>
      <listitem>
        <para>Log into the host machine</para>
      </listitem>

      <listitem>
        <para><programlisting>cd &lt;Automation-installdir&gt;</programlisting></para>
      </listitem>

      <listitem>
        <para>Back up the configuration files from
        <literal>modules/enea/config</literal>.</para>
      </listitem>

      <listitem>
        <para>Extract the archive file:</para>

        <programlisting>unzip Enea_Edge_Automation_&lt;version&gt;-build&lt;build_number&gt;.zip</programlisting>
      </listitem>

      <listitem>
        <para>Restore the configuration files from step 2 into
        <literal>modules/enea/config </literal>.</para>
      </listitem>

      <listitem>
        <para>Run the setup of virtual environment script:</para>

        <programlisting>source setup_env.sh</programlisting>
      </listitem>
    </orderedlist>
  </section>
</chapter>