使用 Cloud SQL 驗證 Proxy 連線至 PostgreSQL 適用的 Cloud SQL

使用 Cloud SQL 驗證 Proxy 連線至 PostgreSQL 適用的 Cloud SQL

MySQL   |  PostgreSQL   |  SQL Server

這個頁面說明如何使用 Cloud SQL 驗證 Proxy，從本機測試環境連線至 Cloud SQL。Cloud SQL Auth Proxy 可安全存取 Cloud SQL 執行個體，不需要授權網路或設定 SSL。使用 Cloud SQL 驗證 Proxy，即可安全連線至 Cloud SQL 執行個體。

本頁的操作說明僅適用於測試環境，不應用於正式環境。如要進一步瞭解生產環境所需的設定，請參閱「在生產環境中使用 Cloud SQL Auth Proxy」 和「使用 Cloud SQL Auth Proxy 連線」。

事前準備

注意： 專案名稱長度必須介於 4 至 30 個字元之間。輸入名稱時，表單會建議專案 ID，您可以編輯。專案 ID 長度必須介於 6 到 30 個字元之間，第一個字元須為小寫英文字母，其餘字元可以是破折號、小寫英文字母或數字，但最後一個字元不得為破折號。

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

1. 啟用必要的 Google Cloud API。

   控制台

   前往 Google Cloud 控制台的「API」頁面。

   前往 API 頁面

   啟用 Cloud SQL Admin API。

   gcloud

   按一下下列按鈕開啟 Cloud Shell，直接在瀏覽器中使用指令列存取 Google Cloud 資源。您可以使用 Cloud Shell 執行本快速入門導覽課程中的 gcloud 指令。

   開啟 Cloud Shell

   使用 Cloud Shell 執行下列 gcloud services enable 指令，啟用本快速入門導覽課程所需的 API：

   gcloud services enable sqladmin.googleapis.com

   這個指令會啟用下列 API：

   • Cloud SQL Admin API

2. Make sure that you have the following role or roles on the project: Cloud SQL Admin (roles/cloudsql.admin), Cloud SQL Viewer (roles/cloudsql.viewer)

   Check for the roles

   1. In the Google Cloud console, go to the IAM page.

      Go to IAM
   2. Select the project.

   3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

   4. For all rows that specify or include you, check the Role column to see whether the list of roles includes the required roles.

   Grant the roles

   1. In the Google Cloud console, go to the IAM page.

      前往「IAM」頁面
   2. 選取專案。
   3. 按一下「授予存取權」。

   4. 在「New principals」(新增主體) 欄位中，輸入您的使用者 ID。 這通常是 Google 帳戶的電子郵件地址。

   5. 在「Select a role」(選取角色) 清單中，選取角色。
   6. 如要授予其他角色，請按一下 「新增其他角色」，然後新增每個其他角色。
   7. 按一下 [Save]。

建立 Cloud SQL 執行個體

在本快速入門導覽課程中，您將使用 Google Cloud 控制台。如要使用 gcloud CLI、cURL 或 PowerShell，請參閱建立執行個體。

1. 前往 Google Cloud 控制台的「Cloud SQL Instances」頁面。

   前往 Cloud SQL 執行個體

2. 點選「建立執行個體」。
3. 按一下「Choose PostgreSQL」(選擇 PostgreSQL)。
4. 在「Instance ID」(執行個體 ID) 欄位中輸入 myinstance。
5. 在「Password」(密碼) 欄位中，輸入 postgres 使用者的密碼。

6. 點選「建立執行個體」。

   您會返回執行個體清單。您可以立即點選新執行個體查看詳細資料，但必須等到執行個體初始化並啟動後，才能執行其他作業。

   注意：在本範例中，執行個體是使用預設設定建立，包括公開 IP 位址。

Debian/Ubuntu

從套件管理員安裝 psql 用戶端：

sudo apt-get update
sudo apt-get install postgresql-client

CentOS/RHEL

從套件管理員安裝 psql 用戶端：

sudo yum install postgresql

openSUSE

從套件管理員安裝 psql 用戶端：

sudo zypper install postgresql

其他平台

1. 從 PostgreSQL 下載頁面下載您平台適用的 PostgreSQL Core Distribution。
   Core Distribution 內含 psql 用戶端。
2. 按照下載頁面上的指示安裝 PostgreSQL 資料庫。

安裝 Cloud SQL 驗證 Proxy 用戶端

下載的 Cloud SQL 驗證 Proxy 二進位檔取決於作業系統，以及是否使用 32 位元或 64 位元核心。大多數較新的硬體都使用 64 位元核心。如果不確定電腦執行的是 32 位元或 64 位元核心，請在 Linux 或 macOS 中使用 uname -a 指令。如為 Windows，請參閱 Windows 說明文件。

Linux 64 位元

1. 下載 Cloud SQL 驗證 Proxy：

   curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.linux.amd64

