73 Commits

Author SHA1 Message Date
MaoyangLiu
a0e1131b0c Replace chinese quotes to English quotes
Change-Id: Ica91e88cbb4e51ef591bf748273a2ca3334aa071
2018-02-06 17:43:45 +08:00
Zuul
3d38fd2bbd Merge "Follow-up patch for api-ref documentation for rescue" 2018-02-03 16:35:40 +00:00
Shivanand Tendulker
8010b07076 Follow-up patch for api-ref documentation for rescue
This patch addresses outstanding comments for commit
9a6c62dd8e54bb07f4ca4da0b4c3c4e71ebf7971

Change-Id: I3072f36a57cfd4d4963d5aa0bd2a60888df4d587
Related-Bug: #1526449
2018-02-02 10:05:47 -05:00
Zuul
193606f0ce Merge "Update api-ref for port group create" 2018-02-02 14:48:04 +00:00
Zuul
fe5063a867 Merge "[api-ref] clarify what /v1/lookup returns" 2018-02-02 00:38:40 +00:00
Zuul
3ac9166298 Merge "Add api-ref and ironic state documentation for rescue" 2018-02-01 20:38:37 +00:00
Ruby Loo
2166974f28 [api-ref] clarify what /v1/lookup returns
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
2018-01-31 15:48:47 -05:00
Mario Villaplana
9a6c62dd8e Add api-ref and ironic state documentation for rescue
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
2018-01-31 04:08:07 -05:00
Mark Goddard
00daa18fc9 Add documentation for node traits
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
2018-01-30 15:50:55 +00:00
Kaifeng Wang
0386a4f966 Update api-ref for port group create
Update the facts that name and MAC address is not mandatory when
creating port groups.

Change-Id: I214cdab5789923341cdb2100b425958df6053d68
2018-01-25 16:41:55 +08:00
Mark Goddard
223e9b1faa Add node traits to API reference
The node traits API was added in API microversion 1.37.

Change-Id: I8c48f2e7662ae9641ec823dc3802d5979a7ea03e
Partial-Bug: #1722194
2018-01-25 01:36:54 +00:00
Zuul
2c13e4157d Merge "Add a provisioning target:adopt" 2018-01-08 16:11:53 +00:00
fpxie
7490b6e743 Add a provisioning target:adopt
Change-Id: If6c8b18b41c1fe3f2868c4b144402d4a031ee957
2018-01-04 15:29:49 +08:00
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