Skip to content

Commit 8d3dffa

Browse files
inocybe-jenkinsGerrit Code Review
authored andcommitted
Merge changes I105bfdcf,Idef5b09b
* changes: Getting the Installation Guide into shippable shape Removing two files that differ only in the case of their file names
2 parents 911d6d4 + c96af02 commit 8d3dffa

File tree

8 files changed

+77
-156
lines changed

8 files changed

+77
-156
lines changed

manuals/developers-guide/src/main/asciidoc/How_To_configure_Vtn_Dataflows.adoc

Lines changed: 0 additions & 107 deletions
This file was deleted.

manuals/developers-guide/src/main/asciidoc/controller.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -935,7 +935,7 @@ In fact, each configuration operation is wrapped in a transaction. Once a transa
935935
If this commit is successful, the transaction enters the last stage, committed. After that, the desired modules are reconfigured. If the second phase commit fails, it means that the transaction is unhealthy - basically, a new configuration instance creation failed, and the application can be in an inconsistent state.
936936

937937
.Configuration states
938-
image::Configuration.jpg[]
938+
image::configuration.jpg[]
939939

940940
.Transaction states
941941
image::Transaction.jpg[]
Binary file not shown.
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
== Defense4All
22

3-
Chapter on Defense For All
4-
3+
For information on how to install Defense4All please see this page on the OpenDaylight here: https://wiki.opendaylight.org/view/Defense4All:Installation_Guide
Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,13 @@
11
== Yang Tools
2-
This chapter contains the following sections:
32

4-
* <<_installation_overview>>
5-
* <<_adding_plugin_repositories>>
6-
* <<_using_plugin>>
7-
8-
== Installation Overview
3+
=== Installation Overview
94
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.
105
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.
116

12-
=== Installing the Project
7+
==== Installing the Project
138
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).
149

15-
== Adding Plugin Repositories
10+
=== Adding Plugin Repositories
1611
==== Plugin Repository
1712
To add following plugin repositories for plugin use: +
1813

@@ -27,36 +22,37 @@ To add following plugin repositories for plugin use: +
2722
<id>opendaylight-snapshot</id>
2823
<name>opendaylight-snapshot</name>
2924
<url>http://nexus.opendaylight.org/content/repositories/opendaylight.snapshot/</url>
30-
</pluginRepository>
25+
</pluginRepository>
26+
</pluginRepositories>
3127

3228
==== Dependency Repository
3329

3430
To add repositories for required dependencies use:
3531
[literal]
36-
<repositories>
32+
<repositories>
3733
<repository>
3834
<id>opendaylight-release</id>
3935
<name>opendaylight-release</name>
4036
<url>http://nexus.opendaylight.org/content/repositories/opendaylight.release/</url>
41-
</repositories>
37+
</repository>
4238
<repository>
4339
<id>opendaylight-snapshot</id>
4440
<name>opendaylight-snapshot</name>
4541
<url>http://nexus.opendaylight.org/content/repositories/opendaylight.snapshot/</url>
46-
</repository>
47-
</repositories>
42+
</repository>
43+
</repositories>
4844

4945
==== Using Plugin
5046

5147
To add yang-maven-plugin to build section of your pom.xml use:
5248
[literal]
5349
<build>
54-
<plugins>
55-
<plugin>
56-
<groupId>org.opendaylight.yangtools</groupId>
57-
<artifactId>yang-maven-plugin</artifactId>
58-
<version>0.6.1-SNAPSHOT</version>
59-
<!-- configuration -->
60-
</plugin>
61-
</plugins>
62-
</build>
50+
<plugins>
51+
<plugin>
52+
<groupId>org.opendaylight.yangtools</groupId>
53+
<artifactId>yang-maven-plugin</artifactId>
54+
<version>0.6.1-SNAPSHOT</version>
55+
<!-- configuration -->
56+
</plugin>
57+
</plugins>
58+
</build>

