Welcome to Open Source MANO’s documentation!
Table of Contents
- 1. OSM Quickstart
- 2. OSM Architecture and Functions
- 3. How to install OSM
- 3.1. Pre-requirements
- 3.2. How to install OSM (standard installation)
- 3.3. How to upgrade components from daily images in standard deployment
- 3.4. How to check OSM installation (standard installation)
- 3.5. Explanation: What the OSM client is
- 3.6. Reference. Helm-based OSM installation
- 3.7. How to install OSM using OSM helm chart
- 3.8. Other installation methods
- 4. How to Set Up Virtual Infrastructure Managers (VIMs)
- 5. OSM Usage
- 5.1. How to deploy your first Network Service
- 5.2. How to update 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. How to deploy Network Slices
- 5.7. Using Kubernetes-based VNFs (KNFs)
- 5.8. Subscription and Notification support in OSM
- 5.9. How to cancel an ongoing operation over a NS
- 5.10. Start, Stop and Rebuild operations over a VDU of a running VNF instance
- 5.11. Migrating VDUs in a Network Service
- 5.12. How to deploy a VNF that comes with a Prometheus exporter
- 5.13. How to prepare a NS that will use static Dual-Stack IP configuration for VNF connection points
- 5.14. Service Function Chaining
- 6. OSM platform configuration
- 6.1. Explanation about OSM Role-based Access Control (RBAC)
- 6.2. OSM User Management
- 6.3. OSM Project management
- 6.4. Role management
- 6.5. User authentication with external LDAP server
- 6.6. Physical Deployment Units
- 6.7. WIM (Inter-VIM SDN) management
- 6.8. Platform configuration for Kubernetes
- 6.9. OSM Repositories
- 6.10. Distributed VCA
- 6.11. Reference - Audit Logs in OSM
- 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 when interacting with NBI
- 9.7. Other operational issues
- 9.8. Logs
- 9.9. How to report an issue
- 9.10. How to troubleshoot issues in the new Service Assurance architecture
- 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: Reference of OSM Information Model
- 12. ANNEX 4: Reference of 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
- 14. ANNEX 6: Kubernetes installation and requirements
- 15. ANNEX 7: Setting up an LXD Cluster
- 16. Annex 8: TACACS Based Authentication Support In OSM
- 17. Annex 9: LTS Upgrade
- 18. Annex 10: Tutorial - Charmed OSM installation and deployment of a CNF
- 19. OSM Reference