summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-platform-guide/doc/getting_started.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-nfv-access-platform-guide/doc/getting_started.xml')
-rw-r--r--doc/book-enea-nfv-access-platform-guide/doc/getting_started.xml127
1 files changed, 127 insertions, 0 deletions
diff --git a/doc/book-enea-nfv-access-platform-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-platform-guide/doc/getting_started.xml
new file mode 100644
index 0000000..b534e20
--- /dev/null
+++ b/doc/book-enea-nfv-access-platform-guide/doc/getting_started.xml
@@ -0,0 +1,127 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<chapter id="plat-release-content">
5 <title>Getting Started with ENFV Access Platform</title>
6
7 <section id="release-content">
8 <title>NFV Access Platform Release content</title>
9
10 <para>The NFV Access Platform 1.0 Release contains along with other items,
11 documentation, pre-built kernels and images, a bootloader and a
12 SDK.</para>
13
14 <para>The directories structure is detailed below:</para>
15
16 <programlisting>-- documentation/
17 /* NFV Access Platform documentation */
18-- inteld1521/
19 /* artifacts for the host side */
20 -- deb/
21 /* deb packages */
22 -- images/
23 -- enea-image-virtualization-host
24 /* precompiled artifacts for the Host release image */
25 -- various artifacts
26 -- enea-image-virtualization-host-sdk
27 /* precompiled artifacts for the Host SDK image.
28 The SDK image contains userspace tools and kernel
29 configurations necessary for developing, debugging
30 and profiling applications and kernel modules */
31 -- various artifacts
32 -- sdk
33 /* NFV Access Platform SDK for the host */
34 -- enea-glibc-x86_64-enea-image-virtualization-host-sdk /
35 -corei7-64-toolchain-7.0.sh
36 /* self-extracting archive installing
37 cross-compilation toolchain for the host */
38-- qemux86-64
39 /* artifacts for the guest side */
40 -- deb/
41 /* deb packages */
42 -- images/
43 -- enea-image-virtualization-guest
44 /* precompiled artifacts for the Guest image */
45 -- various artifacts
46 -- sdk
47 /* NFV Access Platform SDK for the guest */
48 -- enea-glibc-x86_64-enea-image-virtualization-guest-sdk /
49 -core2-64-toolchain-7.0.sh
50 /* self-extracting archive installing cross-compilation
51 toolchain for the guest (QEMU x86-64) */
52</programlisting>
53
54 <para>For each combination of image and target, the following set of
55 artifacts is available:</para>
56
57 <programlisting>-- bzImage
58 /* kernel image */
59-- bzImage-&lt;target&gt;.bin
60 /* kernel image, same as above */
61-- config-&lt;target&gt;.config
62 /* kernel configuration file */
63-- core-image-minimal-initramfs-&lt;target&gt;.cpio.gz
64 /* cpio archive of the initramfs */
65-- core-image-minimal-initramfs-&lt;target&gt;.qemuboot.conf
66 /* qemu config file for the initramfs image */
67-- &lt;image-name&gt;-&lt;target&gt;.ext4
68 /* EXT4 image of the rootfs */
69-- &lt;image-name&gt;-&lt;target&gt;.hddimg
70 /* msdos filesystem containing syslinux, kernel, initrd and rootfs image */
71-- &lt;image-name&gt;-&lt;target&gt;.iso
72 /* CD .iso image */
73-- &lt;image-name&gt;-&lt;target&gt;.qemuboot.conf
74 /* qemu config file for the image */
75-- &lt;image-name&gt;-&lt;target&gt;.tar.gz
76 /* tar archive of the image */
77-- &lt;image-name&gt;-&lt;target&gt;.wic
78 /* Wic image */
79-- microcode.cpio
80 /* kernel microcode data */
81-- modules-&lt;target&gt;.tgz
82 /* external kernel modules */
83-- ovmf.*.qcow2
84 /* ovmf firmware for uefi support in qemu */
85-- rmc.db
86 /* Central RMC Database */
87-- systemd-bootx64.efi
88 /* systemd-boot EFI file */</programlisting>
89 </section>
90
91 <section id="docs">
92 <title>Included Documention</title>
93
94 <para>Enea NFV Access is provided with the following set of
95 documents:</para>
96
97 <itemizedlist>
98 <listitem>
99 <para>Enea NFV Access Guide &ndash; A document describing the Enea NFV
100 Access release content and how to use it, as well as benchmark
101 results.</para>
102 </listitem>
103
104 <listitem>
105 <para>Enea NFV Access Open Source Report &ndash; A document containing
106 the open source and license information pertaining to packages
107 provided with Enea NFV Access 1.0.</para>
108 </listitem>
109
110 <listitem>
111 <para>Enea NFV Access Test Report &ndash; The document that summarizes
112 the test results for the Enea NFV Access release.</para>
113 </listitem>
114
115 <listitem>
116 <para>Enea NFV Access Security Report &ndash; The document that lists
117 all security fixes included in the Enea NFV Access 1.0 release.</para>
118 </listitem>
119 </itemizedlist>
120 </section>
121
122 <section id="prebuilt-artifacts">
123 <title>How to use Prebuilt Artifacts</title>
124
125 <para></para>
126 </section>
127</chapter> \ No newline at end of file