This adds an API to allow manual cleaning of nodes, via
PUT /v1/nodes/<node_ident>/states/provision. The argument
'target' is 'clean', and the argument 'clean_steps' (the
list of clean steps to be performed on the node) must be
specified.
The API version is bumped to 1.15.
Change-Id: I0e34407133684e34c4ab9446b3521a24f3038f92
Partial-Bug: #1526290
This commit makes the following API end-points
discoverable via Ironic API
1. '/v1/nodes/<uuid>/states'
2. '/v1/drivers/<driver-name>/properties'
API Micro version is bumped to v1.14 with this change.
Closes-Bug:#1311288
Closes-Bug: #1475744
Co-Authored-By: Lucas Alvares Gomes <lucasagomes@gmail.com>
Change-Id: Ibc0013b8c09c80d90042bf12b31a54820b00b43c
This patch allows a node in CLEANWAIT to be aborted.
The @clean_step decorator has been extended to accept a new parameter
"abortable". By default this parameter defaults to False since a clean
step could potentially brick a machine so we better make it explicit.
If the clean step is abortable, the process of aborting will happen
immediately; if the clean step is not abortable the abortion will happen
as soon as the clean step is done. If a clean step is marked to have
the abortion done after its completion but it is the final clean step in
the cleaning operation the cleaning process will just finish successfully.
A new verb 'abort' is being added to the API and the microversion is
being bumped to 1.13.
Closes-Bug: #1455825
Change-Id: Ia6846c048b3dab44a8280366a7305aca1d3eb783
This commit addresses some of the final comments
in the following commits:
Ifa640d4839b2f08410ceec57c2972e2f9dc69db3
I806f79d997fab6af9a3640fd69815cadec6cae6b
Change-Id: If3d10dbff24f5aabf0c470ba01c03bf428686920
This adds documentation for the RAID API
GET /v1/drivers/(driver_name)/raid/logical_disk_properties
to Ironic's webapi documentation at
http://docs.openstack.org/developer/ironic/webapi/v1.html#drivers
Change-Id: Iaff3d14a02b507af6cc26fdef79eb58cf3924669
Implements: blueprint ironic-generic-raid-interface
This commit makes the following changes in the Ironic API:
1) Adds PUT /v1/nodes/NNNN/states/raid which helps to set
node.target_raid_config.
2) Adds GET /v1/drivers/DDDD/raid/logical_disk_properties
to retrieve the properties for logical disks that can be
provided for a node with the driver DDD while setting
target RAID configuration.
3) Modifies the API endpoints GET /v1/nodes/NNNN and
GET /v1/nodes/NNNN/states to return node.raid_config and
node.target_raid_config.
It also bumps the API version to 1.12.
APIImpact
DocImpact
Change-Id: I806f79d997fab6af9a3640fd69815cadec6cae6b
Implements: blueprint ironic-generic-raid-interface
The RESTful Web API for nodes [1] was showing 'node_uuid', whereas
this can now be node UUID or node name, so it has been changed to
'node_ident' (which is how it is described in the code/docstrings).
[1] http://docs.openstack.org/developer/ironic/webapi/v1.html#nodes
Change-Id: I5cc5b86c5d8b0551a53d1b3b1f002f27e1f290bb
Implements: blueprint logical-names
The documentation for our web API (v1) has the nodes-related API
in three different sections: Nodes, NodeStates, and BootDevice.
This makes it difficult to find all the available nodes-related
API.
This puts all the nodes-related API in the same Nodes section,
removing the NodeStates and BootDevice sections.
The ConsoleInfo class/type is included in the documentation as well.
Change-Id: I3bdcb2df13861d3a098b1880062b8115855c28b6
Closes-Bug: #1386291
This adds [PUT|DELETE] v1/nodes/(node_uuid)/maintenance
to our RESTful web API documentation. It will show up at
http://docs.openstack.org/developer/ironic/webapi/v1.html#nodes
Change-Id: I42171e429ec72d270b51b246d7c8c6c38fed2e1e
Implements: blueprint maintenance-reason
This patch adds description about above BootDevice Web APIs.
* GET v1/nodes/(node_uuid)/management/boot_device
* GET v1/nodes/(node_uuid)/management/boot_device/supported
* PUT v1/nodes/(node_uuid)/management/boot_device
Change-Id: I2826e59332102b258b72e9850baa1a6b0d189f79
http://docs.openstack.org/developer/ironic/webapi/v1.html is updated
as follows:
- changes the path descriptor of NodeStates to use '(node_uuid)' instead
of '<uuid>' to be consistent with other paths
- adds [GET/PUT] /v1/nodes/(node_uuid)/states/console to show how to
access the node's console
- fixes the "Links" section so that Link information is shown
Change-Id: I9d4a32550b81bb5ccf2fa23d8b591d8a945c04cc
http://docs.openstack.org/developer/ironic/webapi/v1.html does
not contain anything about how to use vendor passthru endpoints.
This adds 'POST /v1/nodes/(node_uuid)/vendor_passthru' and
'POST /v1/drivers/(driver_name)/vendor_passthru' to that
html page.
Change-Id: I6191be759f168c58e80d946530af7a0c4267501c
Closes-Bug: #1331415
* simplify the links on index.rst
* update the main description on the index page
* move install/ironic-install under deploy/
* rename ironic-install to install-guide
* rename userguide to user-guide
* clarify a few things in the install-guide
Change-Id: Ic6eff035df42d0c3fa78f54eac7ad8322ebb0afc
The API documentation mentions NodePowerState, NodeProvisionState,
and NodeVendorPassthru. They do not exist in the code, and their
entries here are error messages. Remove them.
Change-Id: I48c357cdf5d7ef2149b8af0becb517a578def97a
Add the necessary bits for sphinxcontrib-pecanwsme
so that we can start auto-generating REST API docs.
Change-Id: I6ad61a5185462916865884dd1619465ef90aba0a
Closes-bug: 1251011
