Welcome to Open Source MANO’s documentation!

Table of Contents

• 1. OSM Quickstart
  • 1.1. Assumptions about interaction with VIMs and VNFs
  • 1.2. Installing OSM
  • 1.3. Adding VIM accounts
  • 1.4. Deploying your first Network Service
  • 1.5. What’s next?
• 2. OSM Architecture and Functions
  • 2.1. Service Platform view
• 3. Installing OSM
  • 3.1. Pre-requirements
  • 3.2. Installation procedure
  • 3.3. Other installation methods
  • 3.4. Checking your installation
  • 3.5. Installing standalone OSM Client
• 4. How to Set Up Virtual Infrastructure Managers (VIMs)
  • 4.1. OpenStack
  • 4.2. OpenVIM
  • 4.3. VMware’s vCloud Director
  • 4.4. Amazon Web Services (AWS)
  • 4.5. Microsoft Azure
  • 4.6. Google Cloud Platform
  • 4.7. What if I do not have a VIM at hand? Use of sandboxes
  • 4.8. Advanced setups for high I/O performance: EPA and SDN Assist
  • 4.9. Distributed VCA
• 5. OSM Usage
  • 5.1. Deploying your first Network Service
  • 5.2. Updating the VNF instance in a Network Service
  • 5.3. Advanced instantiation: using instantiation parameters
  • 5.4. Understanding Day-1 and Day-2 Operations
  • 5.5. Monitoring and autoscaling
  • 5.6. Using Network Slices
  • 5.7. Using Kubernetes-based VNFs (KNFs)
  • 5.8. Subscription and Notification support in OSM
  • 5.9. Start, Stop and Rebuild operations over a VDU of a running VNF instance
  • 5.10. Migrating VDUs in a Network Service
• 6. OSM platform configuration
  • 6.1. Role-based Access Control (RBAC)
  • 6.2. User management
  • 6.3. Project management
  • 6.4. Role management
  • 6.5. User authentication with external LDAP server
  • 6.6. VIM management
  • 6.7. Physical Deployment Units
  • 6.8. Intra-VIM SDN management (for SDN Assist)
  • 6.9. WIM (Inter-VIM SDN) management
  • 6.10. Platform configuration for Kubernetes
  • 6.11. OSM Repositories
  • 6.12. Distributed VCA
• 7. What to read next
• 8. How to contribute to documentation
• 9. ANNEX 1: Troubleshooting
  • 9.1. How to know the version of your current OSM installation
  • 9.2. Troubleshooting installation
  • 9.3. Common issues with VIMs
  • 9.4. Common issues with VCA/Juju
  • 9.5. Common instantiation errors
  • 9.6. Common issues whwn interacting with NBI
  • 9.7. Other operational issues
  • 9.8. Logs
  • 9.9. How to report an issue
• 10. ANNEX 2: Reference of OSM Client commands and library
  • 10.1. How to install standalone OSM client
  • 10.2. Getting help
  • 10.3. Interaction from the OSM client to an OSM in a different location
  • 10.4. Getting OSM version
  • 10.5. RBAC
  • 10.6. OSM repositories
  • 10.7. Package creation tools
  • 10.8. Advanced onboarding
  • 10.9. Filtering requests
  • 10.10. Debugging
  • 10.11. Other useful options
  • 10.12. Aliases
  • 10.13. Enable autocompletion
  • 10.14. Using osmclient as a library to interact with OSM
• 11. ANNEX 3: OSM Information Model
  • 11.1. YANG model in OSM repos
  • 11.2. OSM IM tree representation
  • 11.3. OSM URN Namespace
  • 11.4. Release EIGHT DESCRIPTOR Documentation (OLD)
  • 11.5. Release TWO Descriptor Documentation (OLD)
• 12. ANNEX 4: NBI API Description
  • 12.1. Introduction
  • 12.2. Request headers
  • 12.3. Response headers
  • 12.4. RBAC
  • 12.5. Query String
  • 12.6. URL and Methods summary
  • 12.7. Administrative Content Details
  • 12.8. PDU Details
  • 12.9. VNFD Details
  • 12.10. NSD Details
  • 12.11. NSLCM Details
  • 12.12. NST Details
  • 12.13. NSILCM Details
  • 12.14. VNFLCM Details
• 13. ANNEX 5: OpenVIM installation
  • 13.1. Required infrastructure
  • 13.2. Requirements for OpenVIM controller
  • 13.3. Installation of the OpenVIM controller
  • 13.4. Setting up compute nodes for OpenVIM
  • 13.5. Configuration of the OpenVIM controller
  • 13.6. OpenVIM Logs and Troubleshooting
• 14. ANNEX 6: Kubernetes installation and requirements
  • 14.1. Installation method 1: OSM Kubernetes cluster from an OSM Network Service
  • 14.2. Installation method 2: Local development environment
  • 14.3. Method 3: Manual cluster installation steps for Ubuntu
  • 14.4. Enabling K8s Cluster Monitoring
• 15. ANNEX 7: Setting up an LXD Cluster
  • 15.1. Install LXD
  • 15.2. Configure the first LXD node
  • 15.3. Configure the second node
  • 15.4. Configure the third node
  • 15.5. Check
  • 15.6. Certificates
• 16. Annex 8: TACACS Based Authentication Support In OSM
  • 16.1. Introduction
  • 16.2. Integration
  • 16.3. Testing Steps
  • 16.4. Limitations
• 17. Annex 9: LTS Upgrade
  • 17.1. Introduction
  • 17.2. Upgrade of 10.1.0 to 10.1.1 LTS
  • 17.3. Upgrade of Pre-LTS to 10.1.0 LTS
  • 17.4. Testing Upgrade
• 18. OSM installation tutorial
  • 18.1. Introduction
  • 18.2. Prerequisites
  • 18.3. Install OSM
  • 18.4. Deployment of a CNF
  • 18.5. Testing the CNF and day-2 actions