Commit bb899851 authored by marsico's avatar marsico
Browse files

Added the OpenStack installer documentation

parent 24cb5210
Loading
Loading
Loading
Loading
+28 −0
Original line number Diff line number Diff line
@@ -67,6 +67,34 @@ In addition, you can use the option `--k8s_monitor` to install an add-on to moni
./install_osm.sh -c k8s --k8s_monitor
 ```

### Remote installation to an OpenStack infrastructure

OSM could be installed to a remote OpenStack infrastructure from the OSM standard installer. It is based on Ansible and it takes care of configuring the OpenStack infrastructure before deploying a VM with OSM. The Ansible playbook performs the following steps:

1. Creation of a new VM flavour (4 CPUs, 8 GB RAM, 40 GB disk) 
2. Download of Ubuntu 18.04 image and upload it to OpenStack Glance
3. Generation of a new SSH private and public key pair
4. Setup of a new security group to allow external SSH and HTTP access
5. Deployment of a clean Ubuntu 18.04 VM and installation of OSM to it

**Important note:** The OpenStack user needs Admin rights or similar to perform those operations. 

The installation can be performed with the following command:

```bash
wget https://osm-download.etsi.org/ftp/osm-8.0-eight/install_osm.sh
chmod +x install_osm.sh
./install_osm.sh -O <openrc file/cloud name> -N <OpenStack public network name/ID> [--volume] [OSM installer options]
```

The options `-O` and `-N` are mandatory. The `-O` accepts both a path to an OpenStack openrc file or a cloud name. If a cloud name is used, the clouds.yaml file should be under `~/.config/openstack/` or `/etc/openstack/`. More information about the `clouds.yaml` file can be found [here](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html)

The `-N` requires an external network name or ID. This is going to be the OpenStack network where the OSM VM is going to be attached.

The `--volume` option is used to instruct OpenStack to create an external volume attached to the VM instead of using a local one. This may be suitable for production environments. It requires OpenStack Cinder configured on the OpenStack infrastructure.

Some OSM installer options are supported, in particular the following: `-r -k -u -R -t`. Other options will be supported in the future.

### Other installer options

You can include optional components in your installation by adding the following flags: