docs/getting-started-guide/installing_opendaylight.rst

   1 .. _install_odl:
   2
   3 ***********************
   4 Installing OpenDaylight
   5 ***********************
   6
   7 You complete the following steps to install your networking environment, with
   8 specific instructions provided in the subsections below.
   9
  10 Before detailing the instructions for these, we address the following:
  11 Java Runtime Environment (JRE) and operating system information
  12 Target environment
  13 Known issues and limitations
  14
  15
  16 Install OpenDaylight
  17 ====================
  18
  19 Downloading and installing OpenDaylight
  20 ---------------------------------------
  21
  22 The default distribution can be found on the OpenDaylight software
  23 download page: http://www.opendaylight.org/software/downloads
  24
  25 The Karaf distribution has no features enabled by default. However, all
  26 of the features are available to be installed.
  27
  28 .. note:: For compatibility reasons, you cannot enable all the features
  29           simultaneously. We try to document known incompatibilities in
  30           the `Install the Karaf features`_ section below.
  31
  32 Running the karaf distribution
  33 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  34
  35 To run the Karaf distribution:
  36
  37 #. Unzip the zip file.
  38 #. Navigate to the directory.
  39 #. run ``./bin/karaf``.
  40
  41 For Example::
  42
  43    $ ls distribution-karaf-0.5.x-Boron.zip
  44    distribution-karaf-0.5.x-Boron.zip
  45    $ unzip distribution-karaf-0.5.x-Boron.zip
  46    Archive:  distribution-karaf-0.5.x-Boron.zip
  47       creating: distribution-karaf-0.5.x-Boron/
  48       creating: distribution-karaf-0.5.x-Boron/configuration/
  49       creating: distribution-karaf-0.5.x-Boron/data/
  50       creating: distribution-karaf-0.5.x-Boron/data/tmp/
  51       creating: distribution-karaf-0.5.x-Boron/deploy/
  52       creating: distribution-karaf-0.5.x-Boron/etc/
  53       creating: distribution-karaf-0.5.x-Boron/externalapps/
  54       ...
  55       inflating: distribution-karaf-0.5.x-Boron/bin/start.bat
  56       inflating: distribution-karaf-0.5.x-Boron/bin/status.bat
  57       inflating: distribution-karaf-0.5.x-Boron/bin/stop.bat
  58    $ cd distribution-karaf-0.5.x-Boron
  59    $ ./bin/karaf
  60
  61        ________                       ________                .__  .__       .__     __
  62        \_____  \ ______   ____   ____ \______ \ _____  ___.__.\|  \| \|__\| ____ \|  \|___/  \|_
  63         /   \|   \\____ \_/ __ \ /    \ \|    \|  \\__  \<   \|  \|\|  \| \|  \|/ ___\\|  \|  \   __\
  64        /    \|    \  \|_> >  ___/\|   \|  \\|    `   \/ __ \\___  \|\|  \|_\|  / /_/  >   Y  \  \|
  65        \_______  /   __/ \___  >___\|  /_______  (____  / ____\|\|____/__\___  /\|___\|  /__\|
  66                \/\|__\|        \/     \/        \/     \/\/            /_____/      \/
  67
  68
  69
  70 * Press ``tab`` for a list of available commands
  71 * Typing ``[cmd] --help`` will show help for a specific command.
  72 * Press ``ctrl-d`` or type ``system:shutdown`` or ``logout`` to shutdown OpenDaylight.
  73
  74 Install the Karaf features
  75 ==========================
  76 To install a feature, use the following command, where feature1 is the feature
  77 name listed in the table below::
  78
  79     feature:install <feature1>
  80
  81 You can install multiple features using the following command::
  82
  83
  84     feature:install <feature1> <feature2> ... <featureN-name>
  85
  86 .. note:: For compatibility reasons, you cannot enable all Karaf features
  87    simultaneously. The table below documents feature installation names and
  88    known incompatibilities.Compatibility values indicate the following:
  89
  90 * **all** - the feature can be run with other features.
  91 * **self+all** - the feature can be installed with other features with a value of
  92   **all**, but may interact badly with other features that have a value of
  93   **self+all**. Not every combination has been tested.
  94
  95 Uninstalling features
  96 ---------------------
  97 To uninstall a feature, you must shut down OpenDaylight, delete the data
  98 directory, and start OpenDaylight up again.
  99
 100 .. important:: Uninstalling a feature using the Karaf feature:uninstall command
 101    is not supported and can cause unexpected and undesirable behavior.
 102
 103 Listing available features
 104 --------------------------
 105 To find the complete list of Karaf features, run the following command::
 106
 107     feature:list
 108
 109 To list the installed Karaf features, run the following command::
 110
 111     feature:list -i
 112
 113 Features to implement networking functionality provide release notes, which
 114 you can find in the :ref:`proj_rel_notes` section.
 115
 116 Karaf running on Windows 10
 117 ---------------------------
 118
 119 Windows 10 cannot be identify by Karaf (equinox).
 120 Issue occurs during installation of karaf features e.g.::
 121
 122    opendaylight-user@root>feature:install odl-restconf
 123    Error executing command: Can't install feature odl-restconf/0.0.0:
 124    Could not start bundle mvn:org.fusesource.leveldbjni/leveldbjni-all/1.8-odl in feature(s) odl-akka-leveldb-0.7: The bundle "org.fusesource.leveldbjni.leveldbjni-all_1.8.0 [300]" could not be resolved. Reason: No match found for native code: META-INF/native/windows32/leveldbjni.dll; processor=x86; osname=Win32, META-INF/native/windows64/leveldbjni.dll; processor=x86-64; osname=Win32, META-INF/native/osx/libleveldbjni.jnilib; processor=x86; osname=macosx, META-INF/native/osx/libleveldbjni.jnilib; processor=x86-64; osname=macosx, META-INF/native/linux32/libleveldbjni.so; processor=x86; osname=Linux, META-INF/native/linux64/libleveldbjni.so; processor=x86-64; osname=Linux, META-INF/native/sunos64/amd64/libleveldbjni.so; processor=x86-64; osname=SunOS, META-INF/native/sunos64/sparcv9/libleveldbjni.so; processor=sparcv9; osname=SunOS
 125
 126 Workaround is to add
 127
 128    org.osgi.framework.os.name = Win32
 129
 130 to the karaf file
 131
 132    etc/system.properties
 133
 134 The workaround and further info are in this thread:
 135 http://stackoverflow.com/questions/35679852/karaf-exception-is-thrown-while-installing-org-fusesource-leveldbjni
 136
 137
 138 Karaf OpenDaylight Features
 139 ===========================
 140
 141 .. list-table:: Karaf OpenDaylight features
 142     :widths: 10 25 10 5
 143     :header-rows: 1
 144
 145     * - Feature Name
 146       - Feature Description
 147       - Karaf feature name
 148       - Compatibility
 149
 150     * - Authentication
 151       - Enables authentication with support for federation using Apache Shiro
 152       - odl-aaa-shiro
 153       - all
 154
 155     * - BGP
 156       - Provides support for Border Gateway Protocol (including Link-State
 157         Distribution) as a source of L3 topology information
 158       - odl-bgpcep-bgp
 159       - all
 160
 161     * - BMP
 162       - Provides support for BGP Monitoring Protocol as a monitoring station
 163       - odl-bgpcep-bmp
 164       - all
 165
 166     * - DIDM
 167       - Device Identification and Driver Management
 168       - odl-didm-all
 169       - all
 170
 171     * - Centinel
 172       - Provides interfaces for streaming analytics
 173       - odl-centinel-all
 174       - all
 175
 176     * - DLUX
 177       - Provides an intuitive graphical user interface for OpenDaylight
 178       - odl-dlux-all
 179       - all
 180     * - Fabric as a Service (Faas)
 181       - Creates a common abstraction layer on top of a physical network so
 182         northbound APIs or services can be more easiliy mapped onto the
 183         physical network as a concrete device configuration
 184       - odl-faas-all
 185       - all
 186
 187     * - Group Based Policy
 188       - Enables Endpoint Registry and Policy Repository REST APIs and associated
 189         functionality for Group Based Policy with the default renderer for
 190         OpenFlow renderers
 191       - odl-groupbasedpolicy-ofoverlay
 192       - all
 193
 194     * - GBP User Interface
 195       - Enables a web-based user interface for Group Based Policy
 196       - odl-groupbasedpolicyi-ui
 197       - all
 198
 199     * - GBP FaaS renderer
 200       - Enables the Fabric as a Service renderer for Group Based Policy
 201       - odl-groupbasedpolicy-faas
 202       - self+all
 203
 204     * - GBP Neutron Support
 205       - Provides OpenStack Neutron support using Group Based Policy
 206       - odl-groupbasedpolicy-neutronmapper
 207       - all
 208
 209     * - L2 Switch
 210       - Provides L2 (Ethernet) forwarding across connected OpenFlow switches and
 211         support for host tracking
 212       - odl-l2switch-switch-ui
 213       - self+all
 214
 215     * - LACP
 216       - Enables support for the Link Aggregation Control Protocol
 217       - odl-lacp-ui
 218       - self+all
 219
 220     * - LISP Flow Mapping
 221       - Enables LISP control plane services including the mapping system
 222         services REST API and LISP protocol SB plugin
 223       - odl-lispflowmapping-msmr
 224       - all
 225
 226     * - NEMO CLI
 227       - Provides intent mappings and implementation with CLI for legacy devices
 228       - odl-nemo-cli-renderer
 229       - all
 230
 231     * - NEMO OpenFlow
 232       - Provides intent mapping and implementation for OpenFlow devices
 233       - odl-nemo-openflow-renderer
 234       - self+all
 235
 236     * - NetIDE
 237       - Enables portabilty and cooperation inside a single network by using a
 238         client/server multi-controller architecture
 239       - odl-netide-rest
 240       - all
 241
 242     * - NETCONF over SSH
 243       - Provides support to manage NETCONF-enabled devices over SSH
 244       - odl-netconf-connector-ssh
 245       - all
 246
 247     * - OF-CONFIG
 248       - Enables remote configuration of OpenFlow datapaths
 249       - odl-of-config-rest
 250       - all
 251
 252     * - OVSDB OpenStack Neutron
 253       - OpenStack Network Virtualization using OpenDaylight's OVSDB support
 254       - odl-ovsdb-openstack
 255       - all
 256
 257     * - OVSDB Southbound
 258       - OVSDB MDSAL southbound plugin for Open_vSwitch schema
 259       - odl-ovsdb-southbound-impl-ui
 260       - all
 261
 262     * - OVSDB HWVTEP Southbound
 263       - OVSDB MDSAL hwvtep southbound plugin for the hw_vtep schema
 264       - odl-ovsdb-hwvtepsouthbound-ui
 265       - all
 266
 267     * - OVSDB NetVirt SFC
 268       - OVSDB NetVirt support for SFC
 269       - odl-ovsdb-sfc-ui
 270       - all
 271
 272     * - OpenFlow Flow Programming
 273       - Enables discovery and control of OpenFlow switches and the topoology
 274         between them
 275       - odl-openflowplugin-flow-services-ui
 276       - all
 277
 278     * - OpenFlow Table Type Patterns
 279       - Allows OpenFlow Table Type Patterns to be manually associated with
 280         network elements
 281       - odl-ttp-all
 282       - all
 283
 284     * - Packetcable PCMM
 285       - Enables flow-based dynamic QoS management of CMTS use in the DOCSIS
 286         infrastructure and a policy server
 287       - odl-packetcable-policy-server
 288       - self+all
 289
 290     * - PCEP
 291       - Enables support for PCEP
 292       - odl-bgpcep-pcep
 293       - all
 294
 295     * - RESTCONF API Support
 296       - Enables REST API access to the MD-SAL including the data store
 297       - odl-restconf
 298       - all
 299
 300     * - SDNinterface
 301       - Provides support for interaction and sharing of state between
 302         (non-clustered) OpenDaylight instances
 303       - odl-sdninterfaceapp-all
 304       - all
 305
 306     * - SFC over L2
 307       - Supports implementing Service Function Chaining using Layer 2
 308         forwarding
 309       - odl-sfcofl2
 310       - self+all
 311
 312     * - SFC over LISP
 313       - Supports implementing Service Function Chaining using LISP
 314       - odl-sfclisp
 315       - all
 316
 317     * - SFC over REST
 318       - Supports implementing Service Function Chaining using REST CRUD
 319         operations on network elements
 320       - odl-sfc-sb-rest
 321       - all
 322
 323     * - SFC over VXLAN
 324       - Supports implementing Service Function Chaining using VXLAN tunnels
 325       - odl-sfc-ovs
 326       - self+all
 327
 328     * - SNMP Plugin
 329       - Enables monitoring and control of network elements via SNMP
 330       - odl-snmp-plugin
 331       - all
 332
 333     * - SNMP4SDN
 334       - Enables OpenFlow-like control of network elements via SNMP
 335       - odl-snmp4sdn-all
 336       - all
 337
 338     * - SSSD Federated Authentication
 339       - Enables support for federated authentication using SSSD
 340       - odl-aaa-sssd-plugin
 341       - all
 342
 343     * - Secure tag eXchange Protocol (SXP)
 344       - Enables distribution of shared tags to network devices
 345       - odl-sxp-controller
 346       - all
 347
 348     * - Time Series Data Repository (TSDR)
 349       - Enables support for collecting, storing and querying time series data.
 350         TSDR supports the following collection data:
 351
 352         * OpenFlow statistics
 353         * NETFLOW statistics
 354         * sFlow statistics
 355         * OpenFlow Controller metrics
 356         * SNMP data
 357         * SysLog data
 358         * RestConf data
 359
 360         TSDR supports the following data stores:
 361
 362         * HSQLDB
 363         * HBase
 364         * Cassandra
 365
 366         TSDR supports the default OpenDaylight RESTCONF and API interfaces and an
 367         ElasticSearch interface for all data stores.
 368       - odl-tsdr-core, odl-tsdr-hsqldb
 369       - all
 370
 371     * - TSDR Data Collectors
 372       - TSDR collector features include support for collecting the following
 373         data:
 374
 375         * OpenFlow statistics
 376         * NETFLOW statistics
 377         * sFlow statistics
 378         * OpenFlow Controller metrics
 379         * SNMP data
 380         * SysLog data
 381         * RESTCONF data.
 382
 383       - * odl-tsdr-openflow-statistics-collector
 384         * odl-tsdr-netflow-statistics-collector
 385         * odl-tsdr-sflow-statistics-collector
 386         * odl-tsdr-controller-metrics-collector
 387         * odl-tsdr-snmp-data-collector
 388         * odl-tsdr-syslog-collector
 389         * odl-tsdr-restconf-collector
 390       - all
 391
 392     * - TSDR Data Stores
 393       - TSDR enables support for the following data stores:
 394         * HSQLDB
 395         * HBase
 396         * Cassandra
 397       - * odl-tsdr-hsqldb
 398         * odl-tsdr-hbase
 399         * odl-tsdr-cassandra
 400       - all
 401
 402     * - TSDR Data Query
 403       - TSDR supports the default OpenDaylight RESTCONF and ODL API interfaces
 404         for queries to all data stores.  It also supports an integrated ElasticSearch query.
 405       - odl-tsdr-elasticsearch
 406       - all
 407
 408     * - Topology Processing Framework
 409       - Enables merged and filtered views of network topologies
 410       - odl-topoprocessing-framework
 411       - all
 412
 413     * - Unified Secure Channel (USC)
 414       - Enables support for secure, remote connections to network devices
 415       - odl-usc-channel-ui
 416       - all
 417
 418     * - VTN Manager
 419       - Enables Virtual Tenant Network support
 420       - odl-vtn-manager-rest
 421       - self+all
 422
 423     * - VTN Manager Neutron
 424       - Enables OpenStack Neutron support of VTN Manager
 425       - odl-vtn-manager-neutron
 426       - self+all
 427
 428
 429 Other OpenDaylight features
 430 ===========================
 431
 432 .. list-table:: Other OpenDaylight features
 433     :widths: 10 25 10 5
 434     :header-rows: 1
 435
 436     * - Feature Name
 437       - Feature Description
 438       - Karaf feature name
 439       - Compatibility
 440
 441     * - OpFlex
 442       - Provides OpFlex agent for Open vSwitch to enforce network policy, such
 443         as GBP, for locally-attached virtual machines or containers
 444       - n/a
 445       - all
 446
 447     * - NeXt
 448       - Provides a developer toolkit for designing network-centric topology
 449         user interfaces
 450       - n/a
 451       - all
 452
 453
 454 Experimental OpenDaylight Features
 455 ==================================
 456 The following functionality is labeled as experimental in this OpenDaylight
 457 release and should be used accordingly. In general, it is not supposed to be
 458 used in production unless its limitations are well understood by those
 459 deploying it.
 460
 461 .. list-table:: Other features
 462     :widths: 10 25 10 5
 463     :header-rows: 1
 464
 465     * - Feature Name
 466       - Feature Description
 467       - Karaf feature name
 468       - Compatibility
 469
 470     * - Authorization
 471       - Enables configurable role-based authorization
 472       - odl-aaa-authz
 473       - all
 474
 475     * - ALTO
 476       - Enables support for Application-Layer Traffic Optimization
 477       - odl-alto-core
 478       - self+all
 479
 480     * - CAPWAP
 481       - Enables control of supported wireless APs
 482       - odl-capwap-ac-rest
 483       - all
 484
 485     * - Clustered Authentication
 486       - Enables the use of the MD-SAL clustered data store for the
 487         authentication database
 488       - odl-aaa-authn-mdsal-cluster
 489       - all
 490
 491     * - Controller Shield
 492       - Provides controller security information to northbound applications
 493       - odl-usecplugin
 494       - all
 495
 496     * - GBP IO Visor Renderer
 497       - Provides support for rendering Group Based Policy to IO Visor
 498       - odl-groupbasedpolicy-iovisor
 499       - all
 500
 501     * - Internet of Things Data Management
 502       - Enables support for the oneM2M specification
 503       - odl-iotdm-onem2m
 504       - all
 505
 506     * - LISP Flow Mapping OpenStack Network Virtualization
 507       - Experimental support for OpenStack Neutron virtualization
 508       - odl-lispflowmapping-neutron
 509       - self+all
 510
 511     * - Network Intent Composition (NIC)
 512       - Provides abstraction layer for communcating network intents (including
 513         a distributed intent mapping service REST API) using either Hazelcast
 514         or the MD-SAL as the backing data store for intents
 515       - odl-nic-core-hazelcast or odl-nic-core-mdsal
 516       - all
 517
 518     * - NIC Console
 519       - Provides a Karaf CLI extension for intent CRUD operations and mapping
 520         service operations
 521       - odl-nic-console
 522       - all
 523
 524     * - NIC VTN renderer
 525       - Virtual Tenant Network renderer for Network Intent Composition
 526       - odl-nic-renderer-vtn
 527       - self+all
 528
 529     * - NIC GBP renderer
 530       - Group Based Policy renderer for Network Intent Composition
 531       - odl-nic-renderer-gbp
 532       - self+all
 533
 534     * - NIC OpenFlow renderer
 535       - OpenFlow renderer for Network Intent Composition
 536       - odl-nic-renderer-of
 537       - self+all
 538
 539     * - NIC NEMO renderer
 540       - NEtwork MOdeling renderer for Network Intent Composition
 541       - odl-nic-renderer-nemo
 542       - self+all
 543
 544     * - OVSDB NetVirt UI
 545       - OVSDB DLUX UI
 546       - odl-ovsdb-ui
 547       - all
 548
 549     * - Secure Networking Bootstrap
 550       - Defines a SNBi domain and associated white lists of devices to be
 551         accommodated to the domain
 552       - odl-snbi-all
 553       - self+all
 554
 555     * - UNI Manager
 556       - Initiates the development of data models and APIs to facilitate
 557         configuration and provisioning connectivity services for OpenDaylight
 558         applications and services
 559       - odl-unimgr
 560       - all
 561
 562     * - YANG PUBSUB
 563       - Allows subscriptions to be placed on targeted subtrees of YANG
 564         datastores residing on remote devices to obviate the need for
 565         OpenDaylight to make continuous fetch requests
 566       - odl-yangpush-rest
 567       - all
 568
 569 Install support for REST APIs
 570 =============================
 571 Most components that offer REST APIs will automatically load the RESTCONF API
 572 Support component, but if for whatever reason they seem to be missing, install
 573 the “odl-restconf” feature to activate this support.