setup-opensearch

December 24, 2025 ยท View on GitHub

An action for OpenSearch :tada:

  • Simpler than containers
  • Works on Linux, Mac, and Windows
  • Supports different versions

Build Status

Getting Started

Add it as a step to your workflow

      - uses: ankane/setup-opensearch@v1

Versions

Specify a version (defaults to the latest)

      - uses: ankane/setup-opensearch@v1
        with:
          opensearch-version: 3

Supports major versions (3, 2), minor versions (3.0, 2.19, etc), and full versions (3.0.0, 2.19.1, etc), and Windows requires 2.4+

Test against multiple versions

    strategy:
      matrix:
        opensearch-version: [3, 2]
    steps:
      - uses: ankane/setup-opensearch@v1
        with:
          opensearch-version: ${{ matrix.opensearch-version }}

Options

Install plugins

      - uses: ankane/setup-opensearch@v1
        with:
          plugins: |
            analysis-kuromoji
            analysis-smartcn

Set opensearch.yml config

      - uses: ankane/setup-opensearch@v1
        with:
          config: |
            http.port: 9200

Caching [experimental]

Add a step to your workflow before the setup-opensearch one

      - uses: actions/cache@v5
        with:
          path: ~/opensearch
          key: ${{ runner.os }}-opensearch-${{ matrix.opensearch-version }}

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help: