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 options
  • 3.3. PM and FM dashboards (optional)
  • 3.4. Checking your installation
  • 3.5. Installing standalone OSM Client
  • 3.6. How to upgrade OSM
• 4. Setup of 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 (GCP)
  • 4.7. Eclipse fog05
  • 4.8. What if I do not have a VIM at hand? Use of sandboxes
  • 4.9. Advanced setups for high I/O performance: EPA and SDN Assist
  • 4.10. Distributed VCA
• 5. OSM Usage
  • 5.1. Deploying your first Network Service
  • 5.2. Advanced instantiation: using instantiation parameters
  • 5.3. Understanding Day-1 and Day-2 Operations
  • 5.4. Monitoring and autoscaling
  • 5.5. Using Network Slices
  • 5.6. Using Kubernetes-based VNFs (KNFs)
• 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. Installing 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
• 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: Tests to validate VIM capabilities from OSM
  • 14.1. OSM packages and images for E2E tests
  • 14.2. Test 1. Sanity check with simple NS
  • 14.3. Test 2a. Failed deployment of scenario when the checksum is invalid
  • 14.4. Test 2b. Successful deployment of scenario when the descriptor has a checksum
  • 14.5. Test 3a. Instantiation time of large NS based on Cirros images
  • 14.6. Test 3b. Instantiation time of large NS based on Cirros images using IP profiles
  • 14.7. Test 3c. Instantiation time of large NS based on Ubuntu images using IP profiles
  • 14.8. Test 4a. Day 0 configuration: SSH key injection to the default user
  • 14.9. Test 4b. Day 0 configuration: user addition
  • 14.10. Test 4c. Day 0 configuration: custom user script with cloud-init
  • 14.11. Test 5. Port security disabled
  • 14.12. Test 6a. Assignment of public IP addresses to management interfaces of single-interface VNFs
  • 14.13. Test 6b. Assignment of public IP addresses to management interfaces of multi-interface VNFs
  • 14.14. Test 6c. Assignment of public IP addresses to management interfaces of multi-interface VNFs even when IP profiles are used
  • 14.15. Test 7a. EPA tests - phase 1
  • 14.16. Test 7b. EPA tests - phase 2
• 15. ANNEX 7: Kubernetes installation and requirements
  • 15.1. Installation method 1: OSM Kubernetes cluster from an OSM Network Service
  • 15.2. Installation method 2: Local development environment
  • 15.3. Method 3: Manual cluster installation steps for Ubuntu
• 16. Enabling K8s Cluster Monitoring
• 17. ANNEX 8: Setting up an LXD Cluster
  • 17.1. Install LXD
  • 17.2. Configure the first LXD node
  • 17.3. Configure the second node
  • 17.4. Configure the third node
  • 17.5. Check
  • 17.6. Certificates
• 18. 17 Subscription and Notification support in OSM
  • 18.1. Introduction
  • 18.2. NS Subscription And Notification
  • 18.3. Current support and future roadmap