Jump to: navigation, search

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

(Created page with "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 con...")
 
Line 3: Line 3:
 
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 Drivers into the application.
  
Once you have created your Stevedore plugin, please add it to the configuration example as follows:
+
== Register your provider in Stevedore ==
 +
/setup.cfg::
  
in /etc/poppy.conf::
+
Add an entry point in setup.cfg so that Poppy recognizes your new driver and operators can start to use it.
  
   [drivers:provider:{provider_name}]
+
  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.
 +
 
 +
== Configuring your Driver ==
 +
/etc/poppy.conf::
 +
 
 +
  # Provider modules list (a list of comma separated provider module list)
 +
  providers = mock,fastly,akamai,{your_provider_name}
 +
 
 +
 
 +
   [drivers:provider:{your_provider_name}]
 
   username = "MY_USERNAME"
 
   username = "MY_USERNAME"
 
   apikey = "MY_APIKEY"
 
   apikey = "MY_APIKEY"
  
 
where username and apikey are configuration parameters that your driver may require to communicate with your backend api.
 
where username and apikey are configuration parameters that your driver may require to communicate with your backend api.

Revision as of 21:57, 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 Drivers into the application.

Register your provider in Stevedore

/setup.cfg::

Add an entry point 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.

Configuring your Driver

/etc/poppy.conf::

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


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

where username and apikey are configuration parameters that your driver may require to communicate with your backend api.