summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-release-info/doc/about_release.xml
blob: f056135d73abd4923fb6de2d0f1f7a6c88dd54e1 (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
206
207
208
209
210
211
212
213
<?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>This release of Enea NFV Access <xi:include
  href="eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(EneaLinux_REL_VER/1)" /> includes optimizations to the
  FCAPS framework, DPDK, cross-developement on both an SDK and an eSDK,
  USB-stick based installation, and various other optimizations,
  security patches and documentation updated accordingly.</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 directory structure is detailed below:</para>

    <programlisting condition="intel">-- Documentation/
   /* Enea NFV Access documentation */
-- x86-64 /* architecture */
        -- xeon-d/
                -- images/
                    -- enea-nfv-access
                        /* HDD image for bootable USB stick installer */
                        -- enea-nfv-access-xeon-d.hddimg
        -- atom-c3000/
                -- images/
                    -- enea-nfv-access
                        /* HDD image for bootable USB stick installer */
                        -- enea-nfv-access-atom-c3000.hddimg
        -- install
                -- sdk
                    /* SDK installer */
                    -- install-sdk.sh
                -- esdk
                    /* Extensible SDK installer */
                    -- install-esdk.sh</programlisting>

    <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
        -- install
                -- sdk
                   /* SDK related artifacts including SDK installer and manifests  */
                        -- install-sdk.sh
                           /* self-extracting archive installing cross-compilation
                              toolchain for the platform */
                -- esdk
                   /* Extensible SDK related artifacts including SDK installer and
                      manifests  */
                        -- install-esdk.sh
                           /* self-extracting archive installing cross-compilation
                              toolchain for the platform */
                -- nfv-installer
                   /* Various tools assisting in booting Enea NFV Access  */
                        -- docker-pxe-ramboot
                           /* tools and files used in buidling a boot setup  */</programlisting>

    <para condition="hidden">For each combination of image and target, the following set of
    artifacts is available:</para>

    <programlisting condition="hidden">-- bzImage
   /* kernel image */
-- bzImage-&lt;target&gt;.bin
   /* kernel image, same as above */
-- config-&lt;target&gt;.config
   /* kernel configuration file */
-- enea-nfv-access-&lt;target&gt;.hddimg
   /* HDD image for bootable USB stick installer */
-- enea-nfv-access-&lt;target&gt;.ext4.gz
   /* compressed EXT4 image of the rootfs */
-- enea-nfv-access-&lt;target&gt;.tar.gz
   /* tar archive of the image */
-- modules-&lt;target&gt;.tgz
   /* external kernel modules */
-- grub-efi-bootx64.efi
   /* GRUB EFI file */</programlisting>

    <programlisting condition="arm">-- Image
   /* kernel image */
-- Image-target.bin
   /* kernel image, same as above */
-- config-target.config
   /* kernel configuration file */
-- image-name-target.ext4.gz
   /* compressed EXT4 image of the rootfs */
-- image-name-target.qcow2
   /* QCOW image for QEMU - only for guest images */
-- image-name-target.qemuboot.conf
   /* qemu config file for the guest images */
-- image-name-target.tar.gz
   /* tar archive of the image */
-- modules-&lt;target&gt;.tgz
   /* external kernel modules */</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="eltf_params_updated.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude"
              xpointer="element(eltf-target-tables-section)" />

  <section id="relinfo-provided-sdk">
    <title>Provided Toolchains</title>

    <para>The provided SDK and eSDK contain toolchains supporting
    cross-compilation of applications for the target machine(s).</para>
  </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 condition="intel">
        <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(book_enea_nfv_access_guide_intel/1)" />. Describes
        how to use Enea NFV Access, provides use cases and benchmark
        results.</para>
      </listitem>

      <listitem condition="arm">
        <para><phrase><olink targetdoc="book_enea_nfv_access_guide">Enea NFV
        Access Guide</olink></phrase>. Describes how to use Enea NFV Access,
        provides use cases and benchmark results.</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 Element On-Device Management Kick Start Guide. Use this
        guide to learn about the Element ODM software product, and install
        and use Element ODM on both development and target platforms.</para>
      </listitem>

      <listitem>
        <para>Enea Element On-Device Management Guide. Use this guide to
        assist in working with the Element ODM product including building
        applications, API reference information, and using the Northbound
        Agents.</para>
      </listitem>

      <listitem condition="hidden">
        <para>Enea NFV Access Test Report. Summarizes the test results for the
        Enea NFV Access release.</para>
      </listitem>

      <listitem condition="hidden">
        <para>Enea NFV Access Security Report. Lists all security fixes
        included in this release of Enea NFV Access.</para>
      </listitem>
    </itemizedlist>
  </section>

</chapter>