docs/guides/onap-user/pnfFault.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

.. contents::
   :depth: 3
..

Fault Management
================

To operate a network, it is important to get an overview about the
currently raised alarms. The application offers basic fault management
of devices supporting ONF-TR-532. The alarms are classified according to
the severity level (warning, minor, major, critical).

Views
-----

The graphical user interface is separated into three views.

Current Problem List
~~~~~~~~~~~~~~~~~~~~

Lists all current active faults in the network. In addition, it also
lists alarms sent by the SDN controller itself, which detects connection
losses to the NetConf server (connectionLossOAM) or to a device via a
mediator to a device (connectionLossNeOAM).

Alarm Notifications
~~~~~~~~~~~~~~~~~~~

As long as the view is open, all alarm notifications received by the SDN
Controller are listed. Please note that refreshing the view will start
the collection again. Previous alarm notification can be viewed in the
alarm log.

Alarm Log
~~~~~~~~~

Next to the current active alarms an alarm log lists all alarm
notifications of the past.

Implementation
--------------

The application has two parts. While the server is listening for NetConf
notifications to store them in the database, the client retrieves the
information from the database and displays them in a table.

The server synchronizes with the current alarm lists of the devices.
Based on raised and cleared notifications, the current alarm status of
the network is calculated. The current alarms are stored in a database.
In addition, all Problem Notifications received by the SDN controller
are stored. There is no logic implemented on the client side.

An alarm status bar in the header of the web application informs the
operator about the health status of the network.

