# -*- coding: utf-8 -*- # # Copyright 2023 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. """Switches over a Cloud SQL instance to one of its replicas. Switches over a Cloud SQL instance to one of its replicas. Currently only supported on Cloud SQL for SQL Server and MySQL instances. """ import sys import textwrap from googlecloudsdk.api_lib.sql import api_util from googlecloudsdk.api_lib.sql import operations from googlecloudsdk.api_lib.sql import validate from googlecloudsdk.calliope import base from googlecloudsdk.command_lib.sql import flags from googlecloudsdk.core import log from googlecloudsdk.core import properties from googlecloudsdk.core.console import console_io # gcloud timeout for monitoring the switchover LRO _SWITCHOVER_OPERATION_TIMEOUT_SECONDS = 3600 DETAILED_HELP = { 'EXAMPLES': """\ To switch over an instance to its replica called replica-instance: $ {command} replica-instance """, } def AddBaseArgs(parser): """Declare flag and positional arguments for this command parser.""" base.ASYNC_FLAG.AddToParser(parser) parser.add_argument( 'replica', completer=flags.InstanceCompleter, help='Cloud SQL replica ID.' ) flags.AddSwitchoverDbTimeout(parser) def RunBaseSwitchoverCommand(args): """Switches over a Cloud SQL instance to one of its replicas. Args: args: argparse.Namespace, The arguments that this command was invoked with. Returns: A dict object representing the operations resource describing the switchover operation if the switchover was successful. Raises: exceptions.OperationError: If the switchover operation is not supported for the instance. """ client = api_util.SqlClient(api_util.API_VERSION_DEFAULT) sql_client = client.sql_client sql_messages = client.sql_messages validate.ValidateInstanceName(args.replica) instance_ref = client.resource_parser.Parse( args.replica, params={'project': properties.VALUES.core.project.GetOrFail}, collection='sql.instances', ) # Format the message ourselves here rather than supplying it as part of the # 'message' to PromptContinue. Having the whole paragraph be automatically # formatted by PromptContinue would leave it with a line break in the middle # of the URL, rendering it unclickable. sys.stderr.write( textwrap.TextWrapper().fill( 'Switching over to a replica leads to a short period of downtime' ' and results in the primary and replica instances "switching"' ' roles. Before switching over to the replica, you must verify' ' that both the primary and replica instances are online.' ' Otherwise, use a promote operation.' ) + '\n\n' ) console_io.PromptContinue(message='', default=True, cancel_on_no=True) db_timeout_str = args.db_timeout if db_timeout_str is not None: db_timeout_str = str(args.db_timeout) + 's' result = sql_client.instances.Switchover( sql_messages.SqlInstancesSwitchoverRequest( project=instance_ref.project, instance=instance_ref.instance, dbTimeout=db_timeout_str, ) ) operation_ref = client.resource_parser.Create( 'sql.operations', operation=result.name, project=instance_ref.project ) if args.async_: return sql_client.operations.Get( sql_messages.SqlOperationsGetRequest( project=operation_ref.project, operation=operation_ref.operation ) ) operations.OperationsV1Beta4.WaitForOperation( sql_client, operation_ref, 'Switching over to Cloud SQL replica', _SWITCHOVER_OPERATION_TIMEOUT_SECONDS ) log.status.write( 'Switched over [{instance}].\n'.format(instance=instance_ref) ) @base.DefaultUniverseOnly @base.ReleaseTracks( base.ReleaseTrack.GA, base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA ) class Switchover(base.Command): """Switches over a Cloud SQL instance to one of its replicas. Switches over a Cloud SQL instance to one of its replicas. """ detailed_help = DETAILED_HELP def Run(self, args): return RunBaseSwitchoverCommand(args) @staticmethod def Args(parser): """Args is called by calliope to gather arguments for this command. Args: parser: An argparse parser that you can use to add arguments that go on the command line after this command. Positional arguments are allowed. """ AddBaseArgs(parser)