summaryrefslogtreecommitdiff
path: root/api-ref/source
Commit message (Collapse)AuthorAgeFilesLines
* Fix api-ref v1-indicatorsHarald Jensås2023-05-091-2/+2
| | | | | | | | | | | | When doing a GET or PUT on an indicator the indicator specified must use `indicator@component` syntax. For example: indicators/led@system or indicators/led-0@chassis Ref: ironic.api.controllers.v1.node.IndicatorAtComponent Change-Id: I6908544b52be88cbddf537c954dd5e097a0d83e6
* Remove all references to the "cpus" propertyDmitry Tantsur2023-03-281-1/+0
| | | | | | | | Unused by Nova and unlike memory_mb/local_gb also by Ironic (actually, our usage of local_gb is worth double-checking as well, but at the very least it's referenced by inspection implementations). Change-Id: Ie8b0d9f58f4dcd102c183c30ae7f5acf68a5e4c3
* Add missing include for inventory API referenceDmitry Tantsur2023-02-232-2/+7
| | | | | | Also fix up the title and make sure the linter checks API ref files. Change-Id: I360fd4fab699e732ac03dc07faab33e18fe2bf13
* Add support for filtering for sharded nodesJay Faulkner2023-02-132-2/+11
| | | | | | | This request parameter will allow an operator to ask the question "Do I need to assign shards to any of my nodes?". Change-Id: I26b745e5ef2b320a8d8a0667ac61c080fcdcd576
* Allow port queries by shard listJay Faulkner2023-02-132-0/+12
| | | | | | | | Adds ability to query ports by shard. Example usage: /v1/ports?shard=lol,cats Change-Id: Icacef7f71414d30f492a6d144bcc89dff4891784
* API support for CRUD node.shardJay Faulkner2023-02-135-1/+115
| | | | | | | | | | | | - Basic support and testing for CRUD for node.shard. - Policy checking for update node.shard. - New API endpoint: GET /v1/shards - Policy checking for GET /v1/shards - Support for querying for nodes in a list of shards Story: 2010378 Task: 46624 Change-Id: I385594339028c20cfc83fdcc4cbbec107efdacff
* Fix API docs to document port filtering behaviorJay Faulkner2023-01-301-1/+7
| | | | | | | Ports cannot be filtered by node, node_uuid, or portgroup at the same time as other potential filters. Explicitly document this. Change-Id: Ia875a6543eb8871ce70028c055de2f1832c3ecdb
* API for node inventoryJakub Jelinek2023-01-123-0/+83
| | | | | | | | Add api to access node inventory Story: 2010275 Task: 46204 Change-Id: If50f665da5fbb16f7646f3d6195a6e14e7325b0a
* Allocation candidates prefer matching nameSteve Baker2022-06-161-1/+5
| | | | | | | | | | | | | | | | | | This change finds a node with the same name as the allocation and moves it to the beginning of the shuffled candidate list so that node is the first allocation attempt. It is common for node naming scheme to match the node's role (such as compute-1, compute-2). Also this often matches the hostname (allocation name) scheme. Without this change, this scenario will generally result in swapped names (node compute-1 having hostname compute-2, etc). By preferring matching names this situation can be avoided in the majority of cases, while not otherwise affecting the candidiate allocation approach. Change-Id: Ie990bfc209959d58852b9080778602eab5aa30af
* Remove unicode literal from codeLiZekun2022-06-021-5/+5
| | | | | | | | | All strings are considered as unicode literal string from Python 3. This patch drops the explicit unicode literal (u'...') appearances from the unicode strings. Change-Id: I52ae9180344baf408e6e8a932e9d59dc45ece9de
* Create API documentation from docstringsMahnoor Asghar2022-03-172-6/+14
| | | | | | | | | | Create a new Sphinx extension called 'web_api_docstring' to process docstrings from the API classes, in order to generate API documentation. Story: 2009785 Task: 44291 Change-Id: Ia6b2b3741e2b1cbd29531c21795df4f0f0dc70ca
* There is no aim, we do deploy/manage baremetal.Julia Kreger2021-10-151-1/+1
| | | | | | | Fix the root description header, since the Ironic project is very far past the days of when we were aiming to provision baremetal. Change-Id: I21f6058fe29b1495dbde63ec09a1227568dc3f08
* API endpoints to get node historyJulia Kreger2021-09-154-0/+135
| | | | | | | | | | | Adds API for retrieving node history events via a node. Includes pagination and limitation of the response set. Story: 2002980 Tas: 42961 Change-Id: I22a92fa6c30d721f6a5dd0670b2e0a9cf76ad7b1
* Merge "Add support for fields in drivers API"Zuul2021-09-151-0/+8
|\
| * Add support for fields in drivers APITadeas Kot2021-08-271-0/+8
| | | | | | | | | | | | | | | | This commit add support for the fields query parameter to the GET /v1/drivers?fields=... and GET /v1/drivers/<driver_name>?fields=.... Story: 1674775 Task: 10581 Change-Id: I2ca4eb490e320e736a93851eed526ec862be901e
* | Minor formatting and doc changes to change boot mode feature commit.Cenne2021-08-241-2/+2
|/ | | | | | | Story: 2008567 Task: 41709 depends-on: https://review.opendev.org/c/openstack/ironic/+/800084 Change-Id: I44e41dc3d8abcb99a2248d7b9c7ac5e9d786bb98
* Add api endpoints for changing boot_mode and secure_boot stateCenne2021-08-236-0/+95
| | | | | | | | | | | | | | | | | | | | Done: - Node API endpoints expose - RPC methods - Conductor Manager methods - Conductor utils new methods - RBAC new policies - Node API tests - Manager Tests (+ some testing for utils methods) - RBAC tests - Docs (api-ref) - REST API version history - Releasenotes Story: 2008567 Task: 41709 Change-Id: I2d72389edf546b99c536c6b130ca85ababf80591
* Merge "Add a section to redfish doc for BIOS registry fields"Zuul2021-07-191-14/+7
|\
| * Add a section to redfish doc for BIOS registry fieldsBob Fournier2021-07-131-14/+7
| | | | | | | | | | | | | | Move the descriptions of the BIOS registry fields in the API to a new section in the Redfish documentation. Change-Id: Ifedb4526113bb84ccc598e13f5767b71a60f5532
* | Add `boot_mode` and `secure_boot` to node object and expose in apiCenne2021-07-083-1/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | * add fields to Node object * expose them at endpoint `/v1/nodes/{node_ident}/states` * update states on powersync / entering managed state. * tests * update api endpoint info in api-ref Story: 2008567 Task: 41709 Change-Id: Iddd1421a6fa37d69da56658a2fefa5bc8cfd15e4
* | Follow-up to Include bios registry fields in bios APIIury Gregory Melo Ferreira2021-06-011-1/+1
|/ | | | | | | | This commit is a follow-up to Ie86ec57e428e2bb2efd099a839105e51a94824ab Story: #2008571 Task: #42546 Change-Id: I6fa4658180772ff9c4ff00f95b28cf8a1b5d4223
* Include bios registry fields in bios APIBob Fournier2021-05-275-5/+177
| | | | | | | | | | Provide the fields in the BIOS setting API - ``/v1/nodes/{node}/bios/{setting}``, and in the BIOS setting list API when details are requested - ``/v1/nodes/<node>/bios?detail=True``. Story: #2008571 Task: #42483 Change-Id: Ie86ec57e428e2bb2efd099a839105e51a94824ab
* Add missing bios_interface to api-ref for validate APIBob Fournier2021-05-212-0/+7
| | | | | | | Fixing another case of bios interface missing from the api-ref documentation, this one for the validate API. Change-Id: I8ae3212f04a8d150af8adde5f5f87e5a5451da14
* Add bios_interface to api-ref specBob Fournier2021-05-141-0/+2
| | | | | | | | This is a doc change to add bios_interface to the api reference. Its included in the detailed node list and node show but wasn't shown in the api-ref. Change-Id: I8735d10db1644f8a2c872c75c156c75c06b79c0c
* Bye-bye iSCSI deploy, you served us wellDmitry Tantsur2021-05-043-5/+5
| | | | | | | | | | | | The iSCSI deploy was very easy to start with, but it has since become apparently that it suffers from scalability and maintenance issues. It was deprecated in the Victoria cycle and can now be removed. Hide the guide to upgrade to hardware types since it's very outdated. I had to remove the iBMC diagram since my SVG-fu is not enough to fix it. Change-Id: I2cd6bf7b27fe0be2c08104b0cc37654b506b2e62
* API to force manual cleaning without booting IPADmitry Tantsur2021-03-162-0/+13
| | | | | | | | | | | | | | Adds a new argument disable_ramdisk to the manual cleaning API. Only steps that are marked with requires_ramdisk=False can be run in this mode. Cleaning prepare/tear down is not done. Some steps (like redfish BIOS) currently require IPA to detect a successful reboot. They are not marked with requires_ramdisk just yet. Change-Id: Icacac871603bd48536188813647bc669c574de2a Story: #2008491 Task: #41540
* Add 'deploy steps' parameter for provisioning APIAija Jauntēva2021-02-033-0/+32
| | | | | | Story: 2008043 Task: 40705 Change-Id: I3dc2d42b3edd2a9530595e752895e9d113f76ea8
* Complete the REST API POST documentationSteve Baker2020-12-168-38/+207
| | | | | | | | | | | This change adds missing POST request parameters and makes other minor corrections to the REST API documentation. Its possible that some of the parameters for /v1/nodes were never intended to be available for the POST call, but this docs change is to document what has been implemented, not the original intention. Change-Id: I1e35586d20bd3eda4d727931235340dd408c7508
* Rewrite DHCP-less documentationDmitry Tantsur2020-12-152-2/+7
| | | | | | | | | | | The current documentation is basically unreadable and contains a few factual errors. Rewrite it for simplicity and move to a separate file since at least 2 hardware types claim its support. The patch does not concern the current status of the feature, an easily revertable follow-up will be posted for that. Change-Id: I3404378333316b0736ce07610a1dbbd7847bac00
* Add 'agent_token' to heartbeat requestRuby Loo2020-09-102-0/+11
| | | | | | | | Updates the API ref to include the 'agent_token' value in a heartbeat request (from IPA). New since v1.62 (https://opendev.org/openstack/ironic/src/commit/9341ca4ef726826f4845635e6567a919f2ddc48c/ironic/api/controllers/v1/versions.py#L102). Change-Id: I5eea9704c1bf62561a5505227735159dad7a8e49
* Add api-ref for indicators APIIury Gregory Melo Ferreira2020-06-197-0/+298
| | | | | | Change-Id: Ie40f585b26efdd70b88f2e642698eb9e988e3d97 Story: 2007745 Task: 39923
* Merge "Fix pygments style"Zuul2020-05-211-1/+1
|\
| * Fix pygments stylegugug2020-05-211-1/+1
| | | | | | | | | | | | | | | | New theme of docs respects pygments_style. more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I5d87b0e4da19a51c47f02e5a88957ce1fea4c21d
* | Merge "Add `network_data` field to ironic node object"Zuul2020-05-196-0/+16
|\ \
| * | Add `network_data` field to ironic node objectIlya Etingof2020-05-056-0/+16
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A new dictionary field `network_data` is added to the node object. This new field can be populated by the operator with node static network configuration. Ironic API now performs formal JSON document validation of node `network_data` field content against user-supplied JSON schema at driver validation step. As of this commit, the new `network_data` field is not actually used by ironic, otherwise it should be perfectly functional. In the following commits, network static configuration will be taken from this field and handed over to ironic ramdisk bootstrapping utilities. Change-Id: I868b3b56a17f59e5aa1494b2e0ebc9c4e34ef173 Story: 2006691 Task: 36991
* | Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-181-3/+3
|/ | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * parallelizing building of documents Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Set openstackdocs_pdf_link to link to PDF file. Set openstackdocs_auto_name to use 'project' as name. Depends-On: https://review.opendev.org/728938 Change-Id: I76a21521eeb432c3f4089048a4635719ba6d785c
* Add node lessee fieldTzu-Mainn Chen2020-04-076-0/+30
| | | | | | | | | | | | This change adds a `lessee` field to nodes, and exposes it to policy. It also updates the non-admin node list API to match for both owner and lessee; and updates the allocation conductor to match owner allocations with nodes with the appropriate lessee. Change-Id: Ib31b49c7143ec8fd6cb486fc24038215b197c418 Story: 2006506 Task: 37930
* Cleanup docs buildingAndreas Jaeger2020-02-291-21/+5
| | | | | | | | | | * Remove doc/source/install/conf.py, it's unused. * Remove settings that are provided by openstackdocstheme from conf.py files. Switch to newer openstackdocstheme for this. * Remove unused deps from tox.ini: releasenotes and api-refonly need doc/requirements but not requirements. Change-Id: Iab5ad6cde40c3342770c0112155fe5e1d262d1e8
* Support node retirementArne Wiebalck2020-01-286-0/+29
| | | | | | | | | | | | | | | This change adds support for node retirement: nodes can have additional properties 'retired' and 'retired_reason' which change the way the nodes (can) traverse the FSM and which operations are allowed. In particular: - retired nodes cannot move from manageable to available; - upon instance deletion, retired nodes move to manageable (rather than available). Story: #2005425 Task: #38142 Change-Id: I8113a44c28f62bf83f8e213aeb6704f96055d52b
* Fix API docs for target_power_state responseZane Bitter2020-01-141-2/+1
| | | | | | | | | | | | | The API docs stated that the values of target_power_state in a Node State Summary are the same as the valid input values in a Change Node Power State request (i.e. they include "rebooting", "soft rebooting", and "soft power off"). However, in actuality these are all compressed to either "power on" or "power off" by the _calculate_target_state() function. Change-Id: I8c8b8c707102275a48233fc853acfb65f556946e Story: #2007089 Task: 38115
* Add a missing versionadded for configdrive[vendor_data]Dmitry Tantsur2020-01-071-0/+3
| | | | Change-Id: Ibfbb2f8f7a5f33e678a472a70b4b46aa1d7704e4
* Add owner to allocations and create relevant policiesTzu-Mainn Chen2019-12-106-1/+21
| | | | | | | | | | Add an owner to allocations. Depending on policy, a non-admin can then create an allocation and have the owner set to their project. Allocation processing then respects the owner. Change-Id: I2965a4a601b9fa2c0212097da37b104a3e5514df Story: #2006506 Task: #37540
* Allow vendor_data to be included in a configdrive dictSteve Baker2019-10-311-0/+1
| | | | | | | | | | | | | | | | | 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
* Merge "Add api-ref for allocation update"Zuul2019-06-073-0/+89
|\
| * Add api-ref for allocation updateMadhuri Kumari2019-06-063-0/+89
| | | | | | | | | | | | Change-Id: I3a8cfa3d959c6906968bca7006583f45446758e5 Story: 2005126 Task: 29796
* | Allocation API: backfilling allocationsDmitry Tantsur2019-05-212-2/+25
|/ | | | | | | | | This feature addresses the case of moving the already deployed nodes under the allocation API. Change-Id: I29d0bd3663e0d1b27727a700c0f0e0fb6ceac1d9 Story: #2005014 Task: #29491
* Deploy Templates: API referenceMark Goddard2019-03-1210-0/+426
| | | | | | Change-Id: I14716e6023dd09096e17e60c7d02230ecb3e7150 Story: 1722275 Task: 28680
* Allow building configdrive from JSON in the APIDmitry Tantsur2019-03-052-4/+16
| | | | | | | | | | | | | | 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
* Merge "Adding bios_interface reference to api docs"Zuul2019-03-014-0/+29
|\
| * Adding bios_interface reference to api docsRiccardo Pittau2019-02-254-0/+29
| | | | | | | | | | | | | | | | 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
View Lorry Controller Status