OSM Release SIX Documentation

THIS PAGE IS DEPRECATED. OSM User Guide has been moved to a new location: https://osm.etsi.org/docs/user-guide/

---

Release SIX Quickstart

• In order to get started quickly and get familiar with the most common operations, you can refer to the Release SIX Quickstart page.

VNF and NS examples

• Examples from OSM Hackfests

Onboarding your own VNF and NS

• VNF Onboarding Guidelines
• Create your own VNF package
• Creating your own VNF charm
  • Some examples of VNF Charms
  • Default VNF Primitives
• OSM Information Model
• Information to create VNF and NS Descriptors
• How to onboard old Release TWO descriptors

Specific installation methods

• How to run OSM on Vagrant
• How to upgrade the OSM Platform
• How to install OSM client separately
• Advanced OSM installation procedures
• How to install OSM in Amazon EC2

EPA and SDN Assist

• How-to guide
• OpenStack configuration for EPA and SDN Assist

Reference material and self training

• OSM client:
  • Installation
  • OSM client commands
  • Enable autocompletion in OSM Client
• OSM instantiation parameters
• Using Monitoring and Autoscaling capabilities:
  • OSM Performance Management
  • OSM Fault Management
  • OSM Autoscaling
• 6th OSM Hackfest - full training material:
  • Table of contents
  • Documentation
  • NS and VNF Packages and VM images
• Description of the OSM North Bound Interface REST API
• How to use the VIM emulator
• Tests to validate VIM capabilities
• OSM Workshops videos
• Other technical videos and demos
• OSM URN Namespace

Troubleshooting

• How to know the version of your current OSM installation
• Common issues and troubleshooting
• Have you detected any bug? Check this guide to see how to report issues.

OSM Scope, Features and Integration Guidelines

• OSM Scope, Functionality, Operation and Integration Guidelines
• Release notes and whitepapers

How to contribute

• Joining the OSM community
• Developer guides:
  • Workflow with OSM tools (git, gerrit, bugzilla, etc.) (MUST READ for developers)
  • Developer how-to (MUST READ for developers)
  • Developer how-to for RO
  • How to work with your own cloned repo for a specific component
• OSM Slack Workplace
• Upcoming Hackfests and events:
  • OSM workshops and events

Your feedback is most welcome!
You can send us your comments and questions to OSM_TECH@list.etsi.org
Or join the OpenSourceMANO Slack Workplace
See hereafter some best practices to report issues on OSM