Feature: Installing OSM to OpenStack using Ansible
[osm/Features.git] / Release7 / Ansible_OSM_installer.md
1 # Install OSM to OpenStack using Ansible #
2
3 ## Proposer(s) ##
4
5 Antonio Marsico (BT)
6
7 ## Type ##
8
9 Feature
10
11 ## Target MDG/TF ##
12
13 Devops, Other
14
15 ## Description ##
16
17 Installing OSM on top of an OpenStack infrastructure may be cumbersome. Networks, Security groups, Flavors and Images are a few example of what you need to setup before being ready to install OSM on OpenStack.
18
19 This feature proposes the automatic installation of OSM on top of an OpenStack infrastructure. It is based on Ansible, a well-known automation tool. The Ansible playbook performs the following operations:
20
21 * Create an external network and its subnet
22 * Download the Ubuntu 18.04 image and upload it
23 * Create a security group to allow SSH and HTTP access to an instance
24 * Create a VM flavour compatible to OSM
25 * Deploy an Ubuntu 18.04 instance
26 * Install OSM when the instance becomes available
27
28 All these tasks are performed only if required. This is a feature of Ansible. For instance, if the Ubuntu 18.04 image is already present, the task is skipped.
29
30 ## Demo or definition of done ##
31
32 It is an open question to the community if it worth adding this as an option to the `install_osm.sh` installer or leave it as a standalone feature. 
33
34 If the standard invocation of Ansible is used, the following procedure is required.
35
36 ### Playbook execution
37
38 In order to execute the playbook, it is required an OpenStack openrc file. It can be downloaded from the OpenStack web interface Horizon.
39
40 After that, it can be loaded with the following command:
41
42 `$ . openrc`
43
44 Then, all the credentials are loaded in the bash environment. Now it is possible to execute the playbook to configure OpenStack and install OSM:
45
46 `$ ansible-playbook site.yml`