Run CrateDB on Ubuntu¶

CrateDB 2.1.0 or Higher¶

Firstly, you will need to configure Apt (the Ubuntu package manager) to trust the CrateDB repository.

Download the CrateDB GPG key:

sh$ wget https://cdn.crate.io/downloads/deb/DEB-GPG-KEY-crate

And then add the key to Apt:

sh$ sudo apt-key add DEB-GPG-KEY-crate

CrateDB provides a stable release and a testing release channel. At this point, you should select which one you wish to use.

Create an Apt configuration file, like so:

sh$ sudo touch /etc/apt/sources.list.d/crate-CHANNEL.list

Here, replace CHANNEL with stable or testing, depending on which type of release channel you plan to use.

Then, edit it, and add the following:

deb https://cdn.crate.io/downloads/deb/CHANNEL/ CODENAME main
deb-src https://cdn.crate.io/downloads/deb/CHANNEL/ CODENAME main

Here, replace CHANNEL as above, and then, additionally, replace CODENAME with the codename of your distribution, which can be round by running:

sh$ source /etc/os-release && echo $UBUNTU_CODENAME

Once that is done, update Apt:

sh$ sudo apt-get update

You should see a success message. This indicates that the CrateDB release channel is correctly configured and the crate package has been registered locally.

You can now install CrateDB.

Skip to Install CrateDB.

Older Versions¶

For version of CrateDB older than 2.1.0, you will have to install from an official, but unmaintained, PPA repository.

Firstly, you will need to install package that allows you to add new PPA repositories:

sh$ sudo apt-get install python-software-properties

If you’re running Xenial Xerus (16.04) or higher, you will also need to install this package:

sh$ sudo apt-get install software-properties-common

CrateDB provides a stable and a testing release channel. At this point, you should select which one you wish to use.

Now, it will be possible to add the PPA repository, like so:

sh$ sudo add-apt-repository ppa:crate/CHANNEL

Here, replace CHANNEL with stable or testing, depending on which release channel you plan to use.

Once that is done, update Apt:

sh$ sudo apt-get update

You should see a success message. This indicates that the CrateDB release channel is correctly configured and the crate package has been registered locally.

You can now install CrateDB.

Configuration Files¶

The main CrateDB configuration files are located in the /etc/crate directory.

Environment¶

The CrateDB startup script sources environment variables from the /etc/default/crate file.

You can use this mechanism to configure CrateDB.

Here’s one example:

# Heap Size (defaults to 256m min, 1g max)
CRATE_HEAP_SIZE=2g

# Maximum number of open files, defaults to 65535.
# MAX_OPEN_FILES=65535

# Maximum locked memory size. Set to "unlimited" if you use the
# bootstrap.mlockall option in crate.yml. You must also set
# CRATE_HEAP_SIZE.
MAX_LOCKED_MEMORY=unlimited

# Additional Java OPTS
# CRATE_JAVA_OPTS=

# Force the JVM to use IPv4 stack
CRATE_USE_IPV4=true