Adds a 'deploy_step' field to the nodes API.
Co-Authored-By: Ruby Loo <rloo@oath.com>
Change-Id: I1baeeaaa6ed521e4189958fd7624cd6c5de96707
Story: #1753128
Task: #22592
We currently support /[nodes, ports, portgroups, chassis]/detail as an
API endpoint for getting a detailed list of each object. This does not
fit the RESTful and resourceful API design principles of <resource
type>/<resource id> and makes it hard to consume the API from frameworks
that expect that structure. We can't remove the old endpoint, so that is
safeguarded by the restricted node names list. This patch adds a
?detail=[True, False] query string to the list API endpoints to allow
those consuming the API to use the expected URL form.
Change-Id: I694919b4a4eaa3419318bbee1cde79de15e19afa
Story: #1662921
Task: #10176
Separate parameter identifiers in case when a parameter
is required in the request or response.
This patch adjusts the relevant *.nic file to fix the problem.
Change-Id: Ie2c8cae2280fc1e92a5e6f3fef4f2783a12a2c3f
Story: #1651775
Task: #10160
This patch exposes fault field to the API node object,
microversion and compatibility is handled.
Story: #1596107
Task: #10469
Change-Id: I31ed332be12cf98baaf01badcbb09ae4b8c6cae9
Partial-Bug: #1596107
Fix the pep8 E402 (Module level import not at top of file) errors.
For the Alembic files move the definitions of 'revision' and
'down_revision' below the imports. This is now done in Alembic [1]
For other files fix as needed by moving the imports or lines before
the imports.
In a few cases add a "# noqa E402" to whitelist the issue.
[1] dc2aae0374
Change-Id: I48c96d5da0cb747b3ca3fceea9b4ffa85a9ebe22
1) Use https instead of http for docs links
2) Update doc links according to OpenStack document migration
Change-Id: Ib9b2fa3b699de361d47aa80d07cdf76b7a1eb143
Update the api-ref documentation for the /v1/lookup API, so that
it mentions the node fields that are returned. It does not return
the configdrive value (that is bleeped out in the response).
Change-Id: I24a47a2cfefc582bd0b5f1f0068e89a3091cf397
This patch adds following:
- Updates ironic state documentation with rescue related states
- Updates api-ref with rescue interface fields introduced in
API version 1.38
Co-Authored-By: Mario Villaplana <mario.villaplana@gmail.com>
Co-Authored-By: Aparna <aparnavtce@gmail.com>
Co-Authored-By: Shivanand Tendulker <stendulker@gmail.com>
Partial-Bug: 1526449
Change-Id: Ifcfa52ede62894b1990aaa640944be3431ddfe8f
Updates the install and admin guides with information on node traits.
Support for node traits was added in Bare Metal REST API version 1.37.
Change-Id: I86e86320df4eb81aa30e5708dde9c82f50ba4d50
Depends-On: https://review.openstack.org/#/c/532288/
Partial-Bug: #1722194
From openstackdocstheme 1.18.0, valid Git URLs can be retrieved by
openstackdocstheme[1], we do not need giturl option anymore.
[1] https://review.openstack.org/532163
Change-Id: I1725e25dd13bfe14c83f3f679092fc36fa6cb208
This patch enables receiving agent_version as part of heartbeat, and
stores this information on driver_internal_info. This is so that Ironic
can dynamically adjust which features and parameters it uses based on
which version of the agent is being used.
Change-Id: I400adba5d908b657751a83971811e8586f46c673
Partial-Bug: #1602265
This updates the description of the
'PUT /v1/nodes/{node_ident}/states/power' request to mention that
Bare Metal API version 1.27 was when:
- the 'timeout' parameter was added
- the 'soft power off' and 'soft rebooting' values were made available
for the 'target' parameter
Change-Id: I1c720a2dd15eab1246ad672b9d7f2b8708ceec0b
make the format of the api:"Detach VIF from
a node" normally and add the Request header
of the parameters' table.
Change-Id: Ica77a99439d9819f629c7f64c2906e5aa2cb5ddc
Previously, the configdrive could only be set when setting
the node's provisioning state to "active". When rebuilding,
the old configdrive was used and therefore was never updated
with latest content.
This change introduces the API microversion 1.35 which will allow
configdrive to be provided when setting the node's provisioning state
to "rebuild".
Closes-bug: #1575935
Change-Id: I9a5529f9fa796c75621e9f4354886bf3032cc248
A portgroup can be identified by a UUID or a name, so we
should be consistent and use 'portgroup_ident' instead of
'portgroup_id' in the API ref. (Similar to how we use
'node_ident'.)
Change-Id: I5b2ddd7e47e02281d62ae90f0e7f4a32af802982
Sphinx provides the versionadded syntax for indicating version related
changes in documentation, the OpenStack doc theme is designed to handle
this and render it nicely. This patch switches our inconsistent
references to API version related change in the API ref to use this
syntax so that it standardised through out the docs, and is more obvious
in the documentation itself.
Change-Id: Ied6f22deecebd71042d2230b81e057543db3d3f4
This patch adds these storage interface fields to api-ref:
- storage_interface of Node
- default_storage_interface of Driver
- enabled_storage_interfaces of Driver
These fields were introdeced with API version 1.33.
Change-Id: Iac73d7ae4976dfd437b9821a2221dd842be24b55
Partial-Bug: #1559691
Currently there are a few missing fields and API microversion notes
in the ports API reference. This change resolves those issues. All
ports microversion notes have been changed to use the active voice.
Change-Id: If16c8e311e439e88fbbdd693c12e0f7992af5044
In change Ib22753aa6ae0fedce7fb9ecf63f135fda0185c5b the port data model
was updated to include a physical_network field, but this was not
exposed to the user by the REST API. This change exposes the
physical_network field in the REST API.
The port CRUD notification object has been updated to include the
physical_network field.
The API reference and user guide have been updated to include
information about the ports' physical network field.
The API microversion has been bumped to 1.34. During a rolling upgrade
from Ocata when the API service is pinned, the port physical network
field is hidden from API responses, and API requests including the field
are rejected.
Change-Id: I7023a1d6618608c867c31396fa677d3016ca493e
Partial-Bug: #1666009
Vendor-passthru lookup and heartbeat was mostly removed (in
5eb4ba26ddbde97758511c9b61046e5a879ab66c). This removes the
remaining code and references to them.
Change-Id: I6b214503999ce1892f10f4507a6063b6e8d604bc
Related-Bug: #1640533
Vendor-passthru lookup and heartbeat have been removed (in
5eb4ba26ddbde97758511c9b61046e5a879ab66c). This removes references
to them.
Change-Id: I3565999f129cf88c2aa5f04bbf27eaa0da6dc588
Related-Bug: #1640533