Browse code
Make reference to service-types-authority from plugins.rst
We want people creating plugins (that add services) to be aware of the
service-types-authority (STA), so this change adds a Prerequisites
section and notes the existince of the STA there, and the need to apply
there to create a service-type.
Change-Id: I1aa48fe231aaa4499f8b4fe336abea668841b9af
Chris Dent authored on 2017/08/17 00:00:16Showing 1 changed files
| ... | ... |
@@ -12,6 +12,15 @@ tree. They are called through a strong contract, so these plugins can |
| 12 | 12 |
be sure that they will continue to work in the future as DevStack |
| 13 | 13 |
evolves. |
| 14 | 14 |
|
| 15 |
+Prerequisites |
|
| 16 |
+============= |
|
| 17 |
+ |
|
| 18 |
+If you are planning to create a plugin that is going to host a service in the |
|
| 19 |
+service catalog (that is, your plugin will use the command |
|
| 20 |
+``get_or_create_service``) please make sure that you apply to the `service |
|
| 21 |
+types authority`_ to reserve a valid service-type. This will help to make sure |
|
| 22 |
+that all deployments of your service use the same service-type. |
|
| 23 |
+ |
|
| 15 | 24 |
Plugin Interface |
| 16 | 25 |
================ |
| 17 | 26 |
|
| ... | ... |
@@ -250,3 +259,5 @@ See Also |
| 250 | 250 |
|
| 251 | 251 |
For additional inspiration on devstack plugins you can check out the |
| 252 | 252 |
`Plugin Registry <plugin-registry.html>`_. |
| 253 |
+ |
|
| 254 |
+.. _service types authority: https://specs.openstack.org/openstack/service-types-authority/ |