From 2267c842bdc69c69b695282311f17f6f33b2ebf5 Mon Sep 17 00:00:00 2001 From: sai-neetha Date: Mon, 22 Jul 2019 17:31:08 +0200 Subject: SDN-R readthedocs content changes SDN-R readthedocs content and tree structure changes Issue-ID: SDNC-819 Signed-off-by: sai-neetha Change-Id: I025d59d59dddc3d68bae5390ef541ca718939a50 --- docs/guides/onap-user/abbreviations.rst | 870 ++++++++++++++++++++- docs/guides/onap-user/applications.rst | 16 + docs/guides/onap-user/home.rst | 11 +- docs/guides/onap-user/installation.rst | 14 + .../onap-user/sdnr_Docker_Image_configuration.rst | 52 ++ .../sdnr_WT_Service_Configuration_parameters.rst | 118 +++ docs/index.rst | 2 - sdnr/wt/readthedocs/src/home.rst | 11 +- sdnr/wt/readthedocs/src/index.rst | 2 - 9 files changed, 1053 insertions(+), 43 deletions(-) create mode 100644 docs/guides/onap-user/applications.rst create mode 100644 docs/guides/onap-user/installation.rst create mode 100644 docs/guides/onap-user/sdnr_Docker_Image_configuration.rst create mode 100644 docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst diff --git a/docs/guides/onap-user/abbreviations.rst b/docs/guides/onap-user/abbreviations.rst index 3f4ab76d3..65e79bf39 100644 --- a/docs/guides/onap-user/abbreviations.rst +++ b/docs/guides/onap-user/abbreviations.rst @@ -5,28 +5,848 @@ Abbreviations ============= -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| **Abbreviation** | **Description** | -+====================+================================================================================================================+ -| A&AI | `Active and Available Inventory `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| AAA | `Authentication, Authorization and Accounting `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| DCAE | `Data Collection Analytics & Events `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| GUI | `Graphical User Interface `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| MSO | `Master Service Orchestrator `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| ONAP | `Open Network Automation Platform `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| SDN | `Software-defined networking `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| SDN-C | `SDN-Controller `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| SDN-R | `SDN-Radio `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| UI | `User Interface `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ -| UX | `User Experience `__ | -+--------------------+----------------------------------------------------------------------------------------------------------------+ ++-------------------+-------------------+ +| **Abbreviation** | **Description** | ++===================+===================+ +| AAF | `Application | +| | Authorization | +| | Framework `__ | ++-------------------+-------------------+ +| A&AI | `Active & | +| | Available | +| | Inventory `_ | +| | _ | ++-------------------+-------------------+ +| AAA | `Authentication, | +| | Authorization and | +| | Accounting `_ | +| | _ | ++-------------------+-------------------+ +| AID | Architecture | +| | Integration | +| | Document | ++-------------------+-------------------+ +| APPC | `Application | +| | Controller `__ | ++-------------------+-------------------+ +| BPEL | Business Process | +| | Execution | +| | Language | ++-------------------+-------------------+ +| BPMN | `Business Process | +| | Model and | +| | Notation or | +| | Business Process | +| | Management | +| | Notation `__ | ++-------------------+-------------------+ +| BRMS | Business Rules | +| | Management System | ++-------------------+-------------------+ +| BSS | Business Support | +| | System | ++-------------------+-------------------+ +| CCSDK | Common Controller | +| | SDK project | ++-------------------+-------------------+ +| CDAP | `Cask Data | +| | Application | +| | Platform `__ | ++-------------------+-------------------+ +| 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) `__ | ++-------------------+-------------------+ +| CMA | Change Management | +| | Application | +| | (within ONAP) | ++-------------------+-------------------+ +| CNF | Cloud Native | +| | network Function. | ++-------------------+-------------------+ +| COE | Container | +| | Orchestration | +| | Engine | ++-------------------+-------------------+ +| CPE | Customer Premise | +| | Equipment | ++-------------------+-------------------+ +| CSAR | `Cloud Service | +| | ARchive | +| | (link) `__ | ++-------------------+-------------------+ +| DAO | `Data Access | +| | Object `__ | ++-------------------+-------------------+ +| DCAE | `Data Collection | +| | Analytics & | +| | Events ` | +| | __ | ++-------------------+-------------------+ +| DDoS | Distributed | +| | Denial-of-Service | +| | attack | ++-------------------+-------------------+ +| DG | Directed Graph | ++-------------------+-------------------+ +| DG Builder | Directed Graph | +| | Builder | ++-------------------+-------------------+ +| DMaaP | `Data Movement as | +| | a | +| | Platform `_ | +| | _ | ++-------------------+-------------------+ +| DME | `Direct Messaging | +| | Engine (common | +| | service within | +| | ONAP) `__ | ++-------------------+-------------------+ +| DNS | Domain Name | +| | System | ++-------------------+-------------------+ +| DPDK | Data Plane | +| | Development Kit | ++-------------------+-------------------+ +| EELF | `Event and | +| | Error-Logging | +| | Framework `__ | ++-------------------+-------------------+ +| EMS | `Element | +| | Management | +| | System `__ | ++-------------------+-------------------+ +| ESR | `External System | +| | Register `__ | ++-------------------+-------------------+ +| ETSI | `European | +| | Telecommunication | +| | s | +| | Standards | +| | Institute `__ | ++-------------------+-------------------+ +| EUAG | `ONAP End User | +| | Advisory | +| | Group `__ | ++-------------------+-------------------+ +| FCAPS | Fault | +| | Configuration | +| | Accounting | +| | Performance | +| | Security | ++-------------------+-------------------+ +| GBP | `Group-Based | +| | Policy `__ | ++-------------------+-------------------+ +| GNFC | `Genric Network | +| | Function | +| | Controller `__ | ++-------------------+-------------------+ +| GUI | `Graphical User | +| | Interface `_ | +| | _ | ++-------------------+-------------------+ +| HAS | `Homing and | +| | Allocation | +| | Service `__ | ++-------------------+-------------------+ +| HDFS | Hadoop | +| | Distributed File | +| | System | ++-------------------+-------------------+ +| HPA | Hardware Platform | +| | Awareness | ++-------------------+-------------------+ +| HTTP | HyperText | +| | Transfer | +| | Protococol | ++-------------------+-------------------+ +| HV VES | `High Volume | +| | Virtual function | +| | Event | +| | Stream ` | +| | __ | ++-------------------+-------------------+ +| IAM/IDAM | Identity and | +| | Access Management | ++-------------------+-------------------+ +| ICE | Incubation and | +| | Certification | +| | Environment | ++-------------------+-------------------+ +| IDS | `Intrusion | +| | Detection | +| | System `__ | ++-------------------+-------------------+ +| IETF | `Internet | +| | Engineering Task | +| | Force `__ | ++-------------------+-------------------+ +| IKE | `Internet Key | +| | Exchange `__ | ++-------------------+-------------------+ +| IPS | `Intrusion | +| | Prevention | +| | System `__ | ++-------------------+-------------------+ +| IPSEC | `Internet | +| | Protocol | +| | Security `__ | ++-------------------+-------------------+ +| JAR | `Java | +| | Archive `__ | ++-------------------+-------------------+ +| JSC | `Java Service | +| | Container `__ | ++-------------------+-------------------+ +| JSON | JavaScript Object | +| | Notation | ++-------------------+-------------------+ +| LCM | Life Cycle | +| | Management | ++-------------------+-------------------+ +| LFN CVC | `Linux Foundation | +| | Networking | +| | Compliance/Verifi | +| | cation | +| | Committee `__ | ++-------------------+-------------------+ +| LFN CVP | `Linux Foundation | +| | Networking | +| | Compliance/Verifi | +| | cation | +| | Program | +| | `__ | ++-------------------+-------------------+ +| 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 `__ | ++-------------------+-------------------+ +| MVP | `Minimum Viable | +| | Product `__ | ++-------------------+-------------------+ +| NAI | Network | +| | Artificial | +| | Intelligence | ++-------------------+-------------------+ +| NANCSP | Network Cloud | +| | Service Provider | ++-------------------+-------------------+ +| NBI | North Bound | +| | Interface | ++-------------------+-------------------+ +| NEP | Network Equipment | +| | Provider | ++-------------------+-------------------+ +| NETCONF | `Network | +| | Configuration | +| | Protocol `__ | ++-------------------+-------------------+ +| NFV | `Network Function | +| | Virtualization `__ | ++-------------------+-------------------+ +| NFVI | `network | +| | functions | +| | virtualization | +| | infrastructure `__ | ++-------------------+-------------------+ +| NOD | Network On Demand | ++-------------------+-------------------+ +| NS | Network Services | ++-------------------+-------------------+ +| NS | (Vendor Specific) | +| | New Start | ++-------------------+-------------------+ +| OA&M | Operations, | +| | Administration | +| | and Management | ++-------------------+-------------------+ +| OMF | Operational | +| | Management | +| | Framework (of | +| | ONAP) | ++-------------------+-------------------+ +| OMSA | ONAP Microservice | +| | Architecture | ++-------------------+-------------------+ +| ONAP | `Open Network | +| | Automation | +| | Platform `__ | ++-------------------+-------------------+ +| OOF | ONAP Optimization | +| | Framework | ++-------------------+-------------------+ +| ODL | `OpenDaylight `__ | ++-------------------+-------------------+ +| OOM | `ONAP Operations | +| | Manager `__ | ++-------------------+-------------------+ +| OPNFV | `Open Platform | +| | for NFV | +| | Project `__ | ++-------------------+-------------------+ +| OSAM | `Open Source | +| | Access | +| | Manager `__ | ++-------------------+-------------------+ +| 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 `__ | ++-------------------+-------------------+ +| PNDA | `Open source | +| | Platform for | +| | Network Data | +| | Analytics `__ | ++-------------------+-------------------+ +| PNF | Physical Network | +| | Function | ++-------------------+-------------------+ +| RCA | Root Cause | +| | Analysis | ++-------------------+-------------------+ +| RCT | Reference | +| | Connection Tool | ++-------------------+-------------------+ +| REST | `Representational | +| | State | +| | Transfer `__ | ++-------------------+-------------------+ +| RESTCONF | REST + NETCONF | ++-------------------+-------------------+ +| RO | Resource | +| | Orchestrator | ++-------------------+-------------------+ +| RPC | Remote Procedure | +| | Call | ++-------------------+-------------------+ +| S3P | `Stability, | +| | Security, | +| | Scalability, | +| | Performance `__ | ++-------------------+-------------------+ +| SDC | Service Design | +| | and Creation | +| | (component of | +| | ONAP for visual | +| | modeling and | +| | design) | ++-------------------+-------------------+ +| SDN | `Software-defined | +| | networking `__ | ++-------------------+-------------------+ +| SDN-C | `SDN-Controller < | +| | https://wiki.onap | +| | .org/display/DW/S | +| | DN+Controller+Dev | +| | elopment+Guide>`_ | +| | _ | ++-------------------+-------------------+ +| SDN-R | `SDN-Radio | +| | `__ | ++-------------------+-------------------+ +| 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) `__ | ++-------------------+-------------------+ +| SOT | Source Of Truth | ++-------------------+-------------------+ +| SR-IOV | `Single-Root | +| | Input/Output | +| | Virtualization `__ | ++-------------------+-------------------+ +| SSL | `Secure Sockets | +| | Layer `__ | ++-------------------+-------------------+ +| 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 `__ | ++-------------------+-------------------+ +| TOSCA | `Topology and | +| | Orchestration | +| | Specification for | +| | Cloud | +| | Applications `__ | ++-------------------+-------------------+ +| TPS | Transactions Per | +| | Second | ++-------------------+-------------------+ +| TSC | Technical | +| | Steering | +| | Committee | ++-------------------+-------------------+ +| U-UI | `Usecase User | +| | Interface `__ | ++-------------------+-------------------+ +| UI | `User | +| | Interface `__ | ++-------------------+-------------------+ +| UX | `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 `__ | ++-------------------+-------------------+ +| VES | `Virtual function | +| | Event | +| | Stream `__ | ++-------------------+-------------------+ +| vF | Virtual Firewall | +| | (an example VNF) | ++-------------------+-------------------+ +| VF | Virtual Function | ++-------------------+-------------------+ +| VFC | `Virtual Function | +| | Controller `__ | ++-------------------+-------------------+ +| VFC | Virtual Function | +| | Component | +| | (Resource | +| | Onboarding) | ++-------------------+-------------------+ +| vfModule | Virtual Function | +| | Module | ++-------------------+-------------------+ +| VID | Virtual | +| | Instantiation | +| | Deployment | ++-------------------+-------------------+ +| VID | `Virtual | +| | Infrastructure | +| | Deployment | +| | (Project) `__ | ++-------------------+-------------------+ +| VIM | Virtualized | +| | Infrastructure | +| | Manager | ++-------------------+-------------------+ +| VLAN | Virtual Local | +| | Area Network | ++-------------------+-------------------+ +| VM | Virtual Machine | ++-------------------+-------------------+ +| VNF | `Virtual Network | +| | Function `__ | ++-------------------+-------------------+ +| VNFC | Virtual Network | +| | Function | +| | Component | ++-------------------+-------------------+ +| VNFD | `VNF | +| | Descriptor `__ | ++-------------------+-------------------+ +| VNFM | VNF Manager | ++-------------------+-------------------+ +| VNO | Virtual Network | +| | Operator | ++-------------------+-------------------+ +| vPE | virtual PE | +| | (Provider Edge) | +| | router (an | +| | example of a VNF) | ++-------------------+-------------------+ +| VPP | `Vector Packet | +| | Processing `__ | ++-------------------+-------------------+ +| VSP | Vendor Software | +| | Product (from SDC | +| | Demo Guide) | ++-------------------+-------------------+ +| VTP | `VNF Test | +| | Platform `__ | ++-------------------+-------------------+ +| VVP | `VNF Validation | +| | Program `__ | ++-------------------+-------------------+ +| WAR | `Web application | +| | Archive `__ | ++-------------------+-------------------+ +| YANG | A Data Modeling | +| | Language for the | +| | Network | +| | Configuration | +| | Protocol | +| | (NETCONF) | ++-------------------+-------------------+ diff --git a/docs/guides/onap-user/applications.rst b/docs/guides/onap-user/applications.rst new file mode 100644 index 000000000..fb908da18 --- /dev/null +++ b/docs/guides/onap-user/applications.rst @@ -0,0 +1,16 @@ +Applications +============ +Below are the UX Applications. + + +.. toctree:: + :maxdepth: 1 + + connect + pnfFault + pnfMaintenance + pnfConfig + pnfPerformance + pnfInventory + pnfMediator + diff --git a/docs/guides/onap-user/home.rst b/docs/guides/onap-user/home.rst index cf8b19254..888572188 100644 --- a/docs/guides/onap-user/home.rst +++ b/docs/guides/onap-user/home.rst @@ -25,10 +25,7 @@ microwave and millimeter wave radios, eNodeB, RRH, DAS equipment). .. toctree:: :maxdepth: 1 - connect - pnfFault - pnfMaintenance - pnfConfig - pnfPerformance - pnfInventory - pnfMediator + applications + installation + faq + abbreviations diff --git a/docs/guides/onap-user/installation.rst b/docs/guides/onap-user/installation.rst new file mode 100644 index 000000000..7fe4dafd3 --- /dev/null +++ b/docs/guides/onap-user/installation.rst @@ -0,0 +1,14 @@ +Installation +============ + +Below is the installation procedure for SDN-R Images and Configuration parameters + + +.. toctree:: + :maxdepth: 1 + + sdnr_WT_Service_Configuration_parameters + sdnr_Docker_Image_configuration + + + diff --git a/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst b/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst new file mode 100644 index 000000000..cd5f619a6 --- /dev/null +++ b/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst @@ -0,0 +1,52 @@ +.. contents:: + :depth: 3 +.. + +SDN-R Docker Image configuration +================================ + +Introduction +~~~~~~~~~~~~ + +ONAP SDN-R is running in a docker container using ONAP/SDN-C image +"onap/sdnc". + +The container is available as Alpine and Ubuntu version. The description +uses examples for the Alpine version. + +The alpine based sdnc docker imanges are stored in \ `ONAP Nexus sdnc +image `__. + +The docker image contains a Opendaylight distribution in a standard +configuration and ONAP/SDN-R specific microservices. + +The Root location of ODL Karaf directory structure +is \ *ODL\_HOME=/opt/opendaylight.* + +During container provisioning the installation of the feature is done, +according to the provided configuration setting. + +The docker image configuration is done by + +- Specific Environment variables settings + +- Files that are provided + +Container startup parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The SDN-R specific configurations are provided during container start.  + +Different SDN-R services are using different parameter to be installed. + ++------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+ +| **Parameter** | **Content** | **Description** | ++==================+=====================+=========================================================================================================================+ +| SDNRWT | true\|\ **false** | Set true to activate sdnr wt featureset. Set this during container start. | +| | | | +| | | Devicemanager configuration is provided via *$ODL\_HOME/etc/devicemanager.properties* | +| | | | +| | | See  `SDN-R WT Service Configuration parameters `__ | ++------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+ +| SDNRNORTHBOUND | true\|\ **false** | Set true to activate sdnr oofpci service. | ++------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst b/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst new file mode 100644 index 000000000..ed68ea517 --- /dev/null +++ b/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst @@ -0,0 +1,118 @@ +.. contents:: + :depth: 3 +.. + +SDN-R WT Service Configuration parameters +========================================= + +ODL is operated as a cluster. The configuration settings must be the +same for each cluster node. + +- `Sections <#SDN-RWTServiceConfigurationparameters-S>`__ + + - `toggleAlarmFilter <#SDN-RWTServiceConfigurationparameters-t>`__ + - `devicemonitor <#SDN-RWTServiceConfigurationparameters-d>`__ + +Backgrounds regarding the container inter structure is described +in \ `SDN-R Docker Image configuration `__. + +The configuration information of sdnr wireless transport parameters are +in a single file. + +For different devicemanager services, like DeviceMonitor there  are +individual sections in the configuration file available. + +Configuration file location:  +***$ODL\_HOME/etc/devicemanager.properties*** + +If SDN-R WT is starting + +- and the file exists, the configuration is used.  +- if it does not exist it will be created with the default parameters. + +Below an example of the content. + +- Example + :: + + [toggleAlarmFilter] + taEnabled=true + taDelay=3000 + + [es] + esCluster=sdnr + esArchiveCheckIntervalSeconds=0 + esArchiveLifetimeSeconds=2592000 + + [dcae] + dcaeUrl=off + dcaeUserCredentials=admin:admin + dcaeHeartbeatPeriodSeconds=120 + + [aai] + aaiUrl=off + aaiUserCredentials= + aaiHeaders=["X-TransactionId: 9999"] + aaiDeleteOnMountpointRemove=false + aaiTrustAllCerts=false + aaiPropertiesFile= + aaiApiVersion=aai/v13 + aaiApplicationId=SDNR + aaiClientConnectionTimeout=30000 + aaiPcks12ClientCertFile= + aaiPcks12ClientCertPassphrase= + + [pm] + pmEnabled=true + pmCluster=sdnr + + [devicemonitor] + SeverityconnectionLossOAM=Major + SeverityconnectionLossMediator=Major + SeverityconnectionLossNeOAM=Major + +Sections +-------- + +toggleAlarmFilter +~~~~~~~~~~~~~~~~~ + +Configure toggle alarm filter. + +taEnabled=true taDelay=3000 + ++-----------------+---------------+---------------+----------------+------------------------------------------------------+ +| **Parameter** | **Values** | **Default** | **Unit** | **Description** | ++=================+===============+===============+================+======================================================+ +| taEnabled | true, false | false | | Enable or disable this service | ++-----------------+---------------+---------------+----------------+------------------------------------------------------+ +| taDelay | number | | milliseconds | Integration time to take over the new alarm status | ++-----------------+---------------+---------------+----------------+------------------------------------------------------+ + +devicemonitor +~~~~~~~~~~~~~ + +Configure alarm severity of related alarms, generated by Device Monitor. + +`SDNC-616 `__ - SDN-R WT app need to change alarm severity "Configurable" for ConnectionLossxxx alarm family (received from Mediator) , when it passed to DCAE VES collector. + + +Syntax: Parameter=Value + +Example: SeverityconnectionLossOAM=Major + ++----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+ +| | **Values** | **Default** | **Unit** | **Description** | ++==================================+===============================================+===============+============+==============================================================+ +| SeverityconnectionLossOAM | NonAlarmed, Warning, Minor, Major, Critical | Major | | SDN-Controller <> Mediator | +| | | | | | +| | | | | Mountpoint monitoring. Indicates a not connected mounpoint | ++----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+ +| SeverityconnectionLossMediator | NonAlarmed, Warning, Minor, Major, Critical | Major | | SDN-Controller <> NetworkElement | +| | | | | | +| | | | | Device monitoring. No LTPs provided | ++----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+ +| SeverityconnectionLossNeOAM | NonAlarmed, Warning, Minor, Major, Critical | Major | | SDN-Controller <> NetworkElement | +| | | | | | +| | | | | Device monitoring. SSH Connetion, Core model not answering | ++----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+ diff --git a/docs/index.rst b/docs/index.rst index 78f6549f7..1da5c6c03 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,5 +10,3 @@ Below are the references for SDN-R User Documentation :maxdepth: 1 guides/onap-user/home - guides/onap-user/faq - guides/onap-user/abbreviations diff --git a/sdnr/wt/readthedocs/src/home.rst b/sdnr/wt/readthedocs/src/home.rst index cf8b19254..888572188 100644 --- a/sdnr/wt/readthedocs/src/home.rst +++ b/sdnr/wt/readthedocs/src/home.rst @@ -25,10 +25,7 @@ microwave and millimeter wave radios, eNodeB, RRH, DAS equipment). .. toctree:: :maxdepth: 1 - connect - pnfFault - pnfMaintenance - pnfConfig - pnfPerformance - pnfInventory - pnfMediator + applications + installation + faq + abbreviations diff --git a/sdnr/wt/readthedocs/src/index.rst b/sdnr/wt/readthedocs/src/index.rst index 78f6549f7..1da5c6c03 100644 --- a/sdnr/wt/readthedocs/src/index.rst +++ b/sdnr/wt/readthedocs/src/index.rst @@ -10,5 +10,3 @@ Below are the references for SDN-R User Documentation :maxdepth: 1 guides/onap-user/home - guides/onap-user/faq - guides/onap-user/abbreviations -- cgit 1.2.3-korg