114 Commits

Author SHA1 Message Date
Steve Baker
7ebad2e344 Allow vendor_data to be included in a configdrive dict
configdrive can contain a vendor_data2.json file containing key/value
pairs injected by nova's vendordata mechanism[1].

This change lets Ironic accept a vendor_data key when configdrive is
provided as json, allowing parity with nova.

This change requires an openstacksdk release 0.37.0

[1] https://www.madebymikal.com/nova-vendordata-deployment-an-excessively-detailed-guide/

Change-Id: Id990b970619a113c5d5ead47fb550870d91b5e04
Task: 36756
Story: 2006597
Blueprint: nova-less-deploy
2019-10-31 08:55:39 +13:00
Zuul
5e4edeab97 Merge "Add api-ref for allocation update" 2019-06-07 14:11:35 +00:00
Madhuri Kumari
2d4380e323 Add api-ref for allocation update
Change-Id: I3a8cfa3d959c6906968bca7006583f45446758e5
Story: 2005126
Task: 29796
2019-06-06 09:32:39 +05:30
Dmitry Tantsur
8f6bf4f9dd Allocation API: backfilling allocations
This feature addresses the case of moving the already deployed nodes
under the allocation API.

Change-Id: I29d0bd3663e0d1b27727a700c0f0e0fb6ceac1d9
Story: #2005014
Task: #29491
2019-05-21 20:09:21 +02:00
Mark Goddard
9672cb73d2 Deploy Templates: API reference
Change-Id: I14716e6023dd09096e17e60c7d02230ecb3e7150
Story: 1722275
Task: 28680
2019-03-12 15:43:12 +00:00
Dmitry Tantsur
3e1e0c9d5e Allow building configdrive from JSON in the API
Extend the API with the ability to build config drives from meta_data,
network_data and user_data, where meta_data and network_data are JSON
objects, and user_data is either a JSON object, a JSON array or
raw contents as a string.

This change uses openstacksdk (which is already an indirect dependency)
for building config drives.

Change-Id: Ie1f399a4cb6d4fe5afec79341d3bccc0f81204b2
Story: #2005083
Task: #29663
2019-03-05 19:14:56 +01:00
Zuul
84f6e5fb84 Merge "Adding bios_interface reference to api docs" 2019-03-01 11:08:48 +00:00
Dmitry Tantsur
08270cebab Allocation API: fix minor issues in the API reference
Follow-up to commit acc4c402de42be0b1fb179d13dcf86a4ca384206.

Change-Id: Ie519caf791b6444afdc5a8665b1fbd719f916388
Story: #2004341
2019-02-26 11:13:07 +01:00
Dmitry Tantsur
acc4c402de Allocation API: reference documentation
Change-Id: I48f20f0b96931a17c477b9687b0ee963cb7b8879
Story: #2004341
Task: #29574
2019-02-26 10:16:25 +01:00
Riccardo Pittau
e0639875f4 Adding bios_interface reference to api docs
As per title, this patch adds default_boot_interface and
enabled_boot_interfaces references, definitions and examples
to the api-ref documentation.

Change-Id: I35d4829c32cc48d5734c269c0a83ad9b4fbdd660
2019-02-25 17:09:11 +01:00
Zuul
352e37a36d Merge "Expose is_smartnic in port API" 2019-02-12 23:20:49 +00:00
Kaifeng Wang
d4233e52a9 Expose conductors: api-ref
This patch updates API reference to contain the changes made
by the feature of exposing conductors.

Story: 1724474
Task: 28064

Change-Id: I47dbea2cda1cc0ad73786fe3fe9b80850e1cf289
2019-02-12 07:02:09 -08:00
Hamdy Khader
6325b6c13c Expose is_smartnic in port API
Changes are made to support ironic handling is_smarting port attribute
that was added in this change Ic2ffbd6f1035907ea5a18bda6d2b21e617194195

This change expose is_smartnic port field in REST API, updated API
reference to include is_smartnic field and relevent documentations.

API version updated to 1.53.

Story: #2003346
Change-Id: I89ce54a0c034f2a5f82ff961ab06cfcc6d853bd4
2019-02-10 12:10:00 +02:00
Kaifeng Wang
96bc6729cf Add description field to node: api-ref
Update api-ref to include the description field.

Also updated a few missing owner field.

Change-Id: I81c5bf1be18ac4109f0e5ef66193ff66f484d107
Story: 2003089
Task: 23178
2019-02-01 10:37:04 +08:00
Zuul
87b25d5447 Merge "Add "owner" information field" 2018-12-11 18:56:47 +00:00
Zuul
be8d81becd Merge "Introduce configuration option [ipmi]ipmi_disable_timeout" 2018-12-11 06:27:51 +00:00
Julia Kreger
052d90506f Add "owner" information field
Adds "owner" field on the node object and exposes it for updates
via the API.

Additionally, fixed a couple minor items related to the prior
where we missed updating version numbers in rebases.

Change-Id: Iaaf3db97d21de9b11236cf2d18ffcc3f73f6e50c
Story: #2001814
Task: #12550
2018-12-10 14:27:31 -08:00
Kaifeng Wang
d379357cad Introduce configuration option [ipmi]ipmi_disable_timeout
Some type of BMCs don't support an IPMI option that disable the
behavior of boot device timeout, which makes them never get booted
from PXE.

This patch extends the fix [1] by adding a configuration option,
which provides the default ipmi behavior.

[1] https://review.openstack.org/#/c/616053

Additionally revising the variable/setting names based upon review
feedback and discussion that took place during the 20181210 weekly
ironic team meeting.

