summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-release-info/doc/about_release.xml
blob: 383f4f22292840a8da5388abe08feb28194667f9 (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
<?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>Enea NFV Access <xi:include href="eltf_params_updated.xml"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(EneaLinux_REL_VER/1)" /> adds support for Element ODM
  integration and updates certain components for better
  performance.<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>NFV Access Release content</title>

    <para>The current release contains along with other items, documentation,
    pre-built kernels and images, a bootloader and a SDK. The directories
    structure is detailed below:</para>

    <programlisting>-- documentation/
   /* NFV Access documentation */
-- x86-64 /* architecture */
        -- inteld1521/
           /* 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 development process. The image
                          contains userspace tools and kernel configurations necessary
                          for developing, debugging and profiling applications and
                          kernel modules */
                        -- various artifacts
        -- qemux86-64
                -- deb/
                   /* deb packages */
                -- images/
                    -- enea-nfv-access-guest
                       /* precompiled artifacts for QEMU/Docker release image  */
                        -- various artifacts
                    -- enea-nfv-access-guest-dev
                       /* precompiled artifacts for development process. The image
                          contains userspace tools and kernel configurations necessary
                          for developing, debugging and profiling applications and
                          kernel modules  */
                        -- various artifacts
        -- install
                -- install-sdk.sh
                       /* self-extracting archive installing cross-compilation
                          toolchain for the platform */</programlisting>

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

    <programlisting>-- bzImage
   /* kernel image */
-- bzImage-&lt;target&gt;.bin
   /* kernel image, same as above */
-- config-&lt;target&gt;.config
   /* kernel configuration file */
-- &lt;image-name&gt;-&lt;target&gt;.ext4.gz
   /* compressed EXT4 image of the rootfs */
-- &lt;image-name&gt;-&lt;target&gt;.qcow2
   /* QCOW image for QEMU - only for guest images */
-- &lt;image-name&gt;-&lt;target&gt;.qemuboot.conf
   /* qemu config file for the guest images */
-- &lt;image-name&gt;-&lt;target&gt;.tar.gz
   /* tar archive of the image */
-- microcode.cpio
   /* kernel microcode data - Intel arch specific*/
-- modules-&lt;target&gt;.tgz
   /* external kernel modules */
-- grub-efi-bootx64.efi
   /* GRUB EFI file */</programlisting>
  </section>

  <section id="relinfo-supported-host-environment">
    <title>Supported Host Environment</title>

    <para>The following environments have been validated as host environments
    for Enea NFV Access 1.0: <emphasis role="bold">Ubuntu 16.04 LTS,
    64bit</emphasis>.</para>

    <para><remark>Hardcoded now in this XML file. Might be moved to the
    parameter file later.</remark><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></para>

    <para>For more details on system requirements and how to configure the
    host environment, please see <xref
    linkend="sys-req-prerequisites" />.</para>
  </section>

  <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 Toolchain(s) (SDK)</title>

    <para>The provided SDK contains toolchains supporting cross-compilation of
    applications for both the host and the guest targets on an x86_64
    machine.</para>

    <para><remark>(Possibly add this in later) See the <trademark
    class="registered">Enea</trademark> NFV Access Application Development
    Guide for information on how to build and install a
    toolchain.</remark></para>
  </section>

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

    <para>Enea NFV Access is provided with the following set of
    documents:</para>

    <itemizedlist>
      <listitem>
        <para>Enea NFV Access Release Information - This document, describing
        the Enea NFV Access release content.</para>
      </listitem>

      <listitem>
        <para>Enea NFV Access Guide - A document describing how to use Enea
        NFV Access, as well as use cases and benchmark results.</para>
      </listitem>

      <listitem>
        <para>Enea NFV Access Open Source Report - A document containing the
        open source and license information pertaining to packages provided
        with Enea NFV Access.</para>
      </listitem>

      <listitem>
        <para>Enea NFV Access Developer's Open Source Report - A document
        containing open source and license information pertaining to packages
        provided with Enea NFV Access for application developers.</para>
      </listitem>

      <listitem>
        <para>Enea NFV Access Guest Open Source Report - A document containing
        open source and license information concerning packages provided with
        Enea NFV Access for a guest target.</para>
      </listitem>

      <listitem>
        <para>Enea NFV Access Guest Developer's Open Source Report - A
        document detailing the open source and license information of packages
        provided with Enea NFV Access for application developers on a guest
        target.</para>
      </listitem>

      <listitem>
        <para>Enea NFV Access Test Report - The document that summarizes the
        test results for the Enea NFV Access release.</para>
      </listitem>

      <listitem>
        <para>Enea NFV Access Security Report - The document that lists all
        security fixes included in the Enea NFV Access release.</para>
      </listitem>
    </itemizedlist>
  </section>

  <xi:include href="../../s_doceneacommon/doc/security_fixes.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>