Open Source MANO (OSM) is an ETSI-hosted open source community delivering a production-quality MANO stack for NFV, capable of consuming openly published information models, available to everyone, suitable for all VNFs, operationally significant and VIM-independent. OSM is aligned to NFV ISG information models while providing first-hand feedback based on its implementation experience.
Release SEVEN brings a number of improvements over previous releases. For the full list of new features, please refer to the [Release SEVEN Documentation](index.md). For a comprehensive overview of OSM functionalities, you can also refer to the [OSM Scope and Functionality White Paper](https://osm.etsi.org/images/OSM_EUAG_White_Paper_OSM_Scope_and_Functionality.pdf) or to the release notes of previous OSM releases ([ONE](https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseONE-FINAL.pdf), [TWO](https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseTWO-FINAL.pdf), [THREE](https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseTHREE-FINAL.pdf), [FOUR](https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseFOUR-FINAL.pdf), [FIVE](https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseFIVE-FINAL.pdf)).
Release EIGHT brings a number of improvements over previous releases. For the full list of new features, please refer to the [Release EIGHT Documentation](index.md). For a comprehensive overview of OSM functionalities, you can also refer to the [OSM Scope and Functionality White Paper](https://osm.etsi.org/images/OSM_EUAG_White_Paper_OSM_Scope_and_Functionality.pdf) or to the release notes of previous OSM releases ([ONE](https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseONE-FINAL.pdf), [TWO](https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseTWO-FINAL.pdf), [THREE](https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseTHREE-FINAL.pdf), [FOUR](https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseFOUR-FINAL.pdf), [FIVE](https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseFIVE-FINAL.pdf)).
**OSM in Practice**:
...
...
@@ -38,7 +38,7 @@ All you need to run OSM is a single server or VM with the following requirements
Once you have prepared the host with the previous requirements, all you need to do is:
#### Installation on a standalone Kubernetes environment
From Release SEVEN, OSM can be deployed on a single host running a Kubernetes cluster. Although the default option is to use docker swarm, you can now tell the installer to use K8s as the container framework. The installer will install the required packages to run a single-node K8s cluster and will deploy the different K8s objects on it.
OSM can be deployed on a single host running a Kubernetes cluster. Although the default option is to use docker swarm, you can now tell the installer to use K8s as the container framework. The installer will install the required packages to run a single-node K8s cluster and will deploy the different K8s objects on it.
```bash
./install_osm.sh -c k8s
...
...
@@ -83,7 +83,7 @@ In addition, you can use the option `--k8s_monitor` to install an add-on to moni
#### Other installation options
- An additional installation option is the [Charmed Installation](03-installing-osm.md#charmed-installation) which will install OSM on Kubernetes with charms.
- You can also run OSM using a pre-built [vagrant](https://app.vagrantup.com/osm/boxes/releaseseven) image. You can find here detailed instruction on [how to install OSM in Vagrant](03-installing-osm.md#vagrant-installation)
- You can also run OSM using a pre-built [vagrant](https://app.vagrantup.com/osm/boxes/releaseeight) image. You can find here detailed instruction on [how to install OSM in Vagrant](03-installing-osm.md#vagrant-installation)
- For other special installation options, please refer to the [specific chapter on installation options](03-installing-osm.md).
From Release SEVEN, OSM can be deployed on a single host running a Kubernetes cluster. Although the default option is to use docker swarm, you can now tell the installer to use K8s as the container framework. The installer will install the required packages to run a single-node K8s cluster and will deploy the different K8s objects on it.
OSM can be deployed on a single host running a Kubernetes cluster. Although the default option is to use docker swarm, you can now tell the installer to use K8s as the container framework. The installer will install the required packages to run a single-node K8s cluster and will deploy the different K8s objects on it.
The minimum requirements to run OSM on top of Kubernetes are 2 CPUs, 6 GB RAM, 20GB disk and a single interface with Internet access.
@@ -122,7 +124,7 @@ Follow the instructions to install them in their respective sites:
#### 2) Create the initial Vagrantfile in a predefined directory of your choice
```bash
vagrant init osm/releaseseven
vagrant init osm/releaseeight
```
- NOTE: to ensure the latest version is downloaded, destroy any previous existing OSM boxes (i.e. using `vagrant box list` and, if needed, `vagrant box remove`)
...
...
@@ -131,7 +133,7 @@ vagrant init osm/releaseseven
Editing the `Vagrantfile` is required if you need to customize the image for opened ports, assigned memory, etc.
For Release SEVEN, this is these are the recommended contents for the `Vagrantfile`:
For Release EIGHT, this is these are the recommended contents for the `Vagrantfile`:
```ruby
Vagrant.configure("2")do|config|
...
...
@@ -147,7 +149,7 @@ Vagrant.configure("2") do |config|
If at any point you need to add the optional components (`elk_stack`, `vimemu`, ...) you can do so by downloading the installer from inside your VM and executing it with the `-o` option, for example:
sudo add-apt-repository -y"deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseEIGHT stable devops IM osmclient"
sudo apt-get update
sudo apt-get install-y python3-pip
sudo-H python3 -m pip install-U pip
...
...
@@ -380,7 +382,7 @@ For additional remote access options, see `osm --help` for more info.
Due to the new architecture and dockerized components introduced in OSM since Release FOUR, OSM platform upgrade is quite easy. Upgrading to the latest minor version is as simple as running again the installer:
@@ -400,7 +402,7 @@ You can use option `-t` in the installer to specify a specific docker tag to be
To install the latest daily images:
```bash
./install_osm.sh -t releaseseven-daily
./install_osm.sh -t releaseeight-daily
```
To install a previous version e.g. v6.0.3:
...
...
@@ -409,16 +411,17 @@ To install a previous version e.g. v6.0.3:
./install_osm.sh -t v6.0.3
```
The previous commands will do the installation and deployment of the stack, but will not make it persistent after re-deployments of the stack (or reboots). In order to make it persistent, you will have to update the file `docker-compose.yaml`. Below an example to update it to use `releaseseven-daily` tag:
The previous commands will do the installation and deployment of the stack, but will not make it persistent after re-deployments of the stack (or reboots). In order to make it persistent, you will have to update the file `docker-compose.yaml`. Below an example to update it to use `releaseeight-daily` tag:
@@ -600,7 +603,7 @@ You can use option `-t` in the installer to specify a specific docker tag to be
To install the latest daily images:
```bash
./install_osm.sh -c k8s -t releaseseven-daily
./install_osm.sh -c k8s -t releaseeight-daily
```
To install a previous version e.g. v6.0.3:
...
...
@@ -611,16 +614,16 @@ To install a previous version e.g. v6.0.3:
The previous commands will do the installation and deployment of the whole platform in the namespace `osm`.
Another option is to change directly the K8s Manifest YAML files located in `/etc/osm/docker/osm_pods`. Below an example to update them to use `releaseseven-daily` tag:
Another option is to change directly the K8s Manifest YAML files located in `/etc/osm/docker/osm_pods`. Below an example to update them to use `releaseeight-daily` tag:
@@ -308,7 +308,7 @@ Day-1 and Day-2 are both managed by the VCA (VNF Configuration & Abstraction) mo
There are two types of charms:
-**Native charms:** the set of scripts run inside the VNF components. This kind of charms are new in Release 7.
-**Native charms:** the set of scripts run inside the VNF components.
-**Proxy charms:** the set of scripts run in LXC containers in an OSM-managed machine (which could be where OSM resides), which use ssh or other methods to get into the VNF instances and configure them.
@@ -1151,7 +1151,7 @@ To remove the NSI2 run the command: `osm nsi-delete my_shared_slice`.
## Using Kubernetes-based VNFs (KNFs)
From Release SEVEN, OSM supports Kubernetes-based Network Functions (KNF). This feature unlocks more than 20.000 packages that can be deployed besides VNFs and PNFs. This section guides you to deploy your first KNF, from the installation of multiple ways of Kubernetes clusters until the selection of the package and deployment.
OSM supports Kubernetes-based Network Functions (KNF). This feature unlocks more than 20.000 packages that can be deployed besides VNFs and PNFs. This section guides you to deploy your first KNF, from the installation of multiple ways of Kubernetes clusters until the selection of the package and deployment.