File: //snap/google-cloud-cli/current/lib/surface/run/jobs/update.py
# -*- coding: utf-8 -*- #
# Copyright 2022 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.
"""Update a Cloud Run Job."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.run import config_changes
from googlecloudsdk.command_lib.run import connection_context
from googlecloudsdk.command_lib.run import container_parser
from googlecloudsdk.command_lib.run import exceptions
from googlecloudsdk.command_lib.run import flags
from googlecloudsdk.command_lib.run import messages_util
from googlecloudsdk.command_lib.run import pretty_print
from googlecloudsdk.command_lib.run import resource_args
from googlecloudsdk.command_lib.run import serverless_operations
from googlecloudsdk.command_lib.run import stages
from googlecloudsdk.command_lib.util.concepts import concept_parsers
from googlecloudsdk.command_lib.util.concepts import presentation_specs
from googlecloudsdk.core import log
from googlecloudsdk.core.console import progress_tracker
def ContainerArgGroup(release_track=base.ReleaseTrack.GA):
"""Returns an argument group with all per-container update args."""
help_text = """
Container Flags
If the --container or --remove-containers flag is specified the following
arguments may only be specified after a --container flag.
"""
group = base.ArgumentGroup(help=help_text)
group.AddArgument(
flags.ImageArg(
image='us-docker.pkg.dev/cloudrun/container/job:latest',
required=False,
)
)
group.AddArgument(flags.MutexEnvVarsFlags(release_track=release_track))
group.AddArgument(flags.MemoryFlag())
group.AddArgument(flags.CpuFlag())
group.AddArgument(flags.GpuFlag())
group.AddArgument(flags.ArgsFlag())
group.AddArgument(flags.SecretsFlags())
group.AddArgument(flags.CommandFlag())
group.AddArgument(flags.DependsOnFlag())
group.AddArgument(flags.AddVolumeMountFlag())
group.AddArgument(flags.RemoveVolumeMountFlag())
group.AddArgument(flags.ClearVolumeMountsFlag())
group.AddArgument(flags.StartupProbeFlag())
return group
@base.UniverseCompatible
@base.ReleaseTracks(base.ReleaseTrack.GA)
class Update(base.Command):
"""Update a Cloud Run Job."""
detailed_help = {
'DESCRIPTION': """\
Updates a Cloud Run job.
""",
'EXAMPLES': """\
To update the container image of Cloud Run job `my-job`:
$ {command} my-job --image=us-docker.pkg.dev/project/image
""",
}
@classmethod
def CommonArgs(cls, parser):
# Flags not specific to any platform
job_presentation = presentation_specs.ResourcePresentationSpec(
'JOB',
resource_args.GetJobResourceSpec(prompt=True),
'Job to update.',
required=True,
prefixes=False,
)
flags.AddLabelsFlags(parser)
flags.AddParallelismFlag(parser)
flags.AddTasksFlag(parser)
flags.AddMaxRetriesFlag(parser)
flags.AddTaskTimeoutFlags(parser)
flags.AddServiceAccountFlag(parser)
flags.AddCloudSQLFlags(parser)
flags.AddVpcConnectorArgs(parser)
flags.AddVpcNetworkGroupFlagsForUpdate(parser, resource_kind='job')
flags.AddEgressSettingsFlag(parser)
flags.AddClientNameAndVersionFlags(parser)
flags.AddBinAuthzPolicyFlags(parser, with_clear=True)
flags.AddBinAuthzBreakglassFlag(parser)
flags.AddCmekKeyFlag(parser, with_clear=False)
flags.AddSandboxArg(parser, hidden=True)
flags.AddGeneralAnnotationFlags(parser)
flags.AddVolumesFlags(parser, cls.ReleaseTrack())
flags.AddGpuTypeFlag(parser)
flags.GpuZonalRedundancyFlag(parser)
polling_group = parser.add_mutually_exclusive_group()
flags.AddAsyncFlag(polling_group)
execute_group = polling_group.add_argument_group(
help='--async cannot be used if executing the job after the update.')
flags.AddWaitForCompletionFlag(execute_group, implies_execute_now=True)
flags.AddExecuteNowFlag(execute_group)
concept_parsers.ConceptParser([job_presentation]).AddToParser(parser)
# No output by default, can be overridden by --format
parser.display_info.AddFormat('none')
@staticmethod
def Args(parser):
Update.CommonArgs(parser)
container_args = ContainerArgGroup()
container_parser.AddContainerFlags(parser, container_args)
flags.RemoveContainersFlag().AddToParser(parser)
def Run(self, args):
"""Update a Job on Cloud Run."""
job_ref = args.CONCEPTS.job.Parse()
flags.ValidateResource(job_ref)
conn_context = connection_context.GetConnectionContext(
args, flags.Product.RUN, self.ReleaseTrack()
)
changes = flags.GetJobConfigurationChanges(
args,
release_track=self.ReleaseTrack())
changes.append(
config_changes.SetLaunchStageAnnotationChange(self.ReleaseTrack())
)
execute_now = args.execute_now or args.wait
with serverless_operations.Connect(conn_context) as operations:
pretty_print.Info(
messages_util.GetStartDeployMessage(
conn_context, job_ref, 'Updating', 'job'
)
)
if execute_now:
header_msg = 'Updating and running job...'
else:
header_msg = 'Updating job...'
def _UpdateJob(changes_):
with progress_tracker.StagedProgressTracker(
header_msg,
stages.JobStages(
execute_now=execute_now, include_completion=args.wait
),
failure_message='Job failed to deploy',
suppress_output=args.async_,
) as tracker:
execution_ = None
job_ = operations.UpdateJob(
job_ref, changes_, tracker, asyn=args.async_
)
if execute_now:
execution_ = operations.RunJob(
job_ref, tracker, args.wait, args.async_, self.ReleaseTrack()
)
return job_, execution_
try:
job, execution = _UpdateJob(changes)
except exceptions.HttpError as e:
if flags.ShouldRetryNoZonalRedundancy(args, str(e)):
changes.append(
config_changes.GpuZonalRedundancyChange(
gpu_zonal_redundancy=False
)
)
job, execution = _UpdateJob(changes)
else:
raise e
if args.async_ and not execute_now:
pretty_print.Success(
'Job [{{bold}}{job}{{reset}}] is being updated '
'asynchronously.'.format(job=job.name)
)
else:
operation = 'been updated'
if args.wait:
operation += ' and completed execution [{}]'.format(execution.name)
elif execute_now:
operation += ' and started running execution [{}]'.format(
execution.name
)
pretty_print.Success(
'Job [{{bold}}{job}{{reset}}] has successfully {operation}.'.format(
job=job.name, operation=operation
)
)
msg = ''
if execute_now:
msg += messages_util.GetExecutionCreatedMessage(
self.ReleaseTrack(), execution
)
msg += '\n'
msg += messages_util.GetRunJobMessage(
self.ReleaseTrack(), job.name, repeat=execute_now
)
log.status.Print(msg)
return job
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class BetaUpdate(Update):
"""Update a Cloud Run Job."""
@classmethod
def Args(cls, parser):
cls.CommonArgs(parser)
container_args = ContainerArgGroup(release_track=base.ReleaseTrack.BETA)
container_parser.AddContainerFlags(
parser, container_args, cls.ReleaseTrack()
)
flags.RemoveContainersFlag().AddToParser(parser)
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class AlphaUpdate(BetaUpdate):
"""Update a Cloud Run Job."""
@classmethod
def Args(cls, parser):
cls.CommonArgs(parser)
container_args = ContainerArgGroup(release_track=base.ReleaseTrack.ALPHA)
container_parser.AddContainerFlags(
parser, container_args, cls.ReleaseTrack()
)
flags.RemoveContainersFlag().AddToParser(parser)
flags.AddRuntimeFlag(parser)