Getting Started

Open Source MANO (OSM) is an ETSI-hosted open source community delivering a production-quality MANO stack for NFV. OSM consumes openly published information models, is suitable for all VNFs, and is VIM-independent.

This page walks you through installing OSM on a single host, verifying the installation, and deploying your first Network Service. For an overview of OSM’s architecture and concepts, see Core Concepts. For the full feature list of the current release, see OSM Releases.

Install OSM

All you need to run OSM is a single server or VM with the following requirements:

  • Recommended: 4 CPUs, 16 GB RAM, 80 GB disk, and a single network interface with Internet access

  • Base image: Ubuntu 24.04 (cloud image or server image, 64-bit)

Run the installer:

wget https://osm-download.etsi.org/ftp/osm-19.0-nineteen/install_osm.sh
chmod +x install_osm.sh
./install_osm.sh 2>&1 | tee osm_install_log.txt

This installs a standalone Kubernetes cluster on the host and deploys OSM on top of it. Saving the log with tee makes troubleshooting easier later.

For special installation options (HA, custom registry, charm-based, etc.) see How to install OSM.

Verify the installation

Once the installer finishes, get the OSM UI URL from the ingress and open it in your browser (default credentials are admin / admin):

export OSM_GUI_URL=$(kubectl get -n osm -o jsonpath="{.spec.rules[0].host}" ingress ngui-ingress)
echo "OSM UI: http://$OSM_GUI_URL"

OSM home

You can also check the status of the OSM workloads from the command line:

kubectl get all -n osm
kubectl get ingress -n osm

The OSM client (osm) is preinstalled on the host. Point it at the NBI ingress and run any command:

export OSM_HOSTNAME=$(kubectl get -n osm -o jsonpath="{.spec.rules[0].host}" ingress nbi-ingress)
osm --help

If something goes wrong, see Troubleshooting.

Configure a VIM

Before deploying Network Services, register a VIM account. OSM supports OpenStack, Microsoft Azure, Google Cloud Platform, AWS, VMware vCloud Director, and OpenVIM.

See Managing VIM accounts for the per-VIM configuration steps and CLI examples.

Deploy your first Network Service

With a VIM registered, you can onboard a VNF/NS package and instantiate a Network Service.

  1. Get sample packages from the osm-packages repository.

  2. Onboard the VNF and NS packages following Managing VNF and NS packages.

  3. Instantiate the Network Service following Deploying Network Services.