summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-edge-automation-user-guide/doc/overview.xml
blob: 78e5e82ee965ec7a970acb1c429ef63e24866231 (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
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="overview">
  <title>Overview</title>

  <para>This document describes the Enea Edge Automation for Enea Edge, along
  with instructions regarding the necessary steps to run these software
  tools.</para>

  <section id="descrip">
    <title>Description</title>

    <para>The Enea Edge Automation complements the Enea Edge Management GUI
    and uses the northbound REST APIs, given to provide full usability of the
    Enea Edge Management features.</para>

    <para>The Enea Edge Automation includes an Automation Framework (AF)
    component, providing a way for driving configuration with Python
    scripting, and a Test Harness (TH) component, based on Ansible Playbooks
    to complete different test cases.</para>

    <para>The Test Harness makes use of the Automation Framework Python
    modules and/or direct commands on the uCPE devices running the Enea Edge
    Runtime.</para>
  </section>

  <section id="def_acro">
    <title>Definitions and Acronyms</title>

    <table>
      <title>Definitions</title>

      <tgroup cols="2">
        <colspec align="left" />

        <thead>
          <row>
            <entry align="center">Component</entry>

            <entry align="center">Description</entry>
          </row>
        </thead>

        <tbody>
          <row>
            <entry>Enea Edge</entry>

            <entry>Enea NFVI software platform.</entry>
          </row>

          <row>
            <entry>Enea Edge Runtime</entry>

            <entry>A lightweight, multi-architecture virtualization platform,
            supporting Virtual Machines.</entry>
          </row>

          <row>
            <entry>Enea Edge Management</entry>

            <entry>Enea Universal Customer Premises Equipment Manager.</entry>
          </row>

          <row>
            <entry>Enea Edge Automation</entry>

            <entry>Enea Edge framework for automated deployment and
            testing.</entry>
          </row>
        </tbody>
      </tgroup>
    </table>

    <table>
      <title>Acronyms</title>

      <tgroup cols="2">
        <colspec align="left" />

        <thead>
          <row>
            <entry align="center">Component</entry>

            <entry align="center">Description</entry>
          </row>
        </thead>

        <tbody>
          <row>
            <entry>AF</entry>

            <entry>Automation Framework.</entry>
          </row>

          <row>
            <entry>API</entry>

            <entry>Application Programming Interface.</entry>
          </row>

          <row>
            <entry>DHCP</entry>

            <entry>Dynamic Host Configuration Protocol.</entry>
          </row>

          <row>
            <entry>DPDK</entry>

            <entry>Data Plane Development Kit.</entry>
          </row>

          <row>
            <entry>FQDN </entry>

            <entry>Fully Qualified Domain Name.</entry>
          </row>

          <row>
            <entry>FTP</entry>

            <entry>File Transfer Protocol.</entry>
          </row>

          <row>
            <entry>GUI</entry>

            <entry>Graphical User Interface.</entry>
          </row>

          <row>
            <entry>IP</entry>

            <entry>Internet Protocol.</entry>
          </row>

          <row>
            <entry>JSON</entry>

            <entry>JavaScript Object Notation.</entry>
          </row>

          <row>
            <entry>NIC</entry>

            <entry>Network Interface Card.</entry>
          </row>

          <row>
            <entry>NETCONF</entry>

            <entry>Network Configuration Protocol.</entry>
          </row>

          <row>
            <entry>NFV</entry>

            <entry>Network Functions Virtualization.</entry>
          </row>

          <row>
            <entry>OVS</entry>

            <entry>Open vSwitch.</entry>
          </row>

          <row>
            <entry>REST</entry>

            <entry>Representational State Transfer.</entry>
          </row>

          <row>
            <entry>SR-IOV</entry>

            <entry>Single Root Input/Output Virtualization.</entry>
          </row>

          <row>
            <entry>SSH</entry>

            <entry>Secure Shell.</entry>
          </row>

          <row>
            <entry>TH</entry>

            <entry>Test Harness.</entry>
          </row>

          <row>
            <entry>VCPE</entry>

            <entry>Virtual Customer Premises Equipment.</entry>
          </row>

          <row>
            <entry>VNF</entry>

            <entry>Virtualized Network Function.</entry>
          </row>
        </tbody>
      </tgroup>
    </table>
  </section>
</chapter>