Cloud SQLに接続する設定方法

概要

　Google CloudのツールであるGoogle Cloud SQLに接続する必要があった為、その接続するまでの設定方法についてまとめます。Google Cloud SQLは、初めて使用する為、今回も自身の備忘録も兼ねて記載します。

Cloud SQLの概要

　Googleが提供するクラウド上のマネージドデータベースサービス。
　MySQL、PostgreSQL、SQL Server等、人気のあるデータベースが利用可能で、ユーザーは殆ど管理作業を行う事なく、簡単にデータベースをセットアップして使用する事が可能となる。

1. gcloud CLIのインストール

gcloud CLIの概要

　Google Cloud Platform（GCP）のリソースとサービスを管理する為のツール。これを使って、コマンドラインから直接GCPの各種機能を操作する事が可能となる。

gcloud CLIの導入手順

• gcloud CLI　を使用する為、下記のサイトから自身のOSにあった、パッケージをダウンロードする
  (私はMac　PCで開発している為、MacOSのパッケージをインストールしています)
  

• google-cloud-sdkファイルは、ホームディレクトリーに配置する

# Unix系システム（macOSやLinuxを含む）では、ホームディレクトリは通常、以下のパスにある
macOS: /Users/username
Linux: /home/username

# usernameは、ユーザー名を示している
# 例えば、ユーザー名が`john`であれば、ホームディレクトリは /Users/john（macOS）または /home/john（Linux）になる。
# ホームディレクトリーは、シェルスクリプトやコマンドラインで ~（チルダ）という記号で表す事が可能
$ ~

• [ホームディレクトリー]にて、下記のコマンドを実行する

$ ./google-cloud-sdk/install.sh

• gcloud --versionのコマンドを実行して、バージョンが確認できたらgcloud CLIの導入が完了

$ gcloud --version
// 出力結果     
Google Cloud SDK 429.0.0
bq 2.0.92
cloud_sql_proxy 1.27.0
core 2023.04.28
gcloud-crc32c 1.0.0
gsutil 5.23

• GCPにアカウントが作成されていれば、下記のコマンドにてCLIでログインが可能となる

$ gcloud auth login
# 出力結果
Your browser has been opened to visit:

    https://accounts.google.com/ ~
# 省略

You are now logged in as [`gmailアドレス`].
Your current project is [`プロジェクト名`].  You can change this setting by running:
  $ gcloud config set project PROJECT_ID

# 下記は、必要に応じて設定を行う
$ gcloud config set project PROJECT_ID

2.Cloud SQL Auth Proxyのインストール

Cloud SQL Auth Proxyの概要

　Google Cloudのツールで、Google Cloud SQLデータベースへの安全で安定した接続を簡単に確立する事が出来るツール。
　公開IPやSSL/TLSの複雑な設定を必要とせず、Googleの認証と認可を使用してセキュアな接続が可能となる。また、接続が切れた場合でも自動的に再接続を試みる機能を提供し、接続の安定性も確保しているので安心である

Cloud SQL Auth Proxyの導入手順

• Cloud SQL Auth ProxyをインストールからCloud SQL Auth Proxyをインストールするコマンドを[ホームディレクトリー]で実行する
• Cloud SQL Auth Proxyをインストールする際は、OSによりコマンドが異なる為、自身のPCに適合するコマンドを使用する
• 著者はMacPCを使用しているので、下記のコマンドでインストールを行った

# インストールコマンド
$ curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.1.2/cloud-sql-proxy.darwin.amd64

# ディレクトリーの操作権限付与コマンド
$ chmod 744 cloud-sql-proxy

• gcloud components listをターミナルで実行し、Cloud SQL Proxyがインストールされているか確認する

$ gcloud components list
# 出力結果
Your current Google Cloud CLI version is: 429.0.0
The latest available version is: 429.0.0

Components

# 省略

# Cloud SQL ProxyのステータスがInstalledであればOK
Status: Installed
Name: Cloud SQL Proxy
ID: cloud_sql_proxy
Size: 7.6 MiB

# 省略

もし、StatusがNot Installedの場合は、下記のコマンドで、Installedにする

$ gcloud components install cloud_sql_proxy

• cloud_sql_proxy --versionのコマンドを実行して、バージョンが確認できたらCloud SQL Auth Proxyの導入が完了

$ cloud_sql_proxy --version
# 出力結果         
Cloud SQL Auth proxy: 1.27.0+darwin.amd64

• 下記の公式手順に従い、自身の使用しているDBのCloud SQL Auth Proxyの起動方法を実施する

【公式】Cloud SQL Auth Proxy の起動【MySQL】

【公式】Cloud SQL Auth Proxy の起動【PostgreSQL】

【公式】Cloud SQL Auth Proxy の起動【SQL Server】

• Cloud SQL Auth Proxyが起動できたら、Cloud SQLに使用しているDBにアクセスを行う

MySQL

mysql -u root -p --host 127.0.0.1 --port 3306

PostgreSQL

psql "host=127.0.0.1 port=5432 sslmode=disable dbname=DB_NAME user=postgres"

SQL Server

sqlcmd -S 127.0.0.1 -U USER_NAME

注意
　上記のコマンドを使用する場合は、ローカル環境にMySQL、PostgreSQL、SQL Serverをインストールしておく必要があります

参考資料

• M1 mac 買ったので、楽しく設定してたら Cloud SQL Proxy がいつまで経ってもインストールできなかった話
• 【公式】gcloud CLI をインストールする
• 【公式】Cloud SQL Auth Proxy クライアントをインストールする
• Mac の開発を便利にするパッケージ管理ソフト Homebrew のインストール手順

感想

GCPは初めて使用する為、分からない事が多々ありますが、今後もしっかりキャッチアップしてGCPについて理解していきたいです。