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