feat: Add new gcloud commands, API clients, and third-party libraries across various services.

This commit is contained in:
2026-01-01 20:26:35 +01:00
parent 5e23cbece0
commit a19e592eb7
25221 changed files with 8324611 additions and 0 deletions

View File

@@ -0,0 +1,28 @@
# -*- coding: utf-8 -*- #
# Copyright 2018 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.
"""The command group for Google Cloud Build's Workerpools."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.calliope import base
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA,
base.ReleaseTrack.GA)
class WorkerPools(base.Group):
"""Manage worker pools for Google Cloud Build."""
category = base.CI_CD_CATEGORY

View File

@@ -0,0 +1,169 @@
# -*- coding: utf-8 -*- #
# Copyright 2024 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.
"""Create worker pool command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.cloudbuild import cloudbuild_exceptions
from googlecloudsdk.api_lib.cloudbuild import workerpool_config
from googlecloudsdk.api_lib.cloudbuild.v2 import client_util as cloudbuild_v2_util
from googlecloudsdk.api_lib.cloudbuild.v2 import input_util
from googlecloudsdk.api_lib.util import waiter
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import exceptions
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
@base.UniverseCompatible
class CreateAlpha(base.CreateCommand):
"""Create a private pool for use by Cloud Build."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser.add_argument(
'--file',
required=True,
help='The YAML file to use as the worker pool configuration file.')
parser.add_argument(
'--region',
help='Region for Cloud Build.')
parser.add_argument(
'--generation',
default=2,
type=int,
help=('Generation of the worker pool.'),
)
parser.display_info.AddFormat("""
table(
name.segment(-1),
createTime.date('%Y-%m-%dT%H:%M:%S%Oz', undefined='-'),
state
)
""")
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
if args.generation == 1:
raise exceptions.InvalidArgumentException(
'--generation',
'for generation=1 please use the gcloud commands "gcloud builds'
' worker-pools create" or "gcloud builds worker-pools update"',
)
if args.generation == 2:
return _CreateWorkerPoolSecondGen(args)
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
def _CreateWorkerPoolSecondGen(args):
"""Creates a worker pool second generation.
Args:
args: an argparse namespace. All the arguments that were provided to the
create command invocation.
Returns:
A worker pool second generation resource.
"""
wp_region = args.region
if not wp_region:
wp_region = properties.VALUES.builds.region.GetOrFail()
client = cloudbuild_v2_util.GetClientInstance()
messages = client.MESSAGES_MODULE
try:
wpsg = workerpool_config.LoadWorkerpoolConfigFromPath(
args.file, messages.WorkerPoolSecondGen
)
# Public IP in primary network interface of VM has to be disabled when
# routing all the traffic to network attachment.
if (
wpsg.network is not None
and wpsg.network.privateServiceConnect is not None
and wpsg.network.privateServiceConnect.routeAllTraffic
and wpsg.network.publicIpAddressDisabled is None
):
wpsg.network.publicIpAddressDisabled = True
except cloudbuild_exceptions.ParseProtoException as err:
log.err.Print(
'\nFailed to parse configuration from file. If you'
' were a Private Preview user, note that the format for this'
' file has changed slightly for GA.\n')
raise err
yaml_data = input_util.LoadYamlFromPath(args.file)
workerpoolsecondgen_id = yaml_data['name']
# Get the workerpool second gen ref
wp_resource = resources.REGISTRY.Parse(
None,
collection='cloudbuild.projects.locations.workerPoolSecondGen',
api_version=cloudbuild_v2_util.GA_API_VERSION,
params={
'projectsId': properties.VALUES.core.project.Get(required=True),
'locationsId': wp_region,
'workerPoolSecondGenId': workerpoolsecondgen_id,
},
)
update_mask = cloudbuild_v2_util.MessageToFieldPaths(wpsg)
req = messages.CloudbuildProjectsLocationsWorkerPoolSecondGenPatchRequest(
name=wp_resource.RelativeName(),
workerPoolSecondGen=wpsg,
updateMask=','.join(update_mask),
allowMissing=True,
)
# Update worker pool second gen (or create if missing).
updated_op = client.projects_locations_workerPoolSecondGen.Patch(req)
op_resource = resources.REGISTRY.ParseRelativeName(
updated_op.name, collection='cloudbuild.projects.locations.operations'
)
updated_wp = waiter.WaitFor(
waiter.CloudOperationPoller(
client.projects_locations_workerPoolSecondGen,
client.projects_locations_operations,
),
op_resource,
'Applying {file} as worker pool second gen {name}'.format(
file=args.file, name=wp_resource.RelativeName()
),
)
return updated_wp

View File

@@ -0,0 +1,352 @@
# -*- coding: utf-8 -*- #
# Copyright 2018 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.
"""Create worker pool command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.cloudbuild import cloudbuild_exceptions
from googlecloudsdk.api_lib.cloudbuild import cloudbuild_util
from googlecloudsdk.api_lib.cloudbuild import workerpool_config
from googlecloudsdk.api_lib.compute import utils as compute_utils
from googlecloudsdk.api_lib.util import waiter
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import exceptions
from googlecloudsdk.command_lib.cloudbuild import workerpool_flags
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
@base.ReleaseTracks(base.ReleaseTrack.GA)
@base.UniverseCompatible
class Create(base.CreateCommand):
"""Create a worker pool for use by Google Cloud Build."""
detailed_help = {
'DESCRIPTION': '{description}',
'EXAMPLES': """\
To create a worker pool named `wp1` in region `us-central1`, run:
$ {command} wp1 --region=us-central1
To create a worker pool in project `p1` in region `us-central1` where workers are of machine type
`e2-standard-2` and are peered to the VPC network `projects/123/global/networks/default` within the IP range `192.168.0.0/28`
and have a disk size of 64GB, run:
$ {command} wp1 --project=p1 --region=us-central1 \
--peered-network=projects/123/global/networks/default \
--peered-network-ip-range=192.168.0.0/28
--worker-machine-type=e2-standard-2 \
--worker-disk-size=64GB
""",
}
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser = workerpool_flags.AddWorkerpoolCreateArgs(parser,
base.ReleaseTrack.GA)
parser.display_info.AddFormat("""
table(
name.segment(-1),
createTime.date('%Y-%m-%dT%H:%M:%S%Oz', undefined='-'),
state
)
""")
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
return _CreateWorkerPoolFirstGen(args, self.ReleaseTrack())
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class CreateBeta(Create):
"""Create a worker pool for use by Cloud Build."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser = workerpool_flags.AddWorkerpoolCreateArgs(parser,
base.ReleaseTrack.BETA)
parser.add_argument(
'--generation',
default=1,
type=int,
help=('Generation of the worker pool.'),
)
parser.display_info.AddFormat("""
table(
name.segment(-1),
createTime.date('%Y-%m-%dT%H:%M:%S%Oz', undefined='-'),
state
)
""")
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
if args.generation == 1:
return _CreateWorkerPoolFirstGen(args, self.ReleaseTrack())
if args.generation == 2:
raise exceptions.InvalidArgumentException(
'--generation',
'for generation=2 please use the gcloud command "gcloud builds'
' worker-pools apply" to create a worker pool',
)
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class CreateAlpha(Create):
"""Create a private pool for use by Cloud Build."""
detailed_help = {
'DESCRIPTION': '{description}',
'EXAMPLES': """\
* Private pools
To create a private pool named `pwp1` in region `us-central1`, run:
$ {command} pwp1 --region=us-central1
To create a private pool in project `p1` in region `us-central1` where workers are of machine type
`e2-standard-2` and are peered to the VPC network `projects/123/global/networks/default` within the IP range `192.168.0.0/28`
and have a disk size of 64GB, run:
$ {command} pwp1 --project=p1 --region=us-central1 --peered-network=projects/123/global/networks/default --peered-network-ip-range=192.168.0.0/28 --worker-machine-type=e2-standard-2 --worker-disk-size=64GB
To create a private pool in project `p1` in region `us-central1` where workers are of machine type
`e2-standard-2` and are peered to the network attachment
`projects/p1/regions/us-central1/networkAttachments/na`. The workers don't
have public IP address and all the traffic is routed to the network attachment.
$ {command} pwp1 --project=p1 --region=us-central1 \
--network-attachment=projects/p1/regions/us-central1/networkAttachments/na \
--route-all-traffic \
--disable-public-ip-address \
--worker-machine-type=e2-standard-2
""",
}
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser = workerpool_flags.AddWorkerpoolCreateArgs(parser,
base.ReleaseTrack.ALPHA)
parser.add_argument(
'--generation',
default=1,
type=int,
help=('Generation of the worker pool.'),
)
parser.display_info.AddFormat("""
table(
name.segment(-1),
createTime.date('%Y-%m-%dT%H:%M:%S%Oz', undefined='-'),
state
)
""")
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
if args.generation == 1:
return _CreateWorkerPoolFirstGen(args, self.ReleaseTrack())
if args.generation == 2:
raise exceptions.InvalidArgumentException(
'--generation',
'for generation=2 please use the gcloud command "gcloud builds'
' worker-pools apply" to create a worker pool',
)
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
def _CreateWorkerPoolFirstGen(args, release_track):
"""Creates a Worker Pool First Generation.
Args:
args: an argparse namespace. All the arguments that were provided to the
create command invocation.
release_track: The desired value of the enum
googlecloudsdk.calliope.base.ReleaseTrack.
Returns:
A Worker Pool First Generation resource.
"""
wp_name = args.WORKER_POOL
wp_region = args.region
if not wp_region:
wp_region = properties.VALUES.builds.region.GetOrFail()
client = cloudbuild_util.GetClientInstance(release_track)
messages = cloudbuild_util.GetMessagesModule(release_track)
# Get the workerpool proto from either the flags or the specified file.
wp = messages.WorkerPool()
if args.config_from_file is not None:
try:
wp = workerpool_config.LoadWorkerpoolConfigFromPath(
args.config_from_file, messages.WorkerPool
)
# Public IP in primary network interface of VM has to be disabled when
# routing all the traffic to network attachment.
config = wp.privatePoolV1Config
if (
release_track == base.ReleaseTrack.ALPHA
and config.privateServiceConnect is not None
and config.privateServiceConnect.routeAllTraffic
and config.privateServiceConnect.publicIpAddressDisabled is None
):
config.privateServiceConnect.publicIpAddressDisabled = True
except cloudbuild_exceptions.ParseProtoException as err:
log.err.Print(
'\nFailed to parse configuration from file. If you'
' were a Private Preview user, note that the format for this'
' file has changed slightly for GA.\n')
raise err
else:
wp.privatePoolV1Config = messages.PrivatePoolV1Config()
network_config = messages.NetworkConfig()
if args.peered_network is not None:
network_config.peeredNetwork = args.peered_network
if args.peered_network_ip_range is not None:
network_config.peeredNetworkIpRange = args.peered_network_ip_range
# All of the egress flags are mutually exclusive with each other.
if args.no_public_egress or (
release_track == base.ReleaseTrack.GA and args.no_external_ip
):
network_config.egressOption = (
messages.NetworkConfig.EgressOptionValueValuesEnum.NO_PUBLIC_EGRESS
)
wp.privatePoolV1Config.networkConfig = network_config
worker_config = messages.WorkerConfig()
if args.worker_machine_type is not None:
worker_config.machineType = args.worker_machine_type
if args.worker_disk_size is not None:
worker_config.diskSizeGb = compute_utils.BytesToGb(
args.worker_disk_size)
wp.privatePoolV1Config.workerConfig = worker_config
if release_track == base.ReleaseTrack.ALPHA:
private_service_connect = messages.PrivateServiceConnect()
if args.network_attachment:
private_service_connect.networkAttachment = args.network_attachment
if args.disable_public_ip_address:
private_service_connect.publicIpAddressDisabled = True
if args.route_all_traffic:
# Public IP in primary network interface of VM has to be disabled when
# routing all the traffic to network attachment.
private_service_connect.publicIpAddressDisabled = True
private_service_connect.routeAllTraffic = True
if (
args.network_attachment
or args.disable_public_ip_address
or args.route_all_traffic
):
# Private Service Connect related fields are specified, remove
# network config.
wp.privatePoolV1Config.networkConfig = None
wp.privatePoolV1Config.privateServiceConnect = private_service_connect
parent = properties.VALUES.core.project.Get(required=True)
# Get the parent project.location ref
parent_resource = resources.REGISTRY.Create(
collection='cloudbuild.projects.locations',
projectsId=parent,
locationsId=wp_region)
# Send the Create request
created_op = client.projects_locations_workerPools.Create(
messages.CloudbuildProjectsLocationsWorkerPoolsCreateRequest(
workerPool=wp,
parent=parent_resource.RelativeName(),
workerPoolId=wp_name))
op_resource = resources.REGISTRY.ParseRelativeName(
created_op.name, collection='cloudbuild.projects.locations.operations')
created_wp = waiter.WaitFor(
waiter.CloudOperationPoller(client.projects_locations_workerPools,
client.projects_locations_operations),
op_resource, 'Creating worker pool',
max_wait_ms=3600000) # 1 hour
# Get the workerpool ref
wp_resource = resources.REGISTRY.Parse(
None,
collection='cloudbuild.projects.locations.workerPools',
api_version=cloudbuild_util.RELEASE_TRACK_TO_API_VERSION[release_track],
params={
'projectsId': parent,
'locationsId': wp_region,
'workerPoolsId': wp_name,
})
log.CreatedResource(wp_resource)
return created_wp

View File

@@ -0,0 +1,250 @@
# -*- coding: utf-8 -*- #
# Copyright 2018 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.
"""Delete worker pool command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.cloudbuild import cloudbuild_util
from googlecloudsdk.api_lib.cloudbuild.v2 import client_util as cloudbuild_v2_util
from googlecloudsdk.api_lib.util import waiter
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import exceptions
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
@base.ReleaseTracks(base.ReleaseTrack.GA)
@base.UniverseCompatible
class Delete(base.DeleteCommand):
"""Delete a worker pool from Cloud Build."""
detailed_help = {
'DESCRIPTION':
'{description}',
'EXAMPLES':
"""\
To delete a worker pool named `wp1` in region `us-central1`, run:
$ {command} wp1 --region=us-central1
""",
}
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser.add_argument(
'--region',
help='The Cloud region where the worker pool is.')
parser.add_argument(
'WORKER_POOL', help='The ID of the worker pool to delete.')
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
_DeleteWorkerPoolFirstGen(args, self.ReleaseTrack())
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class DeleteBeta(Delete):
"""Delete a worker pool from Google Cloud Build."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser.add_argument(
'--region',
help='The Cloud region where the worker pool is.')
parser.add_argument(
'--generation',
default=1,
type=int,
help=('Generation of the worker pool.'))
parser.add_argument(
'WORKER_POOL', help='The ID of the worker pool to delete.')
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
if args.generation == 1:
_DeleteWorkerPoolFirstGen(args, self.ReleaseTrack())
elif args.generation == 2:
_DeleteWorkerPoolSecondGen(args)
else:
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class DeleteAlpha(Delete):
"""Delete a private worker pool from Google Cloud Build."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser.add_argument(
'--region',
help='The Cloud region where the worker pool is.')
parser.add_argument(
'--generation',
default=1,
type=int,
help=('Generation of the worker pool.'))
parser.add_argument(
'WORKER_POOL', help='The ID of the worker pool to delete.')
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
if args.generation == 1:
_DeleteWorkerPoolFirstGen(args, self.ReleaseTrack())
elif args.generation == 2:
_DeleteWorkerPoolSecondGen(args)
else:
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
def _DeleteWorkerPoolSecondGen(args):
"""Deletes a Worker Pool Second Generation.
Args:
args: an argparse namespace. All the arguments that were provided to the
delete command invocation.
"""
client = cloudbuild_v2_util.GetClientInstance()
messages = client.MESSAGES_MODULE
wp_region = args.region
if not wp_region:
wp_region = properties.VALUES.builds.region.GetOrFail()
# Get the workerpool second gen ref
wp_resource = resources.REGISTRY.Parse(
None,
collection='cloudbuild.projects.locations.workerPoolSecondGen',
api_version=cloudbuild_v2_util.GA_API_VERSION,
params={
'projectsId': properties.VALUES.core.project.Get(required=True),
'locationsId': wp_region,
'workerPoolSecondGenId': args.WORKER_POOL,
})
# Send the Delete request
deleted_op = client.projects_locations_workerPoolSecondGen.Delete(
messages.CloudbuildProjectsLocationsWorkerPoolSecondGenDeleteRequest(
name=wp_resource.RelativeName()))
op_resource = resources.REGISTRY.ParseRelativeName(
deleted_op.name, collection='cloudbuild.projects.locations.operations')
waiter.WaitFor(
waiter.CloudOperationPollerNoResources(
client.projects_locations_operations), op_resource,
'Deleting worker pool second gen',
max_wait_ms=3600000) # 1 hour
log.DeletedResource(wp_resource)
def _DeleteWorkerPoolFirstGen(args, release_track):
"""Deletes a Worker Pool First Generation.
Args:
args: an argparse namespace. All the arguments that were provided to the
delete command invocation.
release_track: The desired value of the enum
googlecloudsdk.calliope.base.ReleaseTrack.
"""
wp_region = args.region
if not wp_region:
wp_region = properties.VALUES.builds.region.GetOrFail()
client = cloudbuild_util.GetClientInstance(release_track)
messages = client.MESSAGES_MODULE
parent = properties.VALUES.core.project.Get(required=True)
wp_name = args.WORKER_POOL
# Get the workerpool ref
wp_resource = resources.REGISTRY.Parse(
None,
collection='cloudbuild.projects.locations.workerPools',
api_version=cloudbuild_util.RELEASE_TRACK_TO_API_VERSION[release_track],
params={
'projectsId': parent,
'locationsId': wp_region,
'workerPoolsId': wp_name,
})
# Send the Delete request
deleted_op = client.projects_locations_workerPools.Delete(
messages.CloudbuildProjectsLocationsWorkerPoolsDeleteRequest(
name=wp_resource.RelativeName()))
op_resource = resources.REGISTRY.ParseRelativeName(
deleted_op.name, collection='cloudbuild.projects.locations.operations')
waiter.WaitFor(
waiter.CloudOperationPollerNoResources(
client.projects_locations_operations), op_resource,
'Deleting worker pool',
max_wait_ms=3600000) # 1 hour
log.DeletedResource(wp_resource)

