Jump to: navigation, search

Difference between revisions of "Poppy/Provider - Getting Started/Configuration"

(Configuring your Driver)
Line 1: Line 1:
 
Congratulations!  If you made it here, then you must have a provider ready to go =)
 
Congratulations!  If you made it here, then you must have a provider ready to go =)
  
Poppy uses the [http://docs.openstack.org/developer/stevedore/ Stevedore] framework to configure Drivers into the application.
+
Poppy uses the [http://docs.openstack.org/developer/stevedore/ Stevedore] framework to configure [http://docs.openstack.org/developer/stevedore/patterns_loading.html#extensions-many-names-many-entry-points Extension Drivers] into the application.
  
== Registering your provider using Stevedore ==
+
== Registering your provider extension, using Stevedore ==
 
[https://github.com/stackforge/poppy/blob/master/setup.cfg#L52-L57 /setup.cfg]::
 
[https://github.com/stackforge/poppy/blob/master/setup.cfg#L52-L57 /setup.cfg]::
  
Line 16: Line 16:
 
Once you have registered your Stevedore plugin, please add it to the configuration sample (and your own configuration that you are running).
 
Once you have registered your Stevedore plugin, please add it to the configuration sample (and your own configuration that you are running).
  
== Configuring your Driver ==
+
== Configuring your Provider Extension Driver ==
 
[https://github.com/stackforge/poppy/blob/master/etc/poppy.conf /etc/poppy.conf]::
 
[https://github.com/stackforge/poppy/blob/master/etc/poppy.conf /etc/poppy.conf]::
  

Revision as of 22:06, 26 January 2015

Congratulations! If you made it here, then you must have a provider ready to go =)

Poppy uses the Stevedore framework to configure Extension Drivers into the application.

Registering your provider extension, using Stevedore

/setup.cfg::

Add an entry point to the list in /setup.cfg, so that Poppy recognizes your new driver and operators can start to use it.

 poppy.provider =
 {your_provider_name} = poppy.provider.{your_provider_name}:Driver

This will allow Poppy to detect your provider, and use it in configurations.


Once you have registered your Stevedore plugin, please add it to the configuration sample (and your own configuration that you are running).

Configuring your Provider Extension Driver

/etc/poppy.conf::

Add your provider as a valid option for Poppy to use::

 # Provider modules list (a list of comma separated provider module list)
 providers = mock,fastly,akamai,{your_provider_name}

Set up any provider specific configuration parameters that the operator can set::

 [drivers:provider:{your_provider_name}]
 username = "MY_USERNAME"
 apikey = "MY_APIKEY"

where username and apikey could be configuration parameters that your driver requires to communicate with your backend api.