533 lines
20 KiB
Python
533 lines
20 KiB
Python
# -*- coding: utf-8 -*- #
|
|
# Copyright 2016 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.
|
|
"""Creates a new Cloud SQL instance."""
|
|
# TODO(b/362481808): remove python2-isms.
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import unicode_literals
|
|
|
|
from apitools.base.py import exceptions as apitools_exceptions
|
|
from googlecloudsdk.api_lib.sql import api_util as common_api_util
|
|
from googlecloudsdk.api_lib.sql import exceptions as sql_exceptions
|
|
from googlecloudsdk.api_lib.sql import operations
|
|
from googlecloudsdk.api_lib.sql import validate
|
|
from googlecloudsdk.calliope import base
|
|
from googlecloudsdk.calliope import exceptions
|
|
from googlecloudsdk.command_lib.kms import resource_args as kms_resource_args
|
|
from googlecloudsdk.command_lib.sql import flags
|
|
from googlecloudsdk.command_lib.sql import instances as command_util
|
|
from googlecloudsdk.command_lib.sql import validate as command_validate
|
|
from googlecloudsdk.command_lib.util.args import labels_util
|
|
from googlecloudsdk.core import log
|
|
from googlecloudsdk.core import properties
|
|
from googlecloudsdk.core.resource import resource_lex
|
|
from googlecloudsdk.core.resource import resource_property
|
|
import six
|
|
|
|
# 1h, based off of the max time it usually takes to create a SQL instance.
|
|
_INSTANCE_CREATION_TIMEOUT_SECONDS = 3600
|
|
|
|
DETAILED_HELP = {
|
|
'EXAMPLES': """\
|
|
To create a MySQL 8.0 instance with ID ``prod-instance'' that has 2
|
|
CPUs, 4 GB of RAM, and is in the region ``us-central1'' (a zone will be
|
|
auto-assigned), where the 'root' user has its password set to
|
|
``password123'', run:
|
|
|
|
$ {command} prod-instance --database-version=MYSQL_8_0 --cpu=2 --memory=4GB --region=us-central1 --root-password=password123
|
|
|
|
To create a Postgres 15 instance with ID ``prod-instance'' that has 2
|
|
CPUs, 8 GiB of RAM, and is in the zone ``us-central1-a'', where the
|
|
'postgres' user has its password set to ``password123'', run:
|
|
|
|
$ {command} prod-instance --database-version=POSTGRES_15 --cpu=2 --memory=8GiB --zone=us-central1-a --root-password=password123
|
|
|
|
To create a SQL Server 2022 Express instance with ID ``prod-instance''
|
|
that has 2 CPUs, 3840MiB of RAM, and is in the zone ``us-central1-a'',
|
|
where the 'sqlserver' user has its password set to ``password123'',
|
|
run:
|
|
|
|
$ {command} prod-instance --database-version=SQLSERVER_2022_EXPRESS --cpu=2 --memory=3840MiB --zone=us-central1-a --root-password=password123
|
|
""",
|
|
}
|
|
|
|
|
|
def AddBaseArgs(parser):
|
|
"""Declare flag and positional arguments for this command parser."""
|
|
# TODO(b/35705305): move common flags to command_lib.sql.flags
|
|
base.ASYNC_FLAG.AddToParser(parser)
|
|
parser.display_info.AddFormat(flags.GetInstanceListFormat())
|
|
flags.AddActivationPolicy(parser)
|
|
flags.AddActiveDirectoryDomain(parser)
|
|
flags.AddAssignIp(parser)
|
|
flags.AddAuthorizedNetworks(parser)
|
|
flags.AddAvailabilityType(parser)
|
|
flags.AddBackup(parser)
|
|
flags.AddBackupStartTime(parser)
|
|
flags.AddBackupLocation(parser, allow_empty=False)
|
|
flags.AddCPU(parser)
|
|
flags.AddInstanceCollation(parser)
|
|
flags.AddDatabaseFlags(parser)
|
|
flags.AddEnableBinLog(parser, show_negated_in_help=False)
|
|
flags.AddRetainedBackupsCount(parser)
|
|
flags.AddRetainedTransactionLogDays(parser)
|
|
flags.AddFailoverReplicaName(parser)
|
|
parser.add_argument(
|
|
'instance',
|
|
type=command_validate.InstanceNameRegexpValidator(),
|
|
help='Cloud SQL instance ID.',
|
|
)
|
|
flags.AddMaintenanceReleaseChannel(parser)
|
|
flags.AddMaintenanceWindowDay(parser)
|
|
flags.AddMaintenanceWindowHour(parser)
|
|
flags.AddDenyMaintenancePeriodStartDate(parser)
|
|
flags.AddDenyMaintenancePeriodEndDate(parser)
|
|
flags.AddDenyMaintenancePeriodTime(parser)
|
|
flags.AddInsightsConfigQueryInsightsEnabled(parser, show_negated_in_help=True)
|
|
flags.AddInsightsConfigQueryStringLength(parser)
|
|
flags.AddInsightsConfigRecordApplicationTags(
|
|
parser, show_negated_in_help=True
|
|
)
|
|
flags.AddInsightsConfigRecordClientAddress(parser, show_negated_in_help=True)
|
|
flags.AddInsightsConfigQueryPlansPerMinute(parser)
|
|
flags.AddMasterInstanceName(parser)
|
|
flags.AddMemory(parser)
|
|
flags.AddPasswordPolicyMinLength(parser)
|
|
flags.AddPasswordPolicyComplexity(parser)
|
|
flags.AddPasswordPolicyReuseInterval(parser)
|
|
flags.AddPasswordPolicyDisallowUsernameSubstring(parser)
|
|
flags.AddPasswordPolicyPasswordChangeInterval(parser)
|
|
flags.AddPasswordPolicyEnablePasswordPolicy(parser)
|
|
flags.AddReplicaType(parser)
|
|
flags.AddReplication(parser)
|
|
flags.AddRequireSsl(parser)
|
|
flags.AddRootPassword(parser)
|
|
flags.AddStorageAutoIncrease(parser)
|
|
flags.AddStorageSize(parser)
|
|
flags.AddStorageType(parser)
|
|
flags.AddTier(parser)
|
|
flags.AddEdition(parser)
|
|
kms_flag_overrides = {
|
|
'kms-key': '--disk-encryption-key',
|
|
'kms-keyring': '--disk-encryption-key-keyring',
|
|
'kms-location': '--disk-encryption-key-location',
|
|
'kms-project': '--disk-encryption-key-project',
|
|
}
|
|
kms_resource_args.AddKmsKeyResourceArg(
|
|
parser, 'instance', flag_overrides=kms_flag_overrides
|
|
)
|
|
flags.AddEnablePointInTimeRecovery(parser)
|
|
flags.AddNetwork(parser)
|
|
flags.AddSqlServerAudit(parser)
|
|
flags.AddDeletionProtection(parser)
|
|
flags.AddSqlServerTimeZone(parser)
|
|
flags.AddConnectorEnforcement(parser)
|
|
flags.AddTimeout(parser, _INSTANCE_CREATION_TIMEOUT_SECONDS)
|
|
flags.AddEnableGooglePrivatePath(parser, show_negated_in_help=False)
|
|
flags.AddThreadsPerCore(parser)
|
|
flags.AddCascadableReplica(parser)
|
|
flags.AddEnableDataCache(parser)
|
|
flags.AddEnableAutoUpgrade(parser)
|
|
flags.AddRecreateReplicasOnPrimaryCrash(parser)
|
|
psc_setup_group = parser.add_group()
|
|
flags.AddEnablePrivateServiceConnect(psc_setup_group)
|
|
flags.AddAllowedPscProjects(psc_setup_group)
|
|
flags.AddCustomSubjectAlternativeNames(parser)
|
|
flags.AddSslMode(parser)
|
|
flags.AddEnableGoogleMLIntegration(parser)
|
|
flags.AddEnableDataplexIntegration(parser)
|
|
flags.AddPscAutoConnections(parser)
|
|
flags.AddServerCaMode(parser)
|
|
flags.AddTags(parser)
|
|
flags.AddRetainBackupsOnDelete(parser)
|
|
flags.AddServerCaPool(parser)
|
|
flags.AddStorageProvisionedIops(parser)
|
|
flags.AddStorageProvisionedThroughput(parser)
|
|
flags.AddInstanceType(parser)
|
|
flags.AddNodeCount(parser)
|
|
flags.AddActiveDirectoryMode(parser)
|
|
flags.AddActiveDirectorySecretManagerKey(parser)
|
|
flags.AddActiveDirectoryOrganizationalUnit(parser)
|
|
flags.AddActiveDirectoryDNSServers(parser)
|
|
flags.ClearActiveDirectoryDNSServers(parser)
|
|
flags.AddForceSqlNetworkArchitecture(parser)
|
|
flags.AddFinalBackup(parser)
|
|
flags.AddFinalbackupRetentionDays(parser)
|
|
flags.AddEnableConnectionPooling(parser)
|
|
flags.AddConnectionPoolFlags(parser)
|
|
flags.AddReadPoolAutoScaleConfig(parser)
|
|
|
|
# When adding a new field for instance creation, determine if it should also
|
|
# be included in the restore to new instance command. This command uses backup
|
|
# settings to create a new instance, allowing users to override some settings.
|
|
# If the new field should be user-overridable during restore, add it to the
|
|
# restore command.
|
|
|
|
|
|
def AddBetaArgs(parser):
|
|
"""Declare beta flag and positional arguments for this command parser."""
|
|
flags.AddExternalMasterGroup(parser)
|
|
flags.AddInstanceResizeLimit(parser)
|
|
flags.AddAllocatedIpRangeName(parser)
|
|
labels_util.AddCreateLabelsFlags(parser)
|
|
flags.AddReplicationLagMaxSecondsForRecreate(parser)
|
|
flags.AddEnableDbAlignedAtomicWrites(parser)
|
|
flags.AddEnableAcceleratedReplicaMode(parser)
|
|
flags.AddDataApiAccess(parser)
|
|
flags.AddServerCertificateRotationMode(parser)
|
|
flags.AddPerformanceCaptureConfig(parser, hidden=False)
|
|
flags.AddUncMappings(parser)
|
|
flags.AddSqlServerEntraId(parser)
|
|
|
|
|
|
def AddAlphaArgs(unused_parser):
|
|
"""Declare alpha flags for this command parser."""
|
|
pass
|
|
|
|
|
|
def RunBaseCreateCommand(args, release_track):
|
|
"""Creates a new Cloud SQL instance.
|
|
|
|
Args:
|
|
args: argparse.Namespace, The arguments that this command was invoked with.
|
|
release_track: base.ReleaseTrack, the release track that this was run under.
|
|
|
|
Returns:
|
|
A dict object representing the operations resource describing the create
|
|
operation if the create was successful.
|
|
Raises:
|
|
HttpException: A http error response was received while executing api
|
|
request.
|
|
ArgumentError: An argument supplied by the user was incorrect, such as
|
|
specifying an invalid CMEK configuration or attempting to create a V1
|
|
instance.
|
|
RequiredArgumentException: A required argument was not supplied by the user,
|
|
such as omitting --root-password on a SQL Server instance.
|
|
"""
|
|
client = common_api_util.SqlClient(common_api_util.API_VERSION_DEFAULT)
|
|
sql_client = client.sql_client
|
|
sql_messages = client.sql_messages
|
|
|
|
validate.ValidateInstanceName(args.instance)
|
|
validate.ValidateInstanceLocation(args)
|
|
instance_ref = client.resource_parser.Parse(
|
|
args.instance,
|
|
params={'project': properties.VALUES.core.project.GetOrFail},
|
|
collection='sql.instances',
|
|
)
|
|
|
|
# Get the region, tier, and database version from the master if these fields
|
|
# are not specified.
|
|
# TODO(b/64266672): Remove once API does not require these fields.
|
|
if args.IsSpecified('master_instance_name'):
|
|
master_instance_ref = client.resource_parser.Parse(
|
|
args.master_instance_name,
|
|
params={'project': properties.VALUES.core.project.GetOrFail},
|
|
collection='sql.instances',
|
|
)
|
|
try:
|
|
master_instance_resource = sql_client.instances.Get(
|
|
sql_messages.SqlInstancesGetRequest(
|
|
project=instance_ref.project,
|
|
instance=master_instance_ref.instance,
|
|
)
|
|
)
|
|
except apitools_exceptions.HttpError as error:
|
|
# TODO(b/64292220): Remove once API gives helpful error message.
|
|
log.debug('operation : %s', six.text_type(master_instance_ref))
|
|
exc = exceptions.HttpException(error)
|
|
if (
|
|
resource_property.Get(
|
|
exc.payload.content,
|
|
resource_lex.ParseKey('error.errors[0].reason'),
|
|
None,
|
|
)
|
|
== 'notAuthorized'
|
|
):
|
|
msg = (
|
|
'You are either not authorized to access the master instance or '
|
|
'it does not exist.'
|
|
)
|
|
raise exceptions.HttpException(msg)
|
|
raise
|
|
if not args.IsSpecified('region'):
|
|
args.region = master_instance_resource.region
|
|
if not args.IsSpecified('database_version'):
|
|
args.database_version = master_instance_resource.databaseVersion.name
|
|
if (
|
|
not args.IsSpecified('tier')
|
|
and not (args.IsSpecified('cpu') or args.IsSpecified('memory'))
|
|
and master_instance_resource.settings
|
|
):
|
|
args.tier = master_instance_resource.settings.tier
|
|
|
|
if args.IsKnownAndSpecified('enable_accelerated_replica_mode'):
|
|
if not (
|
|
master_instance_resource.databaseVersion.name.startswith('MYSQL_')
|
|
):
|
|
raise sql_exceptions.ArgumentError(
|
|
'--enable-accelerated-replica-mode is only supported for MySQL.'
|
|
)
|
|
|
|
# Validate master/replica CMEK configurations.
|
|
if master_instance_resource.diskEncryptionConfiguration:
|
|
if args.region == master_instance_resource.region:
|
|
# Warn user that same-region replicas inherit their master's CMEK
|
|
# configuration.
|
|
command_util.ShowCmekWarning('replica', 'the master instance')
|
|
elif not args.IsSpecified('disk_encryption_key'):
|
|
# Raise error that cross-region replicas require their own CMEK key if
|
|
# the master is CMEK.
|
|
raise exceptions.RequiredArgumentException(
|
|
'--disk-encryption-key',
|
|
'`--disk-encryption-key` is required when creating a cross-region '
|
|
'replica of an instance with customer-managed encryption.',
|
|
)
|
|
else:
|
|
command_util.ShowCmekWarning('replica')
|
|
elif args.IsSpecified('disk_encryption_key'):
|
|
# Raise error that cross-region replicas cannot be CMEK encrypted if their
|
|
# master is not.
|
|
raise sql_exceptions.ArgumentError(
|
|
'`--disk-encryption-key` cannot be specified when creating a replica '
|
|
'of an instance without customer-managed encryption.'
|
|
)
|
|
|
|
if args.IsSpecified('cascadable_replica'):
|
|
if args.region == master_instance_resource.region:
|
|
raise exceptions.InvalidArgumentException(
|
|
'--cascadable-replica',
|
|
'`--cascadable-replica` can only be specified when creating a '
|
|
'replica that is in a different region than the primary.',
|
|
)
|
|
else:
|
|
if args.IsSpecified('cascadable_replica'):
|
|
raise exceptions.InvalidArgumentException(
|
|
'--cascadable-replica',
|
|
'`--cascadable-replica` can only be specified when '
|
|
'`--master-instance-name` is specified.',
|
|
)
|
|
|
|
if args.IsKnownAndSpecified('enable_accelerated_replica_mode'):
|
|
if args.IsSpecified('database_version'):
|
|
if not args.database_version.startswith('MYSQL_'):
|
|
raise sql_exceptions.ArgumentError(
|
|
'--enable-accelerated-replica-mode is only supported for MySQL.'
|
|
)
|
|
|
|
# --root-password is required when creating SQL Server instances
|
|
if (
|
|
args.IsSpecified('database_version')
|
|
and args.database_version.startswith('SQLSERVER')
|
|
and not args.IsSpecified('root_password')
|
|
):
|
|
raise exceptions.RequiredArgumentException(
|
|
'--root-password',
|
|
'`--root-password` is required when creating SQL Server instances.',
|
|
)
|
|
|
|
if not args.backup:
|
|
if args.IsSpecified('enable_bin_log'):
|
|
if not args.IsSpecified('master_instance_name'):
|
|
# if we are creating a replica, we allow enable_bin_log with no_backup,
|
|
# otherwise no_backup is not allowed with enable_bin_log
|
|
raise sql_exceptions.ArgumentError(
|
|
'`--enable-bin-log` cannot be specified when --no-backup is '
|
|
'specified'
|
|
)
|
|
elif args.IsSpecified('enable_point_in_time_recovery'):
|
|
raise sql_exceptions.ArgumentError(
|
|
'`--enable-point-in-time-recovery` cannot be specified when '
|
|
'--no-backup is specified'
|
|
)
|
|
|
|
if args.IsKnownAndSpecified(
|
|
'allowed_psc_projects'
|
|
) and not args.IsKnownAndSpecified('enable_private_service_connect'):
|
|
raise sql_exceptions.ArgumentError(
|
|
'`--allowed-psc-projects` requires `--enable-private-service-connect`'
|
|
)
|
|
|
|
if args.IsKnownAndSpecified(
|
|
'psc_auto_connections'
|
|
) and not args.IsKnownAndSpecified('enable_private_service_connect'):
|
|
raise sql_exceptions.ArgumentError(
|
|
'`--psc-auto-connections` requires `--enable-private-service-connect`'
|
|
)
|
|
|
|
# TODO(b/372040396): Add the check for server_ca_mode when it is supported.
|
|
if args.IsKnownAndSpecified(
|
|
'custom_subject_alternative_names'
|
|
) and not args.IsKnownAndSpecified('server_ca_mode'):
|
|
raise sql_exceptions.ArgumentError(
|
|
'`--custom-subject-alternative-names` requires customer managed'
|
|
' server CA'
|
|
)
|
|
|
|
if args.database_flags is not None and any([
|
|
'sync_binlog' in args.database_flags,
|
|
'innodb_flush_log_at_trx_commit' in args.database_flags,
|
|
]):
|
|
log.warning(
|
|
'Changing innodb_flush_log_at_trx_commit '
|
|
'or sync_binlog may cause data loss. Check '
|
|
'https://cloud.google.com/sql/docs/mysql/flags'
|
|
' for more details.'
|
|
)
|
|
|
|
if (
|
|
args.IsKnownAndSpecified('performance_capture_config')
|
|
and args.IsSpecified('database_version')
|
|
and not args.database_version.startswith('MYSQL')
|
|
):
|
|
raise sql_exceptions.ArgumentError(
|
|
'`--performance-capture-config` is only supported for MySQL.'
|
|
)
|
|
|
|
if args.IsSpecified('edition') and args.edition == 'enterprise-plus':
|
|
# This logic is awkward because we only want to change behavior for "new"
|
|
# database types to avoid breaking changes.
|
|
can_infer_tier = (
|
|
args.tier
|
|
and command_util.DoesEnterprisePlusReplicaInferTierForDatabaseType(
|
|
args.database_version
|
|
)
|
|
)
|
|
if not (args.IsSpecified('tier') or can_infer_tier):
|
|
raise sql_exceptions.ArgumentError(
|
|
'`--edition=enterprise-plus` requires `--tier`'
|
|
)
|
|
|
|
instance_resource = (
|
|
command_util.InstancesV1Beta4.ConstructCreateInstanceFromArgs(
|
|
sql_messages,
|
|
args,
|
|
instance_ref=instance_ref,
|
|
release_track=release_track,
|
|
)
|
|
)
|
|
|
|
operation_ref = None
|
|
try:
|
|
result_operation = sql_client.instances.Insert(
|
|
sql_messages.SqlInstancesInsertRequest(
|
|
databaseInstance=instance_resource, project=instance_ref.project
|
|
)
|
|
)
|
|
|
|
operation_ref = client.resource_parser.Create(
|
|
'sql.operations',
|
|
operation=result_operation.name,
|
|
project=instance_ref.project,
|
|
)
|
|
|
|
if args.async_:
|
|
if not args.IsSpecified('format'):
|
|
args.format = 'default'
|
|
return sql_client.operations.Get(
|
|
sql_messages.SqlOperationsGetRequest(
|
|
project=operation_ref.project, operation=operation_ref.operation
|
|
)
|
|
)
|
|
|
|
operations.OperationsV1Beta4.WaitForOperation(
|
|
sql_client,
|
|
operation_ref,
|
|
'Creating Cloud SQL instance for ' + args.database_version,
|
|
max_wait_seconds=args.timeout,
|
|
)
|
|
|
|
log.CreatedResource(instance_ref)
|
|
|
|
new_resource = sql_client.instances.Get(
|
|
sql_messages.SqlInstancesGetRequest(
|
|
project=instance_ref.project, instance=instance_ref.instance
|
|
)
|
|
)
|
|
return new_resource
|
|
except apitools_exceptions.HttpError as error:
|
|
log.debug('operation : %s', six.text_type(operation_ref))
|
|
exc = exceptions.HttpException(error)
|
|
if (
|
|
resource_property.Get(
|
|
exc.payload.content,
|
|
resource_lex.ParseKey('error.errors[0].reason'),
|
|
None,
|
|
)
|
|
== 'errorMaxInstancePerLabel'
|
|
):
|
|
msg = resource_property.Get(
|
|
exc.payload.content, resource_lex.ParseKey('error.message'), None
|
|
)
|
|
raise exceptions.HttpException(msg)
|
|
raise
|
|
|
|
|
|
@base.DefaultUniverseOnly
|
|
@base.ReleaseTracks(base.ReleaseTrack.GA)
|
|
class Create(base.Command):
|
|
"""Creates a new Cloud SQL instance."""
|
|
|
|
detailed_help = DETAILED_HELP
|
|
|
|
def Run(self, args):
|
|
return RunBaseCreateCommand(args, self.ReleaseTrack())
|
|
|
|
@staticmethod
|
|
def Args(parser):
|
|
"""Args is called by calliope to gather arguments for this command."""
|
|
AddBaseArgs(parser)
|
|
flags.AddLocationGroup(parser)
|
|
flags.AddDatabaseVersion(parser)
|
|
|
|
|
|
@base.ReleaseTracks(base.ReleaseTrack.BETA)
|
|
@base.DefaultUniverseOnly
|
|
class CreateBeta(base.Command):
|
|
"""Creates a new Cloud SQL instance."""
|
|
|
|
detailed_help = DETAILED_HELP
|
|
|
|
def Run(self, args):
|
|
return RunBaseCreateCommand(args, self.ReleaseTrack())
|
|
|
|
@staticmethod
|
|
def Args(parser):
|
|
"""Args is called by calliope to gather arguments for this command."""
|
|
AddBaseArgs(parser)
|
|
flags.AddLocationGroup(parser)
|
|
AddBetaArgs(parser)
|
|
flags.AddDatabaseVersion(parser, restrict_choices=False)
|
|
|
|
|
|
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
|
|
@base.DefaultUniverseOnly
|
|
class CreateAlpha(base.Command):
|
|
"""Creates a new Cloud SQL instance."""
|
|
|
|
detailed_help = DETAILED_HELP
|
|
|
|
def Run(self, args):
|
|
return RunBaseCreateCommand(args, self.ReleaseTrack())
|
|
|
|
@staticmethod
|
|
def Args(parser):
|
|
"""Args is called by calliope to gather arguments for this command."""
|
|
AddBaseArgs(parser)
|
|
flags.AddLocationGroup(parser)
|
|
AddBetaArgs(parser)
|
|
AddAlphaArgs(parser)
|
|
flags.AddDatabaseVersion(parser, restrict_choices=False)
|