def __init__(self, plugins=None):
"""User preference for each service.
:param plugins: List of entry point namespaces to load.
Create a new :class:`~openstack.profile.Profile`
object with no preferences defined, but knowledge of the services.
Services are identified by their service type, e.g.: 'identity',
'compute', etc.
"""
self._services = {}
self._add_service(baremetal_service.BaremetalService(version="v1"))
self._add_service(
block_storage_service.BlockStorageService(version="v2"))
self._add_service(clustering_service.ClusteringService(version="v1"))
self._add_service(compute_service.ComputeService(version="v2"))
self._add_service(database_service.DatabaseService(version="v1"))
self._add_service(identity_service.IdentityService(version="v3"))
self._add_service(image_service.ImageService(version="v2"))
self._add_service(key_manager_service.KeyManagerService(version="v1"))
self._add_service(lb_service.LoadBalancerService(version="v2"))
self._add_service(message_service.MessageService(version="v1"))
self._add_service(network_service.NetworkService(version="v2"))
self._add_service(
object_store_service.ObjectStoreService(version="v1"))
self._add_service(
orchestration_service.OrchestrationService(version="v1"))
self._add_service(workflow_service.WorkflowService(version="v2"))
self.service_keys = sorted(self._services.keys())
def __init__(self, plugins=None):
"""User preference for each service.
:param list plugins: List of entry point namespaces to load.
Create a new :class:`~openstack.profile.Profile`
object with no preferences defined, but knowledge of the services.
Services are identified by their service type, e.g.: 'identity',
'compute', etc.
"""
self._preferences = {}
self._services = {}
self._add_service(cluster_service.ClusterService())
self._add_service(compute_service.ComputeService())
self._add_service(database_service.DatabaseService())
self._add_service(identity_service.IdentityService())
self._add_service(image_service.ImageService())
self._add_service(metric_service.MetricService())
self._add_service(network_service.NetworkService())
self._add_service(object_store_service.ObjectStoreService())
self._add_service(orchestration_service.OrchestrationService())
self._add_service(key_management_service.KeyManagementService())
self._add_service(telemetry_service.TelemetryService())
self._add_service(block_store_service.BlockStoreService())
self._add_service(message_service.MessageService())
if plugins:
for plugin in plugins:
self._load_plugin(plugin)
self.service_names = sorted(self._services.keys())
class Member(resource.Resource):
resources_key = 'members'
base_path = '/images/%(image_id)s/members'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_fetch = True
allow_commit = True
allow_delete = True
allow_list = True
# See https://bugs.launchpad.net/glance/+bug/1526991 for member/member_id
# 'member' is documented incorrectly as being deprecated but it's the
# only thing that works. 'member_id' is not accepted.
#: The ID of the image member. An image member is a tenant
#: with whom the image is shared.
member_id = resource.Body('member', alternate_id=True)
#: The date and time when the member was created.
created_at = resource.Body('created_at')
#: Image ID stored through the image API. Typically a UUID.
image_id = resource.URI('image_id')
#: The status of the image.
status = resource.Body('status')
#: The URL for schema of the member.
schema = resource.Body('schema')
#: The date and time when the member was updated.
updated_at = resource.Body('updated_at')
class Image(resource.Resource):
resource_key = 'image'
resources_key = 'images'
base_path = '/images'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_retrieve = True
allow_update = True
allow_delete = True
allow_list = True
# Properties
checksum = resource.prop('checksum')
container_format = resource.prop('container_format')
copy_from = resource.prop('copy_from')
disk_format = resource.prop('disk_format')
is_public = resource.prop('is_public')
location = resource.prop('location')
min_disk = resource.prop('min_disk')
min_ram = resource.prop('min_ram')
name = resource.prop('name')
owner = resource.prop('owner')
properties = resource.prop('properties')
protected = resource.prop('protected')
size = resource.prop('size')
status = resource.prop('status')
created_at = resource.prop('created_at')
updated_at = resource.prop('updated_at')
def __init__(self, plugins=None):
"""User preference for each service.
:param plugins: List of entry point namespaces to load.
Create a new :class:`~openstack.profile.Profile`
object with no preferences defined, but knowledge of the services.
Services are identified by their service type, e.g.: 'identity',
'compute', etc.
"""
self._services = {}
self._add_service(anti_ddos_service.AntiDDosService(version="v1"))
self._add_service(block_store_service.BlockStoreService(version="v2"))
self._add_service(compute_service.ComputeService(version="v2"))
self._add_service(cts_service.CTSService(version="v1"))
self._add_service(dms_service.DMSService(version="v1"))
self._add_service(identity_service.IdentityService(version="v3"))
self._add_service(image_service.ImageService(version="v2"))
self._add_service(kms_service.KMSService(version="v1"))
self._add_service(maas_service.MaaSService(version="v1"))
self._add_service(network_service.NetworkService(version="v2.0"))
self._add_service(
orchestration_service.OrchestrationService(version="v1"))
self._add_service(smn_service.SMNService(version="v2"))
# QianBiao.NG HuaWei Services
self._add_service(dns_service.DNSService(version="v2"))
self._add_service(cloud_eye_service.CloudEyeService(version="v1"))
ass = auto_scaling_service.AutoScalingService(version="v1")
self._add_service(ass)
vbs_v2 = volume_backup_service.VolumeBackupService(version="v2")
self._add_service(vbs_v2)
self._add_service(map_reduce_service.MapReduceService(version="v1"))
self._add_service(evs_service.EvsServiceV2_1(version='v2.1'))
self._add_service(evs_service.EvsService(version='v2'))
self._add_service(ecs_service.EcsService(version='v1'))
self._add_service(ecs_service.EcsServiceV1_1(version='v1.1'))
self._add_service(vpc_service.VpcService(version='v2.0'))
self._add_service(bms_service.BmsService(version='v1'))
self._add_service(lb_service.LoadBalancerService(version='v1'))
# not support below service
# self._add_service(message_service.MessageService(version="v1"))
# self._add_service(cluster_service.ClusterService(version="v1"))
# self._add_service(database_service.DatabaseService(version="v1"))
# self._add_service(alarm_service.AlarmService(version="v2"))
# self._add_service(bare_metal_service.BareMetalService(version="v1"))
# self._add_service(key_manager_service.KeyManagerService(version="v1"))
# self._add_service(
# object_store_service.ObjectStoreService(version="v1"))
self._add_service(rds_service.RDSService(version="v1"))
self._add_service(cdn_service.CDNService(version='v1'))
# self._add_service(rds_os_service.RDSService(version="v1"))
# self._add_service(telemetry_service.TelemetryService(version="v2"))
# self._add_service(workflow_service.WorkflowService(version="v2"))
if plugins:
for plugin in plugins:
self._load_plugin(plugin)
self.service_keys = sorted(self._services.keys())
class Tag(resource.Resource):
id_attribute = "image"
base_path = "/images/%(image)s/tags"
service = image_service.ImageService()
# capabilities
allow_create = True
allow_delete = True
#: The image to manipulate
image = resource.prop("image", type=image.Image)
def create(self, session, tag):
"""Set a tag on the image
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:param string tag: A tag to set on the image
:return: ``None``
"""
url = self._get_url({"image": self.image.id}, tag)
session.put(url, service=self.service, accept=None)
def delete(self, session, tag):
"""Delete a tag on the image
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:param string tag: The tag to delete on the image
:return: ``None``
"""
url = self._get_url({"image": self.image.id}, tag)
session.delete(url, service=self.service, accept=None)
class Image(resource.Resource):
resources_key = 'images'
base_path = '/images'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_retrieve = True
allow_update = True
allow_delete = True
allow_list = True
# Properties
checksum = resource.prop('checksum')
container_format = resource.prop('container_format')
created_at = resource.prop('created_at')
disk_format = resource.prop('disk_format')
min_disk = resource.prop('min_disk')
name = resource.prop('name')
owner = resource.prop('owner')
properties = resource.prop('properties')
protected = resource.prop('protected', type=bool)
status = resource.prop('status')
tags = resource.prop('tags')
updated_at = resource.prop('updated_at')
virtual_size = resource.prop('virtual_size')
visibility = resource.prop('visibility')
class Image(resource.Resource):
resource_key = 'image'
resources_key = 'images'
base_path = '/images'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_retrieve = True
allow_update = True
allow_delete = True
allow_list = True
#: Hash of the image data used. The Image service uses this value
#: for verification.
checksum = resource.prop('checksum')
#: The container format refers to whether the VM image is in a file
#: format that also contains metadata about the actual VM.
#: Container formats include OVF and Amazon AMI. In addition,
#: a VM image might not have a container format - instead,
#: the image is just a blob of unstructured data.
container_format = resource.prop('container_format')
#: A URL to copy an image from
copy_from = resource.prop('copy_from')
#: The timestamp when this image was created.
#: *Type: datetime object parsed from ISO 8601 formatted string*
created_at = resource.prop('created_at', type=format.ISO8601)
#: Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk.
#: The disk format of a VM image is the format of the underlying
#: disk image. Virtual appliance vendors have different formats for
#: laying out the information contained in a VM disk image.
disk_format = resource.prop('disk_format')
#: Defines whether the image can be deleted.
#: *Type: bool*
is_protected = resource.prop('protected', type=bool)
#: ``True`` if this is a public image.
#: *Type: bool*
is_public = resource.prop('is_public', type=bool)
#: A location for the image identified by a URI
location = resource.prop('location')
#: The minimum disk size in GB that is required to boot the image.
min_disk = resource.prop('min_disk')
#: The minimum amount of RAM in MB that is required to boot the image.
min_ram = resource.prop('min_ram')
#: Name for the image. Note that the name of an image is not unique
#: to a Glance node. The API cannot expect users to know the names
#: of images owned by others.
name = resource.prop('name')
#: The ID of the owner, or project, of the image.
owner_id = resource.prop('owner')
#: Properties, if any, that are associated with the image.
properties = resource.prop('properties')
#: The size of the image data, in bytes.
size = resource.prop('size')
#: The image status.
status = resource.prop('status')
#: The timestamp when this image was last updated.
#: *Type: datetime object parsed from ISO 8601 formatted string*
updated_at = resource.prop('updated_at', type=format.ISO8601)
def __init__(self):
"""Preferences for each service.
Create a new :class:`~openstack.profile.Profile`
object with no preferences defined, but knowledge of the services.
Services are identified by their service type, e.g.: 'identity',
'compute', etc.
"""
self._preferences = {}
self._services = {}
"""
NOTE(thowe): We should probably do something more clever here rather
than brute force create all the services. Maybe use entry points
or something, but I'd like to leave that work for another commit.
"""
serv = cluster_service.ClusterService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = compute_service.ComputeService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = database_service.DatabaseService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = identity_service.IdentityService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = image_service.ImageService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = metric_service.MetricService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = network_service.NetworkService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = object_store_service.ObjectStoreService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = orchestration_service.OrchestrationService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = keystore_service.KeystoreService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = telemetry_service.TelemetryService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = block_store_service.BlockStoreService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = message_service.MessageService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
self.service_names = sorted(self._services.keys())
def test_service(self):
sot = image_service.ImageService()
self.assertEqual('image', sot.service_type)
self.assertEqual('public', sot.interface)
self.assertIsNone(sot.region)
self.assertIsNone(sot.service_name)
self.assertEqual(2, len(sot.valid_versions))
self.assertEqual('v2', sot.valid_versions[0].module)
self.assertEqual('v2', sot.valid_versions[0].path)
self.assertEqual('v1', sot.valid_versions[1].module)
self.assertEqual('v1', sot.valid_versions[1].path)
def test_get_versions(self):
sot = catalog.ServiceCatalog(common.TEST_SERVICE_CATALOG_V3)
service = compute_service.ComputeService()
self.assertEqual(['v1.1', 'v1', 'v2.0'], sot.get_versions(service))
service = identity_service.IdentityService()
self.assertEqual(['v1.1'], sot.get_versions(service))
service = image_service.ImageService()
self.assertEqual(['v2'], sot.get_versions(service))
service = network_service.NetworkService()
self.assertEqual(None, sot.get_versions(service))
service = object_store_service.ObjectStoreService()
self.assertEqual([], sot.get_versions(service))
class Image(resource.Resource):
resources_key = 'images'
base_path = '/images'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_retrieve = True
allow_update = True
allow_delete = True
allow_list = True
patch_update = True
# Properties
#: Hash of the image data used. The Image service uses this value
#: for verification.
checksum = resource.prop('checksum')
#: The container format refers to whether the VM image is in a file
#: format that also contains metadata about the actual VM.
#: Container formats include OVF and Amazon AMI. In addition,
#: a VM image might not have a container format - instead,
#: the image is just a blob of unstructured data.
container_format = resource.prop('container_format')
#: The date and time when the image was created.
created_at = resource.prop('created_at')
#: Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk.
#: The disk format of a VM image is the format of the underlying
#: disk image. Virtual appliance vendors have different formats
#: for laying out the information contained in a VM disk image.
disk_format = resource.prop('disk_format')
#: The minimum disk size in GB that is required to boot the image.
min_disk = resource.prop('min_disk')
#: The name of the image.
name = resource.prop('name')
#: The ID of the owner, or tenant, of the image.
owner = resource.prop('owner')
#: Properties, if any, that are associated with the image.
properties = resource.prop('properties')
#: Defines whether the image can be deleted.
protected = resource.prop('protected', type=bool)
#: The image status.
status = resource.prop('status')
#: Tags, if any, that are associated with the image.
tags = resource.prop('tags')
#: The date and time when the image was updated.
updated_at = resource.prop('updated_at')
#: The virtual size of the image.
virtual_size = resource.prop('virtual_size')
#: The image visibility.
visibility = resource.prop('visibility')
def test_parse_url(self):
filt = image_service.ImageService()
self.assertEqual(
"http://127.0.0.1:9292/v1",
session.parse_url(filt, "http://127.0.0.1:9292"))
self.assertEqual(
"http://127.0.0.1:9292/v2",
session.parse_url(filt, "http://127.0.0.1:9292/v2.0"))
filt.version = 'v1'
self.assertEqual(
"http://127.0.0.1:9292/v1/mytenant",
session.parse_url(filt, "http://127.0.0.1:9292/v2.0/mytenant/"))
self.assertEqual(
"http://127.0.0.1:9292/wot/v1/mytenant",
session.parse_url(filt, "http://127.0.0.1:9292/wot/v2.0/mytenant"))
class Member(resource.Resource):
id_attribute = 'member_id'
resources_key = 'members'
base_path = '/images/%(image_id)/members'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_retrieve = True
allow_update = True
allow_delete = True
allow_list = True
# Properties
created_at = resource.prop('created_at')
image_id = resource.prop('image_id')
status = resource.prop('status')
updated_at = resource.prop('updated_at')
class Tag(resource.Resource):
id_attribute = 'tag'
resources_key = 'tags'
base_path = '/images/%(image_id)s/tags'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_delete = True
# Properties
image_id = resource.prop('image_id')
def create(self, session):
"""Create a remote resource from this instance."""
# Service expects a naked PUT. Omit properties.
self.create_by_id(session, None, self.id, path_args=self)
self._reset_dirty()
return self
class Member(resource.Resource):
id_attribute = 'member_id'
resources_key = 'members'
base_path = '/images/%(image_id)s/members'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_retrieve = True
allow_update = True
allow_delete = True
allow_list = True
# Properties
#: The date and time when the member was created.
created_at = resource.prop('created_at')
#: Image ID stored through the image API. Typically a UUID.
image_id = resource.prop('image_id')
#: The status of the image.
status = resource.prop('status')
#: The date and time when the member was updated.
updated_at = resource.prop('updated_at')
class Image(resource.Resource):
resources_key = 'images'
base_path = '/images'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_retrieve = True
allow_update = True
allow_delete = True
allow_list = True
patch_update = True
# The image data (bytes or a file-like object)
data = None
# URI for the image
location = resource.header("location")
# Properties
#: Hash of the image data used. The Image service uses this value
#: for verification.
checksum = resource.prop('checksum')
#: The container format refers to whether the VM image is in a file
#: format that also contains metadata about the actual VM.
#: Container formats include OVF and Amazon AMI. In addition,
#: a VM image might not have a container format - instead,
#: the image is just a blob of unstructured data.
container_format = resource.prop('container_format')
#: The date and time when the image was created.
created_at = resource.prop('created_at')
#: Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk.
#: The disk format of a VM image is the format of the underlying
#: disk image. Virtual appliance vendors have different formats
#: for laying out the information contained in a VM disk image.
disk_format = resource.prop('disk_format')
#: The minimum disk size in GB that is required to boot the image.
min_disk = resource.prop('min_disk')
#: The name of the image.
name = resource.prop('name')
#: The ID of the owner, or tenant, of the image.
owner = resource.prop('owner')
#: Properties, if any, that are associated with the image.
properties = resource.prop('properties')
#: Defines whether the image can be deleted.
protected = resource.prop('protected', type=bool)
#: The size of the image data, in bytes.
size = resource.prop('size', type=int)
#: When present, Glance will attempt to store the disk image data in the
#: backing store indicated by the value of the header. When not present,
#: Glance will store the disk image data in the backing store that is
#: marked default. Valid values are: file, s3, rbd, swift, cinder,
#: gridfs, sheepdog, or vsphere.
store = resource.prop('store')
#: The image status.
status = resource.prop('status')
#: Tags, if any, that are associated with the image.
tags = resource.prop('tags')
#: The date and time when the image was updated.
updated_at = resource.prop('updated_at')
#: The virtual size of the image.
virtual_size = resource.prop('virtual_size')
#: The image visibility.
visibility = resource.prop('visibility')
def upload_image(self, session):
url = utils.urljoin(self._get_url(resource_id=self.id), 'file')
headers = self.get_headers()
headers['Content-Type'] = 'application/octet-stream'
headers['Accept'] = ''
session.put(url, endpoint_filter=self.service, data=self.data,
headers=headers)
class ServicesMixin(object):
identity = identity_service.IdentityService(service_type='identity')
compute = compute_service.ComputeService(service_type='compute')
image = image_service.ImageService(service_type='image')
load_balancer = load_balancer_service.LoadBalancerService(
service_type='load-balancer')
object_store = object_store_service.ObjectStoreService(
service_type='object-store')
clustering = clustering_service.ClusteringService(
service_type='clustering')
resource_cluster = clustering
cluster = clustering
data_processing = service_description.ServiceDescription(
service_type='data-processing')
baremetal = baremetal_service.BaremetalService(service_type='baremetal')
bare_metal = baremetal
baremetal_introspection = baremetal_introspection_service.BaremetalIntrospectionService(
service_type='baremetal-introspection')
key_manager = key_manager_service.KeyManagerService(
service_type='key-manager')
resource_optimization = service_description.ServiceDescription(
service_type='resource-optimization')
infra_optim = resource_optimization
message = message_service.MessageService(service_type='message')
messaging = message
application_catalog = service_description.ServiceDescription(
service_type='application-catalog')
container_infrastructure_management = service_description.ServiceDescription(
service_type='container-infrastructure-management')
container_infrastructure = container_infrastructure_management
container_infra = container_infrastructure_management
search = service_description.ServiceDescription(service_type='search')
dns = dns_service.DnsService(service_type='dns')
workflow = workflow_service.WorkflowService(service_type='workflow')
rating = service_description.ServiceDescription(service_type='rating')
operator_policy = service_description.ServiceDescription(
service_type='operator-policy')
policy = operator_policy
shared_file_system = service_description.ServiceDescription(
service_type='shared-file-system')
share = shared_file_system
data_protection_orchestration = service_description.ServiceDescription(
service_type='data-protection-orchestration')
orchestration = orchestration_service.OrchestrationService(
service_type='orchestration')
block_storage = block_storage_service.BlockStorageService(
service_type='block-storage')
block_store = block_storage
volume = block_storage
alarm = service_description.ServiceDescription(service_type='alarm')
alarming = alarm
meter = service_description.ServiceDescription(service_type='meter')
metering = meter
telemetry = meter
event = service_description.ServiceDescription(service_type='event')
events = event
application_deployment = service_description.ServiceDescription(
service_type='application-deployment')
application_deployment = application_deployment
multi_region_network_automation = service_description.ServiceDescription(
service_type='multi-region-network-automation')
tricircle = multi_region_network_automation
database = database_service.DatabaseService(service_type='database')
application_container = service_description.ServiceDescription(
service_type='application-container')
container = application_container
root_cause_analysis = service_description.ServiceDescription(
service_type='root-cause-analysis')
rca = root_cause_analysis
nfv_orchestration = service_description.ServiceDescription(
service_type='nfv-orchestration')
network = network_service.NetworkService(service_type='network')
backup = service_description.ServiceDescription(service_type='backup')
monitoring_logging = service_description.ServiceDescription(
service_type='monitoring-logging')
monitoring_log_api = monitoring_logging
monitoring = service_description.ServiceDescription(
service_type='monitoring')
monitoring_events = service_description.ServiceDescription(
service_type='monitoring-events')
placement = service_description.ServiceDescription(
service_type='placement')
instance_ha = instance_ha_service.InstanceHaService(
service_type='instance-ha')
ha = instance_ha
reservation = service_description.ServiceDescription(
service_type='reservation')
function_engine = service_description.ServiceDescription(
service_type='function-engine')
accelerator = accelerator_service.AcceleratorService(
service_type='accelerator')
admin_logic = service_description.ServiceDescription(
service_type='admin-logic')
registration = admin_logic
def test_service(self):
sot = image_service.ImageService()
self.assertEqual('image', sot.service_type)
self.assertEqual('public', sot.visibility)
self.assertIsNone(sot.region)
self.assertIsNone(sot.service_name)
class Image(resource2.Resource):
resources_key = 'images'
base_path = '/images'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_get = True
allow_update = True
allow_delete = True
allow_list = True
patch_update = True
_query_mapping = resource2.QueryParameters("name", "visibility",
"member_status", "owner",
"status", "size_min",
"size_max", "sort_key",
"sort_dir", "sort", "tag",
"created_at", "updated_at")
# NOTE: Do not add "self" support here. If you've used Python before,
# you know that self, while not being a reserved word, has special
# meaning. You can't call a class initializer with the self name
# as the first argument and then additionally in kwargs, as we
# do when we're constructing instances from the JSON body.
# Resource.list explicitly pops off any "self" keys from bodies so
# that we don't end up getting the following:
# TypeError: __init__() got multiple values for argument 'self'
# The image data (bytes or a file-like object)
data = None
# Properties
#: Hash of the image data used. The Image service uses this value
#: for verification.
checksum = resource2.Body('checksum')
#: The container format refers to whether the VM image is in a file
#: format that also contains metadata about the actual VM.
#: Container formats include OVF and Amazon AMI. In addition,
#: a VM image might not have a container format - instead,
#: the image is just a blob of unstructured data.
container_format = resource2.Body('container_format')
#: The date and time when the image was created.
created_at = resource2.Body('created_at')
#: Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk.
#: The disk format of a VM image is the format of the underlying
#: disk image. Virtual appliance vendors have different formats
#: for laying out the information contained in a VM disk image.
disk_format = resource2.Body('disk_format')
#: Defines whether the image can be deleted.
#: *Type: bool*
is_protected = resource2.Body('protected', type=bool)
#: The minimum disk size in GB that is required to boot the image.
min_disk = resource2.Body('min_disk')
#: The minimum amount of RAM in MB that is required to boot the image.
min_ram = resource2.Body('min_ram')
#: The name of the image.
name = resource2.Body('name')
#: The ID of the owner, or project, of the image.
owner_id = resource2.Body('owner')
#: Properties, if any, that are associated with the image.
properties = resource2.Body('properties', type=dict)
#: The size of the image data, in bytes.
size = resource2.Body('size', type=int)
#: When present, Glance will attempt to store the disk image data in the
#: backing store indicated by the value of the header. When not present,
#: Glance will store the disk image data in the backing store that is
#: marked default. Valid values are: file, s3, rbd, swift, cinder,
#: gridfs, sheepdog, or vsphere.
store = resource2.Body('store')
#: The image status.
status = resource2.Body('status')
#: Tags, if any, that are associated with the image.
tags = resource2.Body('tags')
#: The date and time when the image was updated.
updated_at = resource2.Body('updated_at')
#: The virtual size of the image.
virtual_size = resource2.Body('virtual_size')
#: The image visibility.
visibility = resource2.Body('visibility')
#: The URL for the virtual machine image file.
file = resource2.Body('file')
#: A list of URLs to access the image file in external store.
#: This list appears if the show_multiple_locations option is set
#: to true in the Image service's configuration file.
locations = resource2.Body('locations')
#: The URL to access the image file kept in external store. It appears
#: when you set the show_image_direct_url option to true in the
#: Image service's configuration file.
direct_url = resource2.Body('direct_url')
#: An image property.
path = resource2.Body('path')
#: Value of image property used in add or replace operations expressed
#: in JSON notation. For example, you must enclose strings in quotation
#: marks, and you do not enclose numeric values in quotation marks.
value = resource2.Body('value')
#: The URL to access the image file kept in external store.
url = resource2.Body('url')
#: The location metadata.
metadata = resource2.Body('metadata', type=dict)
# Additional Image Properties
# http://docs.openstack.org/developer/glance/common-image-properties.html
# http://docs.openstack.org/cli-reference/glance-property-keys.html
#: The CPU architecture that must be supported by the hypervisor.
architecture = resource2.Body("architecture")
#: The hypervisor type. Note that qemu is used for both QEMU and
#: KVM hypervisor types.
hypervisor_type = resource2.Body("hypervisor-type")
#: Optional property allows created servers to have a different bandwidth
#: cap than that defined in the network they are attached to.
instance_type_rxtx_factor = resource2.Body("instance_type_rxtx_factor",
type=float)
# For snapshot images, this is the UUID of the server used to
#: create this image.
instance_uuid = resource2.Body('instance_uuid')
#: Specifies whether the image needs a config drive.
#: `mandatory` or `optional` (default if property is not used).
needs_config_drive = resource2.Body('img_config_drive')
#: The ID of an image stored in the Image service that should be used
#: as the kernel when booting an AMI-style image.
kernel_id = resource2.Body('kernel_id')
#: The common name of the operating system distribution in lowercase
os_distro = resource2.Body('os_distro')
#: The operating system version as specified by the distributor.
os_version = resource2.Body('os_version')
#: Secure Boot is a security standard. When the instance starts,
#: Secure Boot first examines software such as firmware and OS by
#: their signature and only allows them to run if the signatures are valid.
needs_secure_boot = resource2.Body('os_secure_boot')
#: The ID of image stored in the Image service that should be used as
#: the ramdisk when booting an AMI-style image.
ramdisk_id = resource2.Body('ramdisk_id')
#: The virtual machine mode. This represents the host/guest ABI
#: (application binary interface) used for the virtual machine.
vm_mode = resource2.Body('vm_mode')
#: The preferred number of sockets to expose to the guest.
hw_cpu_sockets = resource2.Body('hw_cpu_sockets', type=int)
#: The preferred number of cores to expose to the guest.
hw_cpu_cores = resource2.Body('hw_cpu_cores', type=int)
#: The preferred number of threads to expose to the guest.
hw_cpu_threads = resource2.Body('hw_cpu_threads', type=int)
#: Specifies the type of disk controller to attach disk devices to.
#: One of scsi, virtio, uml, xen, ide, or usb.
hw_disk_bus = resource2.Body('hw_disk_bus')
#: Adds a random-number generator device to the image's instances.
hw_rng_model = resource2.Body('hw_rng_model')
#: For libvirt: Enables booting an ARM system using the specified
#: machine type.
#: For Hyper-V: Specifies whether the Hyper-V instance will be a
#: generation 1 or generation 2 VM.
hw_machine_type = resource2.Body('hw_machine_type')
#: Enables the use of VirtIO SCSI (virtio-scsi) to provide block device
#: access for compute instances; by default, instances use VirtIO Block
#: (virtio-blk).
hw_scsi_model = resource2.Body('hw_scsi_model')
#: Specifies the count of serial ports that should be provided.
hw_serial_port_count = resource2.Body('hw_serial_port_count', type=int)
#: The video image driver used.
hw_video_model = resource2.Body('hw_video_model')
#: Maximum RAM for the video image.
hw_video_ram = resource2.Body('hw_video_ram', type=int)
#: Enables a virtual hardware watchdog device that carries out the
#: specified action if the server hangs.
hw_watchdog_action = resource2.Body('hw_watchdog_action')
#: The kernel command line to be used by the libvirt driver, instead
#: of the default.
os_command_line = resource2.Body('os_command_line')
#: Specifies the model of virtual network interface device to use.
hw_vif_model = resource2.Body('hw_vif_model')
#: If true, this enables the virtio-net multiqueue feature.
#: In this case, the driver sets the number of queues equal to the
#: number of guest vCPUs. This makes the network performance scale
#: across a number of vCPUs.
is_hw_vif_multiqueue_enabled = resource2.Body('hw_vif_multiqueue_enabled',
type=bool)
#: If true, enables the BIOS bootmenu.
is_hw_boot_menu_enabled = resource2.Body('hw_boot_menu', type=bool)
#: The virtual SCSI or IDE controller used by the hypervisor.
vmware_adaptertype = resource2.Body('vmware_adaptertype')
#: A VMware GuestID which describes the operating system installed
#: in the image.
vmware_ostype = resource2.Body('vmware_ostype')
#: If true, the root partition on the disk is automatically resized
#: before the instance boots.
has_auto_disk_config = resource2.Body('auto_disk_config', type=bool)
#: The operating system installed on the image.
os_type = resource2.Body('os_type')
def _action(self, session, action):
"""Call an action on an image ID."""
url = utils.urljoin(self.base_path, self.id, 'actions', action)
return session.post(url, endpoint_filter=self.service)
def deactivate(self, session):
"""Deactivate an image
Note: Only administrative users can view image locations
for deactivated images.
"""
self._action(session, "deactivate")
def reactivate(self, session):
"""Reactivate an image
Note: The image must exist in order to be reactivated.
"""
self._action(session, "reactivate")
def add_tag(self, session, tag):
"""Add a tag to an image"""
url = utils.urljoin(self.base_path, self.id, 'tags', tag)
session.put(url, endpoint_filter=self.service)
def remove_tag(self, session, tag):
"""Remove a tag from an image"""
url = utils.urljoin(self.base_path, self.id, 'tags', tag)
session.delete(url, endpoint_filter=self.service)
def upload(self, session):
"""Upload data into an existing image"""
url = utils.urljoin(self.base_path, self.id, 'file')
session.put(url,
endpoint_filter=self.service,
data=self.data,
headers={
"Content-Type": "application/octet-stream",
"Accept": ""
})
def download(self, session, stream=False):
"""Download the data contained in an image"""
# TODO(briancurtin): This method should probably offload the get
# operation into another thread or something of that nature.
url = utils.urljoin(self.base_path, self.id, 'file')
resp = session.get(url, endpoint_filter=self.service, stream=stream)
# See the following bug report for details on why the checksum
# code may sometimes depend on a second GET call.
# https://bugs.launchpad.net/python-openstacksdk/+bug/1619675
checksum = resp.headers.get("Content-MD5")
if checksum is None:
# If we don't receive the Content-MD5 header with the download,
# make an additional call to get the image details and look at
# the checksum attribute.
details = self.get(session)
checksum = details.checksum
# if we are returning the repsonse object, ensure that it
# has the content-md5 header so that the caller doesn't
# need to jump through the same hoops through which we
# just jumped.
if stream:
resp.headers['content-md5'] = checksum
return resp
if checksum is not None:
digest = hashlib.md5(resp.content).hexdigest()
if digest != checksum:
raise exceptions.InvalidResponse(
"checksum mismatch: %s != %s" % (checksum, digest))
else:
_logger.warn("Unable to verify the integrity of image %s" %
(self.id))
return resp.content
def update(self, session, **attrs):
url = utils.urljoin(self.base_path, self.id)
headers = {
'Content-Type': 'application/openstack-images-v2.1-json-patch',
'Accept': ''
}
original = self.to_dict()
patch_string = jsonpatch.make_patch(original, attrs).to_string()
resp = session.patch(url,
endpoint_filter=self.service,
data=patch_string,
headers=headers)
self._translate_response(resp, has_body=True)
return self
class Image(resource2.Resource):
resources_key = 'images'
base_path = '/images'
service = image_service.ImageService()
# capabilities
allow_create = True
allow_get = True
allow_update = True
allow_delete = True
allow_list = True
patch_update = True
_query_mapping = resource2.QueryParameters("name", "visibility",
"member_status", "owner",
"status", "size_min",
"size_max", "sort_key",
"sort_dir", "sort", "tag",
"created_at", "updated_at")
# NOTE: Do not add "self" support here. If you've used Python before,
# you know that self, while not being a reserved word, has special
# meaning. You can't call a class initializer with the self name
# as the first argument and then additionally in kwargs, as we
# do when we're constructing instances from the JSON body.
# Resource.list explicitly pops off any "self" keys from bodies so
# that we don't end up getting the following:
# TypeError: __init__() got multiple values for argument 'self'
# The image data (bytes or a file-like object)
data = None
# Properties
#: Hash of the image data used. The Image service uses this value
#: for verification.
checksum = resource2.Body('checksum')
#: The container format refers to whether the VM image is in a file
#: format that also contains metadata about the actual VM.
#: Container formats include OVF and Amazon AMI. In addition,
#: a VM image might not have a container format - instead,
#: the image is just a blob of unstructured data.
container_format = resource2.Body('container_format')
#: The date and time when the image was created.
created_at = resource2.Body('created_at')
#: Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk.
#: The disk format of a VM image is the format of the underlying
#: disk image. Virtual appliance vendors have different formats
#: for laying out the information contained in a VM disk image.
disk_format = resource2.Body('disk_format')
#: Defines whether the image can be deleted.
#: *Type: bool*
is_protected = resource2.Body('protected', type=bool)
#: The minimum disk size in GB that is required to boot the image.
min_disk = resource2.Body('min_disk')
#: The minimum amount of RAM in MB that is required to boot the image.
min_ram = resource2.Body('min_ram')
#: The name of the image.
name = resource2.Body('name')
#: The ID of the owner, or project, of the image.
owner_id = resource2.Body('owner')
#: Properties, if any, that are associated with the image.
properties = resource2.Body('properties', type=dict)
#: The size of the image data, in bytes.
size = resource2.Body('size', type=int)
#: When present, Glance will attempt to store the disk image data in the
#: backing store indicated by the value of the header. When not present,
#: Glance will store the disk image data in the backing store that is
#: marked default. Valid values are: file, s3, rbd, swift, cinder,
#: gridfs, sheepdog, or vsphere.
store = resource2.Body('store')
#: The image status.
status = resource2.Body('status')
#: Tags, if any, that are associated with the image.
tags = resource2.Body('tags')
#: The date and time when the image was updated.
updated_at = resource2.Body('updated_at')
#: The virtual size of the image.
virtual_size = resource2.Body('virtual_size')
#: The image visibility.
visibility = resource2.Body('visibility')
#: The URL for the virtual machine image file.
file = resource2.Body('file')
#: A list of URLs to access the image file in external store.
#: This list appears if the show_multiple_locations option is set
#: to true in the Image service's configuration file.
locations = resource2.Body('locations')
#: The URL to access the image file kept in external store. It appears
#: when you set the show_image_direct_url option to true in the
#: Image service's configuration file.
direct_url = resource2.Body('direct_url')
#: An image property.
path = resource2.Body('path')
#: Value of image property used in add or replace operations expressed
#: in JSON notation. For example, you must enclose strings in quotation
#: marks, and you do not enclose numeric values in quotation marks.
value = resource2.Body('value')
#: The URL to access the image file kept in external store.
url = resource2.Body('url')
#: The location metadata.
metadata = resource2.Body('metadata', type=dict)
def _action(self, session, action):
"""Call an action on an image ID."""
url = utils.urljoin(self.base_path, self.id, 'actions', action)
return session.post(url, endpoint_filter=self.service)
def deactivate(self, session):
"""Deactivate an image
Note: Only administrative users can view image locations
for deactivated images.
"""
self._action(session, "deactivate")
def reactivate(self, session):
"""Reactivate an image
Note: The image must exist in order to be reactivated.
"""
self._action(session, "reactivate")
def add_tag(self, session, tag):
"""Add a tag to an image"""
url = utils.urljoin(self.base_path, self.id, 'tags', tag)
session.put(url, endpoint_filter=self.service)
def remove_tag(self, session, tag):
"""Remove a tag from an image"""
url = utils.urljoin(self.base_path, self.id, 'tags', tag)
session.delete(url, endpoint_filter=self.service)
def upload(self, session):
"""Upload data into an existing image"""
url = utils.urljoin(self.base_path, self.id, 'file')
session.put(url,
endpoint_filter=self.service,
data=self.data,
headers={
"Content-Type": "application/octet-stream",
"Accept": ""
})
def download(self, session):
"""Download the data contained in an image"""
# TODO(briancurtin): This method should probably offload the get
# operation into another thread or something of that nature.
url = utils.urljoin(self.base_path, self.id, 'file')
resp = session.get(url, endpoint_filter=self.service)
checksum = resp.headers["Content-MD5"]
digest = hashlib.md5(resp.content).hexdigest()
if digest != checksum:
raise exceptions.InvalidResponse("checksum mismatch")
return resp.content