TimescaleDB: 2. 服務生命週期腳本

此文件屬於GitHub Actions 及 GitLab CI指南的一部分。請在此處查看完整指南:直接於您的 GitHub Actions 或 GitLab CI pipeline 啟動一個真實的 TimescaleDB 服務,執行測試,並自動清理資源

歡迎瀏覽 Stackhero 文件!

Stackhero 為您提供即開即用的 TimescaleDB cloud 方案,助您在數分鐘內輕鬆上手。您可以享有以下優勢:

  • 已預載所有頂級 插件,如 PostGISPgVector 等。
  • 方便存取 PgAdmin 網頁介面,輕鬆管理資料庫。
  • 一鍵式 更新,讓您的部署隨時保持最新狀態。
  • 在您專屬的 私有獨立基礎設施 上,確保 高效能強大安全性

如果您希望節省時間並簡化工作流程,Stackhero 的 TimescaleDB cloud hosting 將為您帶來最流暢的體驗。最快 5 分鐘即可試用!

以下是一個完整的腳本範例,涵蓋服務的全生命週期。您會看到只需幾個指令即可完成設定。您可於下方各平台區段複製對應的 YAML 範本。

#!/bin/bash
set -euo pipefail

# STACKHERO_TOKEN 由 CI 機密提供,CLI 會自動讀取。

stackName="ci-timescaledb-$$"          # 每次執行唯一的 stack 名稱
serviceStore="timescaledb"             # TimescaleDB 服務 store
instance="10G"        # 如有需要可調整(見步驟 3)
region="europe"                         # 區域名稱(可用 stackhero regions-list 查詢)

# 1. 安裝 CLI 至 runner
curl -fsSL https://www.stackhero.io/install.sh | sh

# 2. 安裝 smoke test 所需 client(jq + curl 為基本需求)
apt-get update && apt-get install -y --no-install-recommends jq curl postgresql-client

# 3. 建立本次執行專屬的 stack
stackId=$(stackhero --format=script stack-create --name="$stackName")
echo "Stack created: $stackId"

# 4. 加入 TimescaleDB 並取得其 service id
serviceId=$(stackhero --format=script service-add \
  --stack="$stackId" \
  --service-store="$serviceStore" \
  --instance="$instance" \
  --region="$region")
echo "Service added: $serviceId"

# 5. 等待服務啟動(可能需數分鐘)
stackhero service-wait-for --service="$serviceId"

# 6. 讀取設定(包含產生的認證資料)
config=$(stackhero service-configuration-get --service="$serviceId" --format=json)

# 7. 擷取所需認證資料
host=$(echo "$config" | jq -r '.configuration.domain')
password=$(echo "$config" | jq -r '.configuration.password')

# 8. Smoke test:Run a trivial query against the database.
PGPASSWORD="$password" psql "host=$host port=5432 user=admin dbname=admin sslmode=require" -c "SELECT 1;"

echo "✅ TimescaleDB 已可由 CI 存取。"

清理步驟(刪除服務、等待刪除完成、再刪除 stack)會在下方各平台專屬區段說明。這樣可確保即使 smoke test 失敗也會自動清理。

Stack 必須為空才能刪除。請務必先刪除服務並等待其移除,再刪除 stack。service-wait-for 指令可確保服務已啟動或已刪除,是等待刪除的最佳工具。