Skip to content

crate job from crate/2

Github source: 089663e5 or master branch

Properties

crate

bootstrap

mlockall

Set this property to true to lock the memory (Crate performs poorly when JVM starts swapping: you should ensure that it never swaps)

cluster

graceful_stop
force

The force setting allows you to force a shutdown of a node when the graceful shutdown process runs into the cluster.graceful_stop.timeout

min_availability

The minimum data availability the cluster needs to ensure when a certain node is shut down

reallocate

The cluster may reallocate shards to ensure minimum data availabillity before a certain node shuts down

timeout

The time to wait for the reallocation process to be finished

info_update_interval

Defines how often the cluster collection metadata information if no concrete event is triggered

name

Cluster Name

Default
crate
routing
allocation
allow_rebalance

Allow to control when rebalancing will happen based on the total state of all the indices shards in the cluster

balance
index

Defines a factor to the number of shards per index allocated on a specific node (float)

primary

Defines a weight factor for the number of primaries of a specific index allocated on a node (float)

shard

Defines the weight factor for shards allocated on a node (float)

threshold

Minimal optimization value of operations that should be performed (non negative float)

cluster_concurrent_rebalance

Define how many concurrent rebalancing tasks are allowed cluster wide

disk
threshold_enabled

Prevent shard allocation on nodes depending on the disk usage

watermark
high

Defines the higher disk threshold limit for shard allocations

low

Defines the lower disk threshold limit for shard allocations

enable

Limit shard allocations to certain kinds of shards, for example if you perform a rolling cluster upgrade

node_concurrent_recoveries

How many concurrent recoveries are allowed to happen on a node

node_initial_primaries_recoveries

Define the number of initial recoveries of primaries that are allowed per node

discovery

zen
fd
ping_interval

Ping interval

ping_retries

Ping retries

ping_timeout

Ping timeout

minimum_master_nodes

Set to ensure a node sees M other master eligible nodes to be considered operational within the cluster

ping
multicast
enabled

Enable/Disable multicast discovery

Default
false
timeout

Set the time to wait for ping responses from other nodes when discovering

publish_timeout

Time a node is waiting for responses from other nodes to a published cluster state

es

api_enabled

enable/disable elasticsearch HTTP REST API

group

Group which will own the Crate services

Default
vcap

http

enabled

Disable HTTP completely

max_content_length

Set a custom allowed content length

port

Set a custom port to listen for HTTP traffic

index

indexing
slowlog
threshold
index
debug

Shard level index threshold debug logging

info

Shard level index threshold info logging

trace

Shard level index threshold trace logging

warn

Shard level index threshold warn logging

number_of_replicas

Set the number of replicas (additional copies) of a table (1 by default)

number_of_shards

Set the number of shards (splits) of a table (5 by default)

search
slowlog
threshold
fetch
debug

Shard level fetch threshold debug logging

info

Shard level fetch threshold info logging

trace

Shard level fetch threshold trace logging

warn

Shard level fetch threshold warn logging

query
debug

Shard level query threshold debug logging

info

Shard level query threshold info logging

trace

Shard level query threshold trace logging

warn

Shard level query threshold warn logging

indices

fielddata
breaker
limit

Specifies the limit for the fielddata breaker

overhead

A constant that all field data estimations are multiplied with to determine a final estimation

recovery
compress

Define if transferred data should be compressed during the recovery process

concurrent_streams

Set to limit the number of open concurrent streams when recovering a shard from a peer

file_chunk_size

Specifies the chunk size used to copy the shard data from the source shard

max_bytes_per_sec

Specifies the maximum number of bytes that can be transferred during shard recovery per seconds

max_size_per_sec

Set to throttle throughput when recovering (eg. 100mb, by default unlimited)

translog_ops

Specifies how many transaction log lines should be transfered between shards in a single request during the recovery process

translog_size

Specifies how much data of the transaction log should be transfered between shards in a single request during the recovery process

store
throttle
max_bytes_per_sec

If throttling is enabled, this setting specifies the maximum bytes per second a store module process can operate with

type

Allows to throttle merge (or all) process of the store module

insert_by_query

request_timeout

Insert from subquery timeout

java

direct_size

Java direct size

heap_size

Java heap size

max_mem

Java max memory

min_mem

Java min memory

use_gc_logging

Java use GC logging

logger

action
Default
DEBUG
discovery

Log the discovery process

Default
false
index_indexing_slowlog

Log slow index indexing

Default
false
index_search_slowlog

Log slow index search

Default
false
indices_recovery

Log peer shard recovery

Default
false

master_nodes

Array of master nodes hostnames/addresses

Default
[]

monitor

jvm
gc
concurrentmarksweep
debug

ConcurrentMarkSweep GC Logging

info

ConcurrentMarkSweep GC Logging

warn

ConcurrentMarkSweep GC Logging

parnew
debug

ParNew GC Logging

info

ParNew GC Logging

warn

ParNew GC Logging

network

bind_host

Set the bind address specifically (IPv4 or IPv6)

host

Set both ‘bind_host’ and ‘publish_host’

publish_host

Set the address other nodes will use to communicate with this node

node

data

Set if you want this node to never become a data node

master

Set if you want this node to never become a master node

max_local_storage_nodes

By default, multiple nodes are allowed to start from the same installation location to disable it, set the following

rack

Node generic attributes

node_breaker

query_limit

Specifies the limit for the query breaker

query_overhead

A constant that all query data estimations are multiplied with to determine a final estimation

planner

optimize_pk_queries

If disabled, queries filtering for a primary key will be broadcast to all available shards instead of hitting just the related single shard

threadpool

index
queue_size

Thread pool queue size

type

Thread pool type

transport

tcp
compress

Enable compression for all communication between nodes (disabled by default)

port

Set a custom port for the node to node communication (4300 by default)

udc

enabled

enable/disable usage data collection at all

initial_delay

The delay for first ping after start-up

interval

The interval a ping is sent

url

The url the ping is sent to

user

User which will own the Crate services

Default
root

Templates

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

  • bin/ctl (from bin/ctl)
  • bin/monit_debugger (from bin/monit_debugger)
  • config/crate.yml (from config/crate.yml.erb)
  • config/logging.yml (from config/logging.yml.erb)
  • data/properties.sh (from data/properties.sh.erb)
  • helpers/ctl_setup.sh (from helpers/ctl_setup.sh)
  • helpers/ctl_utils.sh (from helpers/ctl_utils.sh)

Packages

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