+++ /dev/null
-<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.opendaylight.docs</groupId>
- <artifactId>manuals</artifactId>
- <version>0.3.0-SNAPSHOT</version>
- <relativePath>../pom.xml</relativePath>
- </parent>
- <modelVersion>4.0.0</modelVersion>
- <artifactId>getting-started-guide</artifactId>
- <packaging>jar</packaging>
- <name>OpenDaylight Docs - Manuals - Getting Started Guide</name>
- <properties>
- <!-- This is set by Jenkins according to the branch. -->
- <release.path.name>local</release.path.name>
- <comments.enabled>1</comments.enabled>
- <bookname>bk-getting-started-guide</bookname>
- </properties>
- <!-- ################################################ -->
- <!-- USE "mvn clean generate-sources" to run this POM -->
- <!-- ################################################ -->
- <build>
- <plugins>
- <plugin>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <version>${asciidoctor.version}</version>
- <executions>
- <execution>
- <id>output-docbook</id>
- <phase>generate-sources</phase>
- <goals>
- <goal>process-asciidoc</goal>
- </goals>
- <configuration>
- <backend>docbook5</backend>
- <doctype>book</doctype>
- </configuration>
- </execution>
- </executions>
- <configuration>
- <sourceDirectory>src/main/asciidoc</sourceDirectory>
- <sourceDocumentName>${bookname}.adoc</sourceDocumentName>
- <imagesDir>./images</imagesDir>
- </configuration>
- </plugin>
- <plugin>
- <artifactId>maven-resources-plugin</artifactId>
- <version>2.6</version>
- <executions>
- <execution>
- <id>copy-resources</id>
- <phase>generate-resources</phase>
- <goals>
- <goal>copy-resources</goal>
- </goals>
- <configuration>
- <outputDirectory>${basedir}/target/generated-docs</outputDirectory>
- <resources>
- <resource>
- <directory>src/main/resources</directory>
- <includes>
- <include>**/*.*</include>
- </includes>
- </resource>
- </resources>
- </configuration>
- </execution>
- </executions>
- </plugin>
- <plugin>
- <groupId>com.inocybe.api</groupId>
- <artifactId>sdndocs-maven-plugin</artifactId>
- <version>0.1.0</version>
- <executions>
- <execution>
- <id>generate-webhelp</id>
- <goals>
- <goal>generate-webhelp</goal>
- </goals>
- <phase>compile</phase>
- <configuration>
- <profileAudience>enduser</profileAudience>
- <includes>target/generated-docs/${bookname}.xml</includes>
- <generateToc>
- appendix toc,title
- article/appendix nop
- article toc,title
- book toc,title,figure,table,example,equation
- chapter toc,title
- section toc
- part toc,title
- qandadiv toc
- qandaset toc
- reference toc,title
- set toc,title
- </generateToc>
- <webhelpDirname>${bookname}</webhelpDirname>
- <pdfFilenameBase>${bookname}</pdfFilenameBase>
- </configuration>
- </execution>
- </executions>
- <configuration>
- <profileAudience>enduser</profileAudience>
- <chapterAutolabel>1</chapterAutolabel>
- <sectionAutolabel>0</sectionAutolabel>
- <tocSectionDepth>1</tocSectionDepth>
- <formalProcedures>0</formalProcedures>
- <highlightSource>false</highlightSource>
- <xincludeSupported>true</xincludeSupported>
- <showXslMessages>true</showXslMessages>
- <sourceDirectory>.</sourceDirectory>
- <feedbackEmail>mlemay@inocybe.com</feedbackEmail>
- <branding>opendaylight</branding>
- <coverLogoLeft>2.6in</coverLogoLeft>
-<!-- <enableDisqus>${comments.enabled}</enableDisqus>
- <disqusShortname>os-user-guide</disqusShortname>
- <enableGoogleAnalytics>1</enableGoogleAnalytics>
- <googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
- --> <suppressFooterNavigation>0</suppressFooterNavigation>
- <canonicalUrlBase>http://docs.opendaylight.org/user-guide/content/</canonicalUrlBase>
- <glossaryCollection>${basedir}/../glossary/glossary-terms.xml</glossaryCollection>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-site-plugin</artifactId>
- <version>3.1</version>
- <configuration>
- <inputDirectory>${project.build.directory}/docbkx/webhelp</inputDirectory>
- </configuration>
- <dependencies>
- <dependency>
- <groupId>org.apache.maven.wagon</groupId>
- <artifactId>wagon-webdav-jackrabbit</artifactId>
- <version>2.2</version>
- </dependency>
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-api</artifactId>
- <version>1.6.1</version>
- </dependency>
- </dependencies>
- </plugin>
- </plugins>
- </build>
-</project>
+++ /dev/null
-
- <author>
- <personname>
- <firstname>OpenDaylight</firstname>
- <surname>Community</surname>
- </personname>
- <email>documentation@opendaylight.org</email>
- <affiliation>
- <orgname>Linux Foundation</orgname>
- </affiliation>
- </author>
- <copyright>
- <year>2015</year>
- <holder>Linux Foundation</holder>
- </copyright>
- <releaseinfo>Beryllium</releaseinfo>
- <productname>OpenDaylight</productname>
- <pubdate></pubdate>
- <legalnotice role="license">
- <para> This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at <link xlink:href="http://www.eclipse.org/legal/epl-v10.html"/></para>
- </legalnotice>
- <abstract>
- <para>This guide describes how to get started with OpenDaylight.</para>
- </abstract>
- <revhistory>
- <revision>
- <date>2014-07-16</date>
- <revdescription>
- <itemizedlist spacing="compact">
- <listitem>
- <para>Initial Guide Creation</para>
- </listitem>
- </itemizedlist>
- </revdescription>
- </revision>
- </revhistory>
-
+++ /dev/null
-[[bk-getting-started-guide]]
-= OpenDaylight Getting Started Guide
-:docinfo:
-
-//////////////////////////
-// BEGIN COMMENT
-[dedication]
-Example Dedication
-------------------
-Optional dedication.
-
-This document is an AsciiDoc book skeleton containing briefly
-annotated example elements plus a couple of example index entries and
-footnotes.
-
-Books are normally used to generate DocBook markup and the titles of
-the preface, appendix, bibliography, glossary and index sections are
-significant ('specialsections').
-
-
-[preface]
-Example Preface
----------------
-Optional preface.
-
-Preface Sub-section
-~~~~~~~~~~~~~~~~~~~
-Preface sub-section body.
-
-Using OpenDaylight
---------------------------
-
-[partintro]
-.Optional part introduction title
---
-Optional part introduction goes here.
---
-
-OpenDaylight Add-ons
--------------------------
-
-[partintro]
-.Optional part introduction title
---
-Optional part introduction goes here.
---
-// END COMMENT
-//////////////////////////
-
-//////////////////////////
-// BEGIN COMMENT
-Please note and leave the blank line between include statements here.
-
-It is a defensive measure to prevent individual projects' .adoc files
-from eating the next section if they forget to leave a blank line at
-the end of their file.
-// END COMMENT
-//////////////////////////
-
-= Getting to know OpenDaylight
-
-== Placeholder
-
-Placeholder to keep the build working before this whole book is deleted.
-
-:numbered!:
-
-//////////////////////////
-// BEGIN COMMENT
-[appendix]
-Example Appendix
-----------------
-One or more optional appendixes go here at section level 1.
-
-Appendix Sub-section
-~~~~~~~~~~~~~~~~~~~
-Sub-section body.
-
-
-[glossary]
-Example Glossary
-----------------
-Glossaries are optional. Glossaries entries are an example of a style
-of AsciiDoc labeled lists.
-
-[glossary]
-A glossary term::
- The corresponding (indented) definition.
-
-A second glossary term::
- The corresponding (indented) definition.
-
-
-[colophon]
-Example Colophon
-----------------
-Text at the end of a book describing facts about its production.
-
-
-[index]
-Example Index
--------------
-// END COMMENT
-//////////////////////////
-
-////////////////////////////////////////////////////////////////
-The index is normally left completely empty, it's contents being
-generated automatically by the DocBook toolchain.
-////////////////////////////////////////////////////////////////
+++ /dev/null
-
-=== Installing from Zip
-
-Installing from zip is an easy way to get started with OpenDaylight. When installing from zip, the process is as simple as running the completely packaged environment. However unlike official distribution packages OpenDaylight will have to be upgraded manually after each release when installing from zip files.
-
-==== Prerequisites
-
-In order to be able to install and run the zip file the following prerequisites have to be fulfilled:
-
-* A Java 1.7 compatible JDK or JRE have to be installed (i.e. Oracle JDK 1.7 or OpenJDK 1.7)
-In general, OpenDaylight requires appropriate setting of the JAVA_HOME directory
-More information can be found in the OpenDaylight Hydrogen Release Notes
-On some platforms, there are known issues with Oracle Java 1.7.0_21 and 1.7.0_25, but 1.7.0_45 and 1.7.0_51 have worked fine
-
-==== Getting the Zip File
-
-You can find the OpenDaylight Hydrogen Release Base Edition zip file on the download page here:
-
-http://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/integration/distributions-base/0.1.1/distributions-base-0.1.1-osgipackage.zip
-
-Understanding Structure
-The main content of OpenDaylight Hydrogen is in a directory called opendaylight, where you will see the following files:
-run.sh
-launches OpenDaylight on Linux/Mac/Unix systems
-run.bat
-launches OpenDaylight on Windows systems
-version.properties
-indicates the build version
-configuration
-basic initialization files (internal to OpenDaylight)
-lib
-Java libraries
-Running OpenDaylight
-To launch OpenDaylight follow these easy steps from the root opendaylight directory
-Enter ./run.sh or ./run.bat with administrator privileges to launch OpenDaylight.
-Starting
-To run OpenDaylight in background enter ./run.sh -start with administrator priviledges.
-Stopping
-To stop OpenDaylight, which is running in background enter ./run.sh -stop with administrator priviledges.
-Status
-In order to see the status of OpenDaylight, enter ./run.sh -status. It will show whether it is running or has been stopped.
-Navigate to http://<ip-address-of-machine-where-you-ran-opendaylight>:8080 to open the web interface, then use the following credentials to log in:
-User: admin
-Password: admin
-If you are running OpenDaylight on the same machine as your browser, you can browse to http://localhost:8080 or http://127.0.0.1:8080 to avoid needing to know the IP address of the machine you are using.
-You will now have a completely running OpenDaylight installation.
+++ /dev/null
-== AAA service
-
-Chapter on AAA service.
-
+++ /dev/null
-== Controller
-
-Chapter on the controller
-
+++ /dev/null
-== Defense4All
-
-For information on how to install Defense4All please see this page on the OpenDaylight here: https://wiki.opendaylight.org/view/Defense4All:Installation_Guide
\ No newline at end of file
+++ /dev/null
-== dLux
-
-Chapter on DLUX
-
+++ /dev/null
-== Group Based Policy
-
-Chapter on Group Based Policy
-
+++ /dev/null
-== L2 Switch
-
-Chapter on L2 Switch
-
+++ /dev/null
-== Lisp Flow Mapping
-
-Please see the OpenDaylight Developer's Guide for detailed instructions.
-
-
-
+++ /dev/null
-== ODL-SDNi
-
-Chapter on ODL-SDNi
-
-https://wiki.opendaylight.org/view/ODL-SDNiApp:Developer_Guide
-
+++ /dev/null
-== OpenFlow Protocol Library
-
-Chapter on OpenFlow protocol library
-
+++ /dev/null
-== OpenFlow Plugin
-
-Chapter on Open Flow Plugin
+++ /dev/null
-== Helium Overview
-
-add text and reference to helium project dependency diagram
-
+++ /dev/null
-== OVSDB
-
-Chapter on OVSDB
-
+++ /dev/null
-== PacketCable PCMM
-
-Once the karaf distribution is downloaded and running, it is suggested that you install the following features:
-
-* +odl-restconf+
-* +odl-l2switch-switch+
-* +odl-dlux-core+
-* +odl-mdsal-apidocs+
-* +odl-packetcable-all+
-
-This can be done as a single command at the Karaf CLI:
-
-+feature:install standard odl-restconf odl-l2switch-switch odl-dlux-core odl-mdsal-apidocs odl-packetcable-all+
-
-Technically, the +odl-dlux-core+ and +odl-mdsal-apidocs+ features are not required for operation, but they enable you to verify the installation has worked and provide REST interfaces.
+++ /dev/null
-== Plugin for OpenContrail
-
-Chapter on Southbound plugin to OpenContrail
-
-https://wiki.opendaylight.org/view/Southbound_plugin_to_the_OpenContrail_platform:Environment_Setup
+++ /dev/null
-== Service Function Chaining
-
-Chapter on Service Function Chaining
-
+++ /dev/null
-== Secure Network Bootstrapping Infrastructure
-
-Chapter on Secure Network Bootstrapping Infrastructure
-
+++ /dev/null
-== SNMP4SDN
-
-Chapter on SNMP for SDN
-
+++ /dev/null
-== Yang Tools \r
-\r
-=== Installation Overview\r
-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
-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
-\r
-==== Installing the Project\r
-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
-\r
-=== Adding Plugin Repositories \r
-==== Plugin Repository\r
-To add following plugin repositories for plugin use: +\r
-\r
-[literal]\r
-<pluginRepositories>\r
- <pluginRepository> \r
- <id>opendaylight-release</id>\r
- <name>opendaylight-release</name>\r
- <url>http://nexus.opendaylight.org/content/repositories/opendaylight.release/</url>\r
- </pluginRepository>\r
- <pluginRepository> \r
- <id>opendaylight-snapshot</id>\r
- <name>opendaylight-snapshot</name>\r
- <url>http://nexus.opendaylight.org/content/repositories/opendaylight.snapshot/</url>\r
- </pluginRepository>\r
-</pluginRepositories>\r
-\r
-==== Dependency Repository\r
-\r
-To add repositories for required dependencies use: \r
-[literal]\r
-<repositories> \r
- <repository> \r
- <id>opendaylight-release</id>\r
- <name>opendaylight-release</name>\r
- <url>http://nexus.opendaylight.org/content/repositories/opendaylight.release/</url>\r
- </repository>\r
- <repository> \r
- <id>opendaylight-snapshot</id>\r
- <name>opendaylight-snapshot</name>\r
- <url>http://nexus.opendaylight.org/content/repositories/opendaylight.snapshot/</url>\r
- </repository>\r
-</repositories>\r
- \r
-==== Using Plugin\r
-\r
-To add yang-maven-plugin to build section of your pom.xml use:\r
-[literal]\r
-<build>\r
- <plugins>\r
- <plugin>\r
- <groupId>org.opendaylight.yangtools</groupId>\r
- <artifactId>yang-maven-plugin</artifactId>\r
- <version>0.6.1-SNAPSHOT</version>\r
- <!-- configuration -->\r
- </plugin>\r
- </plugins>\r
-</build>\r
+++ /dev/null
-== OpenDaylight Release Notes
-
-=== Key Features
-
-A list of the key functionality provided in OpenDaylight Helium can be found in the table in the <<_installing_components,section below>>.
-
-////
-The following table describes the key features provided by OpenDaylight Helium.
-
-[cols="2",option="headers"]
-|==============================================
-| *Feature* | *Description*
-| Maven support | Used to simplify build automation.
-| OSGi framework | Serves as the controller’s back-end, allowing it to dynamically load bundles, package JAR files, and bind bundles together when exchanging information.
-| Java interface support | Used by specific bundles to implement call-back functions for events and indicate the awareness of specific states.
-| Model- Driven Service Abstraction Layer (MD-SAL) | Allows the controller to support multiple protocols (such as BGP-LS and OpenFlow) on the southbound interface. Also provides consistent services for modules and applications (which is where the business logic is embedded).
-| Switch Manager | Once a network element has been discovered, its details (such as device type, software version, etc.) are stored by the Switch Manager.
-| High Availability (HA) | The controller supports cluster-based HA, allowing you to connect multiple controllers and configure them to act as one in order to ensure the controller’s continuous operation.
-|==============================================
-////
-=== Target Environment
-
-NOTE: If you are using Oracle, JDK version 1.7.0_45 or later is required.
-
-==== For Execution
-
-The OpenDaylight controller source files are completely portable and only require a Java 7-compliant JVM to run.
-
-==== For Development
-
-Although the OpenDaylight controller is developed as a normal Java project, it makes heavy use of the Xtend language in some places. While development is possible with bare tools, we recommend you use Eclipse with the Xtend plugin.
-
-=== Known Issues and Limitation
-
-Other than as noted in project-specific release notes, there are two known limitations.
-
-. The Karaf distribution of OpenDaylight requires internet access when run for the first time.
-. There are scales beyond which the controller has been unreliable when collecting flow statistics from OpenFlow switches. In tests, theses issues became apparent when managing 10s of thousands of OpenFlow switches, however this may vary depending on deployment and use cases. Flow programming has been unaffected in our tests.
-
-==== Full Bug List
-
-All of the known issues for the OpenDaylight controller are listed https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_status%2Cresolution%2Cshort_desc%2Cchangeddate%2Ccf_target_milestone&f1=cf_target_milestone&list_id=15952&n1=1&o1=substring&product=controller&query_based_on=&query_format=advanced&resolution=---&v1=Lithium[here].
-
-=== Project-specific Release Notes
-
-Project-specific release notes can be found on the OpenDaylight wiki. This table provides links to them by project.
-
-[options="header",cols="1,4"]
-|==============================================
-| Project | Release Notes URL
-| AAA | https://wiki.opendaylight.org/view/AAA:Helium_Release_Notes
-| BGPCEP | https://wiki.opendaylight.org/view/BGP_LS_PCEP:Helium_Release_Notes
-| DLUX | https://wiki.opendaylight.org/view/OpenDaylight_dlux:Release_Notes_Helium
-| Group Based Policy | https://wiki.opendaylight.org/view/Group_Policy:Helium-Release-Notes
-| L2 Switch | https://wiki.opendaylight.org/view/L2_Switch:Helium:Release_Notes
-| LISP Flow Mapping | https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:_Helium_Release_Notes
-| OpenFlow Plugin | https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:Helium_Release_Notes
-| OpenFlow Protocol Library | https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Release_Notes
-| OVSDB | https://wiki.opendaylight.org/view/OVSDB_Integration:Helium_Release_Notes
-| PackCable PCMM | https://wiki.opendaylight.org/view/PacketCablePCMM:ReleaseNotes
-| Plugin2OC | https://wiki.opendaylight.org/view/Southbound_Plugin_to_the_OpenContrail_Platform:Helium_Release_Notes
-| SDNi | https://wiki.opendaylight.org/view/ODL-SDNi_App:Helium_Release_Notes
-| SNBI | https://wiki.opendaylight.org/view/SecureNetworkBootstrapping:HeliumReleaseNotes
-| SNMP4SDN | https://wiki.opendaylight.org/view/SNMP4SDN:Helium_Release_Note
-| SFC | https://wiki.opendaylight.org/view/Service_Function_Chaining:Helium_Release_Notes
-| TCPMD5 | https://wiki.opendaylight.org/view/TCPMD5:Helium_Release_Notes
-| TTP | https://wiki.opendaylight.org/view/Table_Type_Patterns:Helium_Release_Notes
-| VTN | https://wiki.opendaylight.org/view/OpenDaylight_Virtual_Tenant_Network_(VTN):Helium_Release_Notes
-| Yang Tools | https://wiki.opendaylight.org/view/YANG_Tools:Helium:Release_Notes
-|==============================================
-
</properties>
<modules>
<module>readme</module> <!-- this is just to make sure readme builds -->
- <module>getting-started-guide</module>
<module>developer-guide</module>
<module>user-guide</module>
<module>howto-openstack</module>
Code Review / docs.git / commitdiff