diff options
author | mrpa <miruna.paun@enea.com> | 2021-10-26 16:39:53 +0200 |
---|---|---|
committer | Miruna Paun <mrpa@enea.se> | 2021-10-27 16:39:29 +0100 |
commit | 636f1ee6717f10dcdabfbac72611a4631dcbdba3 (patch) | |
tree | 2d123006162da5bca6e8656417fe7af186a8e79a /doc | |
parent | b0f90cfb633e673000b8603d8c7a50e12b1fe0a8 (diff) | |
download | nfv-access-documentation-feature_CPDX-3453.tar.gz |
Changed the makefile to suit this custom release,feature_CPDX-3453
Updated the Getting Started Manual,
Updated the eltf_updated_params.xml to fit this release.
USERDOCAP-728
Change-Id: Ieb31e9b119808877b80b1e10d248e869d7d67675
Signed-off-by: mrpa <miruna.paun@enea.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile | 8 | ||||
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/security.xml | 75 | ||||
-rw-r--r-- | doc/eltf_params_updated.xml | 4 |
3 files changed, 38 insertions, 49 deletions
diff --git a/doc/Makefile b/doc/Makefile index 5c1a6b9..6df8448 100644 --- a/doc/Makefile +++ b/doc/Makefile | |||
@@ -51,7 +51,7 @@ DOCBOOK_TO_BOOKDIR ?= yes | |||
51 | DOCBOOK_CLEANTMP ?= yes | 51 | DOCBOOK_CLEANTMP ?= yes |
52 | 52 | ||
53 | #Components (books) in this subsystem. Now use all books found here | 53 | #Components (books) in this subsystem. Now use all books found here |
54 | COMPONENTS := book-enea-edge-auto-fw-th-open-source book-enea-edge-auto-fw-th-user-guide book-enea-edge-automation-open-source book-enea-edge-automation-user-guide book-enea-nfv-access-evalkit book-enea-edge-example-usecases book-enea-edge-getting-started book-enea-edge-runtime-open-source book-enea-edge-release-info book-enea-edge-system-test-specification book-enea-edge-telemetry-open-source book-enea-edge-management-open-source | 54 | COMPONENTS := book-enea-edge-getting-started book-enea-edge-management-open-source |
55 | 55 | ||
56 | 56 | ||
57 | # -------------------------------------------------------------- | 57 | # -------------------------------------------------------------- |
@@ -184,8 +184,8 @@ endif | |||
184 | 184 | ||
185 | books: init | 185 | books: init |
186 | # BOOKPACKAGES is defined in all book-*/swcomp.mk | 186 | # BOOKPACKAGES is defined in all book-*/swcomp.mk |
187 | $(VERB)DISTRO_VERSION=`egrep '"EneaEdge_REL_VER"><phrase>' $(ELTF_PARAMS_UPDATED) | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ | 187 | $(VERB)DISTRO_VERSION=`egrep '"EneaEdge_REL_VER"><phrase>' $(ELTF_PARAMS_UPDATED) | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; BUILD_NUMBER=`egrep '"ENA_BUILD_VER"><phrase>' $(ELTF_PARAMS_UPDATED) | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ |
188 | BOOKVER="Enea Edge-$$DISTRO_VERSION"-$(shell date +"%Y.%m.%d"); \ | 188 | BOOKVER="Enea Edge-$$DISTRO_VERSION-build-$$BUILD_NUMBER"; \ |
189 | for book in $(BOOKPACKAGES); do \ | 189 | for book in $(BOOKPACKAGES); do \ |
190 | for format in $(FORMAT); do \ | 190 | for format in $(FORMAT); do \ |
191 | $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ | 191 | $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ |
@@ -196,7 +196,7 @@ books: init | |||
196 | cp $$COMP/$$book.pdf $$COMP/eclipse/plugins/com.enea.doc.book-*/. ; \ | 196 | cp $$COMP/$$book.pdf $$COMP/eclipse/plugins/com.enea.doc.book-*/. ; \ |
197 | fi ; \ | 197 | fi ; \ |
198 | done ; \ | 198 | done ; \ |
199 | done | 199 | done |
200 | ifeq ($(DOCBOOK_TO_BOOKDIR),yes) | 200 | ifeq ($(DOCBOOK_TO_BOOKDIR),yes) |
201 | $(VERB)rm -rf doc tmp | 201 | $(VERB)rm -rf doc tmp |
202 | else | 202 | else |
diff --git a/doc/book-enea-edge-getting-started/doc/security.xml b/doc/book-enea-edge-getting-started/doc/security.xml index 0812a2f..c98014a 100644 --- a/doc/book-enea-edge-getting-started/doc/security.xml +++ b/doc/book-enea-edge-getting-started/doc/security.xml | |||
@@ -16,9 +16,9 @@ | |||
16 | 16 | ||
17 | <note> | 17 | <note> |
18 | <para>Configuring MFA will only be possible using the Web interface, and | 18 | <para>Configuring MFA will only be possible using the Web interface, and |
19 | not the REST API. Users with MFA enabled will not be able to log | 19 | not the REST API. Users with MFA enabled will not be able to log in |
20 | in through the REST API. If attempted, a <literal>401</literal> HTTP | 20 | through the REST API. If attempted, a <literal>401</literal> HTTP code |
21 | code will be returned, with the <literal>EMS-Error</literal> header | 21 | will be returned, with the <literal>EMS-Error</literal> header |
22 | containing the <literal>EMS_UserMFAEnabled</literal> error.</para> | 22 | containing the <literal>EMS_UserMFAEnabled</literal> error.</para> |
23 | </note> | 23 | </note> |
24 | 24 | ||
@@ -26,23 +26,19 @@ | |||
26 | <title>Configuring User MFA</title> | 26 | <title>Configuring User MFA</title> |
27 | 27 | ||
28 | <para>The administrator must enable MFA authentication for the desired | 28 | <para>The administrator must enable MFA authentication for the desired |
29 | new user by:</para> | 29 | new user:</para> |
30 | 30 | ||
31 | <orderedlist> | 31 | <orderedlist> |
32 | <listitem> | 32 | <listitem> |
33 | <para>Accessing the <emphasis role="bold">Security</emphasis> | 33 | <para>Access the <emphasis role="bold">Security</emphasis> tab and |
34 | tab.</para> | 34 | choose the <emphasis role="bold">Configuration</emphasis> |
35 | </listitem> | ||
36 | |||
37 | <listitem> | ||
38 | <para>Accessing the <emphasis role="bold">Configuration</emphasis> | ||
39 | menu.</para> | 35 | menu.</para> |
40 | </listitem> | 36 | </listitem> |
41 | 37 | ||
42 | <listitem> | 38 | <listitem> |
43 | <para>Selecting the <emphasis role="bold">Add</emphasis> option, | 39 | <para>Select the <emphasis role="bold">Add</emphasis> option, enter |
44 | entering the details for the new user and then enabling the | 40 | the details for the new user and enable the <emphasis |
45 | <emphasis role="bold">Enable MFA Login</emphasis> checkbox.</para> | 41 | role="bold">Enable MFA Login</emphasis> checkbox.</para> |
46 | </listitem> | 42 | </listitem> |
47 | </orderedlist> | 43 | </orderedlist> |
48 | 44 | ||
@@ -53,30 +49,27 @@ | |||
53 | be asked to configure a new shared secret. For more details on how to | 49 | be asked to configure a new shared secret. For more details on how to |
54 | configure a new shared secret, please see the following section.</para> | 50 | configure a new shared secret, please see the following section.</para> |
55 | 51 | ||
56 | <note> | 52 | <para>All MFA information for enabled users will be preserved upon |
57 | <para>All MFA information for enabled users will be preserved upon | 53 | upgrading or restoring the Enea Edge Management application.</para> |
58 | upgrading the Enea Edge Management application.</para> | ||
59 | </note> | ||
60 | </section> | 54 | </section> |
61 | 55 | ||
62 | <section id="security_authentication"> | 56 | <section id="security_authentication"> |
63 | <title>Security Authentication</title> | 57 | <title>Security Authentication</title> |
64 | 58 | ||
65 | <para>Before the user logs in, there is no secret set in the Enea Edge | 59 | <para>The user will enter his credentials (username and password) as in |
66 | Management database. Initially, the user will enter his credentials as | 60 | a typical local authentication. He will then be redirected to a second |
67 | in a normal, local authentication. He will then be redirected to a | 61 | page that presents the secret as a QR code, that he must scan using the |
68 | second page that presents the secret as a QR code, that he must scan | 62 | Google Authenticator application. The secret is also presented in clear |
69 | using the Google Authenticator application. The secret is also presented | 63 | text ready for copying and manual entry, in case scanning the QR code |
70 | in clear text ready for copying and manual entry, in case scanning the | 64 | does not work.</para> |
71 | QR code does not work.</para> | ||
72 | 65 | ||
73 | <figure> | 66 | <figure> |
74 | <title>Initial setup for Multi-Factor login</title> | 67 | <title>Initial setup for Multi-Factor login</title> |
75 | 68 | ||
76 | <mediaobject> | 69 | <mediaobject> |
77 | <imageobject> | 70 | <imageobject> |
78 | <imagedata align="center" scale="60" | 71 | <imagedata align="center" |
79 | fileref="images/mfa_first_time_setup.png" /> | 72 | fileref="images/mfa_first_time_setup.png" scale="60" /> |
80 | </imageobject> | 73 | </imageobject> |
81 | </mediaobject> | 74 | </mediaobject> |
82 | </figure> | 75 | </figure> |
@@ -89,34 +82,30 @@ | |||
89 | correct, authentication is successful. The six digit token is available | 82 | correct, authentication is successful. The six digit token is available |
90 | for a maximum of 30 seconds.</para> | 83 | for a maximum of 30 seconds.</para> |
91 | 84 | ||
92 | <para>Once the initial login succeeds and the secret is saved in the | 85 | <para>Subsequent logins will still be done using a two-step method. The |
93 | database, subsequent logins will still be done using a two-step method. | 86 | user will provide first his credentials, and on the second page the |
94 | The user will provide first his classic credentials, and then, on the | 87 | token as generated by Google Authenticator.</para> |
95 | second page he will enter the token as generated by Google | ||
96 | Authenticator, this time, however, the secret will no longer be | ||
97 | displayed.</para> | ||
98 | 88 | ||
99 | <figure> | 89 | <figure> |
100 | <title>Second login</title> | 90 | <title>Second login</title> |
101 | 91 | ||
102 | <mediaobject> | 92 | <mediaobject> |
103 | <imageobject> | 93 | <imageobject> |
104 | <imagedata align="center" scale="80" | 94 | <imagedata align="center" fileref="images/mfa_login.png" |
105 | fileref="images/mfa_login.png" /> | 95 | scale="80" /> |
106 | </imageobject> | 96 | </imageobject> |
107 | </mediaobject> | 97 | </mediaobject> |
108 | </figure> | 98 | </figure> |
109 | 99 | ||
110 | <note> | 100 | <note> |
111 | <para>If the shared secret is ever lost, it can always be regenerated, | 101 | <para>If the shared secret is lost, it can be regenerated by the |
112 | but only upon request to the administrator. It is done by accessing | 102 | administrator by disabling and re-enabling the MFA Login for the selected |
113 | the <emphasis role="bold">Security</emphasis> tab, selecting the | 103 | user. For more information, please see <olink targetdoc="book_enea_edge_getting_started" |
114 | <emphasis role="bold">Configuration</emphasis> menu and choosing the | 104 | targetptr="config_mfa">Configuring User MFA in the <ns:include |
115 | user, and on the right-hand side panel unchecking the <emphasis | 105 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
116 | role="bold">Enable MFA Login</emphasis> checkbox. Then pressing the | 106 | xmlns:ns="http://www.w3.org/2001/XInclude" |
117 | <emphasis role="bold">Apply</emphasis> button, checking it again, and | 107 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> Manual. When the |
118 | clicking <emphasis role="bold">Apply</emphasis> one final time. When | 108 | MFA Login is disabled, the secret is also erased from the |
119 | the MFA Login is disabled, the secret is also erased from the | ||
120 | database.</para> | 109 | database.</para> |
121 | </note> | 110 | </note> |
122 | </section> | 111 | </section> |
diff --git a/doc/eltf_params_updated.xml b/doc/eltf_params_updated.xml index 39755ef..2d3b25e 100644 --- a/doc/eltf_params_updated.xml +++ b/doc/eltf_params_updated.xml | |||
@@ -11,9 +11,9 @@ | |||
11 | correct also compared to the "previous" REL VER in pardoc-distro.xml | 11 | correct also compared to the "previous" REL VER in pardoc-distro.xml |
12 | "prev_baseline".</bridgehead> | 12 | "prev_baseline".</bridgehead> |
13 | 13 | ||
14 | <para id="EneaEdge_REL_VER"><phrase>2.5.0</phrase></para> | 14 | <para id="EneaEdge_REL_VER"><phrase>2.5.0-mfa</phrase></para> |
15 | 15 | ||
16 | <para id="ENA_BUILD_VER"><phrase>1</phrase></para> | 16 | <para id="ENA_BUILD_VER"><phrase>2</phrase></para> |
17 | 17 | ||
18 | <bridgehead>Below is one big section with title "Supported Processor with | 18 | <bridgehead>Below is one big section with title "Supported Processor with |
19 | Parameters". The entire section is included completely in the book via ID | 19 | Parameters". The entire section is included completely in the book via ID |