https://github.com/ankane/setup-opensearch
An action for OpenSearch
https://github.com/ankane/setup-opensearch
Last synced: 1 day ago
JSON representation
An action for OpenSearch
- Host: GitHub
- URL: https://github.com/ankane/setup-opensearch
- Owner: ankane
- License: mit
- Created: 2021-05-21T03:34:55.000Z (almost 4 years ago)
- Default Branch: v1
- Last Pushed: 2025-02-28T02:59:22.000Z (about 2 months ago)
- Last Synced: 2025-03-28T05:06:18.593Z (19 days ago)
- Language: JavaScript
- Homepage:
- Size: 47.9 KB
- Stars: 29
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- jimsghstars - ankane/setup-opensearch - An action for OpenSearch (JavaScript)
README
# setup-opensearch
An action for OpenSearch :tada:
- Simpler than containers
- Works on Linux, Mac, and Windows
- Supports different versions
[](https://github.com/ankane/setup-opensearch/actions)
## Getting Started
Add it as a step to your workflow
```yml
- uses: ankane/setup-opensearch@v1
```
## Versions
Specify a version (defaults to the latest)
```yml
- 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
```yml
strategy:
matrix:
opensearch-version: [2, 1]
steps:
- uses: ankane/setup-opensearch@v1
with:
opensearch-version: ${{ matrix.opensearch-version }}
```
## Options
Install plugins
```yml
- uses: ankane/setup-opensearch@v1
with:
plugins: |
analysis-kuromoji
analysis-smartcn
```
Set `opensearch.yml` config
```yml
- uses: ankane/setup-opensearch@v1
with:
config: |
http.port: 9200
```
## Caching [experimental]
Add a step to your workflow **before** the `setup-opensearch` one
```yml
- uses: actions/cache@v3
with:
path: ~/opensearch
key: ${{ runner.os }}-opensearch-${{ matrix.opensearch-version }}
```
## Related Actions
- [setup-postgres](https://github.com/ankane/setup-postgres)
- [setup-mysql](https://github.com/ankane/setup-mysql)
- [setup-mariadb](https://github.com/ankane/setup-mariadb)
- [setup-mongodb](https://github.com/ankane/setup-mongodb)
- [setup-elasticsearch](https://github.com/ankane/setup-elasticsearch)
- [setup-sqlserver](https://github.com/ankane/setup-sqlserver)
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/ankane/setup-opensearch/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/setup-opensearch/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features