f41bb7dd26
Pagination abilities are described in doc/source/restapi.rst file and in api-ref Change-Id: Ia653f1fb22a640299a1d2642ea11d9b0215dc000 bp: pagination
272 lines
5.8 KiB
ReStructuredText
272 lines
5.8 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
====================
|
|
Node group templates
|
|
====================
|
|
|
|
A cluster is a group of nodes with the same configuration. A node
|
|
group template configures a node in the cluster.
|
|
|
|
A template configures Hadoop processes and VM characteristics, such
|
|
as the number of reduced slots for task tracker, the number of
|
|
CPUs, and the amount of RAM. The template specifies the VM
|
|
characteristics through an OpenStack flavor.
|
|
|
|
|
|
List node group templates
|
|
=========================
|
|
|
|
.. rest_method:: GET /v1.1/{tenant_id}/node-group-templates
|
|
|
|
Lists available node group templates.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: url_tenant_id
|
|
- limit: limit
|
|
- marker: marker
|
|
- sort_by: sort_by_node_groups
|
|
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- markers: markers
|
|
- prev: prev
|
|
- next: next
|
|
- volume_local_to_instance: volume_local_to_instance
|
|
- availability_zone: availability_zone
|
|
- updated_at: updated_at
|
|
- use_autoconfig: use_autoconfig
|
|
- volumes_per_node: volumes_per_node
|
|
- id: id
|
|
- security_groups: security_groups
|
|
- shares: shares
|
|
- node_configs: node_configs
|
|
- auto_security_group: auto_security_group
|
|
- volumes_availability_zone: volumes_availability_zone
|
|
- description: description
|
|
- volume_mount_prefix: volume_mount_prefix
|
|
- plugin_name: plugin_name
|
|
- floating_ip_pool: floating_ip_pool
|
|
- is_default: is_default
|
|
- image_id: image_id
|
|
- volumes_size: volumes_size
|
|
- is_proxy_gateway: is_proxy_gateway
|
|
- is_public: is_public
|
|
- hadoop_version: hadoop_version
|
|
- name: name
|
|
- tenant_id: tenant_id
|
|
- created_at: created_at
|
|
- volume_type: volume_type
|
|
- is_protected: is_protected
|
|
- node_processes: node_processes
|
|
- flavor_id: flavor_id
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
.. rest_method:: GET /v1.1/{tenant_id}/node-group-templates?limit=2&marker=38b4e146-1d39-4822-bad2-fef1bf304a52&sort_by=name
|
|
|
|
.. literalinclude:: samples/node-group-templates/node-group-templates-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Create node group template
|
|
==========================
|
|
|
|
.. rest_method:: POST /v1.1/{tenant_id}/node-group-templates
|
|
|
|
Creates a node group template.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: url_tenant_id
|
|
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/node-group-templates/node-group-template-create-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- volume_local_to_instance: volume_local_to_instance
|
|
- availability_zone: availability_zone
|
|
- updated_at: updated_at
|
|
- use_autoconfig: use_autoconfig
|
|
- volumes_per_node: volumes_per_node
|
|
- id: id
|
|
- security_groups: security_groups
|
|
- shares: shares
|
|
- node_configs: node_configs
|
|
- auto_security_group: auto_security_group
|
|
- volumes_availability_zone: volumes_availability_zone
|
|
- description: description
|
|
- volume_mount_prefix: volume_mount_prefix
|
|
- plugin_name: plugin_name
|
|
- floating_ip_pool: floating_ip_pool
|
|
- is_default: is_default
|
|
- image_id: image_id
|
|
- volumes_size: volumes_size
|
|
- is_proxy_gateway: is_proxy_gateway
|
|
- is_public: is_public
|
|
- hadoop_version: hadoop_version
|
|
- name: name
|
|
- tenant_id: tenant_id
|
|
- created_at: created_at
|
|
- volume_type: volume_type
|
|
- is_protected: is_protected
|
|
- node_processes: node_processes
|
|
- flavor_id: flavor_id
|
|
|
|
|
|
|
|
|
|
|
|
Show node group template details
|
|
================================
|
|
|
|
.. rest_method:: GET /v1.1/{tenant_id}/node-group-templates/{node_group_template_id}
|
|
|
|
Shows a node group template, by ID.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: url_tenant_id
|
|
- node_group_template_id: node_group_template_id
|
|
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- volume_local_to_instance: volume_local_to_instance
|
|
- availability_zone: availability_zone
|
|
- updated_at: updated_at
|
|
- use_autoconfig: use_autoconfig
|
|
- volumes_per_node: volumes_per_node
|
|
- id: id
|
|
- security_groups: security_groups
|
|
- shares: shares
|
|
- node_configs: node_configs
|
|
- auto_security_group: auto_security_group
|
|
- volumes_availability_zone: volumes_availability_zone
|
|
- description: description
|
|
- volume_mount_prefix: volume_mount_prefix
|
|
- plugin_name: plugin_name
|
|
- floating_ip_pool: floating_ip_pool
|
|
- is_default: is_default
|
|
- image_id: image_id
|
|
- volumes_size: volumes_size
|
|
- is_proxy_gateway: is_proxy_gateway
|
|
- is_public: is_public
|
|
- hadoop_version: hadoop_version
|
|
- name: name
|
|
- tenant_id: tenant_id
|
|
- created_at: created_at
|
|
- volume_type: volume_type
|
|
- is_protected: is_protected
|
|
- node_processes: node_processes
|
|
- flavor_id: flavor_id
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/node-group-templates/node-group-template-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Delete node group template
|
|
==========================
|
|
|
|
.. rest_method:: DELETE /v1.1/{tenant_id}/node-group-templates/{node_group_template_id}
|
|
|
|
Deletes a node group template.
|
|
|
|
Error response codes:204,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: url_tenant_id
|
|
- node_group_template_id: node_group_template_id
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Update node group template
|
|
==========================
|
|
|
|
.. rest_method:: PUT /v1.1/{tenant_id}/node-group-templates/{node_group_template_id}
|
|
|
|
Updates a node group template.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: url_tenant_id
|
|
- node_group_template_id: node_group_template_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/node-group-templates/node-group-template-update-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|