elasticsearch data source

blackstork/elastic, v0.4.2

Installation #

BlackStork SaaS: Plugin dependencies are resolved automatically by the platform. You do not need to install plugins or define the blackstork configuration block manually.

To use the elasticsearch data source locally via blackstork-cli, you must declare the blackstork/elastic plugin as a dependency in your global configuration block.

blackstork {
  plugin_versions = {
    "blackstork/elastic" = ">= v0.4.2"
  }
}

After declaring the dependency, execute blackstork-cli install to fetch the plugin. See Configuration for details.

Configuration #

This data source accepts the following configuration arguments within a config data elasticsearch block:

config data elasticsearch {
  # Optional string.
  # Default value:
  base_url = null

  # Optional string.
  # Default value:
  cloud_id = null

  # Optional string.
  # Default value:
  api_key_str = null

  # Optional list of string.
  # Default value:
  api_key = null

  # Optional string.
  # Default value:
  basic_auth_username = null

  # Optional string.
  # Default value:
  basic_auth_password = null

  # Optional string.
  # Default value:
  bearer_auth = null

  # Optional string.
  # Default value:
  ca_certs = null
}

Usage #

This data source accepts the following arguments within a data elasticsearch block:

data elasticsearch {
  # Required string.
  #
  # For example:
  index = "some string"

  # Optional string.
  # Default value:
  id = null

  # Optional string.
  # Default value:
  query_string = null

  # Optional map of any single type.
  # Default value:
  query = null

  # Optional any type.
  # Default value:
  aggs = null

  # Optional bool.
  # Default value:
  only_hits = null

  # Optional list of string.
  # Default value:
  fields = null

  # Optional number.
  # Must be >= 0
  # Default value:
  size = 1000
}