https://github.com/terascope/elasticsearch-assets
Teraslice processors for working with data in Elasticsearch
https://github.com/terascope/elasticsearch-assets
Last synced: 4 months ago
JSON representation
Teraslice processors for working with data in Elasticsearch
- Host: GitHub
- URL: https://github.com/terascope/elasticsearch-assets
- Owner: terascope
- License: mit
- Created: 2018-06-25T21:06:42.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2026-01-12T22:55:46.000Z (5 months ago)
- Last Synced: 2026-01-13T02:50:10.977Z (5 months ago)
- Language: TypeScript
- Homepage: https://terascope.github.io/elasticsearch-assets/
- Size: 15.6 MB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Elasticsearch Asset Bundle
> A bundle of [Teraslice](https://terascope.github.io/teraslice) processors for reading and writing [elasticsearch](https://www.elastic.co/elasticsearch) data
- [Elasticsearch Asset Bundle](#elasticsearch-asset-bundle)
- [APIS](#apis)
- [Operations](#operations)
- [Releases](#releases)
- [Getting Started](#getting-started)
- [Development](#development)
- [Tests](#tests)
- [Build](#build)
- [Contributing](#contributing)
- [License](#license)
## APIS
- [elasticsearch_reader_api](./docs/asset/apis/elasticsearch_reader_api)
- [elasticsearch_sender_api](./docs/asset/apis/elasticsearch_sender_api)
- [elasticsearch_state_storage](./docs/asset/apis/elasticsearch_state_storage)
- [spaces_reader_api](./docs/asset/apis/spaces_reader_api)
## Operations
- [elasticsearch_bulk](./docs/asset/operations/elasticsearch_bulk)
- [elasticsearch_reader](./docs/asset/operations/elasticsearch_reader)
- [id_reader](./docs/asset/operations/id_reader)
- [spaces_reader](./docs/asset/operations/spaces_reader)
## Releases
You can find a list of releases, changes, and pre-built asset bundles [here](https://github.com/terascope/elasticsearch-assets/releases).
## Getting Started
This asset bundle requires a running Teraslice cluster. [Documentation](https://github.com/terascope/teraslice/blob/master/README.md).
```bash
# Step 1: make sure you have teraslice-cli installed
yarn global add teraslice-cli
# Step 2:
# teraslice-cli assets deploy
# deploy the latest release to a teraslice cluster
teraslice-cli assets deploy cluster1 terascope/elasticsearch-assets
# or deploy a specific version to a teraslice cluster
teraslice-cli assets deploy localCluster terascope/elasticsearchassets@4.3.0
# or build from source and deploy to a teraslice cluster
teraslice-cli assets deploy cluster2 --build
```
## Development
### Tests
Run the elasticsearch-assets tests
**Requirements:**
- `docker` - An [Elasticsearch](https://hub.docker.com/r/elastic/elasticsearch) container will be created using [Docker](https://docs.docker.com/get-started/)
```bash
yarn test
```
### Build
Build a compiled asset bundle to deploy to a teraslice cluster.
**Install Teraslice CLI:**
```bash
yarn global add teraslice-cli
```
```bash
teraslice-cli assets build
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://github.com/terascope/elasticsearch-assets/blob/master/LICENSE) licensed.