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. 在 runner 上安装 CLI
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 命令可确保服务已运行或已删除,是等待删除的推荐工具。