PlanetScale
連接
從終端機連接PlanetScale。傳入--help可查看PlanetScale接受的旗標,在無瀏覽器環境中再加上--no-browser。
polylane cloud connect --provider planetscaleOAuth授權,或來自你PlanetScale組織設定的服務權杖。
PlanetScale透過OAuth連接:點擊Connect with PlanetScale、在PlanetScale上授權讀取存取,你就會被重新導向回來,同步已經開始。如果你的PlanetScale帳戶可以存取多個組織,在提示時選擇要連接的那一個。權杖在儲存前會先加密,代理永遠看不到它們。
服務權杖替代方案
如果你偏好長效憑證,改用服務權杖連接:
- 開啟PlanetScale,前往你組織的Settings → Service tokens。
- 點擊Create service token,複製權杖ID與權杖。
- 授予該權杖對組織及其資料庫的讀取存取(例如
read_databases、read_branches)。 - 把權杖ID與權杖貼到Polylane。如果該權杖可以觸及多個組織,也請提供要連接的組織名稱。
- Polylane驗證權杖並開始同步。
每個連接涵蓋單一PlanetScale組織。Polylane會探索它的資料庫及其分支,包括狀態、方案、區域與結構描述活動。
疑難排解
「Invalid service token」錯誤
- 權杖ID與權杖都是必要的;只有權杖無法驗證。
- 檢查該權杖是否已在PlanetScale的設定中被刪除。
- 確認該權杖具有組織讀取存取。
「Multiple PlanetScale organizations are reachable」錯誤
- 這組憑證可以觸及多個組織,所以請指明要連接的那一個。
- 在主控台透過OAuth連接時,授權後在提示時選擇組織。
- 透過API連接時,把
organization欄位設為組織名稱。
缺少資源
- PlanetScale可能需要幾分鐘才能同步完所有內容。
- 從帳戶標頭觸發手動Sync以重新整理。
中斷連接
在Polylane中斷該帳戶的連接,然後從你的PlanetScale組織設定刪除該服務權杖。
從CI工作或任何其他沒有瀏覽器的環境連接PlanetScale。
連接PlanetScale不需要瀏覽器:主控台呼叫的同一個端點可以放進CI工作。一次經過驗證的POST建立連接並開始第一次同步。
先決條件
- 一把具有
cloud_accounts:write與cloud_accounts:read範圍的Polylane API金鑰。請見API金鑰與OAuth。 - 你的工作區ID,以
ws_開頭。用同一把金鑰從GET /v1/workspaces讀取它。 - 一組來自你組織Settings → Service tokens的PlanetScale服務權杖,具有組織讀取存取(例如
read_databases、read_branches)。主控台的OAuth流程需要瀏覽器;服務權杖不需要。
建立連接
curl -X POST https://api.polylane.com/v1/cloud_accounts \
-H "x-api-key: $POLYLANE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"provider": "planetscale",
"workspaceId": "ws_0abc123",
"tokenId": "<service-token-id>",
"token": "<service-token>",
"organization": "my-org"
}'
一次呼叫連接一個PlanetScale組織。
- 只有在該權杖恰好觸及一個組織時才可以省略
organization;否則呼叫會以列出可觸及組織名稱的400失敗。
回應列出已連接的內容,第一次同步已在執行。精簡為流程其餘部分會讀取的兩個欄位:
{
"success": true,
"result": {
"provider": "planetscale",
"accounts": [{ "id": "acc_34gky74ibc92h8t2efn8csrh", "status": "syncing" }],
"failures": []
}
}
已經連接的帳戶會落在failures而不是accounts中,所以重複呼叫永遠不會重複建立連接。
等待第一次同步
依id輪詢每個回傳的帳戶,直到status達到ready(註冊時為new,資源串流進來時為syncing):
until [ "$(curl -s "https://api.polylane.com/v1/cloud_accounts/$WORKSPACE_ID/$ACCOUNT_ID" \
-H "x-api-key: $POLYLANE_API_KEY" | jq -r '.result.status')" = "ready" ]; do
sleep 15
done
給這個迴圈一個期限,讓失敗的連接讓工作失敗,而不是掛住它。帳戶為ready後,它的資源就在拓樸中,Polylane也已開始第一次檢查。
從API中斷連接
刪除連接會停止所有同步與檢查,並刪除Polylane持有的憑證。這個呼叫需要cloud_accounts:delete範圍:
curl -X DELETE "https://api.polylane.com/v1/cloud_accounts/$WORKSPACE_ID/$ACCOUNT_ID" \
-H "x-api-key: $POLYLANE_API_KEY"
然後如下方中斷連接一節所述,在供應商端撤銷PlanetScale憑證。
中斷連接
中斷連接會停止所有同步與檢查,並刪除Polylane持有的憑證。 Polylane會移除PlanetScale的API允許它移除的東西。以下項目會留下,直到你自行移除:
- OAuth grant
polylane cloud disconnect <id>工具
2代理可以在對話串中執行的操作。
支援的資源
2會出現在你基礎設施圖中的資源類型。