Difference between revisions of "Poppy/Provider - Getting Started/Configuration"
Amit Gandhi (talk | contribs) (→Register your provider in Stevedore) |
Amit Gandhi (talk | contribs) |
||
| Line 4: | Line 4: | ||
== Registering your provider using Stevedore == | == Registering your provider using Stevedore == | ||
| − | /setup.cfg:: | + | [https://github.com/stackforge/poppy/blob/master/setup.cfg#L52-L57 /setup.cfg]:: |
| − | Add an entry point in setup.cfg so that Poppy recognizes your new driver and operators can start to use it. | + | 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 = | poppy.provider = | ||
| Line 14: | Line 14: | ||
| − | Once you have registered your Stevedore plugin, please add it to the configuration. | + | 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 Driver == | ||
| − | /etc/poppy.conf:: | + | [https://github.com/stackforge/poppy/blob/master/etc/poppy.conf#L92 /etc/poppy.conf]:: |
| − | Add your provider as a valid option for Poppy to use:: | + | Add your [https://github.com/stackforge/poppy/blob/master/etc/poppy.conf#L43 provider] as a valid option for Poppy to use:: |
# Provider modules list (a list of comma separated provider module list) | # Provider modules list (a list of comma separated provider module list) | ||
providers = mock,fastly,akamai,{your_provider_name} | providers = mock,fastly,akamai,{your_provider_name} | ||
| − | Set up any provider specific configuration parameters that the operator can set:: | + | Set up any provider [https://github.com/stackforge/poppy/blob/master/etc/poppy.conf#L92 specific configuration] parameters that the operator can set:: |
[drivers:provider:{your_provider_name}] | [drivers:provider:{your_provider_name}] | ||
Revision as of 22:03, 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.
Registering your provider using Stevedore
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 Driver
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.
