openstack/deb-sahara
Code Issues Proposed changes

Update plugin spi docs with new method

Browse Source 
Change-Id: I3090966b5fe1f20e9255b4ddcbd9d3cab24d09ca
Partial-Bug: 1490687
This commit is contained in:
Vitaly Gridnev 2015-09-07 12:52:25 +03:00
parent 19eb3f0071
commit c1547e81eb
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/source/devref/plugin.spi.rst
View File

@ -75,7 +75,7 @@ For instance, plugin can ask for additional VMs for the management tool.
configure_cluster(cluster) configure_cluster(cluster)
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
Configures cluster on provisioned by Sahara VMs. Configures cluster on provisioned by sahara VMs.
In this function plugin should perform all actions like adjusting OS, installing required packages (including Hadoop, if needed), configuring Hadoop, etc. In this function plugin should perform all actions like adjusting OS, installing required packages (including Hadoop, if needed), configuring Hadoop, etc.
*Returns*: None *Returns*: None
@ -90,7 +90,7 @@ Start already configured cluster. This method is guaranteed to be called only on
scale_cluster(cluster, instances) scale_cluster(cluster, instances)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Scale an existing Cluster with additional instances. Instances argument is a list Scale an existing cluster with additional instances. Instances argument is a list
of ready-to-configure instances. Plugin should do all configuration operations in this of ready-to-configure instances. Plugin should do all configuration operations in this
method and start all services on those instances. method and start all services on those instances.
@ -129,26 +129,33 @@ See “Cluster Lifecycle for Config File Mode” section below for clarification
on_terminate_cluster(cluster) on_terminate_cluster(cluster)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When user terminates cluster, Sahara simply shuts down all the cluster VMs. This method is guaranteed to be invoked before that, allowing plugin to do some clean-up. When user terminates cluster, sahara simply shuts down all the cluster VMs. This method is guaranteed to be invoked before that, allowing plugin to do some clean-up.
*Returns*: None *Returns*: None
get_open_ports(node_group) get_open_ports(node_group)
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
When user requests Sahara to automatically create security group for the node When user requests sahara to automatically create security group for the node
group (``auto_security_group`` property set to True), Sahara will call this group (``auto_security_group`` property set to True), sahara will call this
plugin method to get list of ports that need to be opened. plugin method to get list of ports that need to be opened.
*Returns*: list of ports to be open in auto security group for the given node group *Returns*: list of ports to be open in auto security group for the given node group
def get_edp_job_types(versions) def get_edp_job_types(versions)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Optional method, which provides ability to see all supported job types for specified plugin versions Optional method, which provides ability to see all supported job types for specified plugin versions
*Returns*: dict with supported job types for specified versions of plugin *Returns*: dict with supported job types for specified versions of plugin
def recommend_configs(self, cluster, scaling=False)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Optional method, which provides recommendations for cluster configuration before creating/scaling operation.
*Returns*: None
Object Model Object Model
============ ============
@ -234,7 +241,7 @@ An instance created for cluster.
+---------------+---------+---------------------------------------------------------+ +---------------+---------+---------------------------------------------------------+
| nova_info | object | Nova Instance object. | | nova_info | object | Nova Instance object. |
+---------------+---------+---------------------------------------------------------+ +---------------+---------+---------------------------------------------------------+
| username | string | Username, that Sahara uses for establishing remote | | username | string | Username, that sahara uses for establishing remote |
| | | connections to instance. | | | | connections to instance. |
+---------------+---------+---------------------------------------------------------+ +---------------+---------+---------------------------------------------------------+
| hostname | string | Same as instance_name. | | hostname | string | Same as instance_name. |
@ -275,7 +282,7 @@ Group of instances.
+----------------------+--------+--------------------------------------------------------+ +----------------------+--------+--------------------------------------------------------+
| count | int | Number of instances in this Node Group. | | count | int | Number of instances in this Node Group. |
+----------------------+--------+--------------------------------------------------------+ +----------------------+--------+--------------------------------------------------------+
| username | string | Username used by Sahara to establish remote | | username | string | Username used by sahara to establish remote |
| | | connections to instances. | | | | connections to instances. |
+----------------------+--------+--------------------------------------------------------+ +----------------------+--------+--------------------------------------------------------+
| configuration | dict | Merged dictionary of node configurations and cluster | | configuration | dict | Merged dictionary of node configurations and cluster |