diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 3fb31b01b..a7106b54d 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -68,6 +68,12 @@ report_count: in: body required: true type: integer +service: + description: | + A Zun services. + in: body + required: true + type: dict services: description: | A list of Zun services. diff --git a/api-ref/source/samples/service-disable-resp.json b/api-ref/source/samples/service-disable-resp.json new file mode 100644 index 000000000..062158e4c --- /dev/null +++ b/api-ref/source/samples/service-disable-resp.json @@ -0,0 +1,8 @@ +{ + "service": { + "disabled": true, + "binary": "zun-compute", + "host": "host1", + "disabled_reason": "abc" + } +} diff --git a/api-ref/source/samples/service-enable-resp.json b/api-ref/source/samples/service-enable-resp.json new file mode 100644 index 000000000..3f3805a66 --- /dev/null +++ b/api-ref/source/samples/service-enable-resp.json @@ -0,0 +1,8 @@ +{ + "service":{ + "disabled": false, + "binary": "zun-compute", + "host": "tecs", + "disabled_reason": null + } +} diff --git a/api-ref/source/samples/service-forcedown-resp.json b/api-ref/source/samples/service-forcedown-resp.json new file mode 100644 index 000000000..8319aea1e --- /dev/null +++ b/api-ref/source/samples/service-forcedown-resp.json @@ -0,0 +1,7 @@ +{ + "service": { + "binary": "zun-compute", + "host": "tecs", + "forced_down": true + } +} diff --git a/api-ref/source/services.inc b/api-ref/source/services.inc index e091d64dc..cd05d94e1 100644 --- a/api-ref/source/services.inc +++ b/api-ref/source/services.inc @@ -48,3 +48,167 @@ Response Example .. literalinclude:: samples/service-get-resp.json :language: javascript + +Delete container management service +=================================== + +.. rest_method:: DELETE /v1/services + +Delete the specified Zun service. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 401 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - binary: binary + - host: host + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + +Enable container management service +=================================== + +.. rest_method:: PUT /v1/services/enable + +Enable the specified Zun service. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 401 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - binary: binary + - host: host + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - service: service + - host: host + - binary: binary + - disabled: disabled + - disabled_reason: disabled_reason + +Response Example +---------------- + +.. literalinclude:: samples/service-enable-resp.json + :language: javascript + + +Disable container management service +==================================== + +.. rest_method:: PUT /v1/services/disable + +Disable the specified Zun service. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 401 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - binary: binary + - host: host + - disabled_reason: disabled_reason + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - service: service + - host: host + - binary: binary + - disabled: disabled + - disabled_reason: disabled_reason + +Response Example +---------------- + +.. literalinclude:: samples/service-disable-resp.json + :language: javascript + + +Force down container management service +======================================= + +.. rest_method:: PUT /v1/services/force_down + +Force the specified Zun service to down or unset it. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 401 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - binary: binary + - host: host + - forced_down: forced_down + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - service: service + - host: host + - binary: binary + - forced_down: forced_down + +Response Example +---------------- + +.. literalinclude:: samples/service-forcedown-resp.json + :language: javascript