From: maximesson Date: Wed, 13 Nov 2019 10:53:26 +0000 (+0100) Subject: Removed dashboard documentation X-Git-Tag: 1.7.3~11 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;ds=sidebyside;h=94978f459b7973585661925054763f8eb612b213;hp=b8ca4e29520360ca7a312aafc6f865bb4e42fab4;p=nonrtric.git Removed dashboard documentation Change-Id: I8b76388a32ea42cac87675d09a7f5e5d4bbfb31d Issue-ID: NONRTRIC-69 Signed-off-by: maximesson --- diff --git a/dashboard/docs/.gitignore b/dashboard/docs/.gitignore deleted file mode 100644 index 173f8dc3..00000000 --- a/dashboard/docs/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -/_build -/out -/_build diff --git a/dashboard/docs/_static/logo.png b/dashboard/docs/_static/logo.png deleted file mode 100644 index c3b6ce56..00000000 Binary files a/dashboard/docs/_static/logo.png and /dev/null differ diff --git a/dashboard/docs/conf.py b/dashboard/docs/conf.py deleted file mode 100644 index 922e22fb..00000000 --- a/dashboard/docs/conf.py +++ /dev/null @@ -1,6 +0,0 @@ -from docs_conf.conf import * -linkcheck_ignore = [ - 'http://localhost.*', - 'http://127.0.0.1.*', - 'https://gerrit.o-ran-sc.org.*' -] diff --git a/dashboard/docs/conf.yaml b/dashboard/docs/conf.yaml deleted file mode 100644 index 127745e9..00000000 --- a/dashboard/docs/conf.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -project_cfg: oran -project: portal-ric-dashboard diff --git a/dashboard/docs/config-deploy.rst b/dashboard/docs/config-deploy.rst deleted file mode 100644 index 6a843cad..00000000 --- a/dashboard/docs/config-deploy.rst +++ /dev/null @@ -1,267 +0,0 @@ -.. ===============LICENSE_START======================================================= -.. O-RAN SC CC-BY-4.0 -.. %% -.. Copyright (C) 2019 AT&T Intellectual Property -.. %% -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. ===============LICENSE_END========================================================= - -RIC Dashboard Configuration and Deployment -========================================== - -This documents the configuration and deployment of the O-RAN SC RIC -Dashboard web application, which is often deployed together with the -ONAP Portal. - -Configuration -------------- - -The application requires the following configuration files:: - - application.properties - key.properties - portal.properties - -In the usual Kubernetes deployment, all file contents are provided by -a configuration map. - -Application Properties -^^^^^^^^^^^^^^^^^^^^^^ - -The file ``application.properties`` must be provided when the -application is launched, either in the current working directory or in -a ``config`` subdirectory (latter is preferred). The Helm chart that -deploys the application should mount this file appropriately. - -Many properties have default values cached within the application, in -file ``src/main/resources/application.properties``. Properties with -default values do NOT need to be repeated in a deployment-specific -configuration. Properties without default values MUST be specified in -a deployment-specific configuration. - -The properties are listed below in alphabetical order. - -``a1med.url.prefix`` - -A1 Mediator URL prefix. No useful default. Usually a service name -like ``http://ricplt-entry/a1mediator`` - -``a1med.url.suffix`` - -A1 Mediator URL suffix. Default is the empty string. - -``anrxapp.url.prefix`` - -ANR Application URL prefix. No useful default. Usually a service name -like ``http://ricxapp-entry/anr`` - -``anrxapp.url.suffix`` - -ANR Application URL suffix. Default is the empty string. - -``appmgr.url.prefix`` - -Application Manager URL prefix. No useful default. Usually a service -name like ``http://ricplt-entry/appmgr`` - -``appmgr.url.suffix`` - -Application Manager URL suffix. Default is ``/ric/v1``. - -``caasingress.aux.url.prefix`` - -CAAS-Ingress application URL prefix for the RIC Auxiliary cluster. No useful default. - -``caasingress.aux.url.suffix`` - -CAAS-Ingress application URL suffix for the RIC Auxiliary cluster. Default is ``api``. - -``caasingress.insecure`` - -Flag whether to disable SSL/TLS certificate and hostname verification. -If true, the dashboard can communicate with a CAAS-Ingress endpoint that -uses self-signed certificates. - -``caasingress.plt.url.prefix`` - -CAAS-Ingress application URL prefix for the RIC Platform cluster. No useful default. - -``caasingress.plt.url.suffix`` - -CAAS-Ingress application URL suffix for the RIC-PLT cluster. Default is ``api``. - -``e2mgr.url.prefix`` - -E2 Manager URL prefix. No useful default. Usually a service name like -``http://ricplt-entry/e2mgr`` - -``e2mgr.url.suffix`` - -E2 Manager URL prefix. Default is ``/v1``. - -``mock.config.delay`` - -Sleep period for mock methods in milliseconds. This mimics slow -endpoints. Default is ``0``. - -``portalapi.appname`` - -Application name expected at ONAP portal. Default is ``RIC Dashboard`` - -``portalapi.decryptor`` - -Java class that decrypts ciphertext from Portal. Default is -``org.oransc.ric.portal.dashboard.portalapi.PortalSdkDecryptorAes``. - -``portalapi.password`` - -REST password expected at ONAP portal. No default value. - -``portalapi.security`` - -Boolean flag whether the Dashboard limits access to users (browsers) -that present security tokens set by the ONAP Portal. If false, no -access control is performed, which is only appropriate for isolated -lab testing. - -``portalapi.usercookie`` - -Name of request cookie with user ID. Default is ``UserId``. - -``portalapi.username`` - -REST user name expected at ONAP portal. No default value. - -``server.port`` - -Port where the Tomcat server listens for requests. Default is ``8080``. - -``metrics.url.ac`` - -Url to the kibana source which visualizes AC App metrics. No default value and needs to be replaced with actual value during deployment time. - -``userfile`` - -Path of file that stores user details. Default is ``users.json``. - - -Key Properties -^^^^^^^^^^^^^^ - -The file ``key.properties`` must be provided on the Java classpath for -the Spring-Boot application, as required by the EPSDK-FW library. The -Helm chart for the application should mount this file appropriately. -A sample file is in directory ``src/test/resources``. - -The file must contain the following entries, listed here in -alphabetical order. - -``cipher.enc.key`` - -Encryption key used by the EPSDK-FW library. No default value. - - -Portal Properties -^^^^^^^^^^^^^^^^^ - -The file ``portal.properties`` must be provided on the Java classpath -for the application, as required by the EPSDK-FW library. The Helm -chart for the application should mount this file appropriately. A -sample file is in directory ``src/test/resources``. - -The file must contain the following entries, listed here in -alphabetical order. - -``ecomp_redirect_url`` - -Portal URL that is reachable by a user's browser. This is a value -like -``https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm`` - -``ecomp_rest_url`` - -Portal REST URL that is reachable by the Dashboard back-end. -This is a value like ``http://portal-app.onap:8989/ONAPPORTAL/auxapi`` - -``portal.api.impl.class`` - -Java class name. No default value. Value must be -``org.oransc.ric.portal.dashboard.portalapi.PortalRestCentralServiceImpl`` - -``role_access_centralized`` - -Selector for role access. No default value. Value must be ``remote``. - -``ueb_app_key`` - -Unique key assigned by ONAP Portal to the RIC Dashboard application. -No default value. - - -Deployment ----------- - -A production server requires the configuration files listed above. -All files should be placed in a ``config`` directory. That name is -important; Spring automatically searches that directory for the -``application.properties`` file. Further, that directory can easily be -placed on the Java classpath so the additional files can be found at -runtime. - - -On-Board Dashboard to ONAP Portal -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -When on-boarding the Dashboard to the ONAP Portal the administrator -must supply the following information about the deployed instance: - -- Dashboard URL that is reachable by a user's browser. The domain of - this host name must match the Portal URL that is similarly reachable - by a user's browser for cookie-based authentication to function as - expected. This should be a value like - ``http://dashboard.simpledemo.onap.org:8080`` -- Dashboard REST URL that is reachable by the Portal back-end server. - This can be a host name or an IP address, because it does not use - cookie-based authentication. This must be a URL with suffix "/api/v3" - for example ``http://192.168.1.1:8080/api/v3``. - -The Dashboard server only listens on a single port, so the examples -above both use the same port number. Different port numbers might be -required if an ingress controller or other proxy server is used. - -After the on-boarding process is complete, the administrator must -enter values from the Portal for the following properties explained -above: - -- ``portalapi.password`` -- ``portalapi.username`` -- ``ueb_app_key`` - -Launch Server -^^^^^^^^^^^^^ - -After creating, populating and mounting Kubernetes config maps -appropriately, launch the server with this command-line invocation to -include the ``config`` directory on the Java classpath:: - - java -cp config:target/ric-dash-be-1.2.0-SNAPSHOT.jar \ - -Dloader.main=org.oransc.ric.portal.dashboard.DashboardApplication \ - org.springframework.boot.loader.PropertiesLauncher - -Alternately, to use the configuration in the "application-abc.properties" file, -modify the command to have "spring.config.name=name" like this:: - - java -cp config:target/ric-dash-be-1.2.0-SNAPSHOT.jar \ - -Dspring.config.name=application-abc \ - -Dloader.main=org.oransc.ric.portal.dashboard.DashboardApplication \ - org.springframework.boot.loader.PropertiesLauncher diff --git a/dashboard/docs/developer-guide.rst b/dashboard/docs/developer-guide.rst deleted file mode 100644 index f99a04dc..00000000 --- a/dashboard/docs/developer-guide.rst +++ /dev/null @@ -1,148 +0,0 @@ -.. ===============LICENSE_START======================================================= -.. O-RAN SC CC-BY-4.0 -.. %% -.. Copyright (C) 2019 AT&T Intellectual Property -.. %% -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. ===============LICENSE_END========================================================= - -RIC Dashboard Developer Guide -============================= - -This document provides a quickstart for developers of the O-RAN SC RIC Dashboard web -application. - -Prerequisites -------------- - -1. Java development kit (JDK), version 11 or later -2. Maven dependency-management tool, version 3.4 or later - -Other required tools including the Node Package Manager (npm) are fetched dynamically. - -Clone and Update Submodules ---------------------------- - -After cloning the repository, initialize and update all git submodules like this:: - - git submodule init - git submodule update - -Check the submodule status at any time like this:: - - git submodule status - - -Angular Front-End Application ------------------------------ - -The Angular 8 application files are in subdirectory ``webapp-frontend``. -Build the front-end application via ``mvn package``. For development and debugging, -build the application, then launch an ng development server using this command:: - - ./ng serve --proxy-config proxy.conf.json - -The app will automatically reload in the browser if you change any of the source files. -The ng server listens for requests at this URL: - - http://localhost:4200 - - -Spring-Boot Back-End Application --------------------------------- - -A development (not production) server uses local configuration and serves mock data -that simulates the behavior of remote endpoints. The back-end server listens for -requests at this URL: - - http://localhost:8080 - -The directory ``src/test/resources`` contains usable versions of the required property -files. These steps are required to launch: - -1. Set an environment variable via JVM argument: ``-Dorg.oransc.ric.portal.dashboard=mock`` -2. Run the JUnit test case ``DashboardServerTest`` which is not exactly a "test" because it never finishes. - -Both steps can be done with this command-line invocation:: - - mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer test - -Development user authentication -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The development server requires basic HTTP user authentication for all requests. Like -the production server, it requires HTTP headers with authentication for Portal API -requests. The username and password are stored in constants in this Java class in -the ``src/test/java`` folder:: - - org.oransc.ric.portal.dashboard.config.WebSecurityMockConfiguration - -Like the production server, the development server also performs role-based -authentication on requests. The user name-role name associations are also defined -in the class shown above. - -Production user authentication -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The server uses the ONAP Portal's "EPSDK-FW" library to support a -single-sign-on (SSO) feature, which requires users to authenticate -at the ONAP Portal UI. The RIC Dashboard can be on-boarded as an -application on the ONAP Portal using its application on-boarding UI. - -The server authenticates requests using cookies that are set -by the ONAP Portal:: - - EPService - UserId - -The EPService value is not checked. The UserId value is decrypted -using a secret key shared with the ONAP Portal to yield a user ID. -That ID must match a user's loginId defined in the user manager. - -The regular server checks requests for the following granted -authorities (role names), as defined in the java class ``DashboardConstants``. -A standard user can invoke all "GET" methods but not make changes. -A system administrator can invoke all methods ("GET", "POST", "PUT", -"DELETE") to make arbitrary changes:: - - Standard_User - System_Administrator - -Use the following structure in a JSON file to publish a user for the -user manager:: - - [ - { - "orgId":null, - "managerId":null, - "firstName":"Demo", - "middleInitial":null, - "lastName":"User", - "phone":null, - "email":null, - "hrid":null, - "orgUserId":null, - "orgCode":null, - "orgManagerUserId":null, - "jobTitle":null, - "loginId":"demo", - "active":true, - "roles":[ - { - "id":null, - "name":"Standard_User", - "roleFunctions":null - } - ] - } - ] diff --git a/dashboard/docs/favicon.ico b/dashboard/docs/favicon.ico deleted file mode 100644 index 00b0fd0e..00000000 Binary files a/dashboard/docs/favicon.ico and /dev/null differ diff --git a/dashboard/docs/index.rst b/dashboard/docs/index.rst deleted file mode 100644 index 9c40271a..00000000 --- a/dashboard/docs/index.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. _portal-ric-dashboard: - -.. ===============LICENSE_START====================================================== -.. O-RAN SC CC-BY-4.0 -.. %% -.. Copyright (C) 2019 AT&T Intellectual Property -.. %% -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. ===============LICENSE_END======================================================== - -.. RIC Dashboard documentation master - -RIC Dashboard -============= - - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - overview.rst - config-deploy.rst - developer-guide.rst - release-notes.rst - -* :ref:`search` diff --git a/dashboard/docs/overview.rst b/dashboard/docs/overview.rst deleted file mode 100644 index f0d5c957..00000000 --- a/dashboard/docs/overview.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. ========================LICENSE_START================================= -.. O-RAN-SC -.. %% -.. Copyright (C) 2019 Nordix Foundation -.. %% -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at - -.. http://www.apache.org/licenses/LICENSE-2.0 - -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. ===============LICENSE_END========================================================= - -NonRT RIC Dashboard Overview -====================== - -The O-RAN NonRT RIC Dashboard provides administrative and operator -functions managing policies. The web app is -built as a single-page app using an Angular (version 8) front end and -a Java (version 11) Spring-Boot (version 2.1) back end. - -Project Resources ------------------ -TBD - diff --git a/dashboard/docs/release-notes.rst b/dashboard/docs/release-notes.rst deleted file mode 100644 index b9ee3fd6..00000000 --- a/dashboard/docs/release-notes.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. ===============LICENSE_START======================================================= -.. O-RAN SC CC-BY-4.0 -.. %% -.. Copyright (C) 2019 Nordix Foundation -.. %% -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. ===============LICENSE_END========================================================= - -NonTR RIC Dashboard Release Notes -================================= - diff --git a/dashboard/docs/requirements-docs.txt b/dashboard/docs/requirements-docs.txt deleted file mode 100644 index 09a0c1cb..00000000 --- a/dashboard/docs/requirements-docs.txt +++ /dev/null @@ -1,5 +0,0 @@ -sphinx -sphinx-rtd-theme -sphinxcontrib-httpdomain -recommonmark -lfdocs-conf diff --git a/docs/api-docs.rst b/docs/api-docs.rst index a2964601..193a8281 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -40,7 +40,7 @@ To run the dashboard locally, you can follow these steps: mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test -- Now you can open URL: `localhost:8080`_ in a browser. +- Now you can open URL: `localhost:8080`_ in a browser. .. _localhost:8080: localhost:8080 diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 63829e26..aea9f07c 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,20 +1,5 @@ -.. ============LICENSE_START======================================================= -.. Copyright (C) 2019 Nordix Foundation. -.. ================================================================================ -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. -.. SPDX-License-Identifier: Apache-2.0 -.. ============LICENSE_END========================================================= +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 A1 Mediation: 1. SDNC Controller