[CONTROLLER-1084] Toaster Tutorials describing Plugin Deployment need updating after Karaf migration. Created: 07/Jan/15  Updated: 25/Jul/23  Resolved: 27/Jun/17

Status: Resolved
Project: controller
Component/s: mdsal
Affects Version/s: None
Fix Version/s: None

Type: Bug
Reporter: RichardHill Assignee: Unassigned
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All


External issue ID: 2558

 Description   

Toaster Tutorials describing Plugin Deployment need updating to karaf. These

https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Toaster_Tutorial

Plugin Deployment

If we only copy the two (sample-toaster and sample-toaster-provider) .JAR bundles ( from the projects target to our distribution plugin folder controller\opendaylight\distribution\opendaylight\target\distribution.opendaylight-osgipackage\opendaylight\plugins, when starting the ODL controller, MD-SAL will only load the data-model of the toaster, and the ToasterService interface, without the implementation. So we have to explicitly inform MD-SAL which implementation (module) of the ToasterService API we want to be loaded.

This is done through the config .XML file that has to be added to the distribution\opendaylight\target\distribution.opendaylight-osgipackage\opendaylight\configuration\initial folder. This initial folder contains configuration files, the folder is parsed during ODL startup, and the files are processed in alphabetical order. Files starting with 01 and 02 contain configuration for MD-SAL generic services, so our toaster configuration should be added at the end of the queue, so we chose the name of the file 03-toaster-sample).

https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Toaster_Step-By-Step

How Do My Jar Files get Deployed in OSGI?

Now that you have created your projects you need to get the .jar files that are created into your OSGi container. You can manually copy the .jar file which is generated under your <project>/target directory to the controller/opendaylight/distribution/opendaylight/target/distribution.opendaylight-osgipackage/opendaylight/plugins directory. To manually copy in the updated code, you can copy the jar file from the target directory to the plugins directory. For example from the toaster-provider project directory:



 Comments   
Comment by Colin Dixon [ 30/Jun/15 ]

The first page:
https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Toaster_Tutorial

Has been updated to note that it's about Helium and might be out of date.

Comment by Colin Dixon [ 27/Jun/17 ]

Moving this bug to the controller since that's who can actually update the docs.

Comment by Tom Pantelis [ 27/Jun/17 ]

Well they're just wikis so anyone can update them. The 2 wikis in question have already been updated w.r.t. the outdated content.

Generated at Wed Feb 07 19:54:39 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.