3 Ansible role for the `OpenDaylight SDN controller`_.
5 Installing Ansible-OpenDaylight
6 -------------------------------
7 The Ansible Galaxy tool that ships with Ansible can be used to install
10 To install the latest version of Ansible on Red Hat-based OSs:
14 $ sudo yum install -y ansible
17 To install the latest version of Ansible on Debian-based OSs:
21 $ sudo apt-add-repository ppa:ansible/ansible
23 $ sudo apt-get install -y ansible
26 After you install **ansible-galaxy**, install ansible-opendaylight:
30 $ ansible-galaxy install git+ssh://<LF ID>@git.opendaylight.org:29418/integration/packaging/ansible-opendaylight.git
32 The OpenDaylight Ansible role doesn't depend on any other Ansible roles.
39 To set extra Karaf features to be installed at OpenDaylight start time, pass
40 them in a list to the **extra_features** variable. The extra features you pass
41 will typically be driven by the requirements of your use case.
43 OpenDaylight normally installs a default set of Karaf features at boot. They
44 are recommended, so the ODL Ansible role defaults to installing them. This can
45 be customized by overriding the **default_features** variable. You shouldn't
46 normally need to do so.
50 To change OpenDaylight's northbound REST API port from the default of 8181, use
51 the **odl_rest_port** variable.
53 For example, in an Openstack deployment, the Swift project uses 8181 and
54 conflicts with OpenDaylight.
56 The Ansible role will handle opening this port in FirewallD if it's active.
60 OpenDaylight supports RPM and deb-based installs, either from a repository
61 or directly from a URL to a package. Use the **instal_method** var to configure
62 which deployment scenario is used.
65 rpm_repo: Install ODL using its Yum repo config
66 rpm_path: Install ODL RPM from a local path or remote URL
67 dep_repo: Install ODL using a Debian repository
68 deb_path: Install ODL .deb from a local path or remote URL
70 Installing OpenDaylight
71 -----------------------
72 To install OpenDaylight via ansible-opendaylight, use **ansible-playbook**.
76 sudo ansible-playbook -i "localhost," -c local examples/<playbook>
78 Example playbooks are provided for various deployments.
82 The playbook below would install and configure OpenDaylight using all defaults.
92 To override default settings, pass variables to the **opendaylight** role.
101 extra_features: ['odl-netvirt-openstack']
107 opendaylight-user@root>feature:list | grep odl-netvirt-openstack
108 odl-netvirt-openstack | <odl-release> | x | odl-netvirt-<odl-release> | OpenDaylight :: NetVirt :: OpenStack
112 OpenDaylight is Open Source. Contributions encouraged!
116 The `OpenDaylight Integration/Packaging project`_ maintains this role.
118 .. _OpenDaylight SDN controller: https://www.opendaylight.org/project/technical-overview
119 .. _OpenDaylight Integration/Packaging project: https://wiki.opendaylight.org/view/Integration/Packaging