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