summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml
blob: 9ac6829c7826faf5ebc913b21528658031cd93c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="getting_started">
  <title>Getting Started with the Enea Edge Automation</title>

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

    <para>There are two scenarios for the setup:</para>

    <itemizedlist spacing="compact">
      <listitem>
        <para>Basic Setup<figure>
            <title>Lab setup overview for Basic Setup</title>

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

      <listitem>
        <para>Chained VNFs Service <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></para>
      </listitem>
    </itemizedlist>

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

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

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

      <listitem>
        <para>Enea Edge Management Host Requirements<itemizedlist spacing="compact">
            <listitem>
              <para>CentOS 7 installed</para>
            </listitem>

            <listitem>
              <para>Connection to the Lab Network</para>
            </listitem>

            <listitem>
              <para>Enea Edge Management installed. For details, see <olink
              targetdoc="book_enea_edge_getting_started"
              targetptr="install_ucpe_mg">Installing the Enea Edge Management 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></para>
      </listitem>

      <listitem>
        <para>uCPE device Requirements for Basic Setup<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></para>
      </listitem>

      <listitem>
        <para>uCPE device 1 and 2 Requirements for Chained VNFs
        Service<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></para>
      </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<programlisting>sudo yum install epel-release</programlisting></para>
      </listitem>

      <listitem>
        <para>PIP package manager<programlisting>sudo yum -y install python-pip</programlisting></para>
      </listitem>

      <listitem>
        <para>Virtualenv tool<programlisting>sudo pip install virtualenv</programlisting></para>
      </listitem>
    </itemizedlist>

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

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

    <para id="install_procedure"><emphasis role="bold">To install the
    Enea Edge Automation</emphasis><orderedlist>
        <listitem>
          <para>Log on the host machine</para>
        </listitem>

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

        <listitem>
          <para>Extract the archive file<programlisting>unzip Enea_Edge_Automation_&lt;version&gt;-build&lt;build_number&gt;.zip</programlisting></para>
        </listitem>

        <listitem>
          <para>Run the <filename>setup_env.sh</filename><programlisting>source setup_env.sh</programlisting></para>
        </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>

    <para><emphasis role="bold">To setup the enviroment for the Enea Edge Automation</emphasis><orderedlist>
        <listitem>
          <para>Activate the Python virtual enviroment</para>

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

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

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

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

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

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

    <para><emphasis role="bold">To upgrade the Enea Edge Automation</emphasis><orderedlist>
        <listitem>
          <para>Log on the host machine</para>
        </listitem>

        <listitem>
          <para><programlisting>cd &lt;AF-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<programlisting>unzip Enea_Edge_Automation_&lt;version&gt;-build&lt;build_number&gt;.zip</programlisting></para>
        </listitem>

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

        <listitem>
          <para>Run the <filename>setup_env.sh</filename><programlisting>source setup_env.sh</programlisting></para>
        </listitem>
      </orderedlist></para>
  </section>
</chapter>