def CreatePersistentAttachedDiskMessages(resources,
compute_client,
csek_keys,
disks,
project,
location,
scope,
container_mount_disk=None):
"""Returns a list of AttachedDisk messages and the boot disk's reference."""
disks_messages = []
messages = compute_client.messages
compute = compute_client.apitools_client
for disk in disks:
name = disk.get('name')
# Resolves the mode.
mode_value = disk.get('mode', 'rw')
if mode_value == 'rw':
mode = messages.AttachedDisk.ModeValueValuesEnum.READ_WRITE
else:
mode = messages.AttachedDisk.ModeValueValuesEnum.READ_ONLY
boot = disk.get('boot') == 'yes'
auto_delete = disk.get('auto-delete') == 'yes'
if 'scope' in disk and disk['scope'] == 'regional':
scope = compute_scopes.ScopeEnum.REGION
else:
scope = compute_scopes.ScopeEnum.ZONE
disk_ref = instance_utils.ParseDiskResource(resources, name, project,
location, scope)
# TODO(b/36051031) drop test after CSEK goes GA
if csek_keys:
disk_key_or_none = csek_utils.MaybeLookupKeyMessage(
csek_keys, disk_ref, compute)
kwargs = {'diskEncryptionKey': disk_key_or_none}
else:
kwargs = {}
device_name = instance_utils.GetDiskDeviceName(disk, name,
container_mount_disk)
attached_disk = messages.AttachedDisk(
autoDelete=auto_delete,
boot=boot,
deviceName=device_name,
mode=mode,
source=disk_ref.SelfLink(),
type=messages.AttachedDisk.TypeValueValuesEnum.PERSISTENT,
**kwargs)
# The boot disk must end up at index 0.
if boot:
disks_messages = [attached_disk] + disks_messages
else:
disks_messages.append(attached_disk)
return disks_messages
def CreatePersistentAttachedDiskMessages(messages,
disks,
container_mount_disk=None):
"""Returns a list of AttachedDisk messages and the boot disk's reference.
Args:
messages: GCE API messages,
disks: disk objects - contains following properties
* name - the name of disk,
* mode - 'rw' (R/W), 'ro' (R/O) access mode,
* boot - whether it is a boot disk ('yes' if True),
* autodelete - whether disks is deleted when VM is deleted ('yes'
if True),
* device-name - device name on VM.
container_mount_disk: list of disks to be mounted to container, if any.
Returns:
list of API messages for attached disks
"""
disks_messages = []
for disk in disks:
name = disk['name']
# Resolves the mode.
mode_value = disk.get('mode', 'rw')
if mode_value == 'rw':
mode = messages.AttachedDisk.ModeValueValuesEnum.READ_WRITE
else:
mode = messages.AttachedDisk.ModeValueValuesEnum.READ_ONLY
boot = disk.get('boot') == 'yes'
auto_delete = disk.get('auto-delete') == 'yes'
device_name = instance_utils.GetDiskDeviceName(disk, name,
container_mount_disk)
attached_disk = messages.AttachedDisk(
autoDelete=auto_delete,
boot=boot,
deviceName=device_name,
mode=mode,
source=name,
type=messages.AttachedDisk.TypeValueValuesEnum.PERSISTENT)
# The boot disk must end up at index 0.
if boot:
disks_messages = [attached_disk] + disks_messages
else:
disks_messages.append(attached_disk)
return disks_messages
def CreatePersistentCreateDiskMessages(compute_client,
resources,
csek_keys,
create_disks,
project,
location,
scope,
enable_kms=False,
enable_snapshots=False,
container_mount_disk=None,
resource_policy=False,
enable_source_snapshot_csek=False,
enable_image_csek=False):
"""Returns a list of AttachedDisk messages for newly creating disks.
Args:
compute_client: creates resources,
resources: parser of resources,
csek_keys: customer suplied encryption keys,
create_disks: disk objects - contains following properties * name - the name
of disk, * description - an optional description for the disk, * mode -
'rw' (R/W), 'ro' (R/O) access mode, * disk-size - the size of the disk, *
disk-type - the type of the disk (HDD or SSD), * image - the name of the
image to initialize from, * image-csek-required - the name of the CSK
protected image, * image-family - the image family name, * image-project -
the project name that has the image, * auto-delete - whether disks is
deleted when VM is deleted, * device-name - device name on VM, *
source-snapshot - the snapshot to initialize from, *
source-snapshot-csek-required - CSK protected snapshot, *
disk-resource-policy - resource policies applied to disk. *
enable_source_snapshot_csek - CSK file for snapshot, * enable_image_csek -
CSK file for image
project: Project of instance that will own the new disks.
location: Location of the instance that will own the new disks.
scope: Location type of the instance that will own the new disks.
enable_kms: True if KMS keys are supported for the disk.
enable_snapshots: True if snapshot initialization is supported for the disk.
container_mount_disk: list of disks to be mounted to container, if any.
resource_policy: True if resource-policies are enabled
enable_source_snapshot_csek: True if snapshot CSK files are enabled
enable_image_csek: True if image CSK files are enabled
Returns:
list of API messages for attached disks
"""
disks_messages = []
messages = compute_client.messages
compute = compute_client.apitools_client
for disk in create_disks or []:
name = disk.get('name')
# Resolves the mode.
mode_value = disk.get('mode', 'rw')
if mode_value == 'rw':
mode = messages.AttachedDisk.ModeValueValuesEnum.READ_WRITE
else:
mode = messages.AttachedDisk.ModeValueValuesEnum.READ_ONLY
auto_delete_value = disk.get('auto-delete', 'yes')
auto_delete = auto_delete_value == 'yes'
disk_size_gb = utils.BytesToGb(disk.get('size'))
disk_type = disk.get('type')
if disk_type:
disk_type_ref = instance_utils.ParseDiskType(resources, disk_type,
project, location, scope)
disk_type_uri = disk_type_ref.SelfLink()
else:
disk_type_uri = None
img = disk.get('image')
img_family = disk.get('image-family')
img_project = disk.get('image-project')
image_uri = None
if img or img_family:
image_expander = image_utils.ImageExpander(compute_client, resources)
image_uri, _ = image_expander.ExpandImageFlag(
user_project=project,
image=img,
image_family=img_family,
image_project=img_project,
return_image_resource=False)
image_key = None
disk_key = None
if csek_keys:
image_key = csek_utils.MaybeLookupKeyMessagesByUri(
csek_keys, resources, [image_uri], compute)
if name:
disk_ref = resources.Parse(
name, collection='compute.disks', params={'zone': location})
disk_key = csek_utils.MaybeLookupKeyMessage(csek_keys, disk_ref,
compute)
if enable_kms:
disk_key = kms_utils.MaybeGetKmsKeyFromDict(disk, messages, disk_key)
initialize_params = messages.AttachedDiskInitializeParams(
diskName=name,
description=disk.get('description'),
sourceImage=image_uri,
diskSizeGb=disk_size_gb,
diskType=disk_type_uri,
sourceImageEncryptionKey=image_key)
if enable_snapshots:
snapshot_name = disk.get('source-snapshot')
attached_snapshot_uri = instance_utils.ResolveSnapshotURI(
snapshot=snapshot_name,
user_project=project,
resource_parser=resources)
if attached_snapshot_uri:
initialize_params.sourceImage = None
initialize_params.sourceSnapshot = attached_snapshot_uri
if resource_policy:
policies = disk.get('disk-resource-policy')
if policies:
initialize_params.resourcePolicies = policies
if enable_image_csek:
image_key_file = disk.get('image_csek')
if image_key_file:
initialize_params.imageKeyFile = image_key_file
if enable_source_snapshot_csek:
snapshot_key_file = disk.get('source_snapshot_csek')
if snapshot_key_file:
initialize_params.snapshotKeyFile = snapshot_key_file
device_name = instance_utils.GetDiskDeviceName(disk, name,
container_mount_disk)
create_disk = messages.AttachedDisk(
autoDelete=auto_delete,
boot=False,
deviceName=device_name,
initializeParams=initialize_params,
mode=mode,
type=messages.AttachedDisk.TypeValueValuesEnum.PERSISTENT,
diskEncryptionKey=disk_key)
disks_messages.append(create_disk)
return disks_messages
def CreatePersistentCreateDiskMessages(client,
resources,
user_project,
create_disks,
support_kms=False,
container_mount_disk=None):
"""Returns a list of AttachedDisk messages.
Args:
client: Compute client adapter
resources: Compute resources registry
user_project: name of user project
create_disks: disk objects - contains following properties
* name - the name of disk,
* description - an optional description for the disk,
* mode - 'rw' (R/W), 'ro' (R/O) access mode,
* size - the size of the disk,
* type - the type of the disk (HDD or SSD),
* image - the name of the image to initialize from,
* image-family - the image family name,
* image-project - the project name that has the image,
* auto-delete - whether disks is deleted when VM is deleted ('yes'
if True),
* device-name - device name on VM,
* disk-resource-policy - resource policies applied to disk.
support_kms: if KMS is supported
container_mount_disk: list of disks to be mounted to container, if any.
Returns:
list of API messages for attached disks
"""
disks_messages = []
for disk in create_disks or []:
name = disk.get('name')
# Resolves the mode.
mode_value = disk.get('mode', 'rw')
if mode_value == 'rw':
mode = client.messages.AttachedDisk.ModeValueValuesEnum.READ_WRITE
else:
mode = client.messages.AttachedDisk.ModeValueValuesEnum.READ_ONLY
auto_delete = disk.get('auto-delete') == 'yes'
boot = disk.get('boot') == 'yes'
disk_size_gb = utils.BytesToGb(disk.get('size'))
img = disk.get('image')
img_family = disk.get('image-family')
img_project = disk.get('image-project')
image_uri = None
if img or img_family:
image_expander = image_utils.ImageExpander(client, resources)
image_uri, _ = image_expander.ExpandImageFlag(
user_project=user_project,
image=img,
image_family=img_family,
image_project=img_project,
return_image_resource=False)
disk_key = None
if support_kms:
disk_key = kms_utils.MaybeGetKmsKeyFromDict(
disk, client.messages, disk_key)
device_name = instance_utils.GetDiskDeviceName(disk, name,
container_mount_disk)
init_params = client.messages.AttachedDiskInitializeParams(
diskName=name,
description=disk.get('description'),
sourceImage=image_uri,
diskSizeGb=disk_size_gb,
diskType=disk.get('type'))
policies = disk.get('disk-resource-policy')
if policies:
init_params.resourcePolicies = policies
multi_writer = disk.get('multi-writer') == 'yes'
if multi_writer:
init_params.multiWriter = True
create_disk = client.messages.AttachedDisk(
autoDelete=auto_delete,
boot=boot,
deviceName=device_name,
initializeParams=init_params,
mode=mode,
type=client.messages.AttachedDisk.TypeValueValuesEnum.PERSISTENT,
diskEncryptionKey=disk_key)
disks_messages.append(create_disk)
return disks_messages
def CreatePersistentCreateDiskMessages(compute_client,
resources,
csek_keys,
create_disks,
project,
location,
scope,
holder,
enable_kms=False,
enable_snapshots=False,
container_mount_disk=None,
enable_source_snapshot_csek=False,
enable_image_csek=False,
support_replica_zones=False,
use_disk_type_uri=True,
support_multi_writer=False,
support_image_family_scope=False,
support_disk_architecture=False):
"""Returns a list of AttachedDisk messages for newly creating disks.
Args:
compute_client: creates resources,
resources: parser of resources,
csek_keys: customer suplied encryption keys,
create_disks: disk objects - contains following properties * name - the name
of disk, * description - an optional description for the disk, * mode -
'rw' (R/W), 'ro' (R/O) access mode, * disk-size - the size of the disk, *
disk-type - the type of the disk (HDD or SSD), * image - the name of the
image to initialize from, * image-csek-required - the name of the CSK
protected image, * image-family - the image family name, * image-project -
the project name that has the image, * auto-delete - whether disks is
deleted when VM is deleted, * device-name - device name on VM, *
source-snapshot - the snapshot to initialize from, *
source-snapshot-csek-required - CSK protected snapshot, *
disk-resource-policy - resource policies applied to disk. *
enable_source_snapshot_csek - CSK file for snapshot, * enable_image_csek -
CSK file for image
project: Project of instance that will own the new disks.
location: Location of the instance that will own the new disks.
scope: Location type of the instance that will own the new disks.
holder: Convenience class to hold lazy initialized client and resources.
enable_kms: True if KMS keys are supported for the disk.
enable_snapshots: True if snapshot initialization is supported for the disk.
container_mount_disk: list of disks to be mounted to container, if any.
enable_source_snapshot_csek: True if snapshot CSK files are enabled
enable_image_csek: True if image CSK files are enabled
support_replica_zones: True if we allow creation of regional disks
use_disk_type_uri: True to use disk type URI, False if naked type.
support_multi_writer: True if we allow multiple instances to write to disk.
support_image_family_scope: True if the zonal image views are supported.
support_disk_architecture: The machine architecture the created disk is
compatible with.
Returns:
list of API messages for attached disks
"""
disks_messages = []
messages = compute_client.messages
compute = compute_client.apitools_client
for disk in create_disks or []:
name = disk.get('name')
# Resolves the mode.
mode_value = disk.get('mode', 'rw')
if mode_value == 'rw':
mode = messages.AttachedDisk.ModeValueValuesEnum.READ_WRITE
else:
mode = messages.AttachedDisk.ModeValueValuesEnum.READ_ONLY
auto_delete = disk.get('auto-delete', True)
disk_size_gb = utils.BytesToGb(disk.get('size'))
disk_type = disk.get('type')
if disk_type:
if use_disk_type_uri:
disk_type_ref = instance_utils.ParseDiskType(resources, disk_type,
project, location, scope)
disk_type = disk_type_ref.SelfLink()
else:
disk_type = None
img = disk.get('image')
img_family = disk.get('image-family')
img_project = disk.get('image-project')
image_family_scope = disk.get('image_family_scope')
image_uri = None
if img or img_family:
image_expander = image_utils.ImageExpander(compute_client, resources)
image_uri, _ = image_expander.ExpandImageFlag(
user_project=project,
image=img,
image_family=img_family,
image_project=img_project,
return_image_resource=False,
image_family_scope=image_family_scope,
support_image_family_scope=support_image_family_scope)
image_key = None
disk_key = None
if csek_keys:
image_key = csek_utils.MaybeLookupKeyMessagesByUri(
csek_keys, resources, [image_uri], compute)
if name:
disk_ref = resources.Parse(
name, collection='compute.disks', params={'zone': location})
disk_key = csek_utils.MaybeLookupKeyMessage(csek_keys, disk_ref,
compute)
if enable_kms:
disk_key = kms_utils.MaybeGetKmsKeyFromDict(disk, messages, disk_key)
initialize_params = messages.AttachedDiskInitializeParams(
diskName=name,
description=disk.get('description'),
sourceImage=image_uri,
diskSizeGb=disk_size_gb,
diskType=disk_type,
sourceImageEncryptionKey=image_key)
replica_zones = disk.get('replica-zones')
if support_replica_zones and replica_zones:
normalized_zones = []
for zone in replica_zones:
zone_ref = holder.resources.Parse(
zone, collection='compute.zones', params={'project': project})
normalized_zones.append(zone_ref.SelfLink())
initialize_params.replicaZones = normalized_zones
if enable_snapshots:
snapshot_name = disk.get('source-snapshot')
attached_snapshot_uri = instance_utils.ResolveSnapshotURI(
snapshot=snapshot_name,
user_project=project,
resource_parser=resources)
if attached_snapshot_uri:
initialize_params.sourceImage = None
initialize_params.sourceSnapshot = attached_snapshot_uri
policies = disk.get('disk-resource-policy')
if policies:
initialize_params.resourcePolicies = policies
if enable_image_csek:
image_key_file = disk.get('image_csek')
if image_key_file:
initialize_params.imageKeyFile = image_key_file
if enable_source_snapshot_csek:
snapshot_key_file = disk.get('source_snapshot_csek')
if snapshot_key_file:
initialize_params.snapshotKeyFile = snapshot_key_file
boot = disk.get('boot', False)
multi_writer = disk.get('multi-writer')
if support_multi_writer and multi_writer:
initialize_params.multiWriter = True
provisioned_iops = disk.get('provisioned-iops')
if provisioned_iops:
initialize_params.provisionedIops = provisioned_iops
disk_architecture = disk.get('architecture')
if support_disk_architecture and disk_architecture:
initialize_params.architecture = messages.AttachedDiskInitializeParams.ArchitectureValueValuesEnum(
disk_architecture)
device_name = instance_utils.GetDiskDeviceName(disk, name,
container_mount_disk)
create_disk = messages.AttachedDisk(
autoDelete=auto_delete,
boot=boot,
deviceName=device_name,
initializeParams=initialize_params,
mode=mode,
type=messages.AttachedDisk.TypeValueValuesEnum.PERSISTENT,
diskEncryptionKey=disk_key)
# The boot disk must end up at index 0.
if boot:
disks_messages = [create_disk] + disks_messages
else:
disks_messages.append(create_disk)
return disks_messages
