Elasticsearch Asset Bundle

A bundle of Teraslice processors for reading and writing elasticsearch data

• Elasticsearch Asset Bundle
  • APIS
  • Operations
  • Releases
  • Getting Started
  • Development
    • Tests
    • Build
  • Contributing
  • License

APIS​

• elasticsearch_reader_api
• elasticsearch_sender_api
• elasticsearch_state_storage
• spaces_reader_api

Operations​

• elasticsearch_bulk
• elasticsearch_reader
• id_reader
• spaces_reader

Releases​

You can find a list of releases, changes, and pre-built asset bundles here.

Getting Started​

This asset bundle requires a running Teraslice cluster. Documentation.

# Step 1: make sure you have teraslice-cli installed
# corepack ships with Node.js (v16.9+) and manages package managers automatically
corepack enable
pnpm add -g teraslice-cli

# Step 2:
# teraslice-cli assets deploy <cluster_alias> <asset-name[@version]>
# 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​

This project uses pnpm as its package manager. pnpm is managed via corepack, which ships with Node.js v16.9+. To enable it:

corepack enable

This ensures the correct pnpm version (defined in packageManager in package.json) is used automatically.

Tests​

Run the elasticsearch-assets tests

Requirements:

• docker - An OpenSearch container will be created using Docker

pnpm test

Build​

Build a compiled asset bundle to deploy to a teraslice cluster.

Install Teraslice CLI:

pnpm add -g teraslice-cli

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 licensed.