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
Updates reference for drivers API as well as nodes API to match the
merged driver composition reform work.
Change-Id: I89a7b1998a858d5c39f21c6653893aa8d7ad15bd
Partial-Bug: 1524745
This patch updates api-ref documentation with soft reboot, soft power
off and power timeout that were added in API microversion 1.27.
Partial-Bug: #1526226
Change-Id: I9b17da3e5e02f7e3de0c5c2b3dec1e81bf642391
This patch updates api-ref documentation with Inject NMI (Non-Masking
Interrupts) that were added in API microversion 1.29.
Partial-Bug: #1526226
Change-Id: I5003abcfd9a79751f40964c5bd5cb0bd550ba89d
A few missing parameters breaking the build on latest api-ref package,
fix them.
Change-Id: I7769844b8a766c78418c28991b97827014886ec4
Closes-Bug: #1658187
This patch updates api-ref documentation with VIF attach/detach
changes that were added in API microversion 1.28.
Closes-Bug: #1582188
Change-Id: I2950a1a356ccb3feb7a4c6335eb95a7a52b3266a
This patch is removing a trailing backtick (`) from the
baremetal-api-v1-node-management.inc document.
Change-Id: Ie1a8c0d15f169287d5b5d6b7cd5b190e87345869
When regenerate-samples.sh called values like uuid, created_at,
updated_at, provision_state, power_state are updated automatically.
This patch ensures that they restored to original values to minimize
commit diff, as they are not related to change itself.
Add a waiter to wait for node state after update request to make sure
it was applied.
Removed unused anywhere files:
* node-set-power-state.json
* node-states-show-response.json
Change-Id: Iccff575990c9c06b6cc2cb60e93dd962bde46347
This change fixes issues pointed out in the last patch set of the
referenced change request.
Apart from that, 406 error code is removed from expected error codes,
as currently .*/portgroups.* resources do not return it.
Change-Id: Ib5fccb3a4d1d2c1c7dd1095b86199536db87da4c
Allow to unset the field "chassis_uuid" from a node using the "ironic
node-update <node_uuid> remove chassis_uuid" command.
The API version has been bumped to 1.25.
Change-Id: I1c8406f83f9d240ede99b0458c5e8b6967f2e37a
Closes-Bug: #1563263
The os-api-ref 1.0.0 is out. We can remove the support to older version now.
Reference:
6d41feb58d
Change-Id: I14266932bf6f936991f1ea675f3e61431b4a0b1c
Currently, Ironic api-ref is configured with logABug feature.
When users click "Report bug" button, it leads to
"bugs.launchpad.net/openstack-manuals" which is default.
We should change it to "bugs.launchpad.net/ironic/"
Change-Id: Ifb0e34a41807f87ae4d5402064b63b76e89ec0b4
This change adds information about keystone policy support in the
following places:
* api-ref: add notes to the Nodes reference, indicating that
password and configdrive contents may be hidden in responses
* deploy security guide: add a section about limiting API access
by using the new policies and roles
* deploy install guide: add instructions for creating the necessary
Roles with the Identity service
* dev quickstart guide: use devstack "demo" user throughout the guide,
and add a note about why. Incidentally, switch to using "openstack"
client instead of "ironic" and "nova" clients.
Partial-bug: #1526752
Change-Id: I392cabbf04badabd8ae7bb00a914b0a06db3d421
This commit does several things, which were just easier to do together.
- Adds a new "misc" page describing the /v1/lookup and /v1/heartbeat
resources.
- Adds descriptions of the node.resource_class and
node.network_interface fields that were introduced into the API but
not into the documentation.
- Introduces a new script, api-ref/regenerate-samples.sh, which can be
used with Ironic to automate the generation of most of the sample files
used in the api-ref documententation.
- Corrects several errors in the sample JSON files that rendered errors
when using them with curl for POST, PUT, or PATCH.
- Uses the aforementioned regenerate-samples.sh script to regenerate
most of the JSON result samples, ensuring that they are all up to date
with the v1.22 API microversion.
- Removes a few old/incorrect "Error Code" listings.
- Updates the index page to remove extraneous wording.
Change-Id: I764cbb43be15f05ba681de6ce1be1ae7c022173d
The descriptions of inspection_started_at and inspection_finished_at
node fields in api-ref are incorrect, this change fixes them.
Change-Id: I2e9e036f1dec0e6f34cae6780d5855b3295ae3c5
API microversions 1.18, 1.19 introduced new fields in Port resource,
this change adds them to api-ref documentation.
Partial-bug: #1526403
Change-Id: Ib7059fd1ec8ffc54fa34647cc558fb8c8e80f8d7
The max_limit option in the [api] section of ironic.conf is not
obviously pointed out in API documentation. This may mislead a user into
believing that using the "limit" parameter when listing resources from
the API may return more resources than the API configuration actually
allows.
This change adds documentation regarding how the max_limit option
affects API usage.
Change-Id: Ic55b31758b144aa8ef8b048f3dd90a4ffeee6fa4
Closes-Bug: 1597834
This updates the API documentation for the Drivers resource class,
replacing many of the samples and adding more verbiage to each property.
It's not perfect, but this is vastly more correct than the current docs.
Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com>
Change-Id: Ibe045bea539b8fd2f02d7be37e09cc74f09b8df1
This updates the API documentation for the Ports resource class,
replacing many of the samples and adding more verbiage to each property.
It's not perfect, but this is vastly more correct than the current docs.
Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com>
Change-Id: I559ef1e921aa8e2f2f1a8bd6ed18e0a39ecc4687
Currently, there is a node_uuid parameter that describes specifically
a node UUID in response body. Let's use just uuid.
Change-Id: I43ffe017188c1f15a0c6d8007d4bd463e867b774
This updates the API root documentation, which was non-existent,
and the Node documentation significantly, replacing many of the samples
and adding more verbiage to each property.
It's not perfect, but this is vastly more correct than the current docs.
Change-Id: Iaeb1c80ac0655fc0d73fa495ed43e3c02b345495
The html_last_updated_fmt option is the output of a shell command, which
is interpeted as a byte string in python 3 and subsequently breaks
Sphinx.
This change converts it to a utf-8 string.
Incidentally, this also removes the quotation marks to make the
formatted output cleaner.
Change-Id: I9aa6446a24d2f340246458dea0c34d456b3eade3
Closes-bug: #1583721
os-api-ref is released on pypi now, so we can move to using it instead
of our in tree version.
Change-Id: If353f4a2e553fa3da3b2a4c920e233f51365b77c
Depends-On: I0e615d36a2e5a8fa0d83f20bdcc2c33ad868ebd5
Per this email[0], it's time to migrate our API docs into our tree.
This copies the sphinx extension from nova into our tree as well, which
will be later split into its own python module. At that time we can cut
over to the module and drop it from our tree.
The conf.py and the tox environment are also cribbed from nova.
[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html
Change-Id: I683cc4d6459d77c42951a06247b6f9ff8f8456bd