Merge "Modified documents with new references for Be release"
[docs.git] / docs / getting-started-guide / introduction.rst
1 Introduction
2 ============
3
4 The OpenDaylight project is an open source platform for Software Defined
5 Networking (SDN) that uses open protocols to provide centralized, programmatic
6 control and network device monitoring. Like many other SDN controllers,
7 OpenDaylight supports OpenFlow, as well as offering ready-to-install network
8 solutions as part of its platform.
9
10 Much as your operating system provides an interface for the devices that
11 comprise your computer, OpenDaylight provides an interface that allows you to
12 connect network devices quickly and intelligently for optimal network
13 performance.
14
15 It’s extremely helpful to understand that setting up your networking environment
16 with OpenDaylight is not a single software installation. While your first
17 chronological step is to install OpenDaylight, you install additional
18 functionality packaged as Karaf features to suit your specific needs.
19
20 Before walking you through the initial OpenDaylight installation, this guide
21 presents a fuller picture of OpenDaylight’s framework and functionality so you
22 understand how to set up your networking environment. The guide then takes you
23 through the installation process.
24
25 What’s different about OpenDaylight
26 -----------------------------------
27
28 Major distinctions of OpenDaylight’s SDN compared to traditional SDN options are
29 the following:
30
31 * A microservices architecture, in which a “microservice” is a particular
32   protocol or service that a user wants to enable within their installation of
33   the OpenDaylight controller, for example:
34
35   * A plugin that provides connectivity to devices via the OpenFlow or BGP
36     protocols
37   * An L2-Switch or a service such as Authentication, Authorization, and
38     Accounting (AAA).
39
40 * Support for a wide and growing range of network protocols beyond OpenFlow,
41   including SNMP, NETCONF, OVSDB, BGP, PCEP, LISP, and more.
42 * Support for developing new functionality comprised of additional networking
43   protocols and services.
44
45 .. note:: A thorough understanding of the microservices architecture is
46    important for experienced network developers who want to create new solutions
47    in OpenDaylight. If you are new to networking and OpenDaylight, you most
48    likely won’t design solutions, but you should comprehend the microservices
49    concept to understand how OpenDaylight works and how it differs from other
50    SDN programs.
51
52 What you’ll find in this guide
53 ------------------------------
54
55 To set up your environment, you first install OpenDaylight followed by the
56 Apache Karaf features that offer the functionality you require. The OpenDaylight
57 Getting Started Guide covers feature descriptions, OpenDaylight installation
58 procedures, and feature installation.
59
60
61 The Getting Started Guide also includes other helpful information, with the
62 following organization:
63
64 #. An overview of OpenDaylight and common use models
65 #. Who should use this guide?
66 #. OpenDaylight concepts and tools
67 #. Explanations of OpenDaylight Apache Karaf features and other features that
68    extend network functionality
69 #. OpenDaylight Beryllium system requirements and Release Notes
70 #. OpenDaylight installation instructions
71 #. Feature tables with installation names and compatibility notes