Change-Id: Ie049bbaf45aeab54c1272d1d561c5a6ca00dc34a
Story: 2002977
Task: 22985
2018-12-10 14:04:02 -08:00
Matt Riedemann
987d330785 api-ref: update node.resource_class description
The future of scheduling with custom resource classes is now!
Actually it has been for a couple of years. This drops the
"future" part of the parameter description and links to the
docs on configuring nova flavors with custom resource classes
for scheduling with the placement service.

Change-Id: Id904acdf305096738604eacb225136f1f9c03338
2018-12-07 16:50:42 -05:00
Zuul
cb543d7705 Merge "Add ipmi_disable_timeout to avoid problematic IPMI command" 2018-12-04 08:08:36 +00:00
Zuul
c5414620c5 Merge "Fix Chinese quotes" 2018-11-28 13:43:56 +00:00
zhangdebo
2344bb5ea5 Fix Chinese quotes
Change-Id: I678a7aff4685b8d807570a6bc69bebfaa2960c4e
2018-11-28 19:19:23 +08:00
Tony Breeds
eb29465bd5 Add ipmi_disable_timeout to avoid problematic IPMI command
The IPMI driver unconditionally instructed the BMC not automatically
clear boot flag valid bit if Chassis Control command not received within
60-second timeout (countdown restarts when a Chassis Control command is
received).  Some BMCs do not support setting this.  Sending the command
aborts the node boot.

A new driver option ``ipmi_disable_timeout`` is added to bypass
sending this command.

Change-Id: I1dda3cf3e4b7b888ed9d8931c8ede3a918dd01f4
Story: 2004266
2018-11-28 01:29:04 +00:00
Dmitry Tantsur
68d62f2bee Support for protecting nodes from undeploying and rebuilding
When handling the "pet" case, some nodes may be critical for the deployment.
For example, in an OpenStack installer like TripleO you may want to make
sure your controllers are not removed by an incorrect operation.

This changes introduces a new field "protected" on nodes. When it is
set to True, the "deleted" and "rebuild" provisioning actions fail with
HTTP 403.  Deleting such nodes is also not possible.

Also adds "protected_reason" for the operators to specify the reason
a node is protected.

Story: #2003869
Task: #26706
Change-Id: I1950bf6dd65b6596cae69d431ef288e578a89d6e
2018-11-27 10:07:30 +01:00
Jim Rollenhagen
d269c47a87 Add api-ref for conductor group
This was missed in the original feature; add it in.

Change-Id: I7bad95be09be90a9d804cf95cde4226ffd98bb46
2018-10-23 07:34:41 -04:00
Yolanda Robla
95a449357c Add documentation for BIOS settings
Update api-ref documentation, to add the BIOS
settings.

Change-Id: Ic592b5fa39f0d19d5676906ecd5c8fcbebf8e25f
2018-07-27 13:23:37 +02:00
Mark Goddard
5a14eed467 Deploy steps - API & notifications
Adds a 'deploy_step' field to the nodes API.

Co-Authored-By: Ruby Loo <rloo@oath.com>

Change-Id: I1baeeaaa6ed521e4189958fd7624cd6c5de96707
Story: #1753128
Task: #22592
2018-07-11 16:19:31 +00:00
Dongcan Ye
e2899de09d Fix list node vifs api error
The node_ident param should in Request, this patch fix it.

Change-Id: Id70533ff75e0f7b7930725fd74428c390321b98d
2018-07-03 11:23:25 +00:00
Zuul
231cef47fb Merge "Modify the Ironic api-ref's parameters in parameters.yaml" 2018-06-22 01:39:06 +00:00
Sam Betts
233d7d5727 Add detail=[True, False] query string to API list endpoints
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
2018-06-18 19:40:07 +00:00
shuangyang.qian
d0dca903df Modify the Ironic api-ref's parameters in parameters.yaml
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
2018-06-14 10:45:48 +08:00
Kaifeng Wang
8ee2f4b58f Power fault recovery follow up
This patch addresses comments relate to API and notification.

[1] https://review.openstack.org/#/c/558152
[2] https://review.openstack.org/#/c/556015/

Story: #1596107
Task: #10469

Change-Id: Ic2f7e6847790ae7af43570ca7af572539e7d5f2c
2018-06-06 13:20:55 +00:00
Kaifeng Wang
b4c4eb99fc Power fault recovery: API implementation
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
2018-06-01 20:10:25 +08:00
fpxie
36ac2988db Add more parameter explanation when create a node
Change-Id: I8035546a21bf55af5df09aca3038ff377e0758a7
2018-04-20 08:33:17 +08:00
John L. Villalovos
6b91ba21df Resolve pep8 E402 errors and no longer ignore E402
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
2018-04-10 17:34:04 -07:00
melissaml
9ea09fca8a Update and replace http with https for doc links
1) Use https instead of http for docs links
2) Update doc links according to OpenStack document migration

Change-Id: Ib9b2fa3b699de361d47aa80d07cdf76b7a1eb143
2018-04-04 22:14:26 +08:00
Zuul
6cbcdaee4e Merge "Add Error Codes" 2018-03-16 15:54:32 +00:00
Zuul
22da631f9c Merge "Remove the deprecated "giturl" option" 2018-03-12 23:15:34 +00:00
wangqi
c6f8d85852 fix a typo in driver-property-response.json: s/doman/domain/
Change-Id: I43fe909213c07f13b7e740c0bfa84ed5cef68cd1
2018-02-26 06:58:44 +00:00
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