Debian GNU/Linux¶
CrateDB actively maintains packages for the following Debian versions:
This guide will show you how to install, control, and configure a single-node CrateDB on a local Debian system.
Table of contents
Configure Apt¶
You need to configure Apt (the package manager) to trust and to add the CrateDB repositories:
# Add HTTPS support
sh$ sudo apt install apt-transport-https
# Download the CrateDB GPG key
sh$ wget https://cdn.crate.io/downloads/apt/DEB-GPG-KEY-crate
# Add the key to Apt
sh$ sudo apt-key add DEB-GPG-KEY-crate
# Add CrateDB repositories to Apt
# `lsb_release -cs` returns the codename of your OS
echo "deb https://cdn.crate.io/downloads/apt/stable/ $(lsb_release -cs) main" |
sudo tee /etc/apt/sources.list.d/crate-stable.list
Note
CrateDB provides a stable release and a testing release channel. To use
the testing channel, replace stable with testing in the command
above. You can read more about our release workflow.
Now update Apt:
sh$ sudo apt 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.
Install CrateDB¶
You can now install CrateDB:
sh$ sudo apt install crate
After the installation is finished, the crate service should be
up-and-running.
You should be able to access it by visiting:
http://localhost:4200/
Caution
When you install via Apt, CrateDB automatically starts as a single-node cluster and you won’t be able to add additional nodes. In order to form a multi-node cluster, you will need to remove the cluster state after changing the configuration.
Control CrateDB¶
You can control the crate service with the systemctl utility:
sh$ sudo systemctl COMMAND crate
Replace COMMAND with start, stop, restart, status and so on.
so on.
Caution
Be sure to read the guide to rolling upgrades and full restart upgrades before attempting to upgrade a running cluster.
Configure CrateDB¶
In order to configure CrateDB, take note of the configuration file location and the available environment variables.
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. Here is an 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
Customized setups¶
A full list of package files can be obtained with this command:
sh$ dpkg-query -L crate
If you want to deviate from the way that the crate package integrates with
your system, we recommend that you go with a basic tarball installation.