diff options
| author |   Michael Dürre <michael.duerre@highstreet-technologies.com> | 2020-01-31 09:35:15 +0100 |
|---|---|---|
| committer | Michael Dürre <michael.duerre@highstreet-technologies.com> | 2020-01-31 09:35:59 +0100 |
| commit | 10cd599727adee39af12e330879560aae43e7489 (patch) | |
| tree | 88b91e1a1978ff26be68befdacd1699a69cf9b63 /sdnr/wt/helpserver | |
| parent | d1981f7e68272cdc5618139a363b80806c2aa77c (diff) | |
update helpserver
update help readme files
Issue-ID: SDNC-1029
Signed-off-by: Michael Dürre <michael.duerre@highstreet-technologies.com>
Change-Id: I79378660f8114b7769d9138a67f9a10f4389d406
Diffstat (limited to 'sdnr/wt/helpserver')
11 files changed, 65 insertions, 56 deletions
diff --git a/sdnr/wt/helpserver/feature/pom.xml b/sdnr/wt/helpserver/feature/pom.xml index 8fb2671be..80de3c5b4 100644 --- a/sdnr/wt/helpserver/feature/pom.xml +++ b/sdnr/wt/helpserver/feature/pom.xml @@ -28,7 +28,7 @@ <groupId>org.onap.ccsdk.parent</groupId> <artifactId>single-feature-parent</artifactId> <version>1.5.2-SNAPSHOT</version> - <relativePath/> + <relativePath /> </parent> <groupId>org.onap.ccsdk.features.sdnr.wt</groupId> diff --git a/sdnr/wt/helpserver/installer/pom.xml b/sdnr/wt/helpserver/installer/pom.xml index 84fc9472b..bb1bfcfa4 100755 --- a/sdnr/wt/helpserver/installer/pom.xml +++ b/sdnr/wt/helpserver/installer/pom.xml @@ -1,4 +1,26 @@ <?xml version="1.0" encoding="UTF-8"?> +<!-- + +* ============LICENSE_START======================================================= +* ONAP : ccsdk features +* ================================================================================ +* Copyright (C) 2020 highstreet technologies GmbH Intellectual Property. +* All rights reserved. +* ================================================================================ +* 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========================================================= + +--> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> @@ -6,7 +28,7 @@ <groupId>org.onap.ccsdk.parent</groupId> <artifactId>odlparent-lite</artifactId> <version>1.5.2-SNAPSHOT</version> - <relativePath/> + <relativePath /> </parent> <groupId>org.onap.ccsdk.features.sdnr.wt</groupId> @@ -69,25 +91,6 @@ <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <executions> - <!-- <execution> --> - <!-- <id>copy-dependencies</id> --> - <!-- <goals> --> - <!-- <goal>copy-dependencies</goal> --> - <!-- </goals> --> - <!-- <phase>prepare-package</phase> --> - <!-- <configuration> --> - <!-- <transitive>true</transitive> --> - <!-- <outputDirectory>${project.build.directory}/assembly/system</outputDirectory> --> - <!-- <overWriteReleases>false</overWriteReleases> --> - <!-- <overWriteSnapshots>true</overWriteSnapshots> --> - <!-- <overWriteIfNewer>true</overWriteIfNewer> --> - <!-- <useRepositoryLayout>true</useRepositoryLayout> --> - <!-- <addParentPoms>false</addParentPoms> --> - <!-- <copyPom>false</copyPom> --> - <!-- <includeArtifactIds>sdnr-wt-apigateway-provider,${application.name}</includeArtifactIds> --> - <!-- <scope>provided</scope> --> - <!-- </configuration> --> - <!-- </execution> --> <execution> <id>copy-nested-dependencies</id> <goals> @@ -103,8 +106,6 @@ <useRepositoryLayout>true</useRepositoryLayout> <addParentPoms>false</addParentPoms> <copyPom>false</copyPom> - <!--<includeArtifactIds>sdnr-wt-apigateway-provider,${application.name}</includeArtifactIds> --> - <!--<scope>provided</scope> --> </configuration> </execution> </executions> diff --git a/sdnr/wt/helpserver/pom.xml b/sdnr/wt/helpserver/pom.xml index c94c3b1ff..51033f85f 100755 --- a/sdnr/wt/helpserver/pom.xml +++ b/sdnr/wt/helpserver/pom.xml @@ -28,7 +28,7 @@ <groupId>org.onap.ccsdk.parent</groupId> <artifactId>odlparent-lite</artifactId> <version>1.5.2-SNAPSHOT</version> - <relativePath/> + <relativePath /> </parent> <groupId>org.onap.ccsdk.features.sdnr.wt</groupId> diff --git a/sdnr/wt/helpserver/provider/pom.xml b/sdnr/wt/helpserver/provider/pom.xml index f1fd7fdaf..639b4d090 100644 --- a/sdnr/wt/helpserver/provider/pom.xml +++ b/sdnr/wt/helpserver/provider/pom.xml @@ -1,16 +1,26 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- * ============LICENSE_START======================================================= - * ONAP : CCSDK.sdnr.wt.apigateway.provider * ================================================================================ - * Copyright (C) 2018 highstreet technologies GmbH Intellectual Property. - * All rights reserved. * ================================================================================ - * 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========================================================= --> +<!-- + +* ============LICENSE_START======================================================= +* ONAP : ccsdk features +* ================================================================================ +* Copyright (C) 2020 highstreet technologies GmbH Intellectual Property. +* All rights reserved. +* ================================================================================ +* 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========================================================= + +--> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> @@ -18,7 +28,7 @@ <groupId>org.onap.ccsdk.parent</groupId> <artifactId>binding-parent</artifactId> <version>1.5.2-SNAPSHOT</version> - <relativePath/> + <relativePath /> </parent> <groupId>org.onap.ccsdk.features.sdnr.wt</groupId> diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/ONAP-SDN-R.png b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/ONAP-SDN-R.png Binary files differindex cc7bd8a2a..6a9f2fac8 100644 --- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/ONAP-SDN-R.png +++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/ONAP-SDN-R.png diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/README.md index 72e4cad05..fa8ce0d76 100644 --- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/README.md +++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/README.md @@ -1,8 +1,8 @@ # SDN controller for 'Radio' (SDN-R) -SDN-R adds features and functionality to the OpenDaylight-based ONAP controller 'SDN-C'. It is built on the Common Controller Framework to control and manage wireless resources. Wireless resources are virtual network functions (e.g. vBBU, vEPC) or physical network functions (e.g. microwave and millimeter wave radios, eNodeB, RRH, DAS equipment). +SDN-R adds features and functionality to the OpenDaylight-based ONAP controller 'CCSDK/SDNC'. It is built on the Common Controller Framework to control and manage wireless resources. Wireless resources are virtual network functions (e.g. vBBU, vEPC) or physical network functions (e.g. microwave and millimeter wave radios, eNodeB, RRH, DAS equipment). -SDN-R is integrated into ONAP. Therefore it is interfacing with PNFs and VNFs and with other ONAP components, such as A&AI, DCAE and SO. +SDN-R is integrated into ONAP using DMaaP APIs. It is interfacing with PNFs and VNFs and with other ONAP components, such as A&AI, DCAE and SO. [See abbreviations](abbreviations.md)  diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/abbreviations.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/abbreviations.md index 4a225197c..272eabe86 100644 --- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/abbreviations.md +++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/abbreviations.md @@ -84,6 +84,9 @@ | NOD | Network On Demand | | NS | Network Services | | NS | (Vendor Specific) New Start | +| O-RAN | [O-RAN Alliance, Operator Defined Next Generation Radio Access Networks Alliance](https://www.o-ran.org) +| O-RAN-SC | [O-RAN Software Community](https://o-ran-sc.org) +| OAM | Operation and Maintenance | | OA&M | Operations, Administration and Management | | OMF | Operational Management Framework (of ONAP) | | OMSA | ONAP Microservice Architecture | @@ -93,6 +96,7 @@ | OOM | [ONAP Operations Manager](https://wiki.onap.org/display/DW/OOM+User+Guide) | | OPNFV | [Open Platform for NFV Project](https://www.sdxcentral.com/nfv/definitions/opnfv/) | | OSAM | [Open Source Access Manager](https://wiki.onap.org/display/DW/OpenSource+Access+Manager+%28OSAM%29+Use+Case) | +| OSC | O-RAN Software Community or Optical Supervisory Channel | | OSS | Operations Support System | | PAP | Policy Administration Point (ONAP) | | PCE | Path Computation and Element (ONAP) | @@ -108,7 +112,7 @@ | RCA | Root Cause Analysis | | RCT | Reference Connection Tool | | REST | [Representational State Transfer](https://en.wikipedia.org/wiki/Representational_state_transfer) | -| RESTCONF | REST + NETCONF | +| RESTCONF | A protocol based on HTTP for configuring data defined in YANG | | RO | Resource Orchestrator | | RPC | Remote Procedure Call | | S3P | [Stability, Security, Scalability, Performance](https://wiki.onap.org/pages/viewpage.action?pageId=16003367) | @@ -163,5 +167,6 @@ | VSP | Vendor Software Product (from SDC Demo Guide) | | VTP | [VNF Test Platform](https://wiki.onap.org/pages/viewpage.action?pageId=43386304) | | VVP | [VNF Validation Program](https://wiki.onap.org/display/DW/VNF+Validation+Program+Project) | -| WAR | [Web application Archive](https://en.wikipedia.org/wiki/WAR_(file_format)) | -| YANG | A Data Modeling Language for the Network Configuration Protocol (NETCONF) | +| WAR | [Web application Archive](https://en.wikipedia.org/wiki/WAR_(file_format)) | +| xNF | The combination of PNF and VNF; Network Function | +| YANG | Yet Another Next Generation - a Data Modeling Language for the Network Configuration Protocol (NETCONF) | diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md index 6eba75461..e1eefcd8e 100644 --- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md +++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md @@ -4,19 +4,12 @@ The 'Connect' application on OpenDaylight provides up-to-date connectivity infor ## Views -The graphical user interfaces is divided in three sections. +The graphical user interfaces is divided in two sections. -### Required Network Elements +### Network Elements -Required Network Elements are physical network functions, which are planned or expected in the network. This means the identifier, IP addresses and its required configuration is well-known and available in a planning database or in ONAP A&AI. - -This view also offer to manually configure/mount the device with the '+' icon. The SDN controller will then start connecting the Netconf server. - -### Unknown Network Elements - -Most of the physical network function support an automatic registration procedure to the SDN controller. It may happen, that devices are connected to the SDN Controller but not available in planning data. - -It might be a normal occurrence for very cheap devices, where an entire planning process to too expensive. But is may also happen that the identifier used in planning process differ from the identifier currently configured in the device. +Network Elements are physical network functions (PNFs). A table view show configured and connected NetConf Servers to the SDN-R cluster. +This view also offer to manually configure/mount the device with the '+' icon. The SDN controller will start connecting the NetConf server. ### Connection Status Log diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/mwtnLog/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/mwtnLog/README.md index 0096ce831..85de8a30c 100644 --- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/mwtnLog/README.md +++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/mwtnLog/README.md @@ -1,3 +1,3 @@ # Log -The application displays (UX) application logs. SDN-R offer a common log server, so that PNFs or other ONAP/ECOMP components could log there data in a common way.
\ No newline at end of file +The application displays (UX) application logs. SDN-R offer a common log server, so that PNFs or other ONAP components could log there data in a common way.
\ No newline at end of file diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfConfig/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfConfig/README.md index d36ec8e09..98c9f946c 100644 --- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfConfig/README.md +++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfConfig/README.md @@ -6,7 +6,7 @@ A separate window is available for modifying the configuration. All changes made ## Implementation -The applications are implemented as OpenDaylight-DLUX web application using the RestConf northbound interface of the SDN controller. The key frameworks are: Maven, Angular.js, Bootstrap and UI-Grid. +The applications are implemented as OpenDaylight-DLUX web application using the RestConf northbound interface of the SDN controller. The key frameworks are: Typescript, react and material-ui. Connections status information are updated automatically due to a web socket for notifications from OpenDaylight to the browser. diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfInventory/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfInventory/README.md index d8122ad0a..8308c0530 100644 --- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfInventory/README.md +++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfInventory/README.md @@ -1,6 +1,6 @@ # Inventory -The application offers basic inventory management of devices supporting ONF-TR-512. +The application offers basic inventory management of devices supporting ONF-TR-512 and ietf-hardware. The view displays the inventory data of the network element - basically serial-numbers and part-numbers are displaced according to the containment of the equipment. |
