Merge branch 'installation' into 'master'

# Installing OSM

# How to install OSM

## Pre-requirements

- Each VIM has a so-called management network, which provides IP addresses to VNFs.

- That management network is reachable from OSM.

## Installation procedure

## How to install OSM (standard installation)

Once you have one host available with the characteristics above, you just need to trigger the OSM installation by:

./install_osm.sh --k8s_monitor

 ```

### Other installer options

### How to install optional components

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

./install_osm.sh --k8s_monitor --pla

```

### Reference: Other installer options

OSM installer includes a larger number of install options. The general usage is the following:

```bash

## Other installation methods

### Remote installation to an OpenStack infrastructure

### How to install OSM in a remote 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:

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

### Charmed Installation

### How to install Charmed OSM

Some cases where the Charmed installer might be more suitable:

This will install OSM on [microk8s](https://microk8s.io/) using Charms. 

#### External

#### How to install Charmed OSM using external infraestructure

For the installation using external components the following parameters can be added:

For more information on the LXD `cloud.yaml` and `credential.yaml` files consult [here](16-lxd-cluster.md)

#### OSM client in Charmed installations

#### How to configure needed environment variables in Charmed OSM

Once the installation is over, follow these instructions to use the osmclient:

Once the installation is over, follow these instructions to configure the environments variables needed by the osmclient:

```bash

NBI_IP=$(microk8s.kubectl describe -n osm ingress | grep -E "nbi.*\.io" | xargs)

echo "export OSM_PASSWORD=$NBI_PASSWORD" >> ~/.bashrc

```

#### How to retrieve login usernames and passwords in OSM Charmed installations

#### How to retrieve login usernames and passwords in Charmed OSM

The following instructions show how to retrieve usernames and passwords of OSM modules in Charmed installations.

#### Scaling OSM Components

##### Scaling OSM Charms

##### How to scale Charmed OSM components

Scaling or replicating the amount of containers each OSM component has can help both with distributing the workloads (in the case of some components) and also with high availability in case of one of the replicas failing. 

If the application is already scaled to the number stated in the scale-application command nothing will change. If the number is lower, the application will scale down.

##### Scaling OSM VCA

##### How to scale Charmed OSM VCA

For more detailed information about setting up a highly available controller please consult the official [documentation](https://juju.is/docs/controller-high-availability).

./install_osm.sh --charmed --vca manual-controller

```

#### Using external DBs

#### How to use external DBs with Charmed OSM

Charmed OSM supports the usage of external DBs. For this purpose, relations to the DBs should be removed:

juju config keystone mysql_root_password="<MySQL Root Password>"

```

### How to upgrade components from daily images

### How to upgrade components from daily images in standard deployment

**Upgrading a specific OSM component without upgrading the others accordingly may lead to potential inconsistencies.** Unless you are really sure about what you are doing, please use this procedure with caution.

# kubectl -n osm apply -f /etc/osm/docker/osm_pods/ng-ui.yaml

```

## Checking your installation

## How to check OSM installation (standard installation)

After some time, you will get a fresh OSM installation with its latest, pre-built docker images which are built daily. You can access to the UI in the following URL (user:`admin`, password: `admin`): [http://1.2.3.4](http://1.2.3.4/), replacing 1.2.3.4 by the IP address of your host.

osm --help

```

## Installing standalone OSM Client

## Explanation: What the OSM client is

The **OSM Client** is a client library and a command-line tool (based on Python) to operate OSM, which accesses OSM's Northbound Interface (NBI) and lets you manage descriptors, VIMs, Network Services, Slices, etc. along with their whole lifecycle. In other words, the OSM Client is a sort of Swiss knife that provides a convenient access to all the functionality that OSM's NBI offers.

There are two methods of installing the OSM client: via a Snap, or a Debian Package.

### Snap Installation

### How to install standalone OSM Client using snaps

On systems that support snaps, you can install the OSM client with the following command:

There are tracks available for all releases.  Omitting the channel will use the latest stable release version.

### Debian Package Installation

### How to install standalone OSM Client using debian packages

In order to install the OSM Client in your local Linux machine, you should follow this procedure: