setup-opensearch

An action for OpenSearch 🎉

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

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: 2

Supports major versions (2, 1), minor versions (2.17, 1.3, etc), and full versions (2.17.0, 1.3.19, etc), and Windows requires 2.4+

Test against multiple versions

    strategy:
      matrix:
        opensearch-version: [2, 1]
    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@v3
        with:
          path: ~/opensearch
          key: ${{ runner.os }}-opensearch-${{ matrix.opensearch-version }}

Related Actions

• setup-postgres
• setup-mysql
• setup-mariadb
• setup-mongodb
• setup-elasticsearch
• setup-sqlserver

Contributing

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

• Report bugs
• Fix bugs and submit pull requests
• Write, clarify, or fix documentation
• Suggest or add new features