1 ############################
2 <Feature> Installation Guide
3 ############################
5 .. note:: *Only* use this template if installation is more complicated
6 than simply installing a feature in the Karaf distribution.
7 Otherwise simply provide the names of all user-facing
8 features in your M3 readout.
10 This is a template for installing a feature or a project developed in
11 the ODL project. The *feature* could be interfaces, protocol plug-ins,
17 Add overview of the feature. Include Architecture diagram and the
18 positioning of this feature in overall controller architecture.
19 Highlighting the feature in a different color within the overall
20 architecture must help. Include information to describe if the project
21 is within ODL installation package or to be installed separately.
23 Pre Requisites for Installing <Feature>
24 =======================================
26 * Hardware Requirements
27 * Software Requirements
29 Preparing for Installation
30 ==========================
32 Include any pre configuration, database, or other software downloads
33 required to install <feature>.
38 Include if you have separate procedures for Windows and Linux
40 Verifying your Installation
41 ===========================
43 Describe how to verify the installation.
52 Post Installation Configuration
53 ===============================
55 Post Installation Configuration section must include some basic
56 (must-do) procedures if any, to get started.
58 Mandatory instructions to get started with the product.
62 * Integration points with controller
64 Upgrading From a Previous Release
65 =================================
69 Uninstalling <Feature>
70 ======================