View File

@@ -0,0 +1,250 @@
# -*- coding: utf-8 -*- #
# Copyright 2018 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.
"""Describe worker pool command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.cloudbuild import cloudbuild_util
from googlecloudsdk.api_lib.cloudbuild.v2 import client_util as cloudbuild_v2_util
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import exceptions
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
@base.ReleaseTracks(base.ReleaseTrack.GA)
@base.UniverseCompatible
class Describe(base.DescribeCommand):
"""Describe a worker pool used by Cloud Build."""
detailed_help = {
'DESCRIPTION':
'{description}',
'EXAMPLES':
"""\
To get information about a worker pool named `wp1` in region `us-central1`, run:
$ {command} wp1 --region=us-central1
""",
}
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser.add_argument(
'--region',
help='The Cloud region where the worker pool is.')
parser.add_argument(
'WORKER_POOL', help='The ID of the worker pool to describe.')
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
return _DescribeWorkerPoolFirstGen(args, self.ReleaseTrack())
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class DescribeBeta(Describe):
"""Describe a worker pool used by Cloud Build."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser.add_argument(
'--region',
help='The Cloud region where the worker pool is.')
parser.add_argument(
'--generation',
default=1,
type=int,
help=('Generation of the worker pool.'))
parser.add_argument(
'WORKER_POOL', help='The ID of the worker pool to describe.')
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
if args.generation == 1:
return _DescribeWorkerPoolFirstGen(args, self.ReleaseTrack())
if args.generation == 2:
return _DescribeWorkerPoolSecondGen(args)
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class DescribeAlpha(Describe):
"""Describe a worker pool used by Cloud Build."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser.add_argument(
'--region',
help='The Cloud region where the worker pool is.')
parser.add_argument(
'--generation',
default=1,
type=int,
help=('Generation of the worker pool.'))
parser.add_argument(
'WORKER_POOL', help='The ID of the worker pool to describe.')
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
if args.generation == 1:
return _DescribeWorkerPoolFirstGen(args, self.ReleaseTrack())
if args.generation == 2:
return _DescribeWorkerPoolSecondGen(args)
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
def _DescribeWorkerPoolSecondGen(args):
"""Describes a Worker Pool Second Generation.
Args:
args: an argparse namespace. All the arguments that were provided to the
create command invocation.
Returns:
A Worker Pool Second Generation resource.
"""
client = cloudbuild_v2_util.GetClientInstance()
messages = client.MESSAGES_MODULE
wp_region = args.region
if not wp_region:
wp_region = properties.VALUES.builds.region.GetOrFail()
# Get the workerpool second gen ref
wp_resource = resources.REGISTRY.Parse(
None,
collection='cloudbuild.projects.locations.workerPoolSecondGen',
api_version=cloudbuild_v2_util.GA_API_VERSION,
params={
'projectsId': properties.VALUES.core.project.Get(required=True),
'locationsId': wp_region,
'workerPoolSecondGenId': args.WORKER_POOL,
})
# Send the Get request
wp = client.projects_locations_workerPoolSecondGen.Get(
messages.CloudbuildProjectsLocationsWorkerPoolSecondGenGetRequest(
name=wp_resource.RelativeName()))
# Format the workerpool second gen name for display
try:
wp.name = cloudbuild_v2_util.WorkerPoolSecondGenShortName(wp.name)
except ValueError:
pass # Must be an old version.
return wp
def _DescribeWorkerPoolFirstGen(args, release_track):
"""Describes a Worker Pool First Generation.
Args:
args: an argparse namespace. All the arguments that were provided to the
create command invocation.
release_track: The desired value of the enum
googlecloudsdk.calliope.base.ReleaseTrack.
Returns:
A Worker Pool First Generation resource.
"""
wp_region = args.region
if not wp_region:
wp_region = properties.VALUES.builds.region.GetOrFail()
client = cloudbuild_util.GetClientInstance(release_track)
messages = cloudbuild_util.GetMessagesModule(release_track)
parent = properties.VALUES.core.project.Get(required=True)
wp_name = args.WORKER_POOL
# Get the workerpool ref
wp_resource = resources.REGISTRY.Parse(
None,
collection='cloudbuild.projects.locations.workerPools',
api_version=cloudbuild_util.RELEASE_TRACK_TO_API_VERSION[release_track],
params={
'projectsId': parent,
'locationsId': wp_region,
'workerPoolsId': wp_name,
})
# Send the Get request
wp = client.projects_locations_workerPools.Get(
messages.CloudbuildProjectsLocationsWorkerPoolsGetRequest(
name=wp_resource.RelativeName()))
# Format the workerpool name for display
try:
wp.name = cloudbuild_util.WorkerPoolShortName(wp.name)
except ValueError:
pass # Must be an old version.
return wp

View File

@@ -0,0 +1,297 @@
# -*- coding: utf-8 -*- #
# Copyright 2018 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.
"""List worker pools command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from apitools.base.py import list_pager
from googlecloudsdk.api_lib.cloudbuild import cloudbuild_util
from googlecloudsdk.api_lib.cloudbuild.v2 import client_util as cloudbuild_v2_util
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import exceptions
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
def _GetWorkerPoolURI(resource):
if isinstance(resource, dict):
resource = resource['wp']
wp = resources.REGISTRY.ParseRelativeName(
resource.name,
collection='cloudbuild.projects.locations.workerPools',
api_version='v1')
return wp.SelfLink()
def _GetWorkerPoolSecondGenURI(resource):
if isinstance(resource, dict):
resource = resource['wp']
wp = resources.REGISTRY.ParseRelativeName(
resource.name,
collection='cloudbuild.projects.locations.workerPoolSecondGen',
api_version='v2')
return wp.SelfLink()
@base.ReleaseTracks(base.ReleaseTrack.GA)
@base.UniverseCompatible
class List(base.ListCommand):
"""List all worker pools in a Google Cloud project."""
detailed_help = {
'DESCRIPTION':
'{description}',
'EXAMPLES':
"""\
To fetch a list of worker pools running in region `us-central1`, run:
$ {command} --region=us-central1
""",
}
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser.add_argument(
'--region',
help='The Cloud region to list worker pools in.')
parser.display_info.AddFormat("""
table(
name.segment(-1),
createTime.date('%Y-%m-%dT%H:%M:%S%Oz', undefined='-'),
state
)
""")
parser.display_info.AddUriFunc(_GetWorkerPoolURI)
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
wp_region = args.region
wp_page_size = args.page_size
if not wp_region:
wp_region = properties.VALUES.builds.region.GetOrFail()
parent = properties.VALUES.core.project.Get(required=True)
# Get the parent project ref
parent_resource = resources.REGISTRY.Create(
collection='cloudbuild.projects.locations',
projectsId=parent,
locationsId=wp_region)
return _ListWorkerPoolFirstGen(
parent_resource, wp_page_size, args.limit, self.ReleaseTrack()
)
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class ListBeta(List):
"""List all worker pools in a Google Cloud project."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser.add_argument(
'--region',
help='The Cloud region to list worker pools in.')
parser.add_argument(
'--generation',
default=1,
type=int,
help=('Generation of the worker pool.'))
parser.display_info.AddFormat("""
table(
name.segment(-1),
createTime.date('%Y-%m-%dT%H:%M:%S%Oz', undefined='-'),
state
)
""")
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
wp_region = args.region
wp_page_size = args.page_size
if not wp_region:
wp_region = properties.VALUES.builds.region.GetOrFail()
parent = properties.VALUES.core.project.Get(required=True)
# Get the parent project ref
parent_resource = resources.REGISTRY.Create(
collection='cloudbuild.projects.locations',
projectsId=parent,
locationsId=wp_region)
if args.generation == 1:
args.GetDisplayInfo().AddUriFunc(_GetWorkerPoolURI)
return _ListWorkerPoolFirstGen(
parent_resource, wp_page_size, args.limit, self.ReleaseTrack()
)
if args.generation == 2:
args.GetDisplayInfo().AddUriFunc(_GetWorkerPoolSecondGenURI)
return _ListWorkerPoolSecondGen(parent_resource)
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class ListAlpha(List):
"""List all worker pools in a Google Cloud project."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser.add_argument(
'--region',
help='The Cloud region to list worker pools in.')
parser.add_argument(
'--generation',
default=1,
type=int,
help=('Generation of the worker pool.'))
parser.display_info.AddFormat("""
table(
name.segment(-1),
createTime.date('%Y-%m-%dT%H:%M:%S%Oz', undefined='-'),
state
)
""")
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
wp_region = args.region
wp_page_size = args.page_size
if not wp_region:
wp_region = properties.VALUES.builds.region.GetOrFail()
parent = properties.VALUES.core.project.Get(required=True)
# Get the parent project ref
parent_resource = resources.REGISTRY.Create(
collection='cloudbuild.projects.locations',
projectsId=parent,
locationsId=wp_region,
)
if args.generation == 1:
args.GetDisplayInfo().AddUriFunc(_GetWorkerPoolURI)
return _ListWorkerPoolFirstGen(
parent_resource, wp_page_size, args.limit, self.ReleaseTrack()
)
if args.generation == 2:
args.GetDisplayInfo().AddUriFunc(_GetWorkerPoolSecondGenURI)
return _ListWorkerPoolSecondGen(parent_resource)
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
def _ListWorkerPoolSecondGen(parent_resource):
"""List Worker Pool Second Generation.
Args:
parent_resource: The parent resource for Worker Pool Second Generation.
Returns:
A list of Worker Pool Second Generation resources.
"""
client = cloudbuild_v2_util.GetClientInstance()
messages = client.MESSAGES_MODULE
# Send the List request
wp_list = client.projects_locations_workerPoolSecondGen.List(
messages.CloudbuildProjectsLocationsWorkerPoolSecondGenListRequest(
parent=parent_resource.RelativeName())).workerPoolSecondGen
return wp_list
def _ListWorkerPoolFirstGen(parent_resource, page_size, limit, release_track):
"""List Worker Pool First Generation.
Args:
parent_resource: The parent resource for Worker Pool First Generation.
page_size: The number of elements to return in each page.
limit: The total number of items to return (from --limit flag)
release_track: The desired value of the enum
googlecloudsdk.calliope.base.ReleaseTrack.
Returns:
A list of Worker Pool First Generation resources.
"""
client = cloudbuild_util.GetClientInstance(release_track)
messages = cloudbuild_util.GetMessagesModule(release_track)
# Send the List request
request = messages.CloudbuildProjectsLocationsWorkerPoolsListRequest(
parent=parent_resource.RelativeName())
return list_pager.YieldFromList(
client.projects_locations_workerPools,
request,
field='workerPools',
limit=limit,
batch_size=page_size,
batch_size_attribute='pageSize')

