File: //snap/google-cloud-cli/current/lib/surface/compute/images/create.py
# -*- coding: utf-8 -*- #
# Copyright 2014 Google LLC. All Rights Reserved.
#
# 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.
"""Command for creating images."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
import re
from googlecloudsdk.api_lib.compute import base_classes
from googlecloudsdk.api_lib.compute import csek_utils
from googlecloudsdk.api_lib.compute import image_utils
from googlecloudsdk.api_lib.compute import kms_utils
from googlecloudsdk.calliope import arg_parsers
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import exceptions
from googlecloudsdk.command_lib.compute import flags as compute_flags
from googlecloudsdk.command_lib.compute.images import flags
from googlecloudsdk.command_lib.kms import resource_args as kms_resource_args
from googlecloudsdk.command_lib.util.args import labels_util
from googlecloudsdk.core import resources
import six
POLL_TIMEOUT = 36000 # 10 hours is recommended by PD team b/131850402#comment20
def _Args(
parser,
messages,
supports_force_create=False,
support_user_licenses=False,
supports_rollout_override=False,
):
"""Set Args based on Release Track."""
# GA Args
parser.display_info.AddFormat(flags.LIST_FORMAT)
sources_group = parser.add_mutually_exclusive_group(required=True)
flags.AddCommonArgs(parser, support_user_licenses=support_user_licenses)
flags.AddCommonSourcesArgs(parser, sources_group)
Create.DISK_IMAGE_ARG = flags.MakeDiskImageArg()
Create.DISK_IMAGE_ARG.AddArgument(parser, operation_type='create')
csek_utils.AddCsekKeyArgs(parser, resource_type='image')
labels_util.AddCreateLabelsFlags(parser)
flags.MakeForceArg().AddToParser(parser)
flags.AddCloningImagesArgs(parser, sources_group)
flags.AddCreatingImageFromSnapshotArgs(parser, sources_group)
image_utils.AddGuestOsFeaturesArg(parser, messages)
image_utils.AddArchitectureArg(parser, messages)
kms_resource_args.AddKmsKeyResourceArg(parser, 'image')
flags.AddSourceDiskProjectFlag(parser)
# Alpha and Beta Args
if supports_force_create:
# Deprecated as of Aug 2017.
flags.MakeForceCreateArg().AddToParser(parser)
parser.add_argument(
'--storage-location',
metavar='LOCATION',
help="""\
Specifies a Cloud Storage location, either regional or multi-regional,
where image content is to be stored. If not specified, the multi-region
location closest to the source is chosen automatically.
""")
parser.add_argument(
'--locked',
action='store_true',
default=None,
hidden=True,
help="""\
Specifies that any boot disk created from this image can't be used
for data backup operations such as snapshot creation, image creation,
instance snapshot creation, and disk cloning.
If a VM instance is created using this image, the boot disk is fixed
to this VM. The disk can't be attached to any other VMs, whether in
`read-write` mode or in `read-only` mode. Also, any VM created from this
disk, has the following characteristics:
* The VM can't be used for creating machine images or instance templates
* After the VM is created, you can't attach any secondary disk
* After the VM is deleted, the attached boot disk can't be retained
""")
# Alpha args
spec = {
'default_rollout_time': str,
'location_rollout_policies': arg_parsers.ArgDict(),
}
if supports_rollout_override:
parser.add_argument(
'--rollout-override',
type=arg_parsers.ArgDict(spec=spec),
help="""\
A rollout policy for the image. A rollout policy is used to restrict
the zones where this image is accessible when using a zonal image
family reference. When specified, the rollout policy overrides per-zone
references to the image through the associated image family. When the
rollout policy does not include the user specified zone, or if the zone
is rolled out, this image is accessible.
default_rollout_time
This is an optional RFC3339 timestamp on or after which
the update is considered rolled out to any zone that is not
explicitly stated.
location_rollout_policies
Location based rollout policies to apply to the resource.
Currently only zone names are supported as the key and must be
represented as valid URLs, like: zones/us-central1-a.
The value expects an RFC3339 timestamp on or after which the update
is considered rolled out to the specified location.
""",
)
compute_flags.AddShieldedInstanceInitialStateKeyArg(parser)
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.GA)
class Create(base.CreateCommand):
"""Create Compute Engine images."""
@classmethod
def Args(cls, parser):
messages = cls._GetApiHolder(no_http=True).client.messages
_Args(parser, messages)
parser.display_info.AddCacheUpdater(flags.ImagesCompleter)
@classmethod
def _GetApiHolder(cls, no_http=False):
return base_classes.ComputeApiHolder(cls.ReleaseTrack(), no_http)
def Run(self, args):
return self._Run(args)
def _Run(
self, args, support_user_licenses=False, supports_rollout_override=False
):
"""Returns a list of requests necessary for adding images."""
holder = self._GetApiHolder()
client = holder.client
messages = client.messages
resource_parser = holder.resources
image_ref = Create.DISK_IMAGE_ARG.ResolveAsResource(args, holder.resources)
image = messages.Image(
name=image_ref.image,
description=args.description,
sourceType=messages.Image.SourceTypeValueValuesEnum.RAW,
family=args.family)
if args.IsSpecified('architecture'):
image.architecture = messages.Image.ArchitectureValueValuesEnum(
args.architecture)
if support_user_licenses and args.IsSpecified('user_licenses'):
image.userLicenses = args.user_licenses
csek_keys = csek_utils.CsekKeyStore.FromArgs(args, True)
if csek_keys:
image.imageEncryptionKey = csek_utils.MaybeToMessage(
csek_keys.LookupKey(image_ref,
raise_if_missing=args.require_csek_key_create),
client.apitools_client)
image.imageEncryptionKey = kms_utils.MaybeGetKmsKey(
args, messages, image.imageEncryptionKey)
if supports_rollout_override and args.IsSpecified('rollout_override'):
location_rollout_policies = None
if 'location_rollout_policies' in args.rollout_override:
location_rollout_policies = messages.RolloutPolicy.LocationRolloutPoliciesValue(
additionalProperties=[
messages.RolloutPolicy.LocationRolloutPoliciesValue.AdditionalProperty(
key=k, value=v
)
for k, v in args.rollout_override[
'location_rollout_policies'
].items()
]
)
default_rollout_time = args.rollout_override.get('default_rollout_time')
image.rolloutOverride = messages.RolloutPolicy(
locationRolloutPolicies=location_rollout_policies,
defaultRolloutTime=default_rollout_time,
)
# Validate parameters.
if args.source_disk_zone and not args.source_disk:
raise exceptions.InvalidArgumentException(
'--source-disk-zone',
'You cannot specify [--source-disk-zone] unless you are specifying '
'[--source-disk].')
if args.source_disk_project and not args.source_disk:
raise exceptions.InvalidArgumentException(
'source_disk_project',
'You cannot specify [source_disk_project] unless you are '
'specifying [--source_disk].')
source_image_project = args.source_image_project
source_image = args.source_image
source_image_family = args.source_image_family
if source_image_project and not (source_image or source_image_family):
raise exceptions.InvalidArgumentException(
'--source-image-project',
'You cannot specify [--source-image-project] unless you are '
'specifying [--source-image] or [--source-image-family].')
if source_image or source_image_family:
image_expander = image_utils.ImageExpander(client, resource_parser)
_, source_image_ref = image_expander.ExpandImageFlag(
user_project=image_ref.project,
image=source_image,
image_family=source_image_family,
image_project=source_image_project,
return_image_resource=True)
image.sourceImage = source_image_ref.selfLink
image.sourceImageEncryptionKey = csek_utils.MaybeLookupKeyMessage(
csek_keys, source_image_ref, client.apitools_client)
if args.source_uri:
# For AR URIs, resources.REGISTRY.Parse will fail. In this case,
# we pass the URI to the API as is.
# The two formats for artifact registry path are:
# projects/<project>/locations/<locations>/repositories/<repo>/packages/<package>/versions/<name>
# projects/<project>/locations/<locations>/repositories/<repo>/packages/<package>/versions/<version_id>@dirsum_sha256:<hex_value>
ar_uri_regex = r'projects/[^/]+/locations/[^/]+/repositories/.*'
if re.match(ar_uri_regex, args.source_uri):
source_uri = args.source_uri
else:
source_uri = six.text_type(resources.REGISTRY.Parse(args.source_uri))
image.rawDisk = messages.Image.RawDiskValue(source=source_uri)
elif args.source_disk:
source_disk_ref = flags.SOURCE_DISK_ARG.ResolveAsResource(
args,
holder.resources,
scope_lister=compute_flags.GetDefaultScopeLister(client),
source_project=args.source_disk_project)
image.sourceDisk = source_disk_ref.SelfLink()
image.sourceDiskEncryptionKey = csek_utils.MaybeLookupKeyMessage(
csek_keys, source_disk_ref, client.apitools_client)
elif hasattr(args, 'source_snapshot') and args.source_snapshot:
source_snapshot_ref = flags.SOURCE_SNAPSHOT_ARG.ResolveAsResource(
args,
holder.resources,
scope_lister=compute_flags.GetDefaultScopeLister(client))
image.sourceSnapshot = source_snapshot_ref.SelfLink()
image.sourceSnapshotEncryptionKey = csek_utils.MaybeLookupKeyMessage(
csek_keys, source_snapshot_ref, client.apitools_client)
if args.licenses:
image.licenses = args.licenses
guest_os_features = getattr(args, 'guest_os_features', [])
if guest_os_features:
guest_os_feature_messages = []
for feature in guest_os_features:
gf_type = messages.GuestOsFeature.TypeValueValuesEnum(feature)
guest_os_feature = messages.GuestOsFeature()
guest_os_feature.type = gf_type
guest_os_feature_messages.append(guest_os_feature)
image.guestOsFeatures = guest_os_feature_messages
initial_state, has_set = image_utils.CreateInitialStateConfig(
args, messages
)
if has_set:
image.shieldedInstanceInitialState = initial_state
if args.IsSpecified('storage_location'):
image.storageLocations = [args.storage_location]
if hasattr(image, 'locked'):
image.locked = args.locked
request = messages.ComputeImagesInsertRequest(
image=image,
project=image_ref.project)
args_labels = getattr(args, 'labels', None)
if args_labels:
labels = messages.Image.LabelsValue(additionalProperties=[
messages.Image.LabelsValue.AdditionalProperty(
key=key, value=value)
for key, value in sorted(six.iteritems(args_labels))])
request.image.labels = labels
# --force is in GA, --force-create is in beta and deprecated.
if args.force or getattr(args, 'force_create', None):
request.forceCreate = True
return client.MakeRequests([(client.apitools_client.images, 'Insert',
request)], timeout=POLL_TIMEOUT)
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class CreateBeta(Create):
"""Create Compute Engine images."""
@classmethod
def Args(cls, parser):
messages = cls._GetApiHolder(no_http=True).client.messages
_Args(
parser,
messages,
supports_force_create=True,
support_user_licenses=True,
supports_rollout_override=False,
)
parser.display_info.AddCacheUpdater(flags.ImagesCompleter)
def Run(self, args):
return self._Run(args, support_user_licenses=True)
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class CreateAlpha(Create):
"""Create Compute Engine images."""
@classmethod
def Args(cls, parser):
messages = cls._GetApiHolder(no_http=True).client.messages
_Args(
parser,
messages,
supports_force_create=True,
support_user_licenses=True,
supports_rollout_override=True,
)
parser.display_info.AddCacheUpdater(flags.ImagesCompleter)
def Run(self, args):
return self._Run(
args, support_user_licenses=True, supports_rollout_override=True
)
Create.detailed_help = {
'brief':
'Create Compute Engine images',
'DESCRIPTION':
"""\
*{command}* is used to create custom disk images.
The resulting image can be provided during instance or disk creation
so that the instance attached to the resulting disks has access
to a known set of software or files from the image.
Images can be created from gzipped compressed tarball containing raw
disk data, existing disks in any zone, existing images, and existing
snapshots inside the same project.
Images are global resources, so they can be used across zones and
projects.
To learn more about creating image tarballs, visit
[](https://cloud.google.com/compute/docs/creating-custom-image).
""",
'EXAMPLES':
"""\
To create an image 'my-image' from a disk 'my-disk' in zone 'us-east1-a', run:
$ {command} my-image --source-disk=my-disk --source-disk-zone=us-east1-a
To create an image 'my-image' from a disk 'my-disk' in zone 'us-east1-a' with source
disk project 'source-disk-project' run:
$ {command} my-image --source-disk=my-disk --source-disk-zone=us-east1-a --source-disk-project=source-disk-project
To create an image 'my-image' from another image 'source-image'
with source image project 'source-image-project', run:
$ {command} my-image --source-image=source-image --source-image-project=source-image-project
To create an image 'my-image' from the latest non-deprecated image in the family 'source-image-family'
with source image project 'source-image-project', run:
$ {command} my-image --source-image-family=source-image-family --source-image-project=source-image-project
To create an image 'my-image' from a snapshot 'source-snapshot', run:
$ {command} my-image --source-snapshot=source-snapshot
""",
}
CreateBeta.detailed_help = Create.detailed_help