diff options
Diffstat (limited to 'saharaclient/api')
| -rw-r--r-- | saharaclient/api/client.py | 20 | ||||
| -rw-r--r-- | saharaclient/api/cluster_templates.py | 5 | ||||
| -rw-r--r-- | saharaclient/api/clusters.py | 34 | ||||
| -rw-r--r-- | saharaclient/api/data_sources.py | 20 | ||||
| -rw-r--r-- | saharaclient/api/images.py | 9 | ||||
| -rw-r--r-- | saharaclient/api/job_binaries.py | 19 | ||||
| -rw-r--r-- | saharaclient/api/job_binary_internals.py | 8 | ||||
| -rw-r--r-- | saharaclient/api/job_executions.py | 5 | ||||
| -rw-r--r-- | saharaclient/api/job_types.py | 1 | ||||
| -rw-r--r-- | saharaclient/api/jobs.py | 6 | ||||
| -rw-r--r-- | saharaclient/api/node_group_templates.py | 5 | ||||
| -rw-r--r-- | saharaclient/api/plugins.py | 12 |
12 files changed, 144 insertions, 0 deletions
diff --git a/saharaclient/api/client.py b/saharaclient/api/client.py index ba5230a..0343a7c 100644 --- a/saharaclient/api/client.py +++ b/saharaclient/api/client.py @@ -47,6 +47,26 @@ class HTTPClient(adapter.Adapter): class Client(object): + """Client for the OpenStack Data Processing v1 API. + + :param str username: Username for Keystone authentication. + :param str api_key: Password for Keystone authentication. + :param str project_id: Keystone Tenant id. + :param str project_name: Keystone Tenant name. + :param str auth_url: Keystone URL that will be used for authentication. + :param str sahara_url: Sahara REST API URL to communicate with. + :param str endpoint_type: Desired Sahara endpoint type. + :param str service_type: Sahara service name in Keystone catalog. + :param str input_auth_token: Keystone authorization token. + :param session: Keystone Session object. + :param auth: Keystone Authentication Plugin object. + :param boolean insecure: Allow insecure. + :param string cacert: Path to the Privacy Enhanced Mail (PEM) file + which contains certificates needed to establish + SSL connection with the identity service. + :param string region_name: Name of a region to select when choosing an + endpoint from the service catalog. + """ def __init__(self, username=None, api_key=None, project_id=None, project_name=None, auth_url=None, sahara_url=None, endpoint_type='publicURL', service_type='data-processing', diff --git a/saharaclient/api/cluster_templates.py b/saharaclient/api/cluster_templates.py index 2cea233..f8f516a 100644 --- a/saharaclient/api/cluster_templates.py +++ b/saharaclient/api/cluster_templates.py @@ -27,6 +27,7 @@ class ClusterTemplateManager(base.ResourceManager): cluster_configs=None, node_groups=None, anti_affinity=None, net_id=None, default_image_id=None, use_autoconfig=None, shares=None, is_public=None, is_protected=None): + """Create a Cluster Template.""" data = { 'name': name, @@ -53,6 +54,7 @@ class ClusterTemplateManager(base.ResourceManager): node_groups=None, anti_affinity=None, net_id=None, default_image_id=None, use_autoconfig=None, shares=None, is_public=None, is_protected=None): + """Update a Cluster Template.""" data = {} self._copy_if_defined(data, name=name, @@ -73,12 +75,15 @@ class ClusterTemplateManager(base.ResourceManager): data, 'cluster_template') def list(self, search_opts=None): + """Get list of Cluster Templates.""" query = base.get_query_string(search_opts) return self._list('/cluster-templates%s' % query, 'cluster_templates') def get(self, cluster_template_id): + """Get information about a Cluster Template.""" return self._get('/cluster-templates/%s' % cluster_template_id, 'cluster_template') def delete(self, cluster_template_id): + """Delete a Cluster Template.""" self._delete('/cluster-templates/%s' % cluster_template_id) diff --git a/saharaclient/api/clusters.py b/saharaclient/api/clusters.py index ba9130f..049d8f4 100644 --- a/saharaclient/api/clusters.py +++ b/saharaclient/api/clusters.py @@ -32,6 +32,7 @@ class ClusterManager(base.ResourceManager): anti_affinity=None, net_id=None, count=None, use_autoconfig=None, shares=None, is_public=None, is_protected=None): + """Launch a Cluster.""" data = { 'name': name, @@ -67,13 +68,44 @@ class ClusterManager(base.ResourceManager): return self._create('/clusters', data, 'cluster') def scale(self, cluster_id, scale_object): + """Scale an existing Cluster. + + :param scale_object: dict that describes scaling operation + + :Example: + + The following `scale_object` can be used to change the number of + instances in the node group and add instances of new node group to + existing cluster: + + .. sourcecode:: json + + { + "add_node_groups": [ + { + "count": 3, + "name": "new_ng", + "node_group_template_id": "ngt_id" + } + ], + "resize_node_groups": [ + { + "count": 2, + "name": "old_ng" + } + ] + } + + """ return self._update('/clusters/%s' % cluster_id, scale_object) def list(self, search_opts=None): + """Get a list of Clusters.""" query = base.get_query_string(search_opts) return self._list('/clusters%s' % query, 'clusters') def get(self, cluster_id, show_progress=False): + """Get information about a Cluster.""" url = ('/clusters/%(cluster_id)s?%(params)s' % {"cluster_id": cluster_id, "params": parse.urlencode({"show_progress": show_progress})}) @@ -81,10 +113,12 @@ class ClusterManager(base.ResourceManager): return self._get(url, 'cluster') def delete(self, cluster_id): + """Delete a Cluster.""" self._delete('/clusters/%s' % cluster_id) def update(self, cluster_id, name=None, description=None, is_public=None, is_protected=None, shares=None): + """Update a Cluster.""" data = {} self._copy_if_defined(data, name=name, description=description, diff --git a/saharaclient/api/data_sources.py b/saharaclient/api/data_sources.py index 20d9d89..4f2af19 100644 --- a/saharaclient/api/data_sources.py +++ b/saharaclient/api/data_sources.py @@ -26,6 +26,8 @@ class DataSourceManager(base.ResourceManager): def create(self, name, description, data_source_type, url, credential_user=None, credential_pass=None, is_public=None, is_protected=None): + """Create a Data Source.""" + data = { 'name': name, 'description': description, @@ -43,15 +45,33 @@ class DataSourceManager(base.ResourceManager): return self._create('/data-sources', data, 'data_source') def list(self, search_opts=None): + """Get a list of Data Sources.""" query = base.get_query_string(search_opts) return self._list('/data-sources%s' % query, 'data_sources') def get(self, data_source_id): + """Get information about a Data Source.""" return self._get('/data-sources/%s' % data_source_id, 'data_source') def delete(self, data_source_id): + """Delete a Data Source.""" self._delete('/data-sources/%s' % data_source_id) def update(self, data_source_id, update_data): + """Update a Data Source. + + :param dict update_data: dict that contains fields that should be + updated with new values. + + Fields that can be updated: + + * name + * description + * type + * url + * is_public + * is_protected + * credentials - dict with `user` and `password` keyword arguments + """ return self._update('/data-sources/%s' % data_source_id, update_data) diff --git a/saharaclient/api/images.py b/saharaclient/api/images.py index 7cb5c55..c10033b 100644 --- a/saharaclient/api/images.py +++ b/saharaclient/api/images.py @@ -25,16 +25,20 @@ class ImageManager(base.ResourceManager): resource_class = Image def list(self, search_opts=None): + """Get a list of registered images.""" query = base.get_query_string(search_opts) return self._list('/images%s' % query, 'images') def get(self, id): + """Get information about an image""" return self._get('/images/%s' % id, 'image') def unregister_image(self, image_id): + """Remove an Image from Sahara Image Registry.""" self._delete('/images/%s' % image_id) def update_image(self, image_id, user_name, desc=None): + """Create or update an Image in Image Registry.""" desc = desc if desc else '' data = {"username": user_name, "description": desc} @@ -42,6 +46,11 @@ class ImageManager(base.ResourceManager): return self._post('/images/%s' % image_id, data) def update_tags(self, image_id, new_tags): + """Update an Image tags. + + :param list new_tags: list of tags that will replace currently + assigned tags + """ old_image = self.get(image_id) old_tags = frozenset(old_image.tags) diff --git a/saharaclient/api/job_binaries.py b/saharaclient/api/job_binaries.py index 5a54534..b5ae3ef 100644 --- a/saharaclient/api/job_binaries.py +++ b/saharaclient/api/job_binaries.py @@ -25,6 +25,7 @@ class JobBinariesManager(base.ResourceManager): def create(self, name, url, description=None, extra=None, is_public=None, is_protected=None): + """Create a Job Binary.""" data = { "name": name, "url": url @@ -36,16 +37,20 @@ class JobBinariesManager(base.ResourceManager): return self._create('/job-binaries', data, 'job_binary') def list(self, search_opts=None): + """Get a list of Job Binaries.""" query = base.get_query_string(search_opts) return self._list('/job-binaries%s' % query, 'binaries') def get(self, job_binary_id): + """Get information about a Job Binary.""" return self._get('/job-binaries/%s' % job_binary_id, 'job_binary') def delete(self, job_binary_id): + """Delete a Job Binary.""" self._delete('/job-binaries/%s' % job_binary_id) def get_file(self, job_binary_id): + """Download a Job Binary.""" resp = self.api.get('/job-binaries/%s/data' % job_binary_id) if resp.status_code != 200: @@ -53,5 +58,19 @@ class JobBinariesManager(base.ResourceManager): return resp.content def update(self, job_binary_id, data): + """Update Job Binary. + + :param dict data: dict that contains fields that should be updated + with new values. + + Fields that can be updated: + + * name + * description + * url + * is_public + * is_protected + * extra - dict with `user` and `password` keyword arguments + """ return self._update( '/job-binaries/%s' % job_binary_id, data, 'job_binary') diff --git a/saharaclient/api/job_binary_internals.py b/saharaclient/api/job_binary_internals.py index 7f60ba8..f36b0a6 100644 --- a/saharaclient/api/job_binary_internals.py +++ b/saharaclient/api/job_binary_internals.py @@ -26,23 +26,31 @@ class JobBinaryInternalsManager(base.ResourceManager): resource_class = JobBinaryInternal def create(self, name, data): + """Create a Job Binary Internal. + + :param str data: raw data ot script text + """ return self._update('/job-binary-internals/%s' % urlparse.quote(name.encode('utf-8')), data, 'job_binary_internal', dump_json=False) def list(self, search_opts=None): + """Get a list of Job Binary Internals.""" query = base.get_query_string(search_opts) return self._list('/job-binary-internals%s' % query, 'binaries') def get(self, job_binary_id): + """Get information about a Job Binary Internal.""" return self._get('/job-binary-internals/%s' % job_binary_id, 'job_binary_internal') def delete(self, job_binary_id): + """Delete a Job Binary Internal.""" self._delete('/job-binary-internals/%s' % job_binary_id) def update(self, job_binary_id, name=None, is_public=None, is_protected=None): + """Update a Job Binary Internal.""" data = {} self._copy_if_defined(data, name=name, is_public=is_public, diff --git a/saharaclient/api/job_executions.py b/saharaclient/api/job_executions.py index 4d76b24..078cd84 100644 --- a/saharaclient/api/job_executions.py +++ b/saharaclient/api/job_executions.py @@ -24,18 +24,22 @@ class JobExecutionsManager(base.ResourceManager): resource_class = JobExecution def list(self, search_opts=None): + """Get a list of Job Executions.""" query = base.get_query_string(search_opts) return self._list('/job-executions%s' % query, 'job_executions') def get(self, obj_id): + """Get information about a Job Execution.""" return self._get('/job-executions/%s' % obj_id, 'job_execution') def delete(self, obj_id): + """Delete a Job Execution.""" self._delete('/job-executions/%s' % obj_id) def create(self, job_id, cluster_id, input_id=None, output_id=None, configs=None, interface=None, is_public=None, is_protected=None): + """Launch a Job.""" url = "/jobs/%s/execute" % job_id data = { @@ -49,6 +53,7 @@ class JobExecutionsManager(base.ResourceManager): return self._create(url, data, 'job_execution') def update(self, obj_id, is_public=None, is_protected=None): + """Update a Job Execution.""" data = {} self._copy_if_defined(data, is_public=is_public, diff --git a/saharaclient/api/job_types.py b/saharaclient/api/job_types.py index 1ebc378..25eed81 100644 --- a/saharaclient/api/job_types.py +++ b/saharaclient/api/job_types.py @@ -24,5 +24,6 @@ class JobTypesManager(base.ResourceManager): resource_class = JobType def list(self, search_opts=None): + """Get a list of job types supported by plugins.""" query = base.get_query_string(search_opts) return self._list('/job-types%s' % query, 'job_types') diff --git a/saharaclient/api/jobs.py b/saharaclient/api/jobs.py index b352772..0638304 100644 --- a/saharaclient/api/jobs.py +++ b/saharaclient/api/jobs.py @@ -25,6 +25,7 @@ class JobsManager(base.ResourceManager): def create(self, name, type, mains=None, libs=None, description=None, interface=None, is_public=None, is_protected=None): + """Create a Job.""" data = { 'name': name, 'type': type @@ -37,20 +38,25 @@ class JobsManager(base.ResourceManager): return self._create('/jobs', data, 'job') def list(self, search_opts=None): + """Get a list of Jobs.""" query = base.get_query_string(search_opts) return self._list('/jobs%s' % query, 'jobs') def get(self, job_id): + """Get information about a Job""" return self._get('/jobs/%s' % job_id, 'job') def get_configs(self, job_type): + """Get config hints for a specified Job type.""" return self._get('/jobs/config-hints/%s' % job_type) def delete(self, job_id): + """Delete a Job""" self._delete('/jobs/%s' % job_id) def update(self, job_id, name=None, description=None, is_public=None, is_protected=None): + """Update a Job.""" data = {} self._copy_if_defined(data, name=name, description=description, diff --git a/saharaclient/api/node_group_templates.py b/saharaclient/api/node_group_templates.py index 84d278c..f4afeb5 100644 --- a/saharaclient/api/node_group_templates.py +++ b/saharaclient/api/node_group_templates.py @@ -32,6 +32,7 @@ class NodeGroupTemplateManager(base.ResourceManager): volume_local_to_instance=None, use_autoconfig=None, shares=None, is_public=None, is_protected=None, volume_mount_prefix=None): + """Create a Node Group Template.""" data = { 'name': name, @@ -83,6 +84,7 @@ class NodeGroupTemplateManager(base.ResourceManager): volume_local_to_instance=None, use_autoconfig=None, shares=None, is_public=None, is_protected=None, volume_mount_prefix=None): + """Update a Node Group Template.""" data = {} self._copy_if_defined( @@ -107,13 +109,16 @@ class NodeGroupTemplateManager(base.ResourceManager): 'node_group_template') def list(self, search_opts=None): + """Get a list of Node Group Templates.""" query = base.get_query_string(search_opts) return self._list('/node-group-templates%s' % query, 'node_group_templates') def get(self, ng_template_id): + """Get information about a Node Group Template.""" return self._get('/node-group-templates/%s' % ng_template_id, 'node_group_template') def delete(self, ng_template_id): + """Delete a Node Group Template.""" self._delete('/node-group-templates/%s' % ng_template_id) diff --git a/saharaclient/api/plugins.py b/saharaclient/api/plugins.py index 6a92182..fd26b54 100644 --- a/saharaclient/api/plugins.py +++ b/saharaclient/api/plugins.py @@ -32,18 +32,30 @@ class PluginManager(base.ResourceManager): resource_class = Plugin def list(self, search_opts=None): + """Get a list of Plugins.""" query = base.get_query_string(search_opts) return self._list('/plugins%s' % query, 'plugins') def get(self, plugin_name): + """Get information about a Plugin.""" return self._get('/plugins/%s' % plugin_name, 'plugin') def get_version_details(self, plugin_name, hadoop_version): + """Get version details + + Get the list of Services and Service Parameters for a specified + Plugin and Plugin Version. + """ return self._get('/plugins/%s/%s' % (plugin_name, hadoop_version), 'plugin') def convert_to_cluster_template(self, plugin_name, hadoop_version, template_name, filecontent): + """Convert to cluster template + + Create Cluster Template directly, avoiding Cluster Template + mechanism. + """ resp = self.api.post('/plugins/%s/%s/convert-config/%s' % (plugin_name, hadoop_version, |