OpenSearch: 2. 生命周期脚本
本文件是GitHub Actions 与 GitLab CI指南的一部分。您可以在这里查看完整指南:通过您的 GitHub Actions 或 GitLab CI pipeline 启动一个真实的 OpenSearch 服务,运行测试并自动销毁。
👋 欢迎来到 Stackhero 文档!
Stackhero 为您提供全托管的 OpenSearch cloud 环境,兼顾高性能与安全性:
- 在专属私有基础设施上实现高性能与强安全性。
- 支持自定义域名,默认启用HTTPS保护。
- 内置 OpenSearch Dashboards,便于数据探索与可视化。
省去繁琐的部署与维护:只需几分钟,您即可在 Stackhero 上快速体验 OpenSearch cloud hosting。
以下是一个完整的服务生命周期管理脚本示例。只需几条命令即可完成全部配置。您可以直接复制下方各平台的 YAML 示例。
#!/bin/bash
set -euo pipefail
# STACKHERO_TOKEN 由 CI 密钥提供,CLI 会自动读取。
stackName="ci-opensearch-$$" # 每次运行唯一的 stack 名称
serviceStore="opensearch" # OpenSearch 服务 store
instance="20G" # 如有需要可修改(见第 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
# 3. 为本次运行创建专用 stack
stackId=$(stackhero --format=script stack-create --name="$stackName")
echo "Stack created: $stackId"
# 4. 添加 OpenSearch 并获取其 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')
user=$(echo "$config" | jq -r '.configuration.credentials.login')
password=$(echo "$config" | jq -r '.configuration.credentials.password')
# 8. Smoke test: Call the cluster health endpoint.
curl -fsS -u "$user:$password" "https://$host:9200/_cluster/health" | grep -q '"status"'
echo "✅ OpenSearch 已可从 CI 访问。"
销毁步骤(删除服务、等待其移除、再删除 stack)请参考下方各平台专属部分。这样可以确保即使 smoke test 失败也能始终完成资源清理。
Stack 只有在为空时才能被删除。请务必先删除服务并等待其移除,再删除 stack。
service-wait-for命令可确保服务已运行或已删除,是等待删除的推荐工具。