summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-release-info/doc/about_release.xml
blob: 4235d36690269f48da71e4d831da618de8f6a6fc (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
<?xml version="1.0" encoding="ISO-8859-1"?>
<!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>The Enea NFV Access <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 uCPE Manager as well as other features and optimizations, security
  patches and documentation updates. A list of new features can be found
  in <xref linkend="relinfo-changes-other">Section 2.1 New Features</xref>.</para>

  <para>
    <remark>INFO <emphasis role="bold">eltf_params_updated.xml</emphasis>
    contains many parameters in the book, also in the open source books, and
    MUST be created FROM <emphasis
    role="bold">eltf_params_template.xml</emphasis>. The parameters are
    automatically used in the books, via xi:include statements, similar to how
    parameters from pardoc-distro.xml are included in the book. Read the file
    <emphasis
    role="bold">eltf_params_updated_template_how_to_use.txt</emphasis> for
    important details about formats and how to do! The idea is that ELTF will
    auto-create/update it.</remark>
  </para>

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

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

    <itemizedlist>
      <listitem>
        <para>Enea_NFV_Access_Run_Time_Platform_XeonD_2.2.1.zip</para>
      </listitem>

      <listitem>
        <para>Enea_NFV_Access_Run_Time_Platform_C3000_2.2.1.zip</para>
      </listitem>

      <listitem>
        <para>uCPEManager-1.0.1-CentOS.zip</para>
      </listitem>

      <listitem>
        <para>Automation and Test Harness (nfvaccess_2.2.1_af-th.zip)</para>
      </listitem>

      <listitem>
        <para>VNF_example_configurations.tar.gz</para>
      </listitem>
    </itemizedlist>

    <programlisting condition="arm">-- documentation/
   /* Enea NFV Access 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>Provided Documentation</title>

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

    <itemizedlist>
      <listitem>
        <para>Enea NFV Access Release Information. Describes the Enea NFV
        Access release content.</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 install the uCPE Manager, the NFV Access Run-Time
        platform and Device Management.</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_open_source/1)" />. Contains
        open source and license information pertaining to packages provided
        with Enea NFV Access.</para>
      </listitem>

      <listitem>
        <para>Enea NFV Access uCPE Manager Open-Source Report. Provides
        license information pertaining to packages available with the uCPE
        Manager.</para>
      </listitem>

      <listitem>
        <para>Enea NFV Access Automation Framework and Test Harness User
        Guide. Describes the Automation Framework and Test Harness for Enea
        NFV Access and provides instructions regarding the necessary steps to
        run these software tools.</para>
      </listitem>

      <listitem>
        <para>Enea NFV Access System Test Specification. Describes a sample
        Test Suite for System Testing of Enea NFV Access.</para>
      </listitem>
    </itemizedlist>
  </section>
</chapter>