diff options
| author | Dmitry Tantsur <dtantsur@protonmail.com> | 2020-12-15 14:34:54 +0100 |
|---|---|---|
| committer | Dmitry Tantsur <dtantsur@protonmail.com> | 2020-12-15 14:45:46 +0100 |
| commit | 255fac17a08aaaf11aff94cb9799ad41c7e64c58 (patch) | |
| tree | fd0fda12d9321629dc6b8be35c793329d8a11464 /api-ref | |
| parent | 2d70e6e26e97cf09291cfabbc74e49d3acde119e (diff) | |
| download | ironic-255fac17a08aaaf11aff94cb9799ad41c7e64c58.tar.gz | |
Rewrite DHCP-less documentation
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
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/baremetal-api-v1-nodes.inc | 3 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 6 |
2 files changed, 7 insertions, 2 deletions
diff --git a/api-ref/source/baremetal-api-v1-nodes.inc b/api-ref/source/baremetal-api-v1-nodes.inc index 526f6e0d2..fb83d7c68 100644 --- a/api-ref/source/baremetal-api-v1-nodes.inc +++ b/api-ref/source/baremetal-api-v1-nodes.inc @@ -208,6 +208,7 @@ microversion 1.48. - lessee: lessee - description: n_description - allocation_uuid: allocation_uuid + - network_data: network_data **Example JSON representation of a Node:** @@ -562,6 +563,7 @@ Response - description: n_description - conductor: conductor - allocation_uuid: allocation_uuid + - network_data: network_data **Example JSON representation of a Node:** @@ -658,6 +660,7 @@ Response - description: n_description - conductor: conductor - allocation_uuid: allocation_uuid + - network_data: network_data **Example JSON representation of a Node:** diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 0d3c8b388..860f463ea 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -1079,8 +1079,10 @@ name: type: string network_data: description: | - Static network configuration for the node to eventually pass to node's - operating system. + Static network configuration in the OpenStack network data format to use + during deployment and cleaning. Requires a specially crafted ramdisk, see + `DHCP-less documentation + <https://docs.openstack.org/ironic/latest/admin/dhcp-less.html>`_. in: body required: false type: JSON |