The ODLUX web application uses web sockets to update the graphical user
interface of the Alarm Notifications (devices) and Connection Status
Notifications in real-time.
<?xml version="1.0" encoding="UTF-8"?>
<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/maven-v4_0_0.xsd">

    <parent>
        <groupId>org.onap.ccsdk.parent</groupId>
        <artifactId>odlparent-lite</artifactId>
        <version>1.5.1</version>
    </parent>

    <modelVersion>4.0.0</modelVersion>
    <packaging>pom</packaging>
    <groupId>org.onap.sdnc.oam</groupId>
    <artifactId>installation-sdnc</artifactId>
    <version>1.8.0-SNAPSHOT</version>

    <name>sdnc-oam :: installation :: ${project.artifactId}</name>
    <description>Creates SDN Controller Docker container</description>

    <properties>
        <image.name>onap/sdnc-aaf-image</image.name>
        <standalone.image.name>onap/sdnc-image</standalone.image.name>
        <sdnc.project.version>${project.version}</sdnc.project.version>
        <sdnc.build.timestamp>${maven.build.timestamp}</sdnc.build.timestamp>
        <sdnc.northbound.version>1.8.0-SNAPSHOT</sdnc.northbound.version>
        <ccsdk.docker.version>0.7-STAGING-latest</ccsdk.docker.version>
        <ccsdk.features.version>0.7.0-SNAPSHOT</ccsdk.features.version>
        <sdnc.keystore>org.onap.sdnc.p12</sdnc.keystore>
        <sdnc.keypass><![CDATA[ff^G9D]yf&r}Ktum@BJ0YB?N]]></sdnc.keypass>
        <sdnc.secureport>8443</sdnc.secureport>
        <docker.buildArg.https_proxy>${https_proxy}</docker.buildArg.https_proxy>
        <docker.push.phase>deploy</docker.push.phase>
        <docker.verbose>true</docker.verbose>
        <maven.build.timestamp.format>yyyyMMdd'T'HHmmss'Z'</maven.build.timestamp.format>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.onap.sdnc.northbound</groupId>
            <artifactId>generic-resource-api-installer</artifactId>
            <version>${sdnc.northbound.version}</version>
            <classifier>repo</classifier>
            <type>zip</type>
        </dependency>
        <dependency>
            <groupId>org.onap.sdnc.northbound</groupId>
            <artifactId>vnfapi-installer</artifactId>
            <version>${sdnc.northbound.version}</version>
            <classifier>repo</classifier>
            <type>zip</type>
        </dependency>
        <dependency>
            <groupId>org.onap.sdnc.northbound</groupId>
            <artifactId>vnftools-installer</artifactId>
            <version>${sdnc.northbound.version}</version>
            <classifier>repo</classifier>
            <type>zip</type>
        </dependency>
        <dependency>
            <groupId>org.onap.sdnc.northbound</groupId>
            <artifactId>sdnc-northbound-features-installer</artifactId>
            <version>${sdnc.northbound.version}</version>
            <classifier>repo</classifier>
            <type>zip</type>
        </dependency>

        <dependency>
            <groupId>org.onap.ccsdk.features.sdnr.northbound</groupId>
            <artifactId>oofpcipoc-installer</artifactId>
            <version>${ccsdk.features.version}</version>
            <classifier>repo</classifier>
            <type>zip</type>
        </dependency>

        <dependency>
            <groupId>org.onap.ccsdk.features.sdnr.northbound</groupId>
            <artifactId>sdnr-northbound-features-installer</artifactId>
            <version>${ccsdk.features.version}</version>
            <classifier>repo</classifier>
            <type>zip</type>
        </dependency>
        <dependency>
            <groupId>org.onap.ccsdk.features.sdnr.wt</groupId>
            <artifactId>sdnr-wt-feature-aggregator-installer</artifactId>
            <version>${ccsdk.features.version}</version>
            <classifier>repo</classifier>
            <type>zip</type>
        </dependency>
    </dependencies>

    <build>
        <plugins>


            <plugin>
                <groupId>org.codehaus.groovy.maven</groupId>
                <artifactId>gmaven-plugin</artifactId>
                <executions>
                    <execution>
                        <phase>validate</phase>
                        <goals>
                            <goal>execute</goal>
                        </goals>
                        <configuration>
                            <source>${basedir}/../TagVersion.groovy</source>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

            <plugin>
                <groupId>io.fabric8</groupId>
                <artifactId>docker-maven-plugin</artifactId>
                <version>0.28.0</version>
                <inherited>false</inherited>
                <executions>
                    <execution>
                        <id>generate-images</id>
                        <phase>package</phase>
                        <goals>
                            <goal>build</goal>
                        </goals>
                        <configuration>
                           <images>
                            <image>
                             <name>${image.name}</name>
                             <build>
                              <cleanup>try</cleanup>
                              <dockerFileDir>${basedir}/target/docker-stage</dockerFileDir>
                              <dockerFile>Dockerfile</dockerFile>
                              <tags>
                                 <tag>${project.docker.latestminortag.version}</tag>
                                 <tag>${project.docker.latestfulltag.version}</tag>
                                 <tag>${project.docker.latesttagtimestamp.version}</tag>
                              </tags>
                             </build>
                            </image>
                           </images>
                          </configuration>
                    </execution>
                    <execution>
                      <id>push-images</id>
                      <phase>${docker.push.phase}</phase>
                      <goals>
                       <goal>build</goal>
                       <goal>push</goal>
                      </goals>
                       <configuration>
                        <images>
                         <image>
                          <name>${image.name}</name>
                          <build>
                           <cleanup>try</cleanup>
                           <dockerFileDir>${basedir}/target/docker-stage</dockerFileDir>
                           <dockerFile>Dockerfile</dockerFile>
                           <tags>
                              <tag>${project.docker.latestminortag.version}</tag>
                              <tag>${project.docker.latestfulltag.version}</tag>
                              <tag>${project.docker.latesttagtimestamp.version}</tag>
                           </tags>
                          </build>
                         </image>
                        </images>
                       </configuration>
                   </execution>
                   <execution>
                     <id>generate-standalone-images</id>
                     <phase>package</phase>
                     <goals>
                      <goal>build</goal>
                     </goals>
                     <configuration>
                      <images>
                       <image>
                        <name>${standalone.image.name}</name>
                        <build>
                         <cleanup>try</cleanup>
                         <dockerFileDir>${basedir}/target/docker-stage</dockerFileDir>
                         <dockerFile>standalone.Dockerfile</dockerFile>
                         <tags>
                             <tag>${project.docker.latestminortag.version}</tag>
                             <tag>${project.docker.latestfulltag.version}</tag>
                             <tag>${project.docker.latesttagtimestamp.version}</tag>
                         </tags>
                        </build>
                       </image>
                      </images>
                     </configuration>
                   </execution>
                   <execution>
                     <id>push-standalone-images</id>
                     <phase>${docker.push.phase}</phase>
                     <goals>
                      <goal>build</goal>
                      <goal>push</goal>
                     </goals>
                     <configuration>
                       <images>
                        <image>
                         <name>${standalone.image.name}</name>
                         <build>
                          <cleanup>try</cleanup>
                          <dockerFileDir>${basedir}/target/docker-stage</dockerFileDir>
                          <dockerFile>standalone.Dockerfile</dockerFile>
                          <tags>
                             <tag>${project.docker.latestminortag.version}</tag>
                             <tag>${project.docker.latestfulltag.version}</tag>
                             <tag>${project.docker.latesttagtimestamp.version}</tag>
                          </tags>
                         </build>
                        </image>
                       </images>
                     </configuration>
                  </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-resources-plugin</artifactId>
                <version>2.6</version>
                <executions>
                    <execution>
                        <id>copy-dockerfile</id>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals><!-- here the phase you need -->
                        <phase>validate</phase>
                        <configuration>
                            <outputDirectory>${basedir}/target/docker-stage</outputDirectory>
                            <resources>
                                <resource>
                                    <directory>src/main/docker</directory>
                                    <includes>
                                        <include>Dockerfile</include>
                                        <include>standalone.Dockerfile</include>
                                    </includes>
                                    <filtering>true</filtering>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                    <execution>
                        <id>copy-scripts</id>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals><!-- here the phase you need -->
                        <phase>validate</phase>
                        <configuration>
                            <outputDirectory>${basedir}/target/docker-stage/opt/onap/sdnc/bin</outputDirectory>
                            <resources>
                                <resource>
                                    <directory>src/main/scripts</directory>
                                    <includes>
                                        <include>*.py</include>
                                        <include>*.sh</include>
                                    </includes>
                                    <filtering>false</filtering>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                    <execution>
                        <id>copy-tarballs</id>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals><!-- here the phase you need -->
                        <phase>validate</phase>
                        <configuration>
                            <outputDirectory>${basedir}/target/docker-stage</outputDirectory>
                            <resources>
                                <resource>
                                    <directory>src/main/resources</directory>
                                    <includes>
                                        <include>idmlight.db.mv.db</include>
                                        <include>truststoreONAPall.jks</include>
                                        <include>aaa-app-config.xml</include>
                                    </includes>
                                    <filtering>false</filtering>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                    <execution>
                        <id>copy-data</id>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals><!-- here the phase you need -->
                        <phase>validate</phase>
                        <configuration>
                            <outputDirectory>${basedir}/target/docker-stage/opt/onap/sdnc/data</outputDirectory>
                            <resources>
                                <resource>
                                    <directory>src/main/resources</directory>
                                    <includes>
                                        <include>*.dump</include>
                                    </includes>
                                    <filtering>false</filtering>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                    <execution>
                        <id>copy-properties</id>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals><!-- here the phase you need -->
                        <phase>validate</phase>
                        <configuration>
                            <outputDirectory>${basedir}/target/docker-stage/opt/onap/sdnc/data/properties</outputDirectory>
                            <resources>
                                <resource>
                                    <directory>../src/main/properties</directory>
                                    <includes>
                                        <include>*.properties</include>
                                        <include>*.props</include>
                                        <include>*.csv</include>
                                    </includes>
                                    <filtering>false</filtering>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                    <execution>
                        <id>copy-keystores</id>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals><!-- here the phase you need -->
                        <phase>validate</phase>
                        <configuration>
                            <outputDirectory>${basedir}/target/docker-stage/opt/onap/sdnc/data/stores</outputDirectory>
                            <resources>
                                <resource>
                                    <directory>../src/main/stores</directory>
                                    <includes>
                                        <include>*.jks</include>
                                        <include>*.keyfile</include>
                                        <include>*.p12</include>
                                    </includes>
                                    <filtering>false</filtering>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <version>3.0.2</version>
                <executions>
                    <execution>
                        <id>unpack sdnc features</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>unpack-dependencies</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${basedir}/target/docker-stage</outputDirectory>
                            <excludeTransitive>true</excludeTransitive>
                        </configuration>
                    </execution>
                    <execution>
                        <id>unpack dgs</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>unpack</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${basedir}/target/docker-stage/opt/onap/sdnc</outputDirectory>
                            <artifactItems>
                                <artifactItem>
                                    <groupId>${project.groupId}</groupId>
                                    <artifactId>platform-logic-installer</artifactId>
                                    <version>${project.version}</version>
                                    <type>zip</type>
                                </artifactItem>
                            </artifactItems>
                        </configuration>
                    </execution>
                    <execution>
                        <id>unpack migration utility</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>unpack</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${basedir}/target/docker-stage/opt/onap/sdnc/data-migrator</outputDirectory>
                            <artifactItems>
                                <artifactItem>
                                    <groupId>org.onap.sdnc.oam</groupId>
                                    <artifactId>data-migrator</artifactId>
                                    <version>${project.version}</version>
                                    <type>zip</type>
                                </artifactItem>
                            </artifactItems>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>exec-maven-plugin</artifactId>
                <groupId>org.codehaus.mojo</groupId>
                <version>1.5.0</version>
                <executions>
                    <execution>
                        <id>change shell permissions</id>
                        <phase>process-sources</phase>
                        <goals>
                            <goal>exec</goal>
                        </goals>
                        <configuration>
                            <executable>/usr/bin/find</executable>
                            <arguments>
                                <argument>${basedir}/target/docker-stage/opt/onap/sdnc</argument>
                                <argument>-name</argument>
                                <argument>*.sh</argument>
                                <argument>-exec</argument>
                                <argument>chmod</argument>
                                <argument>+x</argument>
                                <argument>{}</argument>
                                <argument>;</argument>
                            </arguments>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    <organization>
        <name>ONAP</name>
    </organization>
</project>