summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorToma Bilius <toma.bilius@enea.com>2021-02-25 14:14:14 +0200
committerMiruna Paun <mrpa@enea.se>2021-02-25 14:44:11 +0100
commit0e1f14feda9b1105b4a0e4a3258f203631f31fae (patch)
tree1e18a793a0f1a5e4541189a197c5a93f0bd47ae5
parent56849e5e7f0ce5a1c2b1b5d982f61593855e6d30 (diff)
downloadnfv-access-documentation-0e1f14feda9b1105b4a0e4a3258f203631f31fae.tar.gz
Document the usage of createCertificate script as an
installation step Change-Id: Ib09a22de17286c0a164b8164085f47fea539c5e6 Signed-off-by: Toma Bilius <toma.bilius@enea.com>
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml63
1 files changed, 34 insertions, 29 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
index 0ce5d16..be4342f 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
@@ -215,8 +215,8 @@ sudo systemctl mask now firewalld</programlisting>
215 215
216 <entry>TCP</entry> 216 <entry>TCP</entry>
217 217
218 <entry>Required for Call Home when connecting uCPE Devices 218 <entry>Required for Call Home when connecting uCPE Devices using
219 using Enea NFV Access 2.3.0 or older.</entry> 219 Enea NFV Access 2.3.0 or older.</entry>
220 </row> 220 </row>
221 </tbody> 221 </tbody>
222 </tgroup> 222 </tgroup>
@@ -394,10 +394,10 @@ userdel postgres</programlisting>
394 394
395 <para>Select a text string to represent the uCPE device, e.g. 395 <para>Select a text string to represent the uCPE device, e.g.
396 <literal>uCPE-1</literal> or <literal>fwa-t1012vc_boston_1234</literal>. 396 <literal>uCPE-1</literal> or <literal>fwa-t1012vc_boston_1234</literal>.
397 It can have any length and any type of characters with the exception of 397 It can have any length and any type of characters with the exception of
398 quotation characters (' or ") or line terminators (\n or \r) which can 398 quotation characters (' or ") or line terminators (\n or \r) which can
399 interfere with the JSON format of the <filename>install_data.json</filename> 399 interfere with the JSON format of the
400 file.</para> 400 <filename>install_data.json</filename> file.</para>
401 </section> 401 </section>
402 402
403 <section id="bios_config"> 403 <section id="bios_config">
@@ -590,14 +590,19 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
590 </listitem> 590 </listitem>
591 591
592 <listitem> 592 <listitem>
593 <para>Heap Configuration:</para> 593 <para>Heap Configuration: <literal>Please enter the new Maximum Heap
594 Size [4g]</literal>:</para>
595 </listitem>
594 596
595 <itemizedlist spacing="compact"> 597 <listitem>
596 <listitem> 598 <para>Create the self-signed certificate:
597 <para>Please enter the new Maximum Heap Size 599 <literal>Specify IP or domain name:</literal></para>
598 [<literal>4g]</literal>:</para> 600
599 </listitem> 601 <note>
600 </itemizedlist> 602 <para>The certificate can be generated again by running the
603 <filename>createCertificate</filename> script from the
604 distribution folder.</para>
605 </note>
601 </listitem> 606 </listitem>
602 </itemizedlist> 607 </itemizedlist>
603 608
@@ -782,8 +787,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
782 </listitem> 787 </listitem>
783 788
784 <listitem> 789 <listitem>
785 <para>On the <emphasis role="bold">Requirements</emphasis> page of the 790 <para>On the <emphasis role="bold">Requirements</emphasis> page of
786 Web-installer, the user must confirm the current state of 791 the Web-installer, the user must confirm the current state of
787 installation prerequisites is inline with the desired state:</para> 792 installation prerequisites is inline with the desired state:</para>
788 793
789 <itemizedlist> 794 <itemizedlist>
@@ -792,8 +797,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
792 installation process only. For runtime operations, additional 797 installation process only. For runtime operations, additional
793 resources should be available depending on the specific 798 resources should be available depending on the specific
794 workload. Requirements are color coded (green when met, red when 799 workload. Requirements are color coded (green when met, red when
795 mandatory and not met, orange when optional and not met). 800 mandatory and not met, orange when optional and not met). The
796 The Requirements table has the following fields:</para> 801 Requirements table has the following fields:</para>
797 802
798 <itemizedlist spacing="compact"> 803 <itemizedlist spacing="compact">
799 <listitem> 804 <listitem>
@@ -824,32 +829,32 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
824 <listitem> 829 <listitem>
825 <para>IOMMU Group separation (optional). If the hardware 830 <para>IOMMU Group separation (optional). If the hardware
826 does not support IOMMU Group separation, there are certain 831 does not support IOMMU Group separation, there are certain
827 limitations regarding how the 832 limitations regarding how the <literal>vfio-pci</literal>
828 <literal>vfio-pci</literal> driver can be used. 833 driver can be used. For more details, see the <olink
829 For more details, see the <olink
830 targetdoc="book_enea_nfv_access_release_info" 834 targetdoc="book_enea_nfv_access_release_info"
831 targetptr="bugs-limitations">Known Issues and Limitations in 835 targetptr="bugs-limitations">Known Issues and Limitations in
832 this Release in the <xi:include 836 this Release in the <xi:include
833 href="../../s_docbuild/olinkdb/pardoc-names.xml" 837 href="../../s_docbuild/olinkdb/pardoc-names.xml"
834 xmlns:xi="http://www.w3.org/2001/XInclude" 838 xmlns:xi="http://www.w3.org/2001/XInclude"
835 xpointer="element(book_enea_nfv_access_release_info/1)"/></olink> 839 xpointer="element(book_enea_nfv_access_release_info/1)" /></olink>
836 Manual.</para> 840 Manual.</para>
837 </listitem> 841 </listitem>
838 </itemizedlist> 842 </itemizedlist>
839 </listitem> 843 </listitem>
840 844
841 <listitem> 845 <listitem>
842 <para>Force installation checkbox. When enabled, the installation 846 <para>Force installation checkbox. When enabled, the
843 can be performed even if some of the mandatory requirements are 847 installation can be performed even if some of the mandatory
844 not met or if non-fatal problems are detected during the 848 requirements are not met or if non-fatal problems are detected
845 process.</para> 849 during the process.</para>
846 </listitem> 850 </listitem>
847 </itemizedlist> 851 </itemizedlist>
848 </listitem> 852 </listitem>
849 853
850 <listitem> 854 <listitem>
851 <para>On the Enea <emphasis role="bold">uCPE Manager settings</emphasis> 855 <para>On the Enea <emphasis role="bold">uCPE Manager
852 page of the Web-installer, the user must fill in:</para> 856 settings</emphasis> page of the Web-installer, the user must fill
857 in:</para>
853 858
854 <itemizedlist> 859 <itemizedlist>
855 <listitem> 860 <listitem>
@@ -929,7 +934,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
929 drive without further user configuration.</para> 934 drive without further user configuration.</para>
930 </note> 935 </note>
931 </section> 936 </section>
932 937
933 <section id="prep_phys_exec"> 938 <section id="prep_phys_exec">
934 <title>Preparing Physical Deployment for Execution</title> 939 <title>Preparing Physical Deployment for Execution</title>
935 940
@@ -1179,4 +1184,4 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1179 </note> 1184 </note>
1180 </section> 1185 </section>
1181 </section> 1186 </section>
1182</chapter> 1187</chapter> \ No newline at end of file