summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-edge-automation-user-guide/doc/components.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-edge-automation-user-guide/doc/components.xml')
-rw-r--r--doc/book-enea-edge-automation-user-guide/doc/components.xml116
1 files changed, 116 insertions, 0 deletions
diff --git a/doc/book-enea-edge-automation-user-guide/doc/components.xml b/doc/book-enea-edge-automation-user-guide/doc/components.xml
new file mode 100644
index 0000000..2323fdf
--- /dev/null
+++ b/doc/book-enea-edge-automation-user-guide/doc/components.xml
@@ -0,0 +1,116 @@
1<?xml version="1.0" encoding="UTF-8"?>
2<chapter id="components">
3 <title>Components</title>
4
5 <para>This chapter presents an overview of the Enea Edge components: Enea
6 Edge Runtime, Enea Edge Management and Enea Edge Automation.</para>
7
8 <figure>
9 <title>Component Overview</title>
10
11 <mediaobject>
12 <imageobject>
13 <imagedata align="center" contentwidth="600"
14 fileref="images/autofw_testh_overview.png" />
15 </imageobject>
16 </mediaobject>
17 </figure>
18
19 <section id="eucpe_manager">
20 <title>Enea Edge Management</title>
21
22 <para>The Enea Edge Management application is installed on a supported
23 platform. It manages Enea Edge <literal>devices</literal>, that are
24 virtualized CPE devices.</para>
25
26 <para>For more details about Enea Edge Management installation, see <olink
27 targetdoc="book_enea_edge_getting_started"
28 targetptr="install_ucpe_mg">Installing the Enea Edge Management
29 application in the <xi:include
30 href="../../s_docbuild/olinkdb/pardoc-names.xml"
31 xmlns:xi="http://www.w3.org/2001/XInclude"
32 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
33 Manual.</para>
34 </section>
35
36 <section id="ena_plat">
37 <title>Enea Edge Runtime</title>
38
39 <para>One or more uCPE devices running the Enea Edge Runtime are required
40 as hosts, to run the VNFs. The uCPE device is known to the Enea Edge
41 Management application as the <literal>VcpeAgent</literal> device
42 module.</para>
43
44 <para>Before running any use case with the Enea Edge Automation, the uCPE
45 devices have to be added to the Enea Edge Management application.</para>
46
47 <para>Adding a <literal>VcpeAgent</literal> device can be done:</para>
48
49 <itemizedlist>
50 <listitem>
51 <para>using the Enea Edge Management GUI</para>
52 </listitem>
53
54 <listitem>
55 <para>using REST API</para>
56 </listitem>
57 </itemizedlist>
58
59 <para>For more details about the Enea Edge Runtime installation, see
60 <olink targetdoc="book_enea_edge_getting_started"
61 targetptr="prep_usb_ena">Preparing the USB stick for installation of the
62 Edge Runtime in the <xi:include
63 href="../../s_docbuild/olinkdb/pardoc-names.xml"
64 xmlns:xi="http://www.w3.org/2001/XInclude"
65 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
66 Manual.</para>
67 </section>
68
69 <section id="automation">
70 <title>Enea Edge Automation</title>
71
72 <para>Enea Edge Automation has two components: Automation Framework and
73 Test Harness. It provides Python scripts using Enea Edge Management REST
74 API and Ansible Playbooks.</para>
75
76 <para>The Automation Framework component provides a Python unit-test suite
77 that runs automatically the test-cases defined for each Python
78 script.</para>
79
80 <para>It is recommended to use a different host for running the tests, in
81 order to allow external users to access and use the Enea Edge Management
82 application effectively.</para>
83
84 <para>The Test Harness component provides a way for driving configuration
85 with Ansible Playbooks, by running the Python modules from the Automation
86 Framework component and by direct connection over SSH to the boards that
87 run Enea Edge.</para>
88
89 <para>The Test Harness includes an automated test suite that
90 contains:</para>
91
92 <itemizedlist>
93 <listitem>
94 <para>VNF, Device and Network Smoke Test Cases. A sample test suite
95 that acts as basic smoke tests for Enea Edge and also as a
96 sanity-check test suite for the Enea Edge Automation.</para>
97 </listitem>
98
99 <listitem>
100 <para>VNF Deployment and Lifecycle. A sample test suite that verifies
101 the instantiation, lifecycle control and destruction of a VNF for Enea
102 Edge.</para>
103 </listitem>
104
105 <listitem>
106 <para>Service Creation and Lifecycle. A sample test suite that
107 contains complex test cases showcasing service creation and lifecycle
108 management.</para>
109 </listitem>
110 </itemizedlist>
111
112 <para>For more details about the test suites or test cases, see the README
113 file included in the test scenario folders from the Enea Edge Automation
114 archive.</para>
115 </section>
116</chapter> \ No newline at end of file