summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-example-usecases/doc/appendix_4.xml
blob: 9fe1b2b1615290a9fd40399cd9825c2eacebd6cf (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
<?xml version="1.0" encoding="ISO-8859-1"?>
<appendix id="appendix_four_cust">
  <title>Running Enea Automation Framework tests</title>

  <para>For more detailed information regarding the Automation Framework and
  Test Harness please see the <xi:include
  href="../../s_docbuild/olinkdb/pardoc-common.xml"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" />.</para>

  <para>The most relevant information from the Automation Framework and Test
  Harness structure is presented below:</para>

  <programlisting>|---automation_framework
|  |---unittestSuite
|  |  |---128tCleanup.json             - Use case 1 - clean up - test.
|  |  |---128tDeploy.json              - Use case 1 - test.
|  |  |---128t_FG_SFCCleanup.json      - Use case 2 - clean up - test.
|  |  |---128t_FG_SFCDeploy.json       - Use case 2 - test.
|  |  |---config
|  |  |  |---cust  
            - Folder containing the configuration files used by tests.
|  |  |---unittestLoader.py
|  |  |---unittestSuite.py
|---lab_config
|  |---trgt-1 
|  |  |---ibm_br.json                  - In-band management definition.
|  |  |---lan_br.json                  - Lan bridge definition.
|  |  |---target.json      
            - Target definition - the "address", "deviceId", "name" and \
              "version" must be updated.
|  |  |---sfc_br.json                  - Service chain bridge definition.
|  |  |---vnf_mgmt_br.json             - VNF management bridge definition.
|  |  |---lan_nic.json                 - NIC definition.
|---vnf_config
|  |---128t
|  |  |---128tInstance.json            - 128T instantiation - used in use case 1.
|  |  |---128t.json                    - 128T onboarding.
|  |  |---128tSFCInstance.json         - 128T instantiation - used in use case 2.
|  |  |---centos_128t_internet_ci.iso  - 128T cloud init (day-0) iso image.
|  |---fortigate
|  |  |---fg_basic_fw.conf             - Fortigate day-0 configuration.
|  |  |---fortigateInstance.json       - Fortigate instantiantion.
|  |  |---fortigate.json               - Fortigate onboarding.
|  |  |---fortigateLicense.lic
            - Fortigate license - contact Fortinet to get a VNF image and license file.
|---vnf_image
|  |---centos_128t_with_ci.qcow2       - Contact 128 Technology to get a \
                                         VNF image and its license file.
|  |---fortios.qcow2                   - Contact Fortinet to get a VNF image \
                                         and its license file.</programlisting>

  <para>Make sure to update the relevant configuration file for your setup.
  The essential files to consider are the uCPE Device configuration
  (<filename>target.json</filename>), the license for the Fortigate VNF, and
  the 128T cloud-init iso image matching your network.</para>

  <para>For uCPE Device configuration (<filename>target.json</filename>)
  please change the following information, if needed, in the JSON file:</para>

  <itemizedlist spacing="compact">
    <listitem>
      <para><literal>address</literal> - The IP address of uCPE Device.</para>
    </listitem>

    <listitem>
      <para><literal>version</literal> - The NFVA version.</para>
    </listitem>

    <listitem>
      <para><literal>deviceId</literal> - The device ID of uCPE Device.</para>
    </listitem>

    <listitem>
      <para><literal>name</literal> - The name of uCPE Device.</para>
    </listitem>
  </itemizedlist>

  <note>
    <para>Before starting the two usecases detailed in the following appendix,
    the uCPE Device needs to be added into the uCPE Manager.</para>
  </note>

  <para>To run a test:</para>

  <programlisting>&gt; cd automation_framework/unittestSuite/
&gt; python unittestSuite.py -u admin -p admin -H &lt;uCPEManager IP address&gt; -n \
&lt;uCPE Device name&gt; -s &lt;Test suite&gt; -d &lt;description&gt;</programlisting>

  <para>The <literal>Test suite</literal> must be one from any of the
  following: <filename>128tDeploy.json</filename>,
  <filename>128tCleanup.json</filename>,
  <filename>128t_FG_SFCDeploy.json</filename>, or
  <filename>128t_FG_SFCCleanup.json</filename>.</para>
</appendix>