openstack/nova
Code Issues Proposed changes
c52920aced
nova/api-ref/source/servers-action-evacuate.inc

53 lines
1.2 KiB
PHP
Raw Normal View History

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. -*- rst -*-
api-ref: servers-action-evacuate.inc -Verify evacuate action method, examples, params. -Update parameters.yaml with request parameter, on_shared_storage. Added field max_version, required == true. Update adminPass_evacuate_rebuild with max_version field for response. -Updated headers with action name. Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0
2016-05-10 16:59:57 -04:00
Evacuate Server (evacuate Action)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
=================================
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: POST /servers/{server_id}/action
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: servers-action-evacuate.inc -Verify evacuate action method, examples, params. -Update parameters.yaml with request parameter, on_shared_storage. Added field max_version, required == true. Update adminPass_evacuate_rebuild with max_version field for response. -Updated headers with action name. Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0
2016-05-10 16:59:57 -04:00
Evacuates a server from a failed host to a new host.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: servers-action-evacuate.inc -Verify evacuate action method, examples, params. -Update parameters.yaml with request parameter, on_shared_storage. Added field max_version, required == true. Update adminPass_evacuate_rebuild with max_version field for response. -Updated headers with action name. Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0
2016-05-10 16:59:57 -04:00
- Specify the ``evacuate`` action in the request body.
- In the request body, if ``onSharedStorage`` is set, then do not set ``adminPass``.
- The target host should not be the same as the instance host.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix sample file path for 4 files This fix sample file path and status code of evacuate Part of bp:api-ref-in-rst Change-Id: I3bec0fcf622c0a1c85bbfea53283bd73fd613c75
2016-04-20 15:34:02 +09:00
Normal response codes: 200
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
-------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
- server_id: server_id
- evacuate: evacuate
- host: host
api-ref: servers-action-evacuate.inc -Verify evacuate action method, examples, params. -Update parameters.yaml with request parameter, on_shared_storage. Added field max_version, required == true. Update adminPass_evacuate_rebuild with max_version field for response. -Updated headers with action name. Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0
2016-05-10 16:59:57 -04:00
- adminPass: adminPass_evacuate_rebuild_request
- onSharedStorage: on_shared_storage
API change for verifying the scheduler when evacuating Adding a new microversion for changing the evacuate action behaviour to call the scheduler anyway unless the admin user provides a force flag that then keeps the previous behaviour by forcing the conductor to call the destination without verifying it. Implements: blueprint check-destination-on-migrations APIImpact Change-Id: I9ecbe3d481bf17b12072511da4bb106ff1b6404e
2016-05-18 21:58:06 +02:00
- force: force_evacuate
api-ref: servers-action-evacuate.inc -Verify evacuate action method, examples, params. -Update parameters.yaml with request parameter, on_shared_storage. Added field max_version, required == true. Update adminPass_evacuate_rebuild with max_version field for response. -Updated headers with action name. Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0
2016-05-10 16:59:57 -04:00
|
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: servers-action-evacuate.inc -Verify evacuate action method, examples, params. -Update parameters.yaml with request parameter, on_shared_storage. Added field max_version, required == true. Update adminPass_evacuate_rebuild with max_version field for response. -Updated headers with action name. Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0
2016-05-10 16:59:57 -04:00
**Example Evacuate Server (evacuate Action):**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix sample file path for 4 files This fix sample file path and status code of evacuate Part of bp:api-ref-in-rst Change-Id: I3bec0fcf622c0a1c85bbfea53283bd73fd613c75
2016-04-20 15:34:02 +09:00
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-req.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
api-ref: servers-action-evacuate.inc -Verify evacuate action method, examples, params. -Update parameters.yaml with request parameter, on_shared_storage. Added field max_version, required == true. Update adminPass_evacuate_rebuild with max_version field for response. -Updated headers with action name. Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0
2016-05-10 16:59:57 -04:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: servers-action-evacuate.inc -Verify evacuate action method, examples, params. -Update parameters.yaml with request parameter, on_shared_storage. Added field max_version, required == true. Update adminPass_evacuate_rebuild with max_version field for response. -Updated headers with action name. Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0
2016-05-10 16:59:57 -04:00
.. rest_parameters:: parameters.yaml
- adminPass: adminPass_evacuate_rebuild
|
**Example Evacuate Server (evacuate Action):**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix sample file path for 4 files This fix sample file path and status code of evacuate Part of bp:api-ref-in-rst Change-Id: I3bec0fcf622c0a1c85bbfea53283bd73fd613c75
2016-04-20 15:34:02 +09:00
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-resp.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
Copy Permalink