From 636f1ee6717f10dcdabfbac72611a4631dcbdba3 Mon Sep 17 00:00:00 2001 From: mrpa Date: Tue, 26 Oct 2021 16:39:53 +0200 Subject: Changed the makefile to suit this custom release, Updated the Getting Started Manual, Updated the eltf_updated_params.xml to fit this release. USERDOCAP-728 Change-Id: Ieb31e9b119808877b80b1e10d248e869d7d67675 Signed-off-by: mrpa --- doc/Makefile | 8 +-- .../doc/security.xml | 75 +++++++++------------- 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 DOCBOOK_CLEANTMP ?= yes #Components (books) in this subsystem. Now use all books found here -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 +COMPONENTS := book-enea-edge-getting-started book-enea-edge-management-open-source # -------------------------------------------------------------- @@ -184,8 +184,8 @@ endif books: init # BOOKPACKAGES is defined in all book-*/swcomp.mk - $(VERB)DISTRO_VERSION=`egrep '"EneaEdge_REL_VER">' $(ELTF_PARAMS_UPDATED) | sed 's/.*//;s/<\/phrase>.*//'` ; \ - BOOKVER="Enea Edge-$$DISTRO_VERSION"-$(shell date +"%Y.%m.%d"); \ + $(VERB)DISTRO_VERSION=`egrep '"EneaEdge_REL_VER">' $(ELTF_PARAMS_UPDATED) | sed 's/.*//;s/<\/phrase>.*//'` ; BUILD_NUMBER=`egrep '"ENA_BUILD_VER">' $(ELTF_PARAMS_UPDATED) | sed 's/.*//;s/<\/phrase>.*//'` ; \ + BOOKVER="Enea Edge-$$DISTRO_VERSION-build-$$BUILD_NUMBER"; \ for book in $(BOOKPACKAGES); do \ for format in $(FORMAT); do \ $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ @@ -196,7 +196,7 @@ books: init cp $$COMP/$$book.pdf $$COMP/eclipse/plugins/com.enea.doc.book-*/. ; \ fi ; \ done ; \ - done + done ifeq ($(DOCBOOK_TO_BOOKDIR),yes) $(VERB)rm -rf doc tmp 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 @@ Configuring MFA will only be possible using the Web interface, and - not the REST API. Users with MFA enabled will not be able to log - in through the REST API. If attempted, a 401 HTTP - code will be returned, with the EMS-Error header + not the REST API. Users with MFA enabled will not be able to log in + through the REST API. If attempted, a 401 HTTP code + will be returned, with the EMS-Error header containing the EMS_UserMFAEnabled error. @@ -26,23 +26,19 @@ Configuring User MFA The administrator must enable MFA authentication for the desired - new user by: + new user: - Accessing the Security - tab. - - - - Accessing the Configuration + Access the Security tab and + choose the Configuration menu. - Selecting the Add option, - entering the details for the new user and then enabling the - Enable MFA Login checkbox. + Select the Add option, enter + the details for the new user and enable the Enable MFA Login checkbox. @@ -53,30 +49,27 @@ be asked to configure a new shared secret. For more details on how to configure a new shared secret, please see the following section. - - All MFA information for enabled users will be preserved upon - upgrading the Enea Edge Management application. - + All MFA information for enabled users will be preserved upon + upgrading or restoring the Enea Edge Management application.
Security Authentication - Before the user logs in, there is no secret set in the Enea Edge - Management database. Initially, the user will enter his credentials as - in a normal, local authentication. He will then be redirected to a - second page that presents the secret as a QR code, that he must scan - using the Google Authenticator application. The secret is also presented - in clear text ready for copying and manual entry, in case scanning the - QR code does not work. + The user will enter his credentials (username and password) as in + a typical local authentication. He will then be redirected to a second + page that presents the secret as a QR code, that he must scan using the + Google Authenticator application. The secret is also presented in clear + text ready for copying and manual entry, in case scanning the QR code + does not work.
Initial setup for Multi-Factor login - +
@@ -89,34 +82,30 @@ correct, authentication is successful. The six digit token is available for a maximum of 30 seconds. - Once the initial login succeeds and the secret is saved in the - database, subsequent logins will still be done using a two-step method. - The user will provide first his classic credentials, and then, on the - second page he will enter the token as generated by Google - Authenticator, this time, however, the secret will no longer be - displayed. + Subsequent logins will still be done using a two-step method. The + user will provide first his credentials, and on the second page the + token as generated by Google Authenticator.
Second login - +
- If the shared secret is ever lost, it can always be regenerated, - but only upon request to the administrator. It is done by accessing - the Security tab, selecting the - Configuration menu and choosing the - user, and on the right-hand side panel unchecking the Enable MFA Login checkbox. Then pressing the - Apply button, checking it again, and - clicking Apply one final time. When - the MFA Login is disabled, the secret is also erased from the + If the shared secret is lost, it can be regenerated by the + administrator by disabling and re-enabling the MFA Login for the selected + user. For more information, please see Configuring User MFA in the Manual. When the + MFA Login is disabled, the secret is also erased from the database.
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 @@ correct also compared to the "previous" REL VER in pardoc-distro.xml "prev_baseline". - 2.5.0 + 2.5.0-mfa - 1 + 2 Below is one big section with title "Supported Processor with Parameters". The entire section is included completely in the book via ID -- cgit v1.2.3-54-g00ecf