297 lines
9.8 KiB
Python
297 lines
9.8 KiB
Python
# Copyright 2017 INAP
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from datetime import datetime
|
|
|
|
from almanachclient.http_client import HttpClient
|
|
|
|
|
|
class Client(HttpClient):
|
|
DATE_FORMAT_QS = '%Y-%m-%d %H:%M:%S.%f'
|
|
DATE_FORMAT_BODY = '%Y-%m-%dT%H:%M:%S.%fZ'
|
|
|
|
api_version = 'v1'
|
|
|
|
def get_url(self):
|
|
return self.url
|
|
|
|
def get_info(self):
|
|
"""Display information about the current version and counts of entities in the database.
|
|
|
|
:rtype: dict
|
|
"""
|
|
return self._get('{}/{}/info'.format(self.url, self.api_version))
|
|
|
|
def get_volume_types(self):
|
|
"""List volume types.
|
|
|
|
:rtype: list
|
|
"""
|
|
return self._get('{}/{}/volume_types'.format(self.url, self.api_version))
|
|
|
|
def get_volume_type(self, volume_type_id):
|
|
"""Get a volume type.
|
|
|
|
:arg str volume_type_id: Volume Type UUID
|
|
:raises: ClientError
|
|
:rtype: dict
|
|
"""
|
|
return self._get('{}/{}/volume_type/{}'.format(self.url, self.api_version, volume_type_id))
|
|
|
|
def create_volume_type(self, volume_type_id, volume_type_name):
|
|
"""Create a volume type.
|
|
|
|
:arg str volume_type_id: The Volume Type ID
|
|
:arg str volume_type_name: The Volume Type name
|
|
:raises: ClientError
|
|
:rtype: bool
|
|
"""
|
|
url = '{}/{}/volume_type'.format(self.url, self.api_version)
|
|
data = {'type_id': volume_type_id, 'type_name': volume_type_name}
|
|
self._post(url, data)
|
|
return True
|
|
|
|
def delete_volume_type(self, volume_type_id):
|
|
"""Delete the volume type.
|
|
|
|
:arg str volume_type_id: Volume Type UUID
|
|
:raises: ClientError
|
|
:rtype: bool
|
|
"""
|
|
self._delete('{}/{}/volume_type/{}'.format(self.url, self.api_version, volume_type_id))
|
|
return True
|
|
|
|
def get_volumes(self, tenant_id, start, end):
|
|
"""List volumes for a tenant.
|
|
|
|
:arg str tenant_id: The Tenant UUID
|
|
:arg datetime start: Start date
|
|
:arg datetime end: End date
|
|
:raises: ClientError
|
|
:rtype: list
|
|
"""
|
|
url = '{}/{}/project/{}/volumes'.format(self.url, self.api_version, tenant_id)
|
|
params = {'start': self._format_qs_datetime(start), 'end': self._format_qs_datetime(end)}
|
|
return self._get(url, params)
|
|
|
|
def create_volume(self, tenant_id, volume_id, volume_type_id, name, size, attachments=None, start=None):
|
|
"""Create a volume.
|
|
|
|
:arg str tenant_id: Tenant UUID
|
|
:arg str volume_id: Volume UUID
|
|
:arg str volume_type_id: Volume type
|
|
:arg str name: Volume name
|
|
:arg int size: Volume size
|
|
:arg list attachments: List of instance attached to the volume
|
|
:arg datetime start: Creation date or now if None
|
|
:raises: ClientError
|
|
:rtype: bool
|
|
"""
|
|
data = {
|
|
'volume_id': volume_id,
|
|
'volume_type': volume_type_id,
|
|
'volume_name': name,
|
|
'size': size,
|
|
'attached_to': attachments or [],
|
|
'start': self._format_body_datetime(start or datetime.now()),
|
|
}
|
|
|
|
self._post('{}/{}/project/{}/volume'.format(self.url, self.api_version, tenant_id), data=data)
|
|
return True
|
|
|
|
def delete_volume(self, volume_id, end=None):
|
|
"""Remove a volume.
|
|
|
|
:arg str volume_id: Volume UUID
|
|
:arg datetime end: Suppression date
|
|
:raises: ClientError
|
|
:rtype: bool
|
|
"""
|
|
data = {
|
|
'date': self._format_body_datetime(end or datetime.now()),
|
|
}
|
|
|
|
self._delete('{}/{}/volume/{}'.format(self.url, self.api_version, volume_id), data=data)
|
|
return True
|
|
|
|
def resize_volume(self, volume_id, size, resize_date=None):
|
|
"""Resize a volume.
|
|
|
|
:arg str volume_id: Volume UUID
|
|
:arg int size: Volume size
|
|
:arg datetime resize_date: Resize date
|
|
:raises: ClientError
|
|
:rtype: bool
|
|
"""
|
|
data = {
|
|
'size': size,
|
|
'date': self._format_body_datetime(resize_date or datetime.now()),
|
|
}
|
|
|
|
self._put('{}/{}/volume/{}/resize'.format(self.url, self.api_version, volume_id), data=data)
|
|
return True
|
|
|
|
def attach_volume(self, volume_id, attachments, attachment_date=None):
|
|
"""Attach instances to a volume.
|
|
|
|
:arg str volume_id: Volume UUID
|
|
:arg list attachments: List of instance ID
|
|
:arg datetime attachment_date: Attachment date
|
|
:raises: ClientError
|
|
:rtype: bool
|
|
"""
|
|
data = {
|
|
'attachments': attachments,
|
|
'date': self._format_body_datetime(attachment_date or datetime.now()),
|
|
}
|
|
|
|
self._put('{}/{}/volume/{}/attach'.format(self.url, self.api_version, volume_id), data=data)
|
|
return True
|
|
|
|
def detach_volume(self, volume_id, attachments, attachment_date=None):
|
|
"""Detach instances from a volume.
|
|
|
|
:arg str volume_id: Volume UUID
|
|
:arg list attachments: List of instance ID
|
|
:arg datetime attachment_date: Attachment date
|
|
:raises: ClientError
|
|
:rtype: bool
|
|
"""
|
|
data = {
|
|
'attachments': attachments,
|
|
'date': self._format_body_datetime(attachment_date or datetime.now()),
|
|
}
|
|
|
|
self._put('{}/{}/volume/{}/detach'.format(self.url, self.api_version, volume_id), data=data)
|
|
return True
|
|
|
|
def get_instances(self, tenant_id, start, end):
|
|
"""List instances for a tenant.
|
|
|
|
:arg str tenant_id: The Tenant UUID
|
|
:arg datetime start: Start date
|
|
:arg datetime end: End date
|
|
:raises: ClientError
|
|
:rtype: list
|
|
"""
|
|
url = '{}/{}/project/{}/instances'.format(self.url, self.api_version, tenant_id)
|
|
params = {'start': self._format_qs_datetime(start), 'end': self._format_qs_datetime(end)}
|
|
return self._get(url, params)
|
|
|
|
def create_instance(self, tenant_id, instance_id, name, flavor, start, image_meta=None):
|
|
"""Create an instance for a tenant.
|
|
|
|
:arg str tenant_id: The Tenant UUID
|
|
:arg str instance_id: The instance UUID
|
|
:arg str name: The instance name
|
|
:arg str flavor: The flavor
|
|
:arg datetime start: Start date
|
|
:arg dict image_meta: The OS type, distro and version of the image
|
|
:raises: ClientError
|
|
:rtype: bool
|
|
"""
|
|
url = '{}/{}/project/{}/instance'.format(self.url, self.api_version, tenant_id)
|
|
image_meta = image_meta or {}
|
|
self._post(url, data={
|
|
'id': instance_id,
|
|
'created_at': self._format_body_datetime(start),
|
|
'name': name,
|
|
'flavor': flavor,
|
|
'os_distro': image_meta.get('distro'),
|
|
'os_version': image_meta.get('version'),
|
|
'os_type': image_meta.get('type'),
|
|
})
|
|
return True
|
|
|
|
def delete_instance(self, instance_id, end=None):
|
|
"""Delete an instance.
|
|
|
|
:arg str instance_id: Instance UUID
|
|
:arg datetime end: End date
|
|
:raises: ClientError
|
|
:rtype: bool
|
|
"""
|
|
data = {'date': self._format_body_datetime(end or datetime.now())}
|
|
self._delete('{}/{}/instance/{}'.format(self.url, self.api_version, instance_id), data=data)
|
|
return True
|
|
|
|
def resize_instance(self, instance_id, flavor, resize_date=None):
|
|
"""Resize an instance.
|
|
|
|
:arg str instance_id: Instance UUID
|
|
:arg str flavor: Flavor
|
|
:arg datetime resize_date: Resize date
|
|
:raises: ClientError
|
|
:rtype: bool
|
|
"""
|
|
data = {
|
|
'flavor': flavor,
|
|
'date': self._format_body_datetime(resize_date or datetime.now()),
|
|
}
|
|
|
|
self._put('{}/{}/instance/{}/resize'.format(self.url, self.api_version, instance_id), data=data)
|
|
return True
|
|
|
|
def get_entity(self, entity_id):
|
|
"""Get single entity.
|
|
|
|
:arg str entity_id: Entity UUID
|
|
:raises: ClientError
|
|
:rtype: list
|
|
"""
|
|
url = '{}/{}/entity/{}'.format(self.url, self.api_version, entity_id)
|
|
return self._get(url)
|
|
|
|
def get_tenant_entities(self, tenant_id, start, end=None):
|
|
"""List instances and volumes for a tenant.
|
|
|
|
:arg str tenant_id: Tenant UUID
|
|
:arg datetime start: Start date
|
|
:arg datetime end: End date
|
|
:raises: ClientError
|
|
:rtype: list
|
|
"""
|
|
url = '{}/{}/project/{}/entities'.format(self.url, self.api_version, tenant_id)
|
|
params = {'start': self._format_qs_datetime(start)}
|
|
|
|
if end:
|
|
params['end'] = self._format_qs_datetime(end)
|
|
|
|
return self._get(url, params)
|
|
|
|
def update_instance_entity(self, instance_id, **kwargs):
|
|
"""Update an instance entity.
|
|
|
|
:arg str instance_id: Instance UUID
|
|
:arg datetime start_date: Start date
|
|
:arg datetime end_date: End date
|
|
:arg str flavor: The flavor
|
|
:arg str name: The instance name
|
|
:raises: ClientError
|
|
:rtype: dict
|
|
"""
|
|
url = '{}/{}/entity/instance/{}'.format(self.url, self.api_version, instance_id)
|
|
|
|
for param in ['start_date', 'end_date']:
|
|
if param in kwargs:
|
|
kwargs[param] = self._format_body_datetime(kwargs[param])
|
|
|
|
return self._put(url, kwargs)
|
|
|
|
def _format_body_datetime(self, dt):
|
|
return dt.strftime(self.DATE_FORMAT_BODY)
|
|
|
|
def _format_qs_datetime(self, dt):
|
|
return dt.strftime(self.DATE_FORMAT_QS)
|