manuals/getting-started-guide/src/main/asciidoc/old-helium-docs/addons/yangtools.adoc

   1 == Yang Tools \r
   2 \r
   3 === Installation Overview\r
   4 Yang tools is a infrastructure project aiming to develop necessary tooling and libraries providing support for NETCONF and YANG for Java (JVM-language based) projects and applications.\r
   5 Yang tools is used for application such as Model Driven SAL for Controller (which uses YANG as the modeling language) and Netconf or OFConfig plugins. \r
   6 \r
   7 ==== Installing the Project\r
   8 To configure your project and generate source code from YANG edit your projects *pom.xml* and add Opendaylight SNAPSHOT repository for snapshot releases (currently only snapshots are available). \r
   9 \r
  10 === Adding Plugin Repositories \r
  11 ==== Plugin Repository\r
  12 To add following plugin repositories for plugin use: +\r
  13 \r
  14 [literal]\r
  15 <pluginRepositories>\r
  16     <pluginRepository>     \r
  17        <id>opendaylight-release</id>\r
  18        <name>opendaylight-release</name>\r
  19        <url>http://nexus.opendaylight.org/content/repositories/opendaylight.release/</url>\r
  20         </pluginRepository>\r
  21     <pluginRepository>     \r
  22        <id>opendaylight-snapshot</id>\r
  23        <name>opendaylight-snapshot</name>\r
  24        <url>http://nexus.opendaylight.org/content/repositories/opendaylight.snapshot/</url>\r
  25     </pluginRepository>\r
  26 </pluginRepositories>\r
  27 \r
  28 ==== Dependency Repository\r
  29 \r
  30 To add repositories for required dependencies use: \r
  31 [literal]\r
  32 <repositories> \r
  33     <repository>           \r
  34        <id>opendaylight-release</id>\r
  35        <name>opendaylight-release</name>\r
  36        <url>http://nexus.opendaylight.org/content/repositories/opendaylight.release/</url>\r
  37     </repository>\r
  38     <repository>           \r
  39        <id>opendaylight-snapshot</id>\r
  40        <name>opendaylight-snapshot</name>\r
  41        <url>http://nexus.opendaylight.org/content/repositories/opendaylight.snapshot/</url>\r
  42     </repository>\r
  43 </repositories>\r
  44    \r
  45 ==== Using Plugin\r
  46 \r
  47 To add yang-maven-plugin to build section of your pom.xml use:\r
  48 [literal]\r
  49 <build>\r
  50     <plugins>\r
  51         <plugin>\r
  52             <groupId>org.opendaylight.yangtools</groupId>\r
  53             <artifactId>yang-maven-plugin</artifactId>\r
  54             <version>0.6.1-SNAPSHOT</version>\r
  55             <!-- configuration -->\r
  56         </plugin>\r
  57     </plugins>\r
  58 </build>\r