manuals/getting-started-guide/src/main/asciidoc/ch-introduction.adoc

   1 [preface]
   2 == OpenDaylight Overview
   3 The OpenDaylight project is a collaborative open source project that
   4 aims to accelerate adoption of Software-Defined Networking (SDN) and
   5 Network Functions Virtualization (NFV) with a transparent approach that
   6 fosters new innovation.
   7
   8 OpenDaylight mainly consists of software designed to be run on top of a
   9 Java Virtual Machine (JVM) and can be run on any operating system and
  10 hardware as there is a Java Runtime Environment (JRE) available for it.
  11
  12 // TODO: uncomment the following lines when we have them to the point we think they're useful.
  13 // OpenDaylight makes use of the following third-party tools:
  14 //
  15 // * *Maven*: OpenDaylight uses Maven for easier build automation. Maven uses pom.xml
  16 // (Project Object Model) to script the dependencies between bundles.
  17 //
  18 // * *OSGi*: OSGi framework is the back-end of OpenDaylight as it allows dynamically
  19 // loading bundles and packages JAR files, and binding bundles together for exchanging
  20 // information.
  21 //
  22 // * *JAVA interfaces*: Java interfaces are usually generated by compiling the YANG project. Java interfaces are used for event listening, specifications, and forming
  23 // patterns. This is the main way in which specific bundles implement call-back functions for events and also to indicate awareness of specific state.
  24 //
  25 // * *REST APIs*: Most of the REST APIs in OpenDaylight are defined using YANG tools and are RESTCONF APIs.
  26 //
  27 // * *Karaf*: TBD
  28
  29 For a more detailed information about OpenDaylight, see the and _OpenDaylight User Guie_, _OpenDaylight
  30 Developer Guide_.
  31