View File

@@ -0,0 +1,277 @@
# -*- coding: utf-8 -*- #
# Copyright 2018 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 worker pool command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.cloudbuild import cloudbuild_exceptions
from googlecloudsdk.api_lib.cloudbuild import cloudbuild_util
from googlecloudsdk.api_lib.cloudbuild import workerpool_config
from googlecloudsdk.api_lib.compute import utils as compute_utils
from googlecloudsdk.api_lib.util import waiter
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import exceptions
from googlecloudsdk.command_lib.cloudbuild import workerpool_flags
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
@base.ReleaseTracks(base.ReleaseTrack.GA)
@base.UniverseCompatible
class Update(base.UpdateCommand):
"""Update a worker pool used by Cloud Build."""
detailed_help = {
'DESCRIPTION':
'{description}',
'EXAMPLES':
"""\
To change the machine type and disk size of workers in a worker pool named wp1, run:
$ {command} wp1 --region=us-central1 \
--worker-machine-type=e2-standard-2 \
--worker-disk-size=64GB
""",
}
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser = workerpool_flags.AddWorkerpoolUpdateArgs(parser,
base.ReleaseTrack.GA)
parser.display_info.AddFormat("""
table(
name.segment(-1),
createTime.date('%Y-%m-%dT%H:%M:%S%Oz', undefined='-'),
state
)
""")
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
return _UpdateWorkerPoolFirstGen(args, self.ReleaseTrack())
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class UpdateBeta(Update):
"""Update a worker pool used by Cloud Build."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser = workerpool_flags.AddWorkerpoolUpdateArgs(parser,
base.ReleaseTrack.BETA)
parser.add_argument(
'--generation',
default=1,
type=int,
help=('Generation of the worker pool.'),
)
parser.display_info.AddFormat("""
table(
name.segment(-1),
createTime.date('%Y-%m-%dT%H:%M:%S%Oz', undefined='-'),
state
)
""")
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
if args.generation == 1:
return _UpdateWorkerPoolFirstGen(args, self.ReleaseTrack())
if args.generation == 2:
raise exceptions.InvalidArgumentException(
'--generation',
'for generation=2 please use the gcloud command "gcloud builds'
' worker-pools apply" to update a worker pool',
)
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class UpdateAlpha(Update):
"""Update a private pool used by Cloud Build."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
parser = workerpool_flags.AddWorkerpoolUpdateArgs(parser,
base.ReleaseTrack.ALPHA)
parser.add_argument(
'--generation',
default=1,
type=int,
help=('Generation of the worker pool.'),
)
parser.display_info.AddFormat("""
table(
name.segment(-1),
createTime.date('%Y-%m-%dT%H:%M:%S%Oz', undefined='-'),
state
)
""")
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Some value that we want to have printed later.
"""
if args.generation == 1:
return _UpdateWorkerPoolFirstGen(args, self.ReleaseTrack())
if args.generation == 2:
raise exceptions.InvalidArgumentException(
'--generation',
'for generation=2 please use the gcloud command "gcloud builds'
' worker-pools apply" to update a worker pool',
)
raise exceptions.InvalidArgumentException(
'--generation',
'please use one of the following valid generation values: 1, 2',
)
def _UpdateWorkerPoolFirstGen(args, release_track):
"""Updates a Worker Pool First Generation.
Args:
args: an argparse namespace. All the arguments that were provided to the
update command invocation.
release_track: The desired value of the enum
googlecloudsdk.calliope.base.ReleaseTrack.
Returns:
A Worker Pool First Generation resource.
"""
wp_name = args.WORKER_POOL
wp_region = args.region
if not wp_region:
wp_region = properties.VALUES.builds.region.GetOrFail()
client = cloudbuild_util.GetClientInstance(release_track)
messages = cloudbuild_util.GetMessagesModule(release_track)
parent = properties.VALUES.core.project.Get(required=True)
# Get the workerpool proto from either the flags or the specified file.
wp = messages.WorkerPool()
if args.config_from_file is not None:
try:
wp = workerpool_config.LoadWorkerpoolConfigFromPath(
args.config_from_file, messages.WorkerPool)
except cloudbuild_exceptions.ParseProtoException as err:
log.err.Print('\nFailed to parse configuration from file.\n')
raise err
else:
wp.privatePoolV1Config = messages.PrivatePoolV1Config()
worker_config = messages.WorkerConfig()
if args.worker_machine_type is not None:
worker_config.machineType = args.worker_machine_type
if args.worker_disk_size is not None:
worker_config.diskSizeGb = compute_utils.BytesToGb(
args.worker_disk_size
)
wp.privatePoolV1Config.workerConfig = worker_config
nc = messages.NetworkConfig()
# All of the egress flags are mutually exclusive with each other.
if (args.public_egress is not None and not args.public_egress) or (
release_track == base.ReleaseTrack.GA and args.no_external_ip
):
nc.egressOption = (
messages.NetworkConfig.EgressOptionValueValuesEnum.NO_PUBLIC_EGRESS
)
wp.privatePoolV1Config.networkConfig = nc
if args.public_egress:
nc.egressOption = (
messages.NetworkConfig.EgressOptionValueValuesEnum.PUBLIC_EGRESS
)
wp.privatePoolV1Config.networkConfig = nc
# Get the workerpool ref
wp_resource = resources.REGISTRY.Parse(
None,
collection='cloudbuild.projects.locations.workerPools',
api_version=cloudbuild_util.RELEASE_TRACK_TO_API_VERSION[release_track],
params={
'projectsId': parent,
'locationsId': wp_region,
'workerPoolsId': wp_name,
})
update_mask = cloudbuild_util.MessageToFieldPaths(wp)
req = messages.CloudbuildProjectsLocationsWorkerPoolsPatchRequest(
name=wp_resource.RelativeName(),
workerPool=wp,
updateMask=','.join(update_mask))
# Send the Update request
updated_op = client.projects_locations_workerPools.Patch(req)
op_resource = resources.REGISTRY.ParseRelativeName(
updated_op.name, collection='cloudbuild.projects.locations.operations')
updated_wp = waiter.WaitFor(
waiter.CloudOperationPoller(client.projects_locations_workerPools,
client.projects_locations_operations),
op_resource, 'Updating worker pool')
log.UpdatedResource(wp_resource)
return updated_wp