summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml
blob: 1de84541b7d9bb512dac7ccb0fb49380841e01be (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
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="components">
  <title>Components</title>

  <para>An overview of the Enea NFV Access Run Time Platform and the uCPE
  Manager in cooperation with the Automation Framework and Test Harness, will
  be presented in detail.</para>

  <figure>
    <title>Component Overview</title>

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

  <section id="enfva_runtime_plt">
    <title>Enea NFV Access</title>

    <para>Enea NFV Access is comprised of the Enea uCPE Manager and the Enea
    NFV Access Run Time Platform.</para>

    <section id="eucpe_manager">
      <title>Enea uCPE Manager</title>

      <para>The Enea uCPE Manager application needs to be installed on a
      supported platform. Upon installation, the system will be set up to
      manage Enea NFV Access "devices", these are the virtualized CPE devices
      used in testing.</para>

      <para>For more on Enea uCPE Manager installation instructions, please
      refer to the section on how to <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>
    </section>

    <section id="ena_plat">
      <title>Enea NFV Access Run Time Platform</title>

      <para>One or more uCPE devices running the Enea NFV Access Run Time
      Platform are required as hosts to run the VNF(s). The uCPE device is
      known to the uCPE Manager as the "VcpeAgent" device module.</para>
      
      <note><para>Before running any use case with the Automation Framework or 
        the Test Harness, make sure the uCPE device(s) have been added to 
        the uCPE Manager, as needed.</para></note>

      <para>Adding a VcpeAgent device can be done via two methods:</para>

      <itemizedlist>
        <listitem>
          <para>Through the uCPE Manager GUI. Add the device using the
          appropriate parameters by launching the UI under
          <literal>Devices</literal> -&gt; <literal>Manage</literal> in the
          main screen.</para>
        </listitem>

        <listitem>
          <para>REST API. Invoke the uCPE Manager REST API to add a
          device.</para>
        </listitem>
      </itemizedlist>

      <para>For more on Enea NFV Access installation instructions, please
      refer to chapter <olink targetdoc="book_enea_nfv_access_getting_started"
      targetptr="access_installer">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>
    </section>
  </section>

  <section id="automation">
    <title>Automation Framework</title>

    <para>Testing can be performed by running the available Python scripts
    against the uCPE Manager REST API (Python samples supplied). This can be
    done by using the Python scripts individually or by using the Python
    unit-test suite that is able to automatically run test-cases defined for
    each available Python script.</para>

    <para>In either case, it is desirable to use a different host (instead of
    running the tests on the same system as the uCPE Manager) in order to
    ensure that the uCPE Manager is setup and installed correctly in terms of
    allowing external users to access it and use it effectively.</para>
  </section>

  <section id="harness">
    <title>Test Harness</title>

    <para>The Test Harness (TH) provides a way for driving configuration with
    Ansible Playbooks, by running the python modules from the Automation
    Framework (AF) and by direct connection over SSH to the boards that run
    Enea NFV Access.</para>

    <para>The Test Harness includes an automated test suite that
    contains:</para>

    <itemizedlist>
      <listitem>
        <para>VNF, Device and Network Smoke Test Cases. A sample test suite
        that acts as basic smoke tests for Enea NFV Access and also as a
        sanity-check test suite for the AF and TH.</para>
      </listitem>

      <listitem>
        <para>VNF Deployment and Lifecycle. A sample test suite that verifies
        the instantiation, lifecycle control and destruction of a VNF for Enea
        NFV Access.</para>
      </listitem>

      <listitem>
        <para>Service Creation and Lifecycle. A sample test suite that
        contains complex test cases showcasing service creation and lifecycle
        management.</para>
      </listitem>
    </itemizedlist>

    <para>For details about the test suites or test cases please refer to
    chapter <olink targetdoc="book_enea_nfv_access_system_test_specification"
    targetptr="sample_testcases">Sample Test Cases 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>

    <remark>this olink needs to be fixed it points to getting started not the
    test spec manual, an olinkdb update is needed to know why.</remark>
  </section>
</chapter>