2. 將 Cloud SQL 驗證 Proxy 設為允許執行：

   chmod +x cloud-sql-proxy

Linux 32 位元

1. 下載 Cloud SQL 驗證 Proxy：

   curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.linux.386

2. 如果找不到 curl 指令，請執行 sudo apt install curl，然後重複下載指令。
3. 將 Cloud SQL 驗證 Proxy 設為允許執行：

   chmod +x cloud-sql-proxy

macOS 64 位元

1. 下載 Cloud SQL 驗證 Proxy：

   curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.darwin.amd64

2. 將 Cloud SQL 驗證 Proxy 設為允許執行：

   chmod +x cloud-sql-proxy

Mac M1

1. 下載 Cloud SQL 驗證 Proxy：

     curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.darwin.arm64
     

2. 將 Cloud SQL 驗證 Proxy 設為允許執行：

     chmod +x cloud-sql-proxy
     

Windows 64 位元

在 https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.x64.exe 上按一下滑鼠右鍵，然後選取「另存連結為」來下載 Cloud SQL Auth Proxy。將檔案重新命名為 cloud-sql-proxy.exe。

Windows 32 位元

在 https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.x86.exe 上按一下滑鼠右鍵，然後選取「另存連結為」來下載 Cloud SQL Auth Proxy。將檔案重新命名為 cloud-sql-proxy.exe。

Cloud SQL 驗證 Proxy Docker 映像檔

Cloud SQL 驗證 Proxy 有不同的容器映像檔，例如 distroless、alpine 和 buster。預設的 Cloud SQL 驗證 Proxy 容器映像檔使用 distroless，其中不含任何殼層。如需 Shell 或相關工具，請根據 alpine 或 buster 下載映像檔。 詳情請參閱「Cloud SQL Auth Proxy 容器映像檔」。

您可以使用 Docker 執行下列指令，將最新映像檔提取至本機電腦：

docker pull gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.17.1

注意：Cloud SQL Auth Proxy 使用支援 gcr.io 網域的存放區，但會從 Artifact Registry 提供映像檔。詳情請參閱「從 Container Registry 轉換」。

其他 OS

如果您的作業系統不在上述說明內，可以從原始碼編譯 Cloud SQL 驗證 Proxy。

取得執行個體連線名稱

1. 前往 Google Cloud 控制台的「Cloud SQL Instances」頁面。

   前往 Cloud SQL 執行個體

2. 請按一下執行個體名稱，開啟執行個體的「Overview」 (總覽) 頁面。
3. 在「連線至這個執行個體」部分，複製「連線名稱」。連線名稱的格式為 projectID:region:instanceID。

啟動 Cloud SQL 驗證 Proxy

在 Proxy 本身的終端機上啟動 Proxy，這樣即可監控 Proxy 的輸出內容。將 INSTANCE_CONNECTION_NAME 替換成您在上一個步驟中複製的執行個體連線名稱。

在 Linux 環境中，請使用下列指令啟動 Cloud SQL 驗證 Proxy：

./cloud-sql-proxy INSTANCE_CONNECTION_NAME

在 Windows 的 PowerShell 中，使用下列指令啟動 Cloud SQL 驗證 Proxy：

.\cloud-sql-proxy.exe INSTANCE_CONNECTION_NAME

系統會顯示類似以下內容的訊息：

Listening on 127.0.0.1:5432 for INSTANCE_CONNECTION_NAME
Ready for new connections

執行下列指令，並將 DB_NAME 替換為 Cloud SQL 資料庫的名稱：

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

在「Enter password:」提示中，輸入 PostgreSQL 帳戶的密碼。

確認系統顯示 PostgreSQL 提示字元。您已使用 psql 用戶端連線至資料庫。

返回啟動 Cloud SQL 驗證 Proxy 的終端機視窗。畫面會顯示類似以下的訊息：

New connection for myInstance

清除所用資源

如要避免系統向您的 Google Cloud 帳戶收取本頁所用資源的費用，請按照下列步驟操作。

1. 前往 Google Cloud 控制台的「Cloud SQL Instances」頁面。

   前往 Cloud SQL 執行個體

2. 選取 myinstance 執行個體，開啟「執行個體詳細資料」頁面。
3. 在頁面頂端的圖示列中，按一下 [刪除]。
4. 在「Delete instance」(刪除執行個體) 視窗中輸入執行個體名稱，然後按一下「Delete」(刪除)。

選用清除步驟

如果您未使用本快速入門導覽課程啟用的 API，可以停用這些 API。

• 本快速入門導覽課程中啟用的 API：
  • Cloud SQL Admin API

1. 前往 Google Cloud 控制台的「API」頁面。

   前往 API 頁面

2. 選取 Cloud SQL Admin API，然後按一下「停用 API」按鈕。

後續步驟

• 瞭解如何排解 Cloud SQL Auth Proxy 的相關資訊。

• 進一步瞭解 Cloud SQL 驗證 Proxy。

• 進一步瞭解其他連線選項。