diff options
Diffstat (limited to 'sdnr/wt')
8 files changed, 265 insertions, 233 deletions
diff --git a/sdnr/wt/devicemanager-core/provider/src/main/java/org/onap/ccsdk/features/sdnr/wt/devicemanager/vescollectorconnector/impl/config/VESCollectorCfgImpl.java b/sdnr/wt/devicemanager-core/provider/src/main/java/org/onap/ccsdk/features/sdnr/wt/devicemanager/vescollectorconnector/impl/config/VESCollectorCfgImpl.java index 105b915c7..0e88b8435 100644 --- a/sdnr/wt/devicemanager-core/provider/src/main/java/org/onap/ccsdk/features/sdnr/wt/devicemanager/vescollectorconnector/impl/config/VESCollectorCfgImpl.java +++ b/sdnr/wt/devicemanager-core/provider/src/main/java/org/onap/ccsdk/features/sdnr/wt/devicemanager/vescollectorconnector/impl/config/VESCollectorCfgImpl.java @@ -31,31 +31,37 @@ public class VESCollectorCfgImpl implements VESCollectorCfgService, Configuratio /** set to true if VES Collector is installed and configured */ private static final String PROPERTY_KEY_VES_COLLECTOR_ENABLED = "VES_COLLECTOR_ENABLED"; - private static final boolean DEFAULT_VALUE_VES_COLLECTOR_ENABLED = false; + private static final String DEFAULT_VALUE_VES_COLLECTOR_ENABLED = "${SDNR_VES_COLLECTOR_ENABLED}"; private static final String PROPERTY_KEY_VES_COLLECTOR_IP = "VES_COLLECTOR_IP"; - private static final String DEFAULT_VALUE_VES_COLLECTOR_IP = "127.0.0.1"; + private static final String DEFAULT_VALUE_VES_COLLECTOR_IP = "${SDNR_VES_COLLECTOR_IP}"; private static final String PROPERTY_KEY_VES_COLLECTOR_PORT = "VES_COLLECTOR_PORT"; - private static final String DEFAULT_VALUE_VES_COLLECTOR_PORT = "8080"; + private static final String DEFAULT_VALUE_VES_COLLECTOR_PORT = "${SDNR_VES_COLLECTOR_PORT}"; private static final String PROPERTY_KEY_VES_COLLECTOR_TLS_ENABLED = "VES_COLLECTOR_TLS_ENABLED"; + private static final String DEFAULT_VALUE_VES_COLLECTOR_TLS_ENABLED = "${SDNR_VES_COLLECTOR_TLS_ENABLED}"; + private static final String PROPERTY_KEY_VES_COLLECTOR_TRUST_ALL_CERTS = "VES_COLLECTOR_TRUST_ALL_CERTS"; + private static final String DEFAULT_VALUE_VES_COLLECTOR_TRUST_ALL_CERTS = "${SDNR_VES_COLLECTOR_TRUST_ALL_CERTS}"; private static final String PROPERTY_KEY_VES_COLLECTOR_USERNAME = "VES_COLLECTOR_USERNAME"; - private static final String DEFAULT_VALUE_VES_COLLECTOR_USERNAME = "sample1"; + private static final String DEFAULT_VALUE_VES_COLLECTOR_USERNAME = "${SDNR_VES_COLLECTOR_USERNAME}"; private static final String PROPERTY_KEY_VES_COLLECTOR_PASSWORD = "VES_COLLECTOR_PASSWORD"; - private static final String DEFAULT_VALUE_VES_COLLECTOR_PASSWORD = "sample1"; + private static final String DEFAULT_VALUE_VES_COLLECTOR_PASSWORD = "${SDNR_VES_COLLECTOR_PASSWORD}"; private static final String PROPERTY_KEY_VES_COLLECTOR_VERSION = "VES_COLLECTOR_VERSION"; - private static final String DEFAULT_VALUE_VES_COLLECTOR_VERSION = "v7"; + private static final String DEFAULT_VALUE_VES_COLLECTOR_VERSION = "${SDNR_VES_COLLECTOR_VERSION}"; + private static final String DEFAULT_VALUE_VES_COLLECTOR_VERSION_NA = "v7"; private static final String PROPERTY_KEY_REPORTING_ENTITY_NAME = "REPORTING_ENTITY_NAME"; - private static final String DEFAULT_VALUE_REPORTING_ENTITY_NAME = "ONAP SDN-R"; + private static final String DEFAULT_VALUE_REPORTING_ENTITY_NAME = "${SDNR_VES_COLLECTOR_REPORTING_ENTITY_NAME}"; + private static final String DEFAULT_VALUE_REPORTING_ENTITY_NAME_NA = "ONAP SDN-R"; private static final String PROPERTY_KEY_EVENTLOG_DETAIL = "EVENTLOG_MSG_DETAIL"; - private static final String DEFAULT_VALUE_EVENTLOG_DETAIL = "SHORT"; // "SHORT", "MEDIUM", "LONG" + private static final String DEFAULT_VALUE_EVENTLOG_DETAIL = "${SDNR_VES_COLLECTOR_EVENTLOG_MSG_DETAIL}"; + private static final String DEFAULT_VALUE_EVENTLOG_DETAIL_NA = "SHORT"; // "SHORT", "MEDIUM", "LONG" private static ConfigurationFileRepresentation configuration; @@ -73,12 +79,14 @@ public class VESCollectorCfgImpl implements VESCollectorCfgService, Configuratio @Override public String getReportingEntityName() { - return configuration != null ? configuration.getProperty(SECTION_MARKER, PROPERTY_KEY_REPORTING_ENTITY_NAME) : "ONAP SDN-R"; + String v = configuration.getProperty(SECTION_MARKER, PROPERTY_KEY_REPORTING_ENTITY_NAME); + return (v == null || v.isBlank()) ? DEFAULT_VALUE_REPORTING_ENTITY_NAME_NA : v; } @Override public String getEventLogMsgDetail() { - return configuration != null ?configuration.getProperty(SECTION_MARKER, PROPERTY_KEY_EVENTLOG_DETAIL) : DEFAULT_VALUE_EVENTLOG_DETAIL; + String v = configuration.getProperty(SECTION_MARKER, PROPERTY_KEY_EVENTLOG_DETAIL); + return (v == null || v.isBlank()) ? DEFAULT_VALUE_EVENTLOG_DETAIL_NA : v; } @Override @@ -107,7 +115,8 @@ public class VESCollectorCfgImpl implements VESCollectorCfgService, Configuratio } public String getVersion() { - return configuration.getProperty(SECTION_MARKER, PROPERTY_KEY_VES_COLLECTOR_VERSION); + String v = configuration.getProperty(SECTION_MARKER, PROPERTY_KEY_VES_COLLECTOR_VERSION); + return (v == null || v.isBlank()) ? DEFAULT_VALUE_VES_COLLECTOR_VERSION_NA : v; } public boolean isTrustAllCerts() { @@ -116,9 +125,12 @@ public class VESCollectorCfgImpl implements VESCollectorCfgService, Configuratio @Override public synchronized void defaults() { - configuration.setPropertyIfNotAvailable(SECTION_MARKER, PROPERTY_KEY_VES_COLLECTOR_ENABLED, DEFAULT_VALUE_VES_COLLECTOR_ENABLED); - configuration.setPropertyIfNotAvailable(SECTION_MARKER, PROPERTY_KEY_VES_COLLECTOR_TLS_ENABLED, Boolean.FALSE); - configuration.setPropertyIfNotAvailable(SECTION_MARKER, PROPERTY_KEY_VES_COLLECTOR_TRUST_ALL_CERTS, Boolean.FALSE); + configuration.setPropertyIfNotAvailable(SECTION_MARKER, PROPERTY_KEY_VES_COLLECTOR_ENABLED, + DEFAULT_VALUE_VES_COLLECTOR_ENABLED); + configuration.setPropertyIfNotAvailable(SECTION_MARKER, PROPERTY_KEY_VES_COLLECTOR_TLS_ENABLED, + DEFAULT_VALUE_VES_COLLECTOR_TLS_ENABLED); + configuration.setPropertyIfNotAvailable(SECTION_MARKER, PROPERTY_KEY_VES_COLLECTOR_TRUST_ALL_CERTS, + DEFAULT_VALUE_VES_COLLECTOR_TRUST_ALL_CERTS); configuration.setPropertyIfNotAvailable(SECTION_MARKER, PROPERTY_KEY_VES_COLLECTOR_USERNAME, DEFAULT_VALUE_VES_COLLECTOR_USERNAME); configuration.setPropertyIfNotAvailable(SECTION_MARKER, PROPERTY_KEY_VES_COLLECTOR_PASSWORD, diff --git a/sdnr/wt/devicemanager-core/provider/src/test/java/org/onap/ccsdk/features/sdnr/wt/devicemanager/test/TestVESCollectorClient.java b/sdnr/wt/devicemanager-core/provider/src/test/java/org/onap/ccsdk/features/sdnr/wt/devicemanager/test/TestVESCollectorClient.java index 1ff8efafb..9198e84fe 100644 --- a/sdnr/wt/devicemanager-core/provider/src/test/java/org/onap/ccsdk/features/sdnr/wt/devicemanager/test/TestVESCollectorClient.java +++ b/sdnr/wt/devicemanager-core/provider/src/test/java/org/onap/ccsdk/features/sdnr/wt/devicemanager/test/TestVESCollectorClient.java @@ -21,16 +21,20 @@ */ package org.onap.ccsdk.features.sdnr.wt.devicemanager.test; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; import com.google.common.io.Files; import java.io.File; import java.io.FileNotFoundException; import java.io.IOException; import java.nio.charset.StandardCharsets; import org.junit.After; +import org.junit.Before; import org.junit.Test; import org.onap.ccsdk.features.sdnr.wt.common.configuration.ConfigurationFileRepresentation; import org.onap.ccsdk.features.sdnr.wt.devicemanager.types.VESMessage; import org.onap.ccsdk.features.sdnr.wt.devicemanager.vescollectorconnector.impl.VESCollectorServiceImpl; +import org.onap.ccsdk.features.sdnr.wt.devicemanager.vescollectorconnector.impl.config.VESCollectorCfgImpl; public class TestVESCollectorClient { @@ -44,6 +48,7 @@ public class TestVESCollectorClient { private static final VESMessage message = new VESMessage("Test Message"); private static final String CONFIG_FILE = "test.properties"; + private static final String CONFIG_FILE2 = "test2.properties"; @Test public void testNoAuth() throws Exception { @@ -72,10 +77,26 @@ public class TestVESCollectorClient { vesClient.close(); } + @Test + public void testDefaultConfigValues() throws IOException { + Files.asCharSink(new File(CONFIG_FILE2), StandardCharsets.UTF_8).write(""); + ConfigurationFileRepresentation cfg = new ConfigurationFileRepresentation(CONFIG_FILE2); + VESCollectorCfgImpl vesConfig = new VESCollectorCfgImpl(cfg); + assertEquals("ONAP SDN-R", vesConfig.getReportingEntityName()); + assertEquals("SHORT", vesConfig.getEventLogMsgDetail()); + assertEquals("v7",vesConfig.getVersion()); + assertFalse(vesConfig.isVESCollectorEnabled()); + assertFalse(vesConfig.isTrustAllCerts()); + + } + + + @Before @After public void after() throws InterruptedException, IOException { delete(new File(CONFIG_FILE)); + delete(new File(CONFIG_FILE2)); } @@ -85,8 +106,10 @@ public class TestVESCollectorClient { delete(c); } } - if (!f.delete()) { - throw new FileNotFoundException("Failed to delete file: " + f); + if(f.exists()) { + if (!f.delete()) { + throw new FileNotFoundException("Failed to delete file: " + f); + } } } } 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 272eabe86..120d685d8 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 @@ -1,172 +1,212 @@ # Abbreviations -| **Abbreviation** | **Description** | -| ---------------: | ---------------- | -| AAF | [Application Authorization Framework](https://wiki.onap.org/display/DW/Application+Authorization+Framework+Project) | -| A&AI | [Active & Available Inventory](https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project) | -| AAA | [Authentication, Authorization and Accounting](https://en.wikipedia.org/wiki/AAA_(computer_security)) | -| AID | Architecture Integration Document | -| APPC | [Application Controller](https://wiki.onap.org/display/DW/Application+Controller+Project) | -| BPEL | Business Process Execution Language -| BPMN | [Business Process Model and Notation or Business Process Management Notation](https://en.wikipedia.org/wiki/Business_Process_Model_and_Notation) | -| BRMS | Business Rules Management System | -| BSS | Business Support System | -| CCSDK | Common Controller SDK project | -| CDAP | [Cask Data Application Platform](https://cdap.io/) | -| CDS | Controller Design Studio | -| CI/CD | Continuous Integration / Continuous Delivery | -| CL | Control Loop | -| CLAMP | Closed Loop Automation Management Platform (project) | -| CLI | [Command Line Interface (project)](https://wiki.onap.org/display/DW/Command+Line+Interface+Project) | -| CMA | Change Management Application (within ONAP) | -| CNF | Cloud Native network Function. | -| COE | Container Orchestration Engine | -| CPE | Customer Premise Equipment | -| CSAR | [Cloud Service ARchive (link)](http://openbaton.github.io/documentation/tosca-CSAR-onboarding/) | -| DAO | [Data Access Object](https://en.wikipedia.org/wiki/Data_access_object) | -| DCAE | [Data Collection Analytics & Events](https://wiki.onap.org/pages/viewpage.action?pageId=6592895) | -| DDoS | Distributed Denial-of-Service attack | -| DG | Directed Graph | -| DG Builder | Directed Graph Builder | -| DMaaP | [Data Movement as a Platform](https://wiki.onap.org/display/DW/DMaaP) | -| DME | [Direct Messaging Engine (common service within ONAP)](https://wiki.onap.org/display/DW/Common+Services) | -| DNS | Domain Name System | -| DPDK | Data Plane Development Kit | -| EELF | [Event and Error-Logging Framework](https://wiki.onap.org/display/DW/Common+Services) | -| EMS | [Element Management System](https://en.wikipedia.org/wiki/Element_management_system) | -| ESR | [External System Register](https://wiki.onap.org/pages/viewpage.action?pageId=5734948) | -| ETSI | [European Telecommunications Standards Institute](http://www.etsi.org/technologies-clusters/technologies/689-network-functions-virtualisation) | -| EUAG | [ONAP End User Advisory Group](https://wiki.lfnetworking.org/pages/viewpage.action?pageId=2916362) | -| FCAPS | Fault Configuration Accounting Performance Security | -| GBP | [Group-Based Policy ](https://wiki.openstack.org/wiki/GroupBasedPolicy) | -| GNFC | [Genric Network Function Controller](https://wiki.onap.org/download/attachments/45300148/ONAP_GNF_ControllersSOL003.pptx?version=1&modificationDate=1548619943000&api=v2) | -| GUI | [Graphical User Interface](https://en.wikipedia.org/wiki/Graphical_user_interface) | -| HAS | [Homing and Allocation Service](https://wiki.onap.org/pages/viewpage.action?pageId=16005528) | -| HDFS | Hadoop Distributed File System | -| HPA | Hardware Platform Awareness | -| HTTP | HyperText Transfer Protococol | -| HV VES | [High Volume Virtual function Event Stream](https://wiki.onap.org/display/DW/High+Volume+VES+Collector) | -| IAM/IDAM | Identity and Access Management | -| ICE | Incubation and Certification Environment | -| IDS | [Intrusion Detection System](https://en.wikipedia.org/wiki/Intrusion_detection_system) | -| IETF | [Internet Engineering Task Force](http://www.ietf.org) | -| IKE | [Internet Key Exchange](https://en.wikipedia.org/wiki/Internet_Key_Exchange) | -| IPS | [Intrusion Prevention System](https://en.wikipedia.org/wiki/Intrusion_detection_system) | -| IPSEC | [Internet Protocol Security](https://en.wikipedia.org/wiki/IPsec) | -| JAR | [Java Archive](https://en.wikipedia.org/wiki/JAR_(file_format)) | -| JSC | [Java Service Container](https://wiki.onap.org/display/DW/Common+Services) | -| JSON | JavaScript Object Notation | -| LCM | Life Cycle Management | -| LFN CVC | [Linux Foundation Networking Compliance/Verification Committee](https://wiki.onap.org/display/DW/LFN+CVC+Testing+in+VNFSDK) | -| LFN CVP | [Linux Foundation Networking Compliance/Verification Program](https://wiki.onap.org/display/DW/LFN+CVC+Testing+in+VNFSDK) | -| LRM | Local Resource Monitor | -| M0 | Release Kick-off milestone. See also Release Lifecycle | -| M1 | Release Planning milestone. See also Release Lifecycle | -| M2 | Release Functionality Freeze milestone. See also Release Lifecycle | -| M3 | Release API Freeze milestone. See also Release Lifecycle | -| M4 | Release Code Freeze milestone. See also Release Lifecycle | -| MACD | (Vendor specific) Move Add Change Delete/Disconnect | -| MANO | MANagement and Organization of NFV | -| MD-SAL | Model Driven Service Abstraction Layer | -| MR | Message Router (a Common Service of ONAP) | -| MOP | Method of Procedure | -| MOTS | Mechanized Operations Tracking System | -| MSB | Microservice Bus | -| MSO | [Master Service Orchestrator](https://wiki.onap.org/pages/viewpage.action?pageId=1015834) | -| MVP | [Minimum Viable Product](https://en.wikipedia.org/wiki/Minimum_viable_product) | -| NAI | Network Artificial Intelligence | -| NANCSP | Network Cloud Service Provider | -| NBI | North Bound Interface | -| NEP | Network Equipment Provider | -| NETCONF | [Network Configuration Protocol](https://en.wikipedia.org/wiki/NETCONF) | -| NFV | [Network Function Virtualization](https://en.wikipedia.org/wiki/Network_function_virtualization) | -| NFVI | [network functions virtualization infrastructure](https://www.sdxcentral.com/nfv/definitions/nfv-mano/) | -| 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 | -| ONAP | [Open Network Automation Platform](https://wiki.onap.org/pages/viewpage.action?pageId=1015843) | -| OOF | ONAP Optimization Framework | -| ODL | [OpenDaylight](https://www.opendaylight.org/) | -| 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) | -| PCI | Physical Cell ID | -| pCPE | physical Customer Premise Equipment | -| PDP-x | Policy Decision Point - XACML (ONAP) | -| PDP-d | Policy Decision Point - Drools (ONAP) | -| PO | Platform Orchestrator | -| PoC | Proof of Concept | -| POMBA | [Post Orchestration Model Based Audit](https://wiki.onap.org/display/DW/POMBA) | -| PNDA | [Open source Platform for Network Data Analytics](https://wiki.onap.org/display/DW/Integrating+PNDA) | -| PNF | Physical Network Function | -| RCA | Root Cause Analysis | -| RCT | Reference Connection Tool | -| REST | [Representational State Transfer](https://en.wikipedia.org/wiki/Representational_state_transfer) | -| 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) | -| SDC | Service Design and Creation (component of ONAP for visual modeling and design) | -| SDN | [Software-defined networking](https://en.wikipedia.org/wiki/Software-defined_networking) | -| SDN-C | [SDN-Controller](https://wiki.onap.org/display/DW/SDN+Controller+Development+Guide) | -| SDN-R | [SDN-Radio](https://wiki.onap.org/display/DW/SDN-R) | -| SDN-GP | Software Defined Network - Global Platform | -| SEBA | SDN-Enabled Broadband Access, see also | -| SLA | Service Level Agreement | -| SLI | Service Logic Interpreter | -| SME | Subject Matter Expert | -| SMTP | Simple Mail Transfer Protocol | -| SNMP | Simple Network Management Protocol | -| SO | [Service Orchestrator (project)](https://wiki.onap.org/display/DW/Service+Orchestrator+Project) | -| SOT | Source Of Truth | -| SR-IOV | [Single-Root Input/Output Virtualization](https://en.wikipedia.org/wiki/Single-root_input/output_virtualization) | -| SSL | [Secure Sockets Layer](https://en.wikipedia.org/wiki/Transport_Layer_Security) | -| SUPP | (Vendor Specific) short for supplement, changing a connection before activation | -| Swagger | legacy name for the OpenAPI Specification | -| TCP | Transmission Control Protocol | -| TEM | Telecom Electronics Manufacturer | -| TLS | [Transport Layer Security](https://en.wikipedia.org/wiki/Transport_Layer_Security) | -| TOSCA | [Topology and Orchestration Specification for Cloud Applications](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=tosca) | -| TPS | Transactions Per Second | -| TSC | Technical Steering Committee | -| U-UI | [Usecase User Interface](https://wiki.onap.org/display/DW/Usecase+UI+Project) | -| UI | [User Interface](https://en.wikipedia.org/wiki/User_interface) | -| UX | [User Experience](https://en.wikipedia.org/wiki/User_experience) | -| vCE | virtual CE (Customer Edge) router (an example VNF) | -| vCPE | Virtual Customer Premise Equipment | -| vDNS | Virtual Domain Name Server (an example VNF) | -| VDU | [Virtualisation Deployment Unit](https://wiki.onap.org/display/DW/Comparison+of+Current+R3+Clean+Version+with+IFA011+v2.5.1) | -| VES | [Virtual function Event Stream](https://wiki.opnfv.org/download/attachments/6819329/OPNVF%20VES.pptx?version=4&modificationDate=1466395653000&api=v2) | -| vF | Virtual Firewall (an example VNF) | -| VF | Virtual Function | -| VFC | [Virtual Function Controller](https://wiki.onap.org/display/DW/Virtual+Function+Controller+Project) | -| VFC | Virtual Function Component (Resource Onboarding) | -| vfModule | Virtual Function Module | -| VID | Virtual Instantiation Deployment | -| VID | [Virtual Infrastructure Deployment (Project)](https://wiki.onap.org/display/DW/Virtual+Infrastructure+Deployment+Project) | -| VIM | Virtualized Infrastructure Manager | -| VLAN | Virtual Local Area Network | -| VM | Virtual Machine | -| VNF | [Virtual Network Function](http://searchsdn.techtarget.com/definition/virtual-network-functions) | -| VNFC | Virtual Network Function Component | -| VNFD | [VNF Descriptor](https://wiki.onap.org/pages/viewpage.action?pageId=8226059) | -| VNFM | VNF Manager | -| VNO | Virtual Network Operator | -| vPE | virtual PE (Provider Edge) router (an example of a VNF) | -| VPP | [Vector Packet Processing](https://wiki.fd.io/view/VPP/What_is_VPP%3F) | -| 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)) | -| xNF | The combination of PNF and VNF; Network Function | -| YANG | Yet Another Next Generation - a Data Modeling Language for the Network Configuration Protocol (NETCONF) | +|**Abbreviation**|**Description**| +|----------------|---------------| +| AAF | [Application Authorization Framework](https://wiki.onap.org/display/DW/Application+Authorization+Framework+Project) | +| A&AI | [Active & Available Inventory](https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project) | +| AAA | [Authentication, Authorization and Accounting](https://en.wikipedia.org/wiki/AAA_(computer_security)) | +| AEC | AT&T Edge Cloud | +| AIC | AT&T Integrated Cloud | +| AID | Architecture Integration Document | +| APPC | [Application Controller](https://wiki.onap.org/display/DW/Application+Controller+Project) | +| BPEL | Business Process Execution Language | +| BPMN | [Business Process Model and Notation or Business Process Management Notation](https://en.wikipedia.org/wiki/Business_Process_Model_and_Notation) | +| BRMS | Business Rules Management System | +| BSS | Business Support System | +| CCSDK | Common Controller SDK project | +| CDAP | [Cask Data Application Platform](https://cdap.io/) | +| CDR | Charging Data Record | +| CDS | Controller Design Studio | +| CI/CD | Continuous Integration / Continuous Delivery | +| Cinder | OpenStack Block Storage | +| CL | Control Loop | +| CLAMP | Closed Loop Automation Management Platform (project) | +| CLI | [Command Line Interface (project)](https://wiki.onap.org/display/DW/Command+Line+Interface+Project) | +| CMA | Change Management Application (within ONAP) | +| CN | Core Network | +| CNF | Cloud Native network Function. | +| COE | Container Orchestration Engine | +| CPE | Customer Premise Equipment | +| CSAR | [Cloud Service ARchive (link)](http://openbaton.github.io/documentation/tosca-CSAR-onboarding/) | +| CU | Centralized Unit | +| DAO | [Data Access Object](https://en.wikipedia.org/wiki/Data_access_object) | +| DCAE | [Data Collection Analytics and Events](https://wiki.onap.org/pages/viewpage.action?pageId=6592895) | +| DDoS | Distributed Denial-of-Service attack | +| DG | Directed Graph | +| DG Builder | Directed Graph Builder | +| DMaaP | [Data Movement as a Platform](https://wiki.onap.org/display/DW/DMaaP) | +| DME | [Direct Messaging Engine (common service within ONAP)](https://wiki.onap.org/display/DW/Common+Services) | +| DMIP | Device Management Interface Profile | +| DNS | Domain Name System | +| DPDK | Data Plane Development Kit | +| DU | Distributed Unit | +| ECA | External Content Adapter | +| ECOMP | Enhanced, Control, Orchestration, Management and Policy | +| EELF | [Event&Error LoggingFramework](https://wiki.onap.org/display/DW/Common+Services) | +| EMS | [Element Management System](https://en.wikipedia.org/wiki/Element_management_system) | +| ESR | [External System Register](https://wiki.onap.org/pages/viewpage.action?pageId=5734948) | +| ETSI | [European Telecommunications Standards Institute](http://www.etsi.org/technologies-clusters/technologies/689-network-functions-virtualisation) | +| EUAG | [ONAP End User Advisory Group](https://wiki.lfnetworking.org/pages/viewpage.action?pageId=2916362) | +| FCAPS | Fault Configuration Accounting Performance Security | +| FM | Fault Management | +| FQDN | Fully Qualified Domain Name | +| GBP | [Group-Based Policy ](https://wiki.openstack.org/wiki/GroupBasedPolicy) | +| Glance | OpenStack Image repository | +| GNFC | [Genric Network Function Controller](https://wiki.onap.org/download/attachments/45300148/ONAP_GNF_ControllersSOL003.pptx?version=1&modificationDate=1548619943000&api=v2) | +| GUI | [Graphical User Interface](https://en.wikipedia.org/wiki/Graphical_user_interface) | +| HAS | [Homing and Allocation Service](https://wiki.onap.org/pages/viewpage.action?pageId=16005528) | +| HDFS | Hadoop Distributed File System | +| Horizon | OpenStack GUI | +| HPA | Hardware Platform Awareness | +| HTTP | HyperText Transfer Protococol | +| HV VES | [High Volume Virtual function Event Stream](https://wiki.onap.org/display/DW/High+Volume+VES+Collector) | +| IAM/IDAM | Identity and Access Management | +| ICE | Incubation and Certification Environment | +| ICMMS | Syniverse Inter-carrier messaging solution | +| IDS | [Intrusion Detection System](https://en.wikipedia.org/wiki/Intrusion_detection_system) | +| IETF | [Internet Engineering Task Force](http://www.ietf.org) | +| IKE | [Internet KeyExchange](https://en.wikipedia.org/wiki/Internet_Key_Exchange) | +| IPS | [Intrusion Prevention System](https://en.wikipedia.org/wiki/Intrusion_detection_system) | +| IPSEC | [Internet Protocol Security](https://en.wikipedia.org/wiki/IPsec) | +| JAR | [Java Archive](https://en.wikipedia.org/wiki/JAR_(file_format)) | +| JSC | [JavaServiceContainer](https://wiki.onap.org/display/DW/Common+Services) | +| JSON | JavaScript Object Notation | +| Keystone | OpenStack Authorization Project | +| KVM | Kernel-based Virtual machine | +| LCM | Life Cycle Management | +| LDAP | Lightweight Directory Access Protocol | +| LFN CVC | [Linux Foundation Networking Compliance/Verification Committee](https://wiki.onap.org/display/DW/LFN+CVC+Testing+in+VNFSDK) | +| LFN CVP | [Linux Foundation Networking Compliance/Verification Program](https://wiki.onap.org/display/DW/LFN+CVC+Testing+in+VNFSDK) | +| LRM | Local Resource Monitor | +| M0 | Release Kick-off milestone. See also Release Lifecycle | +| M1 | Release Planning milestone. See also Release Lifecycle | +| M2 | Release Functionality Freeze milestone. See also Release Lifecycle | +| M3 | Release API Freeze milestone. See also Release Lifecycle | +| M4 | Release Code Freeze milestone. See also Release Lifecycle | +| MACD | (Vendor specific) Move Add Change Delete/Disconnect | +| MANO | MANagement and Organization of NFV | +| MD-SAL | Model Driven Service Abstraction Layer | +| MIND | Master Integrated Network Directory | +| MR | Message Router (a Common Service of ONAP) | +| MOP | Method of Procedure | +| MOTS | Mechanized Operations Tracking System | +| MSB | Microservice Bus | +| MSO | [Master Service Orchestrator](https://wiki.onap.org/pages/viewpage.action?pageId=1015834) | +| MVP | [Minimum ViableProduct](https://en.wikipedia.org/wiki/Minimum_viable_product) | +| NAI | Network Artificial Intelligence | +| NANCSP | Network Cloud Service Provider | +| NBI | North Bound Interface | +| NEP | Network Equipment Provider | +| NETCONF | [Network Configuration Protocol](https://en.wikipedia.org/wiki/NETCONF) | +| Neutron | OpenStack Networking | +| NFMF | Network Function Management Function | +| NFV | [Network Function Virtualization](https://en.wikipedia.org/wiki/Network_function_virtualization) | +| NFVI | [network functions virtualization infrastructure](https://www.sdxcentral.com/nfv/definitions/nfv-mano/) | +| NOD | Network On Demand | +| Nova | OpenStack compute | +| NS | Network Services | +| NS | (Vendor Specific) New Start | +| NSI | Network Slice Subnet Instance | +| NSMF | Network Slice Management Function | +| NSSMF | Network Slice Subnet Management Function | +| O-RAN | [O-RAN Alliance , OperatorDefined NextGeneration RadioAccessNetworksAlliance ](https://www.o-ran.org) | +| O-RAN-SC | [O-RAN SoftwareCommunity](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 | +| ONAP | [Open Network Automation Platform](https://wiki.onap.org/pages/viewpage.action?pageId=1015843) | +| OOF | ONAP Optimization Framework | +| ODL | [OpenDaylight](https://www.opendaylight.org/) | +| OOM | [ONAP Operations Manager](https://wiki.onap.org/display/DW/OOM+User+Guide) | +| OpenStack | A cloud operating system | +| OPNFV | [Open Platform for NFV Project](https://www.sdxcentral.com/nfv/definitions/opnfv/) | +| Originato | MMSC Any Non-AT&T MMSC that originally sent the request to ICMMS | +| 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) | +| PCI | Physical Cell ID | +| pCPE | physical Customer Premise Equipment | +| PDP-x | Policy Decision Point - XACML (ONAP) | +| PDP-d | Policy Decision Point - Drools (ONAP) | +| PM | Performance Management | +| PNDA | [OpensourcePlatform for Network DataAnalytics](https://wiki.onap.org/display/DW/Integrating+PNDA) | +| PNF | Physical Network Function | +| PnP | Plug and Play | +| PO | Platform Orchestrator | +| PoC | Proof of Concept | +| POMBA | [Post Orchestration Model Based Audit](https://wiki.onap.org/display/DW/POMBA) | +| PRH | Phyiical Network Function Registration Handler | +| Pub/Sub | Publisher/Subscriber | +| RAN | Radio Access Network | +| RCA | Root Cause Analysis | +| RCT | Reference Connection Tool | +| REST | [Representational State Transfer](https://en.wikipedia.org/wiki/Representational_state_transfer) | +| RESTCONF | A protocol based on HTTP for configuring data defined in YANG | +| RO | Resource Orchestrator | +| RPC | Remote Procedure Call | +| RU | Radio Unit | +| RRH | Remote Radio Head | +| S3P | [Stability, Security, Scalability, Performance](https://wiki.onap.org/pages/viewpage.action?pageId=16003367) | +| SDC | Service Design and Creation (component of ONAP for visual modeling and design) | +| SDN | [Software-defined networking](https://en.wikipedia.org/wiki/Software-defined_networking) | +| SDN-C | [SDN-Controller](https://wiki.onap.org/display/DW/SDN+Controller+Development+Guide) | +| SDN-R | [SDN-Radio, Router, ROADM - a set of model-driven application based on SDN-C](https://wiki.onap.org/display/DW/SDN-R) | +| SDN-GP | Software Defined Network - Global Platform | +| SEBA | SDN-Enabled Broadband Access, see also | +| SLA | Service Level Agreement | +| SLI | Service Logic Interpreter | +| SME | Subject Matter Expert | +| SMTP | Simple Mail Transfer Protocol | +| SNMP | Simple Network Management Protocol | +| SO | [Service Orchestrator (project)](https://wiki.onap.org/display/DW/Service+Orchestrator+Project) | +| SON | Self-Organizing Networks | +| SOT | Source Of Truth | +| SR-IOV | [Single-Root Input/Output Virtualization](https://en.wikipedia.org/wiki/Single-root_input/output_virtualization) | +| SRS | Software Requirements Specification | +| SSL | [SecureSocketsLayer](https://en.wikipedia.org/wiki/Transport_Layer_Security) | +| SUPP | (Vendor Specific) short for supplement, changing a connection before activation | +| Swagger | legacy name for the OpenAPI Specification | +| Swift | OpenStack Object storage | +| TCP | Transmission Control Protocol | +| TEM | Telecom Electronics Manufacturer | +| TLS | [Transport Layer Security](https://en.wikipedia.org/wiki/Transport_Layer_Security) | +| TN | Transport Network | +| TOSCA | [Topology and Orchestration Specification for Cloud Applications](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=tosca) | +| TPS | Transactions Per Second | +| TSC | Technical Steering Committee | +| U-UI | [Usecase UserInterface](https://wiki.onap.org/display/DW/Usecase+UI+Project) | +| UI | [User Interface](https://en.wikipedia.org/wiki/User_interface) | +| UUI | User to User Information | +| UX | [User Experience](https://en.wikipedia.org/wiki/User_experience) | +| vCE | virtual CE (Customer Edge) router (an example VNF) | +| vCPE | Virtual Customer Premise Equipment | +| vDNS | Virtual Domain Name Server (an example VNF) | +| VDU | [Virtualisation Deployment Unit](https://wiki.onap.org/display/DW/Comparison+of+Current+R3+Clean+Version+with+IFA011+v2.5.1) | +| VES | [Virtual function EventStream](https://wiki.opnfv.org/download/attachments/6819329/OPNVF%20VES.pptx?version=4&modificationDate=1466395653000&api=v2) | +| vF | Virtual Firewall (an example VNF) | +| VF | Virtual Function | +| VFC | [Virtual Function Controller](https://wiki.onap.org/display/DW/Virtual+Function+Controller+Project) | +| VFC | Virtual Function Component (Resource Onboarding) | +| vfModule | Virtual Function Module | +| VID | Virtual Instantiation Deployment | +| VID | [Virtual Infrastructure Deployment (Project)](https://wiki.onap.org/display/DW/Virtual+Infrastructure+Deployment+Project) | +| VIM | Virtualized Infrastructure Manager | +| VLAN | Virtual Local Area Network | +| VM | Virtual Machine | +| VNF | [Virtual Network Function](http://searchsdn.techtarget.com/definition/virtual-network-functions) | +| VNFC | Virtual Network Function Component | +| VNFD | [VNF Descriptor](https://wiki.onap.org/pages/viewpage.action?pageId=8226059) | +| VNFM | VNF Manager | +| VNO | Virtual Network Operator | +| vPE | virtual PE (Provider Edge) router (an example of a VNF) | +| VPP | [Vector Packet Processing](https://wiki.fd.io/view/VPP/What_is_VPP%3F) | +| 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)) | +| 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 e15be5e5b..ac5bbe4f0 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 @@ -12,7 +12,7 @@ Network Elements are physical network functions (PNFs). A table view shows all c Network Elements can be marked as 'required'. If an element is required, it will stay available even if disconnected. If an element is not required, it will be deleted once disconnected. -By right-clicking on an element, an action menu opens. The menu allows to mount, unmount, view the details, edit and remove the element. Additionally, it links to several applications like [Fault](../pnfFault/README.md) and [Configure](../pnfConfig/README.md), which will be filtered to display information relevant to the selected element. +By right-clicking on an element, an action menu opens. The menu allows to mount, unmount, view the details, edit and remove the element. Additionally, it links to several applications like [Fault](pnfFault.html) and [Configure](pnfConfig.html), which will be filtered to display information relevant to the selected element. ### Connection Status Log diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/networkMap/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/networkMap/README.md index 98d413529..b538eb1f6 100644 --- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/networkMap/README.md +++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/networkMap/README.md @@ -31,7 +31,7 @@ The details panel shows information specific to the selected element. Sites offer information about itself, such as name, address and owner, and a short overview of its links and nodes data. The nodes are physical network elements, comparable to the elements of the 'connect' application, and offer an interface to other apps via buttons, such as connect, configure, and fault. Currently, those buttons are disabled. By clicking on a link, the given link is loaded into details. -If a link of type 'microwave' is selected, the 'calculate link' button is available, which opens the [Link Calculator](../linkCalculator/README.md) in a new tab or page. +If a link of type 'microwave' is selected, the 'calculate link' button is available, which opens the [Link Calculator](linkCalculator.html) in a new tab or page. Just like the map, the details panel updates the URL if data is loaded. Once again, the 'Network Map' application will try to load the element specified in the URL, if one is present. diff --git a/sdnr/wt/readthedocs/convert.sh b/sdnr/wt/readthedocs/convert.sh index 435751eb6..f50abf330 100755 --- a/sdnr/wt/readthedocs/convert.sh +++ b/sdnr/wt/readthedocs/convert.sh @@ -23,8 +23,8 @@ for file in ${markdown_files[@]}; do pandoc -s --toc -f markdown -t rst $file > $PATH_DOC_USERDOC_DST"$rstfile" done -cp "$BASEDIR"sdnr/wt/readthedocs/src/home.rst "$PATH_DOC_USERDOC_DST" -cp "$BASEDIR"sdnr/wt/readthedocs/src/index.rst "$PATH_DOC_DST" +#cp "$BASEDIR"sdnr/wt/readthedocs/src/home.rst "$PATH_DOC_USERDOC_DST" +#cp "$BASEDIR"sdnr/wt/readthedocs/src/index.rst "$PATH_DOC_DST" #echo "================Creating html==========================================" #/usr/local/bin/sphinx-build -b html $PATH_DOC_DST /home/jack/public_html/sdnr-trial/ diff --git a/sdnr/wt/readthedocs/src/home.rst b/sdnr/wt/readthedocs/src/home.rst deleted file mode 100644 index 888572188..000000000 --- a/sdnr/wt/readthedocs/src/home.rst +++ /dev/null @@ -1,31 +0,0 @@ - -.. contents:: - :depth: 3 -.. - -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 is integrated into ONAP. Therefore it is interfacing with PNFs - and VNFs and with other ONAP components, such as A&AI, DCAE and SO. -| `See abbreviations <abbreviations>`__ - -.. figure:: ./ONAP-SDN-R.png - :alt: SDN-R in ONAP - - SDN-R in ONAP - - -.. toctree:: - :maxdepth: 1 - - applications - installation - faq - abbreviations diff --git a/sdnr/wt/readthedocs/src/index.rst b/sdnr/wt/readthedocs/src/index.rst deleted file mode 100644 index 1da5c6c03..000000000 --- a/sdnr/wt/readthedocs/src/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -================= -SDN-R Online help -================= - -Below are the references for SDN-R User Documentation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - -.. toctree:: - :maxdepth: 1 - - guides/onap-user/home |