diff options
author | mrpa <miruna.paun@enea.com> | 2021-03-25 15:49:16 +0100 |
---|---|---|
committer | Miruna Paun <mrpa@enea.se> | 2021-03-25 16:44:57 +0100 |
commit | fa0b00ee867935591dd3af92f401035b74a4408c (patch) | |
tree | 83637ecaaf71538285c4df5140c12c638c839f00 | |
parent | 70f6371dd56f1553d2a189dac7a9310aad4dba3d (diff) | |
download | nfv-access-documentation-fa0b00ee867935591dd3af92f401035b74a4408c.tar.gz |
Updated the rel notes with new olinks and dape's comments.
Change-Id: Ib072f49571952743de4dbcbb578f506604df3cb8
Signed-off-by: mrpa <miruna.paun@enea.com>
3 files changed, 77 insertions, 89 deletions
diff --git a/doc/book-enea-edge-release-info/doc/about_release.xml b/doc/book-enea-edge-release-info/doc/about_release.xml index 960f136..766c02a 100644 --- a/doc/book-enea-edge-release-info/doc/about_release.xml +++ b/doc/book-enea-edge-release-info/doc/about_release.xml | |||
@@ -4,11 +4,11 @@ | |||
4 | <chapter id="relinfo-about-release"> | 4 | <chapter id="relinfo-about-release"> |
5 | <title>About This Release</title> | 5 | <title>About This Release</title> |
6 | 6 | ||
7 | <para>Enea Edge is a complete NFVI software platform designed for | 7 | <para>Enea Edge is a complete NFVI software platform designed for deployment |
8 | deployment on any white box uCPE device, and optimized for common use cases. | 8 | on any white box uCPE device, and optimized for common use cases. Enea Edge |
9 | Enea Edge includes both the Enea Edge Runtime deployed on a white box, | 9 | includes both the Enea Edge Runtime deployed on a white box, and a |
10 | and a management component with automation tools deployed in a private or | 10 | management component with automation tools deployed in a private or public |
11 | public cloud.</para> | 11 | cloud.</para> |
12 | 12 | ||
13 | <para>The Enea Edge <xi:include | 13 | <para>The Enea Edge <xi:include |
14 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 14 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
@@ -48,11 +48,11 @@ | |||
48 | <listitem> | 48 | <listitem> |
49 | <para>VNF_example_configurations.tar.gz</para> | 49 | <para>VNF_example_configurations.tar.gz</para> |
50 | </listitem> | 50 | </listitem> |
51 | 51 | ||
52 | <listitem> | 52 | <listitem> |
53 | <para>Enea_Edge_AF-TH_<version>-build<build_number>.zip | 53 | <para>Enea_Edge_AF-TH_<version>-build<build_number>.zip |
54 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New Features and | 54 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New |
55 | Improvements</xref>.)</para> | 55 | Features and Improvements</xref>.)</para> |
56 | </listitem> | 56 | </listitem> |
57 | </itemizedlist> | 57 | </itemizedlist> |
58 | 58 | ||
@@ -109,63 +109,61 @@ | |||
109 | 109 | ||
110 | <itemizedlist> | 110 | <itemizedlist> |
111 | <listitem> | 111 | <listitem> |
112 | <para>Enea Edge Release Information. Describes the Enea Edge | 112 | <para>Enea Edge Release Information. Describes the Enea Edge release |
113 | release content, main changes, the list of known issues and | 113 | content, main changes, the list of known issues and |
114 | limitations.</para> | 114 | limitations.</para> |
115 | </listitem> | 115 | </listitem> |
116 | 116 | ||
117 | <listitem> | 117 | <listitem> |
118 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 118 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
119 | xmlns:xi="http://www.w3.org/2001/XInclude" | 119 | xmlns:xi="http://www.w3.org/2001/XInclude" |
120 | xpointer="element(book_enea_nfv_access_getting_started/1)" />. | 120 | xpointer="element(book_enea_edge_getting_started/1)" />. Describes how |
121 | Describes how to deploy and upgrade an Enea Edge base | 121 | to deploy and upgrade an Enea Edge base configuration, advanced |
122 | configuration, advanced configurations of the system and | 122 | configurations of the system as well as troubleshooting |
123 | troubleshooting information.</para> | 123 | information.</para> |
124 | </listitem> | 124 | </listitem> |
125 | 125 | ||
126 | <listitem> | 126 | <listitem> |
127 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 127 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
128 | xmlns:xi="http://www.w3.org/2001/XInclude" | 128 | xmlns:xi="http://www.w3.org/2001/XInclude" |
129 | xpointer="element(book_enea_nfv_access_example_usecases/1)" />. | 129 | xpointer="element(book_enea_edge_example_usecases/1)" />. Describes |
130 | Describes examples of onboarding, instantiating and configuring | 130 | examples of onboarding, instantiating and configuring various |
131 | various VNFs.</para> | 131 | VNFs.</para> |
132 | </listitem> | 132 | </listitem> |
133 | 133 | ||
134 | <listitem> | 134 | <listitem> |
135 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 135 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
136 | xmlns:xi="http://www.w3.org/2001/XInclude" | 136 | xmlns:xi="http://www.w3.org/2001/XInclude" |
137 | xpointer="element(book_enea_nfv_access_auto_fw_user_guide/1)" />. | 137 | xpointer="element(book_enea_edge_automation_user_guide/1)" />. |
138 | Describes the Automation Framework for Enea Edge.</para> | 138 | Describes the Enea Edge Automation and provides instructions regarding |
139 | the necessary steps to configure and run the tool.</para> | ||
139 | </listitem> | 140 | </listitem> |
140 | 141 | ||
141 | <listitem> | 142 | <listitem> |
142 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 143 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
143 | xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" | 144 | xmlns:xi="http://www.w3.org/2001/XInclude" |
144 | xmlns:xi="http://www.w3.org/2001/XInclude" />. Describes the | 145 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />. |
145 | Automation Framework and Test Harness for Enea Edge and | 146 | Describes the Automation Framework and Test Harness for Enea Edge |
146 | provides instructions regarding the necessary steps to run these | 147 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 |
147 | software tools (deprecated, see | 148 | New Features and Improvements</xref>).</para> |
148 | <xref linkend="relinfo-changes-other">Section 2.1 New Features | ||
149 | and Improvements</xref>).</para> | ||
150 | </listitem> | 149 | </listitem> |
151 | 150 | ||
152 | <listitem> | 151 | <listitem> |
153 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 152 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
154 | xmlns:xi="http://www.w3.org/2001/XInclude" | 153 | xmlns:xi="http://www.w3.org/2001/XInclude" |
155 | xpointer="element(book_enea_nfv_access_system_test_specification/1)" />. | 154 | xpointer="element(book_enea_edge_system_test_specification/1)" />. |
156 | Describes a sample Test Suite for System Testing of Enea Edge. | 155 | Describes a sample Test Suite for System Testing of Enea Edge. |
157 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 | 156 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New |
158 | New Features and Improvements</xref>).</para> | 157 | Features and Improvements</xref>).</para> |
159 | </listitem> | 158 | </listitem> |
160 | </itemizedlist> | 159 | </itemizedlist> |
161 | </section> | 160 | </section> |
162 | 161 | ||
163 | <section id="release-browsers"> | 162 | <section id="release-browsers"> |
164 | <title>Supported Web Browsers</title> | 163 | <title>Supported Web Browsers</title> |
165 | |||
166 | <remark>These need to be updated</remark> | ||
167 | 164 | ||
168 | <para>The current release supports using the following web browsers:</para> | 165 | <para>The current release supports using the following web |
166 | browsers:</para> | ||
169 | 167 | ||
170 | <itemizedlist> | 168 | <itemizedlist> |
171 | <listitem> | 169 | <listitem> |
diff --git a/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml index 1f5fb0c..4f3eb7a 100644 --- a/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml | |||
@@ -201,11 +201,11 @@ | |||
201 | <para><remark>ELCCR-1468</remark>When using the Enea Edge Management in | 201 | <para><remark>ELCCR-1468</remark>When using the Enea Edge Management in |
202 | HTTPS mode, upgrading a device from NFV Access 2.3.0 is not possible. | 202 | HTTPS mode, upgrading a device from NFV Access 2.3.0 is not possible. |
203 | Either switch to HTTP mode (for more details see <olink | 203 | Either switch to HTTP mode (for more details see <olink |
204 | targetdoc="book_enea_nfv_access_getting_started" | 204 | targetdoc="book_enea_edge_getting_started" |
205 | targetptr="device_up_process">The uCPE device Upgrade Process in the | 205 | targetptr="device_up_process">The uCPE device Upgrade Process in the |
206 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 206 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
207 | xmlns:xi="http://www.w3.org/2001/XInclude" | 207 | xmlns:xi="http://www.w3.org/2001/XInclude" |
208 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 208 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
209 | Manual) or install it manually.</para> | 209 | Manual) or install it manually.</para> |
210 | </listitem> | 210 | </listitem> |
211 | </itemizedlist> | 211 | </itemizedlist> |
diff --git a/doc/book-enea-edge-release-info/doc/main_changes.xml b/doc/book-enea-edge-release-info/doc/main_changes.xml index 10e36a6..63c2216 100644 --- a/doc/book-enea-edge-release-info/doc/main_changes.xml +++ b/doc/book-enea-edge-release-info/doc/main_changes.xml | |||
@@ -31,21 +31,21 @@ | |||
31 | </listitem> | 31 | </listitem> |
32 | 32 | ||
33 | <listitem> | 33 | <listitem> |
34 | <para><remark>CPDX-3500</remark>The Enea Edge Automation, | 34 | <para><remark>CPDX-3500</remark>The Enea Edge Automation, a tool for |
35 | a tool for automatic system configuration based on Python | 35 | automatic system configuration based on Python scripting that will |
36 | scripting that will replace the existing Enea Edge Automation | 36 | replace the existing Enea Edge Automation Framework and Test Harness |
37 | Framework and Test Harness in the next major release.</para> | 37 | in the next major release.</para> |
38 | 38 | ||
39 | <para>The Enea Edge Automation Framework and Test Harness, and | 39 | <para>The Enea Edge Automation Framework and Test Harness, and its |
40 | its related documentation the <xi:include | 40 | related documentation the <xi:include |
41 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 41 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
42 | xmlns:xi="http://www.w3.org/2001/XInclude" | 42 | xmlns:xi="http://www.w3.org/2001/XInclude" |
43 | xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" /> | 43 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" /> and the |
44 | and the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 44 | <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
45 | xmlns:xi="http://www.w3.org/2001/XInclude" | 45 | xmlns:xi="http://www.w3.org/2001/XInclude" |
46 | xpointer="element(book_enea_nfv_access_system_test_specification/1)" /> | 46 | xpointer="element(book_enea_edge_system_test_specification/1)" /> are |
47 | are deprecated starting with Enea Edge 2.4.0.</para> | 47 | deprecated starting with Enea Edge 2.4.0.</para> |
48 | </listitem> | 48 | </listitem> |
49 | </itemizedlist> | 49 | </itemizedlist> |
50 | 50 | ||
51 | <para><emphasis role="bold">Improvements:</emphasis></para> | 51 | <para><emphasis role="bold">Improvements:</emphasis></para> |
@@ -75,38 +75,30 @@ | |||
75 | <itemizedlist> | 75 | <itemizedlist> |
76 | <listitem> | 76 | <listitem> |
77 | <para><remark>CPDX-3498</remark>High Availability support with | 77 | <para><remark>CPDX-3498</remark>High Availability support with |
78 | redundant Enea uCPE Managers in active standby configuration.</para> | 78 | redundant Enea Edge Management applications in active standby |
79 | 79 | configuration.</para> | |
80 | <para>In order to increase resiliency on the uCPE management side, | 80 | |
81 | the Enea uCPE Manager can be installed in High-Availability mode. | 81 | <para>In order to increase resiliency on the uCPE management side, the |
82 | Deployment consists of multiple instances of the Enea uCPE Manager, | 82 | Enea Edge Management application can be installed in High-Availability |
83 | which can be distributed across different Data Centers and | 83 | mode. Deployment consists of multiple instances of the Enea Edge |
84 | geographical locations, and with multiple MariaDB servers for | 84 | Management application, which can be distributed across different Data |
85 | each location.</para> | 85 | Centers and geographical locations, and with multiple MariaDB servers |
86 | for each location.</para> | ||
86 | </listitem> | 87 | </listitem> |
87 | 88 | ||
88 | <listitem> | 89 | <listitem> |
89 | <para>Platform and VNF Snapshots:</para> | 90 | <para>Platform and VNF Snapshots (made originally available starting |
90 | 91 | with Enea NFV Access 2.3.0).</para> | |
91 | <note> | 92 | |
92 | <para>Made originally available with Enea NFV Access 2.3.0.</para> | 93 | <para>Platform Snapshots allow users to store, manage and restore |
93 | </note> | 94 | snapshots of the Enea Edge Runtime configuration, with the purpose |
95 | of recovering after a failed reconfiguration. This feature is | ||
96 | disabled by default.</para> | ||
94 | 97 | ||
95 | <itemizedlist> | ||
96 | <listitem> | ||
97 | <para>Platform Snapshots allow users to store, manage and restore | ||
98 | snapshots of the Enea Edge Runtime configuration, | ||
99 | with the purpose of recovering after a failed reconfiguration. | ||
100 | This feature is disabled by default.</para> | ||
101 | </listitem> | ||
102 | |||
103 | <listitem> | ||
104 | <para>VNF Snapshots allow users to store, manage and restore | 98 | <para>VNF Snapshots allow users to store, manage and restore |
105 | snapshots of VNFs deployed on the Enea Edge | 99 | snapshots of VNFs deployed on the Enea Edge Runtime, with the |
106 | Runtime, with the purpose of restoring the VNF after a persistent | 100 | purpose of restoring the VNF after a persistent VNF failure. This |
107 | VNF failure. This feature is disabled by default.</para> | 101 | feature is disabled by default.</para> |
108 | </listitem> | ||
109 | </itemizedlist> | ||
110 | 102 | ||
111 | <note> | 103 | <note> |
112 | <para>Users that would like to try out the Snapshot features should | 104 | <para>Users that would like to try out the Snapshot features should |
@@ -133,36 +125,34 @@ | |||
133 | 125 | ||
134 | <itemizedlist> | 126 | <itemizedlist> |
135 | <listitem> | 127 | <listitem> |
136 | |||
137 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 128 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
138 | xpointer="element(book_enea_nfv_access_platform_open_source/1)" | 129 | xmlns:xi="http://www.w3.org/2001/XInclude" |
139 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> | 130 | xpointer="element(book_enea_edge_runtime_open_source/1)" />.</para> |
140 | </listitem> | 131 | </listitem> |
141 | 132 | ||
142 | <listitem> | 133 | <listitem> |
143 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 134 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
144 | xpointer="element(book_enea_nfv_access_ucpem_open_source/1)" | 135 | xmlns:xi="http://www.w3.org/2001/XInclude" |
145 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> | 136 | xpointer="element(book_enea_edge_management_open_source/1)" />.</para> |
146 | </listitem> | 137 | </listitem> |
147 | 138 | ||
148 | <listitem> | 139 | <listitem> |
149 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 140 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
150 | xpointer="element(book_enea_nfv_access_telemetry_open_source/1)" | 141 | xmlns:xi="http://www.w3.org/2001/XInclude" |
151 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> | 142 | xpointer="element(book_enea_edge_telemetry_open_source/1)" />.</para> |
152 | </listitem> | 143 | </listitem> |
153 | 144 | ||
154 | <listitem> | 145 | <listitem> |
155 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 146 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
156 | xpointer="element(book_enea_nfv_access_auto_fw_open_source/1)" | 147 | xmlns:xi="http://www.w3.org/2001/XInclude" |
157 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> | 148 | xpointer="element(book_enea_edge_automation_open_source/1)" />.</para> |
158 | </listitem> | 149 | </listitem> |
159 | 150 | ||
160 | <listitem> | 151 | <listitem> |
161 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 152 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
162 | xpointer="element(book_enea_nfv_access_auto_fw_th_open_source/1)" | 153 | xmlns:xi="http://www.w3.org/2001/XInclude" |
163 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> | 154 | xpointer="element(book_enea_edge_auto_fw_th_open_source/1)" />.</para> |
164 | </listitem> | 155 | </listitem> |
165 | |||
166 | </itemizedlist> | 156 | </itemizedlist> |
167 | </section> | 157 | </section> |
168 | 158 | ||