Skip to content

Commit ebbbc05

Browse files
committed
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
1 parent ac1a6aa commit ebbbc05

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

doc/source/plugins.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ tree. They are called through a strong contract, so these plugins can
1212
be sure that they will continue to work in the future as DevStack
1313
evolves.
1414

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+
1524
Plugin Interface
1625
================
1726

@@ -250,3 +259,5 @@ See Also
250259

251260
For additional inspiration on devstack plugins you can check out the
252261
`Plugin Registry <plugin-registry.html>`_.
262+
263+
.. _service types authority: https://specs.openstack.org/openstack/service-types-authority/

0 commit comments

Comments
 (0)