openstack/devstack
Code Issues Proposed changes

Make reference to service-types-authority from plugins.rst

Browse Source 
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
This commit is contained in:
Chris Dent 2017-08-16 16:00:16 +01:00
parent ac1a6aab2c
commit ebbbc0500c
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/plugins.rst
View File

@ -12,6 +12,15 @@ tree. They are called through a strong contract, so these plugins can
be sure that they will continue to work in the future as DevStack be sure that they will continue to work in the future as DevStack
evolves. evolves.
Prerequisites
=============
If you are planning to create a plugin that is going to host a service in the
service catalog (that is, your plugin will use the command
``get_or_create_service``) please make sure that you apply to the `service
types authority`_ to reserve a valid service-type. This will help to make sure
that all deployments of your service use the same service-type.
Plugin Interface Plugin Interface
================ ================
@ -250,3 +259,5 @@ See Also
For additional inspiration on devstack plugins you can check out the For additional inspiration on devstack plugins you can check out the
`Plugin Registry <plugin-registry.html>`_. `Plugin Registry <plugin-registry.html>`_.
.. _service types authority: https://specs.openstack.org/openstack/service-types-authority/