User Tools

Site Tools


fuel_opnfv_integrated-project-guidelines

This is an old revision of the document!


How to become a Fuel@OPNFV Integrated project

Integration request process

  • If your project has the intent to become an OPNFV core-integrated project (part of the mandatory requirements for OPNFV Genesis member installers) - you need to follow this process: How to interface with Genesis? Work procedures
    • This will generate a workflow of genesis committer voting which will either result in a mandatory integration of your project in all Genesis member installers or will be abandoned.
  • If you instead do not yet want to become a core integrated project, and only want to integrate your project with with one or a few projects - like Fuel@OPNFV. You should issue a Jira request in the Fuel@OPNFV Jira namespace - preliminary indicating (As the integration iterations goes along, these items will be refined):
    • Project description
    • Purpose
    • Dependencies (Packages, Patches, Linux kernel, etc)
    • High-availability model
    • Upgrade model
    • Managed objects (configuration, Fault management, Performance management, etc.)
    • Available logs, etc.
    • ETA for functional code freeze.
    • ETA for integration adaptation to Fuel@OPNFV - E.g. a "Fuel plug-in"
  • In any case - no matter the model followed, an integrated project will be responsible for the integration with Fuel@OPNFV and the development of:
    • A functional Fuel Plug-in.
    • Instrumentation of configuration in accordance with the Fuel plug-in concept, as well as a config.yaml template fragment for the plug-in.
    • Build environment, including population of the plug-in to the fuel@OPNFV .iso artifact.
    • Integration/build time tests.
    • Functional tests, coordinated with the OPNFV Func-test project.
    • Higher order tests - I.e. Yard-stick test cases.
  • The acknowledgement of the Fuel@OPNFV integration request is that the corresponding Jira request is assigned to the project lead of the integrated project-lead.
    • Once agreed in which Fuel@OPNFV project work-package/mile-stone the integration should be due, the Jira request goes into status "In progress" - and from now on the integrated project is part of fuel@OPNFV and is expected to:
      • Attend Fuel@OPNFV meetings
      • Follow Fuel@OPNFV committer decisions and plans
      • And execute according to out-set plans
    • If an Integrated project fails to deliver according to plan, quality expectations, or outset dependencies, Fuel@OPNF commiters may through voting decide to exclude the integrated project from a work package/mile-stone, or from a project release as a whole.

How to build a Fuel-Plugin and integrate it with Fuel@OPNFV

Instructions on how to build a Fuel-plugin can be found in the Fuel Plugin Developers Guideline - Note that the Fuel Plugin framework capabilities is rapidly evolving

An example of an ODL Fuel-plugin that was developed for the Fuel@OPNFV Arno release can be found here.

Another example is the OVS 2.4 Fuel-plugin that is being developed for the Fuel@OPNFV Brahmaputra release, work in progress can be found here.

In Fuel@OPNFV we require that all artifacts and plugins are part of the the installable .iso image, here is a Make file fragment example that will ensure inclusion of a plug-in to the local .iso image.

You can also find already developed Fuel Plugins here

fuel_opnfv_integrated-project-guidelines.1443902142.txt.gz · Last modified: 2015/10/03 19:55 by Jonas Bjurel