manuals/install-guide/src/main/asciidoc/bk-install-guide-docinfo.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<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>
2121
</legalnotice>
2222
<abstract>
23-
<para>This guide describes how to use and deploy OpenDaylight.</para>
23+
<para>This guide describes how to download and install OpenDaylight Helium.</para>
2424
</abstract>
2525
<revhistory>
2626
<revision>

manuals/install-guide/src/main/asciidoc/bk-install-guide.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= OpenDaylight Installation Guide
33
:docinfo:
44

5-
5+
//////////////////////////
66
[dedication]
77
Example Dedication
88
------------------
@@ -26,7 +26,6 @@ Preface Sub-section
2626
~~~~~~~~~~~~~~~~~~~
2727
Preface sub-section body.
2828
29-
//////////////////////////
3029
Using OpenDaylight
3130
--------------------------
3231
@@ -57,12 +56,15 @@ the end of their file.
5756
//////////////////////////
5857
include::general_installation.adoc[]
5958

59+
/////////////
6060
include::addons/aaa.adoc[]
6161
6262
include::addons/bgpcep.adoc[]
63+
/////////////
6364

6465
include::addons/defense4all.adoc[]
6566

67+
/////////////
6668
include::addons/groupbasedpolicy.adoc[]
6769
6870
include::addons/l2switch.adoc[]
@@ -84,11 +86,13 @@ include::addons/snmp4sdn.adoc[]
8486
include::addons/ttp.adoc[]
8587
8688
include::addons/vtn.adoc[]
89+
/////////////
8790

8891
include::addons/yangtools.adoc[]
8992

9093
:numbered!:
9194

95+
//////////////////////////
9296
[appendix]
9397
Example Appendix
9498
----------------
@@ -122,6 +126,8 @@ Text at the end of a book describing facts about its production.
122126
[index]
123127
Example Index
124128
-------------
129+
//////////////////////////
130+
125131
////////////////////////////////////////////////////////////////
126132
The index is normally left completely empty, it's contents being
127133
generated automatically by the DocBook toolchain.

manuals/install-guide/src/main/asciidoc/general_installation.adoc

Lines changed: 48 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@ This section should be reworked with content added.
44

55
=== Downloading the Karaf Distribution
66

7-
==== Getting the Default Distribution
7+
// ==== Getting the Default Distribution
8+
9+
The default distribution can be found on the OpenDaylight Software Download page here: http://www.opendaylight.org/software/downloads
810

911
This distribution comes with no features enabled by default, but all
1012
features are able to be installed and run.
1113

1214
CAUTION: Not all features can be run at the same time without negative
1315
consequences.
1416

15-
==== Using the Custom Distribution Download Tool
17+
// ==== Using the Custom Distribution Download Tool
1618

17-
Fill in info once this exists.
19+
// Fill in info once this exists.
1820

1921
=== Running the Karaf distribution
2022

@@ -60,44 +62,69 @@ opendaylight-user@root>
6062

6163
=== Installing Features
6264

65+
The following table describes a list of components in OpenDaylight Helium and the relevant Karaf feature to install in order to enable that component. To install a feature use the +feature:install+ Karaf command, for example:
66+
67+
-----
68+
feature:install <feature-name>
69+
-----
70+
71+
Multiple features can be installed in the same command:
72+
73+
-----
74+
feature:install <feature1-name> <feature2-name> ... <featureN-name>
75+
-----
76+
6377
.Karaf features
6478
[options="header"]
6579
|=======================
6680
| Component Name | Component Description | Karaf feature name | Compatibility
67-
| AAA | description | odl-aaa-all | all
68-
| AAA authz | description | odl-aaa-authz | all
69-
| AD-SAL | description | odl-adsal-all | all
70-
| AD-SAL Compatibility | description | odl-adsal-compatibility | all
7181
| BGPCEP | description | odl-bgpcep-all | all
72-
| dLux Web Interface | description | odl-dlux-core | all
7382
| LISP Flow Mapping | description | odl-lispflowmapping-all | all
74-
| MD-SAL Broker | description | odl-mdsal-broker | all
75-
| MD-SAL Clustering | description | odl-mdsal-clustering | all
83+
| MD-SAL Clustering | description | odl-mdsal-clustering | special
7684
| Netconf over ssh | description | odl-netconf-connector-ssh | all
77-
| Network Service Functions | description | odl-nsf-all | all
78-
| OpenFlow NXM Extensions | description | odl-openflow-nxm-extensions | all
79-
| OpenFlow Protocol | description | odl-openflowjava-protocol | all
80-
| OpenFlow Flow Programming | description | odl-openflowplugin-flow-services | all
81-
| OpenFlow Flow Programming (REST) | description | odl-openflowplugin-flow-services-rest | all
82-
| OpenFlow Flow Programming (UI) | description | odl-openflowplugin-flow-services-ui | all
85+
| OpenFlow Flow Programming | description | odl-openflowplugin-flow-services-ui | all
8386
| OVSDB | description | odl-ovsdb-all | all
8487
| Packetcable PCMM | description | odl-packetcable-all | all
8588
| SDN Interface | description | odl-sdninterfaceapp-all | all
86-
| RESCONF APIS | description | odl-restconf | all
89+
| RESTCONF Northbound API Support | description | odl-restconf | all
8790
| Service Flow Chaining (SFC) | description | odl-sfc-all | all
8891
| SFC over LISP | description | odl-sfclisp | all
8992
| SFC over L2 | description | odl-sfcofl2 | all
93+
| SFC over VXLAN | description | odl-ovsdb-ovssfc | self+all
9094
| Secure Networking Bootstrap | description | odl-snbi-all | all
9195
| OpenFlow Table Type Patterns | description | odl-ttp-all | all
9296
| SNMP4SDN | description | odl-snmp4sdn-all | all
9397
| Group Based Policy | description | odl-groupbasedpolicy-ofoverlay | self+all
94-
| L2 Switch | description | odl-l2switch-switch | self+all
95-
| L2 Switch (REST) | description | odl-l2switch-switch-rest | self+all
96-
| L2 Switch (UI) | description | odl-l2switch-switch-ui | self+all
98+
| L2 Switch | description | odl-l2switch-switch-ui | self+all
9799
| Plugin to OpenContrail | description | odl-plugin2oc | self+all
98100
| OVSDB OpenStack Neutron | description | odl-ovsdb-openstack | self+all
99-
| OVSDB SFC | description | odl-ovsdb-ovssfc | self+all
100101
| VTN Manager | description | odl-vtn-manager-all | self+all
101102
|=======================
102103

103104
In the table a compatibility value of "all" means that it can be run with any other features. A value of "self+all" indicates that the feature can be installed with anything with a value of "all", but not any other features with a value of "self+all".
105+
106+
==== Installing MD-SAL Clustering
107+
108+
The MD-SAL clustering feature is noted to have "special" compatibility. It *must* be installed first, before any other features. That is, the first command run at the Karaf CLI should be:
109+
110+
----
111+
feature:install odl-mdsal-clustering
112+
----
113+
114+
==== Listing Available and Installed Karaf Features
115+
116+
Note, that this is not an exhaustive list of Karaf features, however you can find a full list by running the following command at the Karaf CLI:
117+
118+
----
119+
feature:list
120+
----
121+
122+
To just list the installed Karaf features, run the command:
123+
124+
----
125+
feature:list -i
126+
----
127+
128+
=== Project-Specific Installation Instructions
129+
130+
The Defense4All and Yang Tools projects provide project-specific installation instructions here. Other projects can either be installed by simply installing the appropriate Karaf feature(s) or, in some cases, further instructions can be found in the User Guide or Developer Guide.

0 commit comments

Comments
 (0)