60 Commits

Author SHA1 Message Date
Sam Betts
b642f28be4 Receive and store agent version on heartbeat
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
2017-12-11 16:25:47 +00:00
Ruby Loo
c7e7d3076d update description for Change Node Power State
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
2017-11-14 17:47:01 -05:00
shuangyang.qian
ff0970f308 Make the api format correctly
make the format of the api:"Detach VIF from
a node" normally and add the Request header
of the parameters' table.

Change-Id: Ica77a99439d9819f629c7f64c2906e5aa2cb5ddc
2017-11-08 19:00:39 +08:00
Zuul
896462138c Merge "Add ability to provide configdrive when rebuilding" 2017-11-01 22:27:16 +00:00
Zuul
a710321f7d Merge "Update validating node information docs" 2017-10-24 14:06:08 +00:00
Nguyen Van Trung
b219699e9d Update validating node information docs
eg:
    +------------+--------+--------+
    | Interface  | Result | Reason |
    +------------+--------+--------+
    | boot       | True   |        |
    | console    | True   |        |
    | deploy     | True   |        |
    | inspect    | True   |        |
    | management | True   |        |
    | network    | True   |        |
    | power      | True   |        |
    | raid       | True   |        |
    | storage    | True   |        |
    +------------+--------+--------+

Change-Id: I7f93b866cf4b50047e8666c3c5c01a201f18ef4b
2017-10-23 13:29:08 +07:00
Mathieu Gagné
6a8b38a2ca Add ability to provide configdrive when rebuilding
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
2017-10-19 13:07:03 -04:00
Ruby Loo
738eac1ba6 api-ref portgroup_id should be portgroup_ident
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
2017-09-19 17:19:49 -04:00
Sam Betts
bca44bcefc Switch API ref to use versionadded syntax throughout
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
2017-09-05 17:27:24 +01:00
Hironori Shiina
05d85dd8bb Add storage interface to api-ref
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
2017-08-02 12:49:07 +00:00
Hironori Shiina
7317c17e4e Add API for volume resources to api-ref
This patch adds API for volume resources to api-ref.

Partial-Bug: 1526231
Change-Id: I986860cffd344f5cea9f8f5a2f845f77bf6e9e54
2017-08-02 12:46:36 +00:00
Mark Goddard
2e51f95263 Improve ports API reference
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
2017-07-20 09:13:17 +01:00
Mark Goddard
02fff930fb Expose ports' physical network attribute in API
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
2017-07-19 17:29:20 +01:00
Sam Betts
5647bfc246 Move doc/source/dev to doc/source/contributor
Change-Id: I6a3d143cff31348c62d8825f29f7484bafb9c8f0
2017-07-06 12:59:24 +01:00
Sam Betts
02015a4be6 Move operator docs into into doc/source/admin
Change-Id: I13f90a0b183b7799b4c8b5c340052d96f717fa9f
2017-07-05 12:16:37 +01:00
Kyrylo Romanenko
ab29dccead Fix quotes in documentation and schema description
Fix example of RAID configuration by removing wrong quotes.
Add missing quote in RAID config schema description.

Closes-Bug: #1702129
Change-Id: I2012e3968a0fccec0df1f4de3f682ab97aa1b8ac
2017-07-03 19:32:26 +03:00
Ruby Loo
24006badee Remove remaining vendor passthru lookup/heartbeat
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
2017-05-17 15:03:39 -04:00
Luong Anh Tuan
51bf6b2148 Remove single quoted strings in json sample
Json standard does not allow single quoted strings. Thus I replace
" instead of '.

Change-Id: Ifbb9e1a62706dcfa539f12e38eec0f5ca8ae1422
2017-05-17 23:50:09 +07:00
Ruby Loo
bbb8d3d005 [api-ref] remove reference to old lookup/heartbeat
Vendor-passthru lookup and heartbeat have been removed (in
5eb4ba26ddbde97758511c9b61046e5a879ab66c). This removes references
to them.

Change-Id: I3565999f129cf88c2aa5f04bbf27eaa0da6dc588
Related-Bug: #1640533
2017-04-27 16:48:45 -04:00
Jim Rollenhagen
73328060cc Fix API doc URL in GET / response
The existing URL has a redirect to another URL[0], which has a message
that it has been moved to yet another URL[1]. Fix it so it's just one link.
Also use https while we're in here.

[0] https://docs.openstack.org/developer/ironic/webapi/v1.html
[1] https://docs.openstack.org/developer/ironic/dev/webapi.html

Change-Id: I900e0a7ad84dfcfeb551d4836bf156790706803c
2017-03-15 19:05:54 -04:00
wangkf
72abce14b0 Fix typos of filename in api-ref
Typo is fixed and port-list-response.json is updated.

Closes-Bug: 1672358

Change-Id: Iffe385d705e607966ac00455d56aaac85a1a1e69
2017-03-14 19:35:53 +08:00
Jenkins
2b10dd8bfc Merge "Update api-ref for dynamic drivers" 2017-02-10 13:01:20 +00:00
Mario Villaplana
d33faedbac Update api-ref for dynamic drivers
Updates reference for drivers API as well as nodes API to match the
merged driver composition reform work.

Change-Id: I89a7b1998a858d5c39f21c6653893aa8d7ad15bd
Partial-Bug: 1524745
2017-02-09 19:51:03 +00:00
gengchc2
06c4c00688 Use https instead of http for git.openstack.org
Trivialfix

Change-Id: Ie1dbfa3c89dd10d65f69a948ae1158cf6b864c45
2017-02-07 11:53:15 +08:00
Naohiro Tamura
53a4aa99c9 Add soft reboot, soft power off and power timeout to api-ref
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
2017-01-31 11:05:58 +09:00
Naohiro Tamura
3a91dafb1a Add Inject NMI to api-ref
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
2017-01-30 13:59:56 +09:00
Jim Rollenhagen
eae8e07132 Fix api-ref warnings
A few missing parameters breaking the build on latest api-ref package,
fix them.

Change-Id: I7769844b8a766c78418c28991b97827014886ec4
Closes-Bug: #1658187
2017-01-20 20:30:09 +00:00
Jenkins
c1c86e81af Merge "Add VIFs attach/detach to api-ref" 2017-01-18 23:09:28 +00:00
Vasyl Saienko
77d1537d40 Add VIFs attach/detach to api-ref
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
2017-01-18 18:47:38 +00:00
Jenkins
f2d4d76b7d Merge "Update regenerate-samples.sh api-ref script" 2017-01-10 15:35:23 +00:00
licanwei
480d5be023 Remove trailing backtick
This patch is removing a trailing backtick (`) from the
baremetal-api-v1-node-management.inc document.

Change-Id: Ie1a8c0d15f169287d5b5d6b7cd5b190e87345869
2017-01-03 13:38:03 +00:00
Vasyl Saienko
e7eb1e63c6 Update regenerate-samples.sh api-ref script
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
2016-12-26 14:21:18 +00:00
Vladyslav Drok
519bb0c19d Add API reference for portgroup's mode and properties
Partial-Bug: #1618754
Change-Id: Icf8386715b49c17e153dd397dbcb30d3cd26824a
2016-12-21 17:05:17 +02:00
Jenkins
41ffcf81a8 Merge "Followup to 0335e81a8787" 2016-11-17 13:57:58 +00:00
Vladyslav Drok
7d736d1697 Followup to 0335e81a8787
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
2016-11-17 09:47:05 +00:00
Jenkins
8b1ffd8435 Merge "Add portgroup to api-ref" 2016-11-16 15:19:54 +00:00
Vasyl Saienko
0335e81a87 Add portgroup to api-ref
This patch updates api-ref documentations to reflect
portgroup changes.

Related-Bug: #1618754
Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com>
Change-Id: Id34344df9d3e68efe891c2be4a0b362be6557202
2016-11-16 12:13:53 +02:00
Aline Bousquet
1f61654019 Add possibility to remove chassis_uuid from a node
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
2016-11-10 16:19:44 +00:00
Luong Anh Tuan
ab968fcb87 fix a typo in document
Change-Id: I16469288d631892802360dec82ad4050969b33b1
2016-10-14 13:03:17 +07:00
Jenkins
ba45db8b46 Merge "[api-ref] Correcting type of r_addresses parameter" 2016-09-23 16:19:48 +00:00
Nguyen Phuong An
d5503f97ee [api-ref] Remove temporary block in conf.py
The os-api-ref 1.0.0 is out. We can remove the support to older version now.
Reference:
6d41feb58d

Change-Id: I14266932bf6f936991f1ea675f3e61431b4a0b1c
2016-09-07 08:24:39 +00:00
Nguyen Phuong An
227026058a [api-ref] Correcting type of r_addresses parameter
This patch changes 'r_addresses' type from 'list' to 'array' in
api-ref/source/parameters.yaml.

Change-Id: I266f011fde23b6f089aace43046bc98719c78913
2016-09-06 02:00:25 +00:00
Ha Van Tu
d3be671c9d Config logABug feature for Ironic api-ref
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
2016-08-31 12:15:47 +07:00
Devananda van der Veen
a5c26972b2 Update documentation for keystone policy support
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
2016-08-26 15:11:16 +00:00
Jenkins
2263797a1d Merge "Update api-ref for v1.22" 2016-08-24 02:58:25 +00:00
Devananda van der Veen
28a399a13c Update api-ref for v1.22
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
2016-08-21 11:43:30 -07:00
Graham Hayes
c6441aeba3 Get ready for os-api-ref sphinx theme change
Change-Id: Ib4c12c5f2efbdf0870fbaaf4951bcfe2fcf7c392
2016-08-19 16:44:02 +01:00
Vladyslav Drok
2b75314d20 Fix the description of inspection time fields
The descriptions of inspection_started_at and inspection_finished_at
node fields in api-ref are incorrect, this change fixes them.

Change-Id: I2e9e036f1dec0e6f34cae6780d5855b3295ae3c5
2016-08-15 13:50:54 +03:00
Jenkins
8220e40bba Merge "Document API max_limit configuration option" 2016-08-05 23:22:03 +00:00
Vladyslav Drok
395069cbef Add api-ref for new port fields
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
2016-07-27 18:24:25 +00:00