README.md

   1 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.opendaylight.bgpcep/bgpcep-artifacts/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.opendaylight.bgpcep/bgpcep-artifacts)
   2 [![Javadocs](https://javadoc.io/badge2/org.opendaylight.bgpcep/bgpcep-karaf/javadoc.svg)](https://www.javadoc.io/doc/org.opendaylight.bgpcep)
   3 [![License](https://img.shields.io/badge/License-EPL%201.0-blue.svg)](https://opensource.org/licenses/EPL-1.0)
   4
   5 # BGPCEP
   6
   7 BGPCEP project is an effort to bring two south-bound plugins into the controller:
   8 one for supporting BGP Linkstate Distribution as a source of L3 topology information,
   9 the other one to add support for Path Computation Element Protocol as a way to instantiate paths
  10 into the underlying network.
  11
  12 ## DIRECTORY ORGANIZATION
  13
  14 * concepts:
  15     * Common networking concepts, shared between the protocols
  16
  17 * util:
  18     * Common utility classes
  19
  20 * bgp:
  21     * BGP-related artifacts
  22
  23 * pcep:
  24     * PCEP-related artifacts
  25
  26 * rsvp:
  27     * RSVP modeling concepts (needed by pcep)
  28
  29 ## HOW TO BUILD
  30
  31 In order to build it's required to have JDK 1.7+ and Maven 3+, to get
  32 a build going it's needed to:
  33
  34 1. Go in the root directory and run
  35    `mvn clean install`
  36
  37 2. After successful completion, look for org.opendaylight.bgpcep artifacts in your local maven repository.