OpenSearch: 4. GitHub Actions

このドキュメントはGitHub Actions & GitLab CIガイドの一部です。完全なガイドはこちらからご覧いただけます:GitHub Actions または GitLab CI パイプラインから実際の OpenSearch サービスを起動し、テストを実行して、自動的に削除する方法

👋 Stackhero ドキュメントへようこそ!

Stackhero では、パフォーマンスとセキュリティを両立した、完全マネージド型の OpenSearch クラウド 環境をご提供しています:

  • プライベートかつ専用インフラ上での高いパフォーマンスと強固なセキュリティ
  • ご自身のカスタムドメイン名を利用可能、標準でHTTPSによる保護付き。
  • データの探索や可視化が簡単にできる OpenSearch Dashboards を標準搭載。

セットアップや運用の手間を削減:Stackhero の OpenSearch クラウドホスティング なら、数分でご利用を開始できます。

まず、以下の内容を .github/workflows/ci.yml として保存してください。これ以降、push や pull request ごとに実際の OpenSearch インスタンスでテストが実行されます。

name: CI with OpenSearch

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    env:
      STACKHERO_TOKEN: ${{ secrets.STACKHERO_TOKEN }}
      STACK_NAME: ci-opensearch-${{ github.run_id }}-${{ github.run_attempt }}
      INSTANCE: "20G"   # 必要に応じて変更(ステップ3参照)
      REGION: europe
    steps:
      - uses: actions/checkout@v4

      - name: Stackhero CLI とクライアントのインストール
        run: |
          curl -fsSL https://www.stackhero.io/install.sh | sh
          apt-get update && apt-get install -y --no-install-recommends jq curl

      - name: OpenSearch サービスの作成
        run: |
          set -euo pipefail
          STACK_ID=$(stackhero --format=script stack-create --name="$STACK_NAME")
          echo "STACK_ID=$STACK_ID" >> "$GITHUB_ENV"
          SERVICE_ID=$(stackhero --format=script service-add \
            --stack="$STACK_ID" \
            --service-store="opensearch" \
            --instance="$INSTANCE" \
            --region="$REGION")
          echo "SERVICE_ID=$SERVICE_ID" >> "$GITHUB_ENV"
          stackhero service-wait-for --service="$SERVICE_ID"

      - name: OpenSearch でテストを実行
        run: |
          set -euo pipefail
          config=$(stackhero service-configuration-get --service="$SERVICE_ID" --format=json)
          host=$(echo "$config" | jq -r '.configuration.domain')
user=$(echo "$config" | jq -r '.configuration.credentials.login')
password=$(echo "$config" | jq -r '.configuration.credentials.password')
          # Call the cluster health endpoint.
          curl -fsS -u "$user:$password" "https://$host:9200/_cluster/health" | grep -q '"status"'
          echo "✅ OpenSearch は CI から到達可能です。"
          # 上記の認証情報を使って独自のテストスイートも実行できます ...

      - name: クリーンアップ(常に実行、失敗時も)
        if: always()
        run: |
          if [ -n "${SERVICE_ID:-}" ]; then
            stackhero service-delete --service="$SERVICE_ID" --confirm
            stackhero service-wait-for --service="$SERVICE_ID"
          fi
          if [ -n "${STACK_ID:-}" ]; then
            stackhero stack-delete --stack="$STACK_ID" --confirm
          fi

クリーンアップステップは if: always() で設定されているため、どんな場合でも必ず実行され、OpenSearch インスタンスが削除され、未使用リソースの課金を防ぎます。