def _PerformRollback(self, deployment_name, error_message):
# Print information about the failure.
log.warn('There was an error deploying '
+ deployment_name + ':\n' + error_message)
log.status.Print('`--automatic-rollback-on-error` flag was supplied; '
'deleting failed deployment...')
# Delete the deployment.
try:
delete_operation = self.client.deployments.Delete(
self.messages.DeploymentmanagerDeploymentsDeleteRequest(
project=dm_base.GetProject(),
deployment=deployment_name,
)
)
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error, dm_api_util.HTTP_ERROR_FORMAT)
# TODO(b/37481635): Use gcloud default operation polling.
dm_write.WaitForOperation(self.client,
self.messages,
delete_operation.name,
'delete',
dm_base.GetProject(),
timeout=OPERATION_TIMEOUT)
completed_operation = dm_api_util.GetOperation(self.client,
self.messages,
delete_operation,
dm_base.GetProject())
return completed_operation
def Run(self, args):
"""Run 'deployments describe'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The requested Deployment.
Raises:
HttpException: An http error response was received while executing api
request.
"""
deployment_ref = self.resources.Parse(
args.deployment_name,
params={'project': properties.VALUES.core.project.GetOrFail},
collection='deploymentmanager.deployments')
try:
deployment = self.client.deployments.Get(
self.messages.DeploymentmanagerDeploymentsGetRequest(
project=dm_base.GetProject(),
deployment=deployment_ref.deployment))
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
try:
response = self.client.resources.List(
self.messages.DeploymentmanagerResourcesListRequest(
project=dm_base.GetProject(), deployment=deployment.name))
resources = response.resources
if self.ReleaseTrack() is base.ReleaseTrack.ALPHA:
dm_api_util.UpdateActionResourceIntent(resources)
if (not args.IsSpecified('format')) and (deployment.update):
args.format = (
alpha_flags.
PREVIEWED_DEPLOYMENT_AND_RESOURCES_AND_OUTPUTS_FORMAT)
except apitools_exceptions.HttpError:
# Couldn't get resources, skip adding them to the table.
resources = None
outputs = []
manifest = dm_api_util.ExtractManifestName(deployment)
if manifest:
manifest_response = self.client.manifests.Get(
self.messages.DeploymentmanagerManifestsGetRequest(
project=dm_base.GetProject(),
deployment=deployment_ref.deployment,
manifest=manifest,
))
# We might be lacking a layout if the manifest failed expansion.
if manifest_response.layout:
outputs = dm_api_util.FlattenLayoutOutputs(
manifest_response.layout)
return _Results(deployment, resources, outputs)
def Run(self, args):
"""Run 'operations wait'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Raises:
HttpException: An http error response was received while executing api
request.
Raises:
OperationError: Operation finished with error(s) or timed out.
"""
failed_ops = []
for operation_name in args.operation_name:
try:
dm_write.WaitForOperation(self.client,
self.messages,
operation_name,
'',
dm_base.GetProject(),
timeout=OPERATION_TIMEOUT)
except exceptions.OperationError:
failed_ops.append(operation_name)
if failed_ops:
if len(failed_ops) == 1:
raise exceptions.OperationError(
'Operation %s failed to complete or has errors.' %
failed_ops[0])
else:
raise exceptions.OperationError(
'Some operations failed to complete without errors:\n' +
'\n'.join(failed_ops))
else:
log.status.Print('All operations completed successfully.')
def _isDeploymentInPreview(self, args):
deployment = dm_api_util.FetchDeployment(self.client, self.messages,
dm_base.GetProject(),
args.deployment)
if deployment.update:
return True
return False
def Run(self, args):
"""Run 'resources list'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The list of resources for the specified deployment.
Raises:
HttpException: An http error response was received while executing api
request.
"""
request = dm_v2_base.GetMessages(
).DeploymentmanagerResourcesListRequest(
project=dm_base.GetProject(),
deployment=args.deployment,
)
return dm_api_util.YieldWithHttpExceptions(
list_pager.YieldFromList(dm_v2_base.GetClient().resources,
request,
field='resources',
limit=args.limit,
batch_size=args.page_size))
def Run(self, args):
"""Run 'deployments describe'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The requested Deployment.
Raises:
HttpException: An http error response was received while executing api
request.
"""
try:
deployment = self.client.deployments.Get(
self.messages.DeploymentmanagerDeploymentsGetRequest(
project=dm_base.GetProject(), deployment=args.deployment_name))
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error, dm_api_util.HTTP_ERROR_FORMAT)
try:
response = self.client.resources.List(
self.messages.DeploymentmanagerResourcesListRequest(
project=dm_base.GetProject(), deployment=deployment.name))
resources = response.resources
except apitools_exceptions.HttpError:
# Couldn't get resources, skip adding them to the table.
resources = None
outputs = []
manifest = dm_api_util.ExtractManifestName(deployment)
if manifest:
manifest_response = self.client.manifests.Get(
self.messages.DeploymentmanagerManifestsGetRequest(
project=dm_base.GetProject(),
deployment=args.deployment_name,
manifest=manifest,
)
)
# We might be lacking a layout if the manifest failed expansion.
if manifest_response.layout:
outputs = dm_api_util.FlattenLayoutOutputs(manifest_response.layout)
return _Results(deployment, resources, outputs)
def Run(self, args):
"""Run 'manifests describe'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The requested manifest.
Raises:
HttpException: An http error response was received while executing api
request.
"""
manifest = args.manifest
if not manifest:
try:
deployment = self.client.deployments.Get(
self.messages.DeploymentmanagerDeploymentsGetRequest(
project=dm_base.GetProject(),
deployment=args.deployment
)
)
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error)
manifest = dm_api_util.ExtractManifestName(deployment)
if not manifest:
raise dm_exceptions.ManifestError(
'The deployment [%s] does not have a current manifest. '
'Please specify the manifest name.' % args.deployment)
try:
return self.client.manifests.Get(
self.messages.DeploymentmanagerManifestsGetRequest(
project=dm_base.GetProject(),
deployment=args.deployment,
manifest=manifest,
)
)
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error, dm_api_util.HTTP_ERROR_FORMAT)
def Run(self, args):
"""Run 'manifests describe'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The requested manifest.
Raises:
HttpException: An http error response was received while executing api
request.
"""
if not args.manifest:
try:
deployment = dm_v2_base.GetClient().deployments.Get(
dm_v2_base.GetMessages().DeploymentmanagerDeploymentsGetRequest(
project=dm_base.GetProject(),
deployment=args.deployment
)
)
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error)
manifest = dm_api_util.ExtractManifestName(deployment)
if manifest:
args.manifest = manifest
try:
return dm_v2_base.GetClient().manifests.Get(
dm_v2_base.GetMessages().DeploymentmanagerManifestsGetRequest(
project=dm_base.GetProject(),
deployment=args.deployment,
manifest=args.manifest,
)
)
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error, dm_api_util.HTTP_ERROR_FORMAT)
def project(self):
""" Sets the project for the config
This is a bit complicated but allows for quite a bit of
flexibility. The project can be defined in a few different
places, and this is the order on precedence:
1- Command line
2- Config file
3- CLOUD_FOUNDATION_PROJECT_ID environment variable
4- The GCP SDK configuration
"""
if not hasattr(self, '_project'):
self._project = self.as_dict.get('project') or \
os.environ.get('CLOUD_FOUNDATION_PROJECT_ID') or \
dm_base.GetProject()
return self._project
def _YieldPrintableResourcesOnErrors(self, args):
request = self.messages.DeploymentmanagerResourcesListRequest(
project=dm_base.GetProject(),
deployment=args.deployment,
)
paginated_resources = dm_api_util.YieldWithHttpExceptions(
list_pager.YieldFromList(self.client.resources,
request,
field='resources',
limit=args.limit,
batch_size=args.page_size))
for resource in paginated_resources:
if resource.update:
resource.update.intent = dm_api_util.GetActionResourceIntent(
resource.update.intent, resource.update.runtimePolicies)
yield resource
def Run(self, args):
"""Run 'operations list'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The list of operations for this project.
Raises:
HttpException: An http error response was received while executing api
request.
"""
request = self.messages.DeploymentmanagerOperationsListRequest(
project=dm_base.GetProject(),
)
return dm_api_util.YieldWithHttpExceptions(list_pager.YieldFromList(
self.client.operations, request, field='operations',
limit=args.limit, batch_size=args.page_size))
def Run(self, args):
"""Run 'resources describe'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The requested resource.
Raises:
HttpException: An http error response was received while executing api
request.
"""
try:
return self.client.resources.Get(
self.messages.DeploymentmanagerResourcesGetRequest(
project=dm_base.GetProject(),
deployment=args.deployment,
resource=args.resource))
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
def Run(self, args):
"""Run 'operations describe'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The requested operation.
Raises:
HttpException: An http error response was received while executing api
request.
"""
try:
return dm_v2_base.GetClient().operations.Get(
dm_v2_base.GetMessages().DeploymentmanagerOperationsGetRequest(
project=dm_base.GetProject(),
operation=args.operation_name,
))
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
def Run(self, args):
"""Run 'deployments cancel-preview'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
If --async=true, returns Operation to poll.
Else, returns boolean indicating whether cancel preview operation
succeeded.
Raises:
HttpException: An http error response was received while executing api
request.
"""
if args.fingerprint:
fingerprint = dm_util.DecodeFingerprint(args.fingerprint)
else:
# If no fingerprint is present, default to an empty fingerprint.
# TODO(b/34966984): Remove the empty default after cleaning up all
# deployments that has no fingerprint
fingerprint = dm_api_util.FetchDeploymentFingerprint(
self.client,
self.messages,
dm_base.GetProject(),
args.deployment_name,
) or ''
try:
operation = self.client.deployments.CancelPreview(
self.messages.DeploymentmanagerDeploymentsCancelPreviewRequest(
project=dm_base.GetProject(),
deployment=args.deployment_name,
deploymentsCancelPreviewRequest=self.messages.
DeploymentsCancelPreviewRequest(fingerprint=fingerprint, ),
))
# Fetch and print the latest fingerprint of the deployment.
new_fingerprint = dm_api_util.FetchDeploymentFingerprint(
self.client, self.messages, dm_base.GetProject(),
args.deployment_name)
dm_util.PrintFingerprint(new_fingerprint)
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
if args. async:
return operation
else:
op_name = operation.name
try:
dm_write.WaitForOperation(self.client,
self.messages,
op_name,
'cancel-preview',
dm_base.GetProject(),
timeout=OPERATION_TIMEOUT)
log.status.Print('Cancel preview operation ' + op_name +
' completed successfully.')
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
try:
# Fetch a list of the canceled resources.
response = self.client.resources.List(
self.messages.DeploymentmanagerResourcesListRequest(
project=dm_base.GetProject(),
deployment=args.deployment_name,
))
# TODO(b/36052523): Pagination
return response.resources if response.resources else []
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
def Run(self, args):
"""Run 'deployments update'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
If --async=true, returns Operation to poll.
Else, returns a struct containing the list of resources and list of
outputs in the deployment.
Raises:
HttpException: An http error response was received while executing api
request.
"""
deployment_ref = self.resources.Parse(
args.deployment_name,
params={'project': properties.VALUES.core.project.GetOrFail},
collection='deploymentmanager.deployments')
if not args.IsSpecified('format') and args. async:
args.format = flags.OPERATION_FORMAT
patch_request = False
deployment = self.messages.Deployment(name=deployment_ref.deployment, )
if not (args.config is None and args.template is None
and args.composite_type is None):
deployment.target = importer.BuildTargetConfig(
self.messages,
config=args.config,
template=args.template,
composite_type=args.composite_type,
properties=args.properties)
elif (self.ReleaseTrack()
in [base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA]
and args.manifest_id):
deployment.target = importer.BuildTargetConfigFromManifest(
self.client, self.messages, dm_base.GetProject(),
deployment_ref.deployment, args.manifest_id, args.properties)
# Get the fingerprint from the deployment to update.
try:
current_deployment = self.client.deployments.Get(
self.messages.DeploymentmanagerDeploymentsGetRequest(
project=dm_base.GetProject(),
deployment=deployment_ref.deployment))
if args.fingerprint:
deployment.fingerprint = dm_util.DecodeFingerprint(
args.fingerprint)
else:
# If no fingerprint is present, default to an empty fingerprint.
# TODO(b/34966984): Remove the empty default after cleaning up all
# deployments that has no fingerprint
deployment.fingerprint = current_deployment.fingerprint or b''
# Get the credential from the deployment to update.
if self.ReleaseTrack() in [base.ReleaseTrack.ALPHA
] and args.credential:
deployment.credential = dm_util.CredentialFrom(
self.messages, args.credential)
# Update the labels of the deployment
deployment.labels = self._GetUpdatedDeploymentLabels(
args, current_deployment)
# If no config or manifest_id are specified, but try to update labels,
# only add patch_request header when directly updating a non-previewed
# deployment
no_manifest = (self.ReleaseTrack() is
base.ReleaseTrack.GA) or not args.manifest_id
patch_request = not args.config and no_manifest and (bool(
args.update_labels) or bool(args.remove_labels))
if args.description is None:
deployment.description = current_deployment.description
elif not args.description or args.description.isspace():
deployment.description = None
else:
deployment.description = args.description
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
if patch_request:
args.format = flags.DEPLOYMENT_FORMAT
try:
# Necessary to handle API Version abstraction below
parsed_delete_flag = Update._delete_policy_flag_map.GetEnumForChoice(
args.delete_policy).name
if self.ReleaseTrack() in [
base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA
]:
parsed_create_flag = (
Update._create_policy_v2beta_flag_map.GetEnumForChoice(
args.create_policy).name)
else:
parsed_create_flag = (
Update._create_policy_flag_map.GetEnumForChoice(
args.create_policy).name)
request = self.messages.DeploymentmanagerDeploymentsUpdateRequest(
deploymentResource=deployment,
project=dm_base.GetProject(),
deployment=deployment_ref.deployment,
preview=args.preview,
createPolicy=(
self.messages.DeploymentmanagerDeploymentsUpdateRequest.
CreatePolicyValueValuesEnum(parsed_create_flag)),
deletePolicy=(
self.messages.DeploymentmanagerDeploymentsUpdateRequest.
DeletePolicyValueValuesEnum(parsed_delete_flag)))
client = self.client
client.additional_http_headers['X-Cloud-DM-Patch'] = patch_request
operation = client.deployments.Update(request)
# Fetch and print the latest fingerprint of the deployment.
updated_deployment = dm_api_util.FetchDeployment(
self.client, self.messages, dm_base.GetProject(),
deployment_ref.deployment)
if patch_request:
if args. async:
log.warning(
'Updating Deployment metadata is synchronous, --async flag '
'is ignored.')
log.status.Print(
'Update deployment metadata completed successfully.')
return updated_deployment
dm_util.PrintFingerprint(updated_deployment.fingerprint)
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
if args. async:
return operation
else:
op_name = operation.name
try:
operation = dm_write.WaitForOperation(
self.client,
self.messages,
op_name,
'update',
dm_base.GetProject(),
timeout=OPERATION_TIMEOUT)
dm_util.LogOperationStatus(operation, 'Update')
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
return dm_api_util.FetchResourcesAndOutputs(
self.client, self.messages, dm_base.GetProject(),
deployment_ref.deployment,
self.ReleaseTrack() is base.ReleaseTrack.ALPHA)
def Run(self, args):
"""Run 'deployments delete'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
If --async=true, returns Operation to poll.
Else, returns boolean indicating whether insert operation succeeded.
Raises:
HttpException: An http error response was received while executing api
request.
"""
prompt_message = ('The following deployments will be deleted:\n- '
+ '\n- '.join(args.deployment_name))
if not args.quiet:
if not console_io.PromptContinue(message=prompt_message, default=False):
raise exceptions.OperationError('Deletion aborted by user.')
operations = []
errors = []
for deployment_name in args.deployment_name:
deployment_ref = self.resources.Parse(
deployment_name,
params={'project': properties.VALUES.core.project.GetOrFail},
collection='deploymentmanager.deployments')
try:
operation = self.client.deployments.Delete(
self.messages.DeploymentmanagerDeploymentsDeleteRequest(
project=dm_base.GetProject(),
deployment=deployment_ref.deployment,
deletePolicy=(Delete._delete_policy_flag_map.
GetEnumForChoice(args.delete_policy)),
)
)
if args.async:
operations.append(operation)
else:
op_name = operation.name
try:
# TODO(b/62720778): Refactor to use waiter.CloudOperationPoller
operation = dm_write.WaitForOperation(
self.client,
self.messages,
op_name,
'delete',
dm_base.GetProject(),
timeout=OPERATION_TIMEOUT)
dm_util.LogOperationStatus(operation, 'Delete')
except exceptions.OperationError as e:
errors.append(exceptions.OperationError(
u'Delete operation {0} failed.\n{1}'.format(op_name, e)))
completed_operation = self.client.operations.Get(
self.messages.DeploymentmanagerOperationsGetRequest(
project=dm_base.GetProject(),
operation=op_name,
)
)
operations.append(completed_operation)
except apitools_exceptions.HttpError as error:
errors.append(api_exceptions.HttpException(
error, dm_api_util.HTTP_ERROR_FORMAT))
if errors:
raise core_exceptions.MultiError(errors)
return operations
def Run(self, args):
"""Run 'deployments stop'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
If --async=true, returns Operation to poll.
Else, returns boolean indicating whether stop operation succeeded.
Raises:
HttpException: An http error response was received while executing api
request.
"""
if args.fingerprint:
fingerprint = dm_util.DecodeFingerprint(args.fingerprint)
else:
# If no fingerprint is present, default to an empty fingerprint.
# TODO(b/34966984): Remove the empty default after cleaning up all
# deployments that has no fingerprint
fingerprint = dm_api_util.FetchDeploymentFingerprint(
self.client, self.messages, dm_base.GetProject(),
args.deployment_name) or b''
try:
operation = self.client.deployments.Stop(
self.messages.DeploymentmanagerDeploymentsStopRequest(
project=dm_base.GetProject(),
deployment=args.deployment_name,
deploymentsStopRequest=(
self.messages.DeploymentsStopRequest(
fingerprint=fingerprint)),
))
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
if args. async:
return operation
else:
op_name = operation.name
try:
operation = dm_write.WaitForOperation(
self.client,
self.messages,
op_name,
'stop',
dm_base.GetProject(),
timeout=OPERATION_TIMEOUT)
dm_util.LogOperationStatus(operation, 'Stop')
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
try:
# Fetch a list of the stopped resources.
response = self.client.resources.List(
self.messages.DeploymentmanagerResourcesListRequest(
project=dm_base.GetProject(),
deployment=args.deployment_name,
))
# TODO(b/36055861): Pagination
return response.resources if response.resources else []
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error,
dm_api_util.HTTP_ERROR_FORMAT)
def Run(self, args):
"""Run 'deployments create'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
If --async=true, returns Operation to poll.
Else, returns a struct containing the list of resources and list of
outputs in the deployment.
Raises:
HttpException: An http error response was received while executing api
request.
ConfigError: Config file could not be read or parsed, or the
deployment creation operation encountered an error.
"""
deployment_ref = self.resources.Parse(
args.deployment_name,
params={'project': properties.VALUES.core.project.GetOrFail},
collection='deploymentmanager.deployments')
if (not args.IsSpecified('format')) and (args.async):
args.format = flags.OPERATION_FORMAT
deployment = self.messages.Deployment(
name=deployment_ref.deployment,
target=importer.BuildTargetConfig(self.messages,
config=args.config,
template=args.template,
composite_type=args.composite_type,
properties=args.properties)
)
self._SetMetadata(args, deployment)
try:
operation = self.client.deployments.Insert(
self.messages.DeploymentmanagerDeploymentsInsertRequest(
project=dm_base.GetProject(),
deployment=deployment,
preview=args.preview,
)
)
# Fetch and print the latest fingerprint of the deployment.
fingerprint = dm_api_util.FetchDeploymentFingerprint(
self.client,
self.messages,
dm_base.GetProject(),
deployment_ref.deployment)
dm_util.PrintFingerprint(fingerprint)
except apitools_exceptions.HttpError as error:
raise exceptions.HttpException(error, dm_api_util.HTTP_ERROR_FORMAT)
if args.async:
return operation
else:
op_name = operation.name
try:
dm_write.WaitForOperation(self.client,
self.messages,
op_name,
operation_description='create',
project=dm_base.GetProject(),
timeout=OPERATION_TIMEOUT)
log.status.Print('Create operation ' + op_name
+ ' completed successfully.')
except apitools_exceptions.HttpError as error:
# TODO(b/37911296): Use gcloud default error handling.
raise exceptions.HttpException(error, dm_api_util.HTTP_ERROR_FORMAT)
except dm_exceptions.OperationError as error:
response = self._HandleOperationError(error,
args,
operation,
dm_base.GetProject(),
deployment_ref)
if getattr(args, 'automatic_rollback', False):
args.format = flags.OPERATION_FORMAT
return response
return dm_api_util.FetchResourcesAndOutputs(
self.client, self.messages, dm_base.GetProject(),
deployment_ref.deployment,
self.ReleaseTrack() is base.ReleaseTrack.ALPHA)
