| Dan Timoney | 2a93b9d | 2017-07-18 19:40:01 -0400 | [diff] [blame] | 1 | ====================== |
| 2 | Introduction |
| 3 | ====================== |
| 4 | You have generated an MD-SAL module using the Brocade Archetype. |
| 5 | |
| 6 | * You should be able to successfully run 'mvn clean install' on this project. |
| 7 | * This will produce a .zip file under the karaf.extension directory which you can deploy using |
| 8 | Brocade's extension deployment mechanism. |
| 9 | |
| 10 | ====================== |
| 11 | Next Steps: |
| 12 | ====================== |
| 13 | * run a 'mvn clean install' if you haven't already. This will generate some code from the yang models. |
| 14 | * Modify the model yang file under the model project. |
| 15 | * Follow the comments in the generated provider class to wire your new provider into the generated |
| 16 | code. |
| 17 | * Modify the generated provider model to respond to and handle the yang model. Depending on what |
| 18 | you added to your model you may need to inherit additional interfaces or make other changes to |
| 19 | the provider model. |
| 20 | |
| 21 | ====================== |
| 22 | Generated Bundles: |
| 23 | ====================== |
| 24 | * model |
| 25 | - Provides the yang model for your application. This is your primary northbound interface. |
| 26 | * provider |
| 27 | - Provides a template implementation for a provider to respond to your yang model. |
| 28 | * features |
| 29 | - Defines a karaf feature. If you add dependencies on third-party bundles then you will need to |
| 30 | modify the features.xml to list out the dependencies. |
| 31 | * karaf.extension |
| 32 | - Bundles all of the jars and third party dependencies (minus ODL dependencies) into a single |
| 33 | .zip file with the necessary configuration files to work correctly with the Brocade extension |
| 34 | mechanism. |
| 35 | |