openstack/deb-mistral
Code Issues Proposed changes

Adding "Services" section into API v2 specification

Browse Source 
Change-Id: I9da81482d862930467a922f6385a95ae4c17d7fb
Closes-Bug: #1505623
This commit is contained in:
Lingxian Kong 2015-10-14 10:45:42 +08:00
parent aebd8e706b
commit f27f5dde73
2 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/source/developer/webapi/v2.rst
View File

@ -156,3 +156,20 @@ Note: using CLI, Environment can be created via JSON or YAML file.
.. rest-controller:: mistral.api.controllers.v2.environment:EnvironmentController
:webprefix: /v2/environments
Services
--------
Through service management API, system administrator or operator can retrieve Mistral services information of the system, including service group and service identifier. The internal implementation of this feature make use of tooz library, which needs coordinator backend(the most commonly used at present is Zookeeper) installed, please refer to tooz official documentation for more detailed instruction.
There are three service groups according to Mistral architecture currently, namely api_group, engine_group and executor_group. The service identifier contains name of the host the service is running on and the process identifier of the service on that host.
.. autotype:: mistral.api.controllers.v2.service.Service
:members:
.. autotype:: mistral.api.controllers.v2.service.Services
:members:
.. rest-controller:: mistral.api.controllers.v2.service:ServicesController
:webprefix: /v2/services

2
mistral/api/controllers/v2/service.py
View File

@ -39,7 +39,7 @@ class Service(resource.Resource):
@classmethod
def sample(cls):
return cls(name='executor_host', type='executor_group')
return cls(name='host1_1234', type='executor_group')
class Services(resource.Resource):