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. Advanced cluster management
- 7. OSM platform configuration
- 7.1. Explanation about OSM Role-based Access Control (RBAC)
- 7.2. OSM User Management
- 7.3. OSM Project management
- 7.4. Role management
- 7.5. User authentication with external LDAP server
- 7.6. Physical Deployment Units
- 7.7. WIM (Inter-VIM SDN) management
- 7.8. Platform configuration for Kubernetes
- 7.9. OSM Repositories
- 7.10. Distributed VCA
- 7.11. Reference - Audit Logs in OSM
- 8. What to read next
- 9. How to contribute to documentation
- 10. ANNEX 1: Troubleshooting
- 10.1. How to know the version of your current OSM installation
- 10.2. Logs
- 10.3. Troubleshooting installation
- 10.4. How to troubleshoot issues in the new Service Assurance architecture
- 10.5. Checking workflows in new OSM declarative framework
- 10.6. Checking progress of operations in new OSM declarative framework
- 10.7. Common issues with VIMs
- 10.8. How to report an issue
- 10.9. (OLD) Common issues with VCA/Juju
- 10.10. Other operational issues
- 11. ANNEX 2: Reference of OSM Client commands and library
- 11.1. How to install standalone OSM client
- 11.2. Getting help
- 11.3. Interaction from the OSM client to an OSM in a different location
- 11.4. Getting OSM version
- 11.5. RBAC
- 11.6. OSM repositories
- 11.7. Package creation tools
- 11.8. Advanced onboarding
- 11.9. Filtering requests
- 11.10. Debugging
- 11.11. Other useful options
- 11.12. Aliases
- 11.13. Enable autocompletion
- 11.14. Using osmclient as a library to interact with OSM
- 12. ANNEX 3: Reference of OSM Information Model
- 13. ANNEX 4: Reference of NBI API Description
- 13.1. Introduction
- 13.2. Request headers
- 13.3. Response headers
- 13.4. RBAC
- 13.5. Query String
- 13.6. URL and Methods summary
- 13.7. Administrative Content Details
- 13.8. PDU Details
- 13.9. VNFD Details
- 13.10. NSD Details
- 13.11. NSLCM Details
- 13.12. NST Details
- 13.13. NSILCM Details
- 13.14. VNFLCM Details
- 14. ANNEX 5: OpenVIM installation
- 15. ANNEX 6: Kubernetes installation and requirements
- 16. ANNEX 7: Setting up an LXD Cluster
- 17. Annex 8: TACACS Based Authentication Support In OSM
- 18. Annex 9: LTS Upgrade
- 19. Annex 10: Tutorial - Charmed OSM installation and deployment of a CNF
- 20. OSM Reference