summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml
blob: 2f430c3dfc8c67d00721168eca78328868fe5e57 (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
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="getting_started">
  <title>Getting Started with the Automation Framework and Test
  Harness</title>

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

    <para>For installation of the Automation Framework and Test Harness a
    CentOS 7 host machine is needed with support for:</para>

    <itemizedlist>
      <listitem>
        <para>Python 2.7.</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><literal>Virtualenv</literal> tool: <programlisting>sudo pip install virtualenv</programlisting></para>
      </listitem>
    </itemizedlist>

    <note>
      <para>The Automation Framework and Test Harness installation may be done
      on the same machine used for uCPE Manager installation, although this is
      not encouraged. For more details see <link linkend="automation">chapter
      3.2</link>.<remark>what chapter of what book is this link refering
      to?</remark></para>
    </note>
  </section>

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

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

        <mediaobject>
          <imageobject>
            <imagedata align="center"
                       fileref="images/environment_basicsetup.png" scale="35" />
          </imageobject>
        </mediaobject>
      </figure>The following enviroment setup is needed for running all tests
    defined in the Enea NFV Access System Test Specification manual:</para>

    <remark>olink to the book needed here.</remark>

    <para><emphasis role="bold">Lab Network
    Requirements</emphasis><itemizedlist spacing="compact">
        <listitem>
          <para>DHCP enabled.</para>
        </listitem>

        <listitem>
          <para>Internet Connectivity.</para>
        </listitem>
      </itemizedlist></para>

    <para><emphasis role="bold">uCPE Manager Host
    Requirements</emphasis></para>

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

      <listitem>
        <para>Connected to the Lab Network.</para>
      </listitem>

      <listitem>
        <para>uCPE Manager installed.</para>

        <note>
          <para>For details on how to install the uCPE Manager, see <olink
          targetdoc="book_enea_nfv_access_getting_started"
          targetptr="install_ucpe_manager">Install the Enea uCPE Manager in
          <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
          xmlns:xi="http://www.w3.org/2001/XInclude"
          xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>.</para>
        </note>
      </listitem>
    </itemizedlist>

    <para><emphasis role="bold">uCPE device
    Requirements</emphasis><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 NFV Access Run-Time Platform installed.</para>

          <note>
            <para>For information on how to install Enea NFV Access refer to
            <olink targetdoc="book_enea_nfv_access_getting_started"
            targetptr="plat-release-content">Getting Started with Enea NFV
            Access in <xi:include
            href="../../s_docbuild/olinkdb/pardoc-names.xml"
            xmlns:xi="http://www.w3.org/2001/XInclude"
            xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>.</para>
          </note>
        </listitem>
      </itemizedlist><figure>
        <title>Lab Setup Overview for ChainedVNFsService</title>

        <mediaobject>
          <imageobject>
            <imagedata align="center"
                       fileref="images/ChainedVNFsService_setup.png"
                       scale="40" />
          </imageobject>
        </mediaobject>
      </figure></para>

    <para><emphasis role="bold">uCPE device 1 and 2
    Requirements</emphasis><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 NFV Access Run-Time Platform installed.</para>
        </listitem>
      </itemizedlist></para>
  </section>

  <section id="initial_setup">
    <title>Installation and Initial Setup</title>

    <orderedlist>
      <listitem>
        <para>Unzip the <filename>nfvaccess&lt;version&gt;_af-th.zip</filename> archive
        file, provided by Enea, on a supported host machine.</para>

        <para>The directory in which the archive has been unpacked will be
        denoted as <literal>&lt;AF-TH-installdir&gt;</literal>.</para>
      </listitem>

      <listitem>
        <para>Enter the <literal>&lt;AF-TH-install-dir&gt;</literal> directory
        and run the <filename>setup_env.sh</filename> script to do the initial
        setup of the Test Harness environment: <programlisting>source setup_env.sh</programlisting></para>
      </listitem>

      <listitem>
        <para>Set up the uCPE Manager which will be used by the TH:</para>

        <orderedlist spacing="compact">
          <listitem>
            <para>Create the uCPE Manager JSON config file in the
            <literal>&lt;AF-TH-install-dir&gt;/uCPEM_config/</literal>
            directory:<programlisting>{
"ucpe_usr":"uCPE Manager Username",
"ucpe_pass":"uCPE Manager Password",
"ucpe_host":"uCPE Manager IP/Hostname",
"ftp_usr":"FTP Username",
"ftp_pass":"FTP Password",
"ftp_port":"FTP Port"
}</programlisting>See the
            <filename>&lt;AF-TH-install-dir&gt;/uCPEM_config/ucpem01.json</filename>
            file as an example.</para>
          </listitem>

          <listitem>
            <para>Run the <filename>setupuCPEManager.yml</filename> Ansible
            Playbook with the JSON config path as a parameter:
            <programlisting>ansible-playbook playbooks/setupuCPEManager.yml -e\
"@uCPEM_config/&lt;config_name&gt;.json"</programlisting></para>

            <para><emphasis role="bold">Example</emphasis> <programlisting>ansible-playbook playbooks/setupuCPEManager.yml -e\
"@uCPEM_config/ucpem01.json"</programlisting></para>
          </listitem>
        </orderedlist>
      </listitem>
    </orderedlist>

    <note>
      <para>The steps presented in this section are to be executed only once,
      for the initial setup of the TH environment.</para>
    </note>

    <para>After the initial setup, each session ends by closing the Python
    virtual environment through running <literal>deactivate</literal>
    from the <literal>&lt;AF-THinstall-dir&gt;</literal> directory.</para>

    <para>Subsequent use of the installation requires activating the Python
    virtual enviroment before using the Automation Framework and Test Harness:
    <literal>source
    &lt;AF-THinstall-dir&gt;/testHarness/bin/activate</literal>.</para>

    <para>Furthermore, if a user wants to use a new uCPE Manager instance for
    a new session, the user also has to re-run the
    <filename>setupuCPEManager.yml</filename> playbook with the corresponding
    JSON config for the new uCPE Manager instance.</para>
  </section>
</chapter>