Merge "Add more parameter explanation when create a node"
This commit is contained in:
commit
47c596298a
@ -95,7 +95,24 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- driver: r_driver_name
|
- boot_interface: req_boot_interface
|
||||||
|
- console_interface: req_console_interface
|
||||||
|
- deploy_interface: req_deploy_interface
|
||||||
|
- driver_info: req_driver_info
|
||||||
|
- driver: req_driver_name
|
||||||
|
- extra: req_extra
|
||||||
|
- inspect_interface: req_inspect_interface
|
||||||
|
- management_interface: req_management_interface
|
||||||
|
- name: node_name
|
||||||
|
- network_interface: req_network_interface
|
||||||
|
- power_interface: req_power_interface
|
||||||
|
- properties: req_properties
|
||||||
|
- raid_interface: req_raid_interface
|
||||||
|
- rescue_interface: req_rescue_interface
|
||||||
|
- resource_class: req_resource_class_create
|
||||||
|
- storage_interface: req_storage_interface
|
||||||
|
- uuid: req_uuid
|
||||||
|
- vendor_interface: req_vendor_interface
|
||||||
|
|
||||||
**Example Node creation request with a dynamic driver:**
|
**Example Node creation request with a dynamic driver:**
|
||||||
|
|
||||||
|
@ -334,7 +334,7 @@ agent_node:
|
|||||||
required: true
|
required: true
|
||||||
type: JSON
|
type: JSON
|
||||||
|
|
||||||
# variables in the API response body
|
# variables in the API body
|
||||||
boot_device:
|
boot_device:
|
||||||
description: |
|
description: |
|
||||||
The boot device for a Node, eg. "pxe" or "disk".
|
The boot device for a Node, eg. "pxe" or "disk".
|
||||||
@ -936,12 +936,6 @@ pxe_enabled:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: boolean
|
type: boolean
|
||||||
r_driver_name:
|
|
||||||
description: |
|
|
||||||
The name of the driver used to manage this Node.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
raid_config:
|
raid_config:
|
||||||
description: |
|
description: |
|
||||||
Represents the current RAID configuration of the node. Introduced with
|
Represents the current RAID configuration of the node. Introduced with
|
||||||
@ -961,6 +955,115 @@ reason:
|
|||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
req_boot_interface:
|
||||||
|
description: |
|
||||||
|
The boot interface for a Node, e.g. "pxe".
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_console_interface:
|
||||||
|
description: |
|
||||||
|
The console interface for a node, e.g. "no-console".
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_deploy_interface:
|
||||||
|
description: |
|
||||||
|
The deploy interface for a node, e.g. "iscsi".
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_driver_info:
|
||||||
|
description: |
|
||||||
|
All the metadata required by the driver to manage this Node. List of fields
|
||||||
|
varies between drivers, and can be retrieved from the
|
||||||
|
``/v1/drivers/<DRIVER_NAME>/properties`` resource.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: JSON
|
||||||
|
req_driver_name:
|
||||||
|
description: |
|
||||||
|
The name of the driver used to manage this Node.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
req_extra:
|
||||||
|
description: |
|
||||||
|
A set of one or more arbitrary metadata key and
|
||||||
|
value pairs.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: object
|
||||||
|
req_inspect_interface:
|
||||||
|
description: |
|
||||||
|
The interface used for node inspection, e.g. "no-inspect".
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_management_interface:
|
||||||
|
description: |
|
||||||
|
Interface for out-of-band node management, e.g. "ipmitool".
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_network_interface:
|
||||||
|
description: |
|
||||||
|
Which Network Interface provider to use when plumbing the network
|
||||||
|
connections for this Node.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_power_interface:
|
||||||
|
description: |
|
||||||
|
Interface used for performing power actions on the node, e.g. "ipmitool".
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_properties:
|
||||||
|
description: |
|
||||||
|
Physical characteristics of this Node. Populated during inspection, if
|
||||||
|
performed. Can be edited via the REST API at any time.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: JSON
|
||||||
|
req_raid_interface:
|
||||||
|
description: |
|
||||||
|
Interface used for configuring RAID on this node, e.g. "no-raid".
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_rescue_interface:
|
||||||
|
description: |
|
||||||
|
The interface used for node rescue, e.g. “no-rescue”.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_resource_class_create:
|
||||||
|
description: |
|
||||||
|
A string which can be used by external schedulers to identify this Node as
|
||||||
|
a unit of a specific type of resource.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_storage_interface:
|
||||||
|
description: |
|
||||||
|
Interface used for attaching and detaching volumes on this node, e.g.
|
||||||
|
"cinder".
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_uuid:
|
||||||
|
description: |
|
||||||
|
The UUID for the resource.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
req_vendor_interface:
|
||||||
|
description: |
|
||||||
|
Interface for vendor-specific functionality on this node, e.g. "no-vendor".
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
requested_provision_state:
|
requested_provision_state:
|
||||||
description: |
|
description: |
|
||||||
One of the provisioning verbs: manage, provide, inspect, clean, active,
|
One of the provisioning verbs: manage, provide, inspect, clean, active,
|
||||||
|
Loading…
Reference in New Issue
Block a user