summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-edge-release-info/doc/about_release.xml
blob: 960f136e8dbfe4a71162da8262cc9f3fdf0c89ec (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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<chapter id="relinfo-about-release">
  <title>About This Release</title>

  <para>Enea Edge is a complete NFVI software platform designed for
  deployment on any white box uCPE device, and optimized for common use cases.
  Enea Edge includes both the Enea Edge Runtime deployed on a white box,
  and a management component with automation tools deployed in a private or
  public cloud.</para>

  <para>The Enea Edge <xi:include
  href="../../s_doceneacommon/doc/eltf_params_updated.xml"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(EneaLinux_REL_VER/1)" /> Release includes a new version of
  the major components as well as other features and optimizations, and
  documentation updates. A list of new features and improvements can be found
  in <xref linkend="relinfo-changes-other">Section 2.1 New Features and
  Improvements</xref>.</para>

  <section id="release-content">
    <title>Enea Edge Release Content</title>

    <para>The release content is detailed below:</para>

    <itemizedlist>
      <listitem>
        <para>Enea_Edge_Runtime_C3000_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
      </listitem>

      <listitem>
        <para>Enea_Edge_Runtime_XeonD_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
      </listitem>

      <listitem>
        <para>Enea_Edge_Automation_&lt;version&gt;-build&lt;build_number&gt;.zip</para>
      </listitem>

      <listitem>
        <para>Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
      </listitem>

      <listitem>
        <para>Enea_Edge_Telemetry_Deploy_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
      </listitem>

      <listitem>
        <para>VNF_example_configurations.tar.gz</para>
      </listitem>
      
      <listitem>
        <para>Enea_Edge_AF-TH_&lt;version&gt;-build&lt;build_number&gt;.zip 
          (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New Features and
  Improvements</xref>.)</para>
      </listitem>
    </itemizedlist>

    <programlisting condition="arm">-- documentation/
   /* Enea Edge documentation */
-- README
-- aarch64 /* architecture */
        -- cn8304/
           /* artifacts for the host side */
                -- deb/
                   /* deb packages */
                -- images/
                    -- enea-nfv-access
                       /* precompiled artifacts for the platform release image */
                        -- various artifacts (rootfs, kernel, config etc.)
                    -- enea-nfv-access-dev
                       /* precompiled artifacts for the development process. The image
                          contains userspace tools and kernel configurations necessary
                          for developing, debugging and profiling applications and
                          kernel modules */
                        -- various artifacts
        -- qemuarm64
           /* artifacts for the guest side */
                -- deb/
                   /* deb packages */
                -- images/
                    -- enea-nfv-access-guest
                       /* precompiled artifacts for the QEMU/Docker release image  */
                        -- various artifacts
                    -- enea-nfv-access-guest-dev
                       /* precompiled artifacts for the development process. The image
                          contains userspace tools and kernel configurations necessary
                          for developing, debugging and profiling applications and
                          kernel modules  */
                        -- various artifacts</programlisting>
  </section>

  <remark>INFO Below is a complete section with ID
  "eltf-target-tables-section" included from elft_params_updated.xml. It
  contains a variable number of target tables and the section title should be
  "Supported Targets with Parameters". It has have a short sentence about what
  it is in the beginning. The subtitles shall have the directory name of the
  target in the manifest.</remark>

  <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude"
              xpointer="element(eltf-target-tables-section)" />

  <section id="relinfo-documentation">
    <title>User Documentation</title>

    <para>This release of Enea Edge contains the following set of
    documents:</para>

    <itemizedlist>
      <listitem>
        <para>Enea Edge Release Information. Describes the Enea Edge
        release content, main changes, the list of known issues and
        limitations.</para>
      </listitem>

      <listitem>
        <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(book_enea_nfv_access_getting_started/1)" />.
        Describes how to deploy and upgrade an Enea Edge base
        configuration, advanced configurations of the system and
        troubleshooting information.</para>
      </listitem>

      <listitem>
        <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(book_enea_nfv_access_example_usecases/1)" />.
        Describes examples of onboarding, instantiating and configuring
        various VNFs.</para>
      </listitem>

      <listitem>
        <para><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_user_guide/1)" />. 
		Describes the Automation Framework for Enea Edge.</para>
      </listitem>

      <listitem>
        <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
        xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)"
        xmlns:xi="http://www.w3.org/2001/XInclude" />. Describes the 
          Automation Framework and Test Harness for Enea Edge and 
          provides instructions regarding the necessary steps to run these 
          software tools (deprecated, see 
          <xref linkend="relinfo-changes-other">Section 2.1 New Features 
            and Improvements</xref>).</para>
      </listitem>
	  
      <listitem>
        <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(book_enea_nfv_access_system_test_specification/1)" />.
        Describes a sample Test Suite for System Testing of Enea Edge.
        (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 
          New Features and Improvements</xref>).</para>
      </listitem>
    </itemizedlist>
  </section>

  <section id="release-browsers">
    <title>Supported Web Browsers</title>
	
	<remark>These need to be updated</remark>

    <para>The current release supports using the following web browsers:</para>

    <itemizedlist>
      <listitem>
        <para>Google Chrome (tested with version 86).</para>
      </listitem>

      <listitem>
        <para>Mozilla Firefox (tested with version 82).</para>
      </listitem>

      <listitem>
        <para>Microsoft Edge (tested with version 84).</para>
      </listitem>
    </itemizedlist>
  </section>
</chapter>