Skip to content

elasticsearch job from logsearch/211.0.2

This job runs Elasticsearch node (master or data)

Github source: a08d4dc or master branch

Properties

elasticsearch

cloud

aws
access_key

Access key ID for AWS account

bucket

Bucket name on S3 where to keep snapshots

Default
""
protocol

Protocol to use for all API calls to AWS endpoints

Default
https
read_timeout

The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out

Default
50s
region

Specify the AWS region to use

secret_key

Secret access key for AWS account

cluster_name

The name of the elastic search cluster

Default
logsearch

config_options

Additional options to append to elasticsearch’s config.yml (YAML format).

discovery

minimum_master_nodes

The minimum number of master eligible nodes a node should “see” in order to operate within the cluster. Recommended to set it to a higher value than 1 when running more than 2 nodes in the cluster.

Default
auto

exec

environment

A hash of additional environment variables for the process

options

An array of additional options to pass when starting elasticsearch

Default
[]

health

connect_interval

Post-start interval for node to become available (seconds)

Default
5
connect_timeout

Post-start timeout for node to become available (seconds)

Default
60
disable_post_start

Allow node to run post-start script? (true / false)

Default
false
interval

Post-start interval for node to join cluster (seconds)

Default
15
timeout

Post-start timeout for node to join cluster (seconds)

Default
300

heap_percentage

The percentage value used in the calculation to set the heap size.

Default
46

heap_size

sets jvm heap sized

http_host

The host address to bind the elasticsearch HTTP service to and to publish for HTTP clients to connect to

Default
0.0.0.0

jvm_options

Additional Java Virtual Machine options

Default
[]

limits

fd

Maximum file descriptors

Default
65536

log_level

The default logging level (e.g. WARN, DEBUG, INFO)

Default
INFO

logging_options

Additional options to append to elasticsearch’s logging.yml (YAML format).

master_hosts

The list of elasticsearch master node IPs

node

allow_data

Allow node to store data? (true / false)

Default
false
allow_ingest

Allow node to become ingest node? (true / false)

Default
false
allow_master

Allow node to become master? (true / false)

Default
false
tags

A hash of additional tags for the node

path_repo

Shared file system to store snapshots. In order to register the shared file system repository it is necessary to mount the same shared filesystem to the same location on all master and data nodes.

Default
""

plugins

Plugins to run elasticsearch with (array[] = { plugin-name: install-source }; e.g. [ { kopf: ‘lmenezes/elasticsearch-kopf’ } ])

Default
[]

port

Port address of elasticsearch host to proxy requests for

Default
9200

recovery

delay_allocation

Delay allocation interval

Default
1m
delay_allocation_restart

Delay allocation interval during restart

Default
5m

snapshots

repository

Repository name for automatic snapshots

Default
""

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/elasticsearch/ directory (learn more).

  • bin/drain (from bin/drain.erb)
  • bin/elasticsearch.sh (from bin/elasticsearch)
  • bin/post-deploy (from bin/post-deploy.erb)
  • bin/post-start (from bin/post-start.erb)
  • bin/pre-start (from bin/pre-start)
  • config/bpm.yml (from config/bpm.yml.erb)
  • config/elasticsearch.yml (from config/config.yml.erb)
  • config/jvm.options (from config/jvm.options.erb)
  • config/log4j2.properties (from config/log4j2.properties.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.