48 Commits

Author SHA1 Message Date
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
Devananda van der Veen
6d846590bc Follow-up fixes to 206244
This commit is a collection of follow-up fixes to the nits/comments on
https://review.openstack.org/#/c/206244/116

Change-Id: I5631f5df3c0b6a3baa386da8b93b1e888c1f8d3c
2016-07-13 18:12:35 -07:00
Mario Villaplana
8458f9bccf Document API max_limit configuration option
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
2016-07-07 15:52:28 +00:00
Vladyslav Drok
1fbbd14485 Fix nits related to Ports api-ref
This is the followup of 14e48ec273ffb57c1db333f387f5df9d49fa4077.

Change-Id: I8d9ce2807d697ef694af9b8fc2b700cb47bc8d91
2016-06-08 13:25:32 +03:00
Devananda van der Veen
3c20a9bae6 Update the api-ref documentation for Drivers
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
2016-06-07 15:01:52 +00:00
Devananda van der Veen
14e48ec273 Update the api-ref documentation for Ports
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
2016-05-31 18:11:52 +03:00
Vladyslav Drok
8ea1d8c7d6 Use a single uuid parameter in api-ref
Currently, there is a node_uuid parameter that describes specifically
a node UUID in response body. Let's use just uuid.

Change-Id: I43ffe017188c1f15a0c6d8007d4bd463e867b774
2016-05-30 21:36:42 +03:00
Devananda van der Veen
6e82b2118a Update the api-ref documentation for Root and Nodes
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
2016-05-20 08:35:29 -07:00
Devananda van der Veen
a496a6bae0 Read the Sphinx html_last_updated_fmt option correctly in py3
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
2016-05-20 08:14:14 -07:00
Jim Rollenhagen
2f0e1e180e Migrate to os-api-ref library
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
2016-05-16 08:12:48 -04:00
Jim Rollenhagen
fa098f69e4 Migrate api-ref into our tree
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
2016-05-03 21:39:42 +00:00