It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Configure your operating system Red Hat Enterprise Linux (RHEL) and CentOS »

› › › ›

Ubuntu 16.04 LTS (Xenial Xerus) and 18.04 LTS (Bionic Beaver)

edit

Ubuntu 16.04 LTS (Xenial Xerus) and 18.04 LTS (Bionic Beaver)

edit

The following instructions show you how to prepare your hosts on Ubuntu 16.04 LTS (Xenial Xerus) and 18.04 LTS (Bionic Beaver).

Install a supported Linux kernel

edit

Elastic Cloud Enterprise requires 3.10 or higher. The steps shown here install kernel 4.4.

Refresh the package index files from their sources:
```
sudo apt-get update
```
Install the xfsprogs package available on your system. You can omit the xfsprogs package if you don’t plan to use XFS.
```
sudo apt-get install -y xfsprogs
```

Install Docker

edit

Install Docker LTS version 18.09 for Ubuntu 16.04 or 19.03 for Ubuntu 18.04

Add the Docker repository:

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo \
     apt-key add -

Verify that you have the key with the 9DC8 5822 9FC7 DD38 854A E2D8 8D81 803C 0EBF CD88 fingerprint.

sudo apt-key fingerprint 0EBFCD88
...
pub   4096R/0EBFCD88 2017-02-22
      Key fingerprint = 9DC8 5822 9FC7 DD38 854A  E2D8 8D81 803C 0EBF CD88
uid                  Docker Release (CE deb) <docker@docker.com>
sub   4096R/F273FCD8 2017-02-22
...

Add the stable docker repository:

`# Install package manager dependencies
sudo apt install -y software-properties-common apt-transport-https
# Add repo GPG key
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add
# Add the docker managed repo
sudo add-apt-repository \
   "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
   $(lsb_release -cs) \
   stable"
# Update apt to pick up the new packages
sudo apt update

Install the correct version of the docker-ce package, for Ubuntu 16.04 LTS (Xenial Xerus):

sudo apt install -y docker-ce=5:18.09.* docker-ce-cli=5:18.09.* containerd.io=1.2.*

For Ubuntu 18.04 LTS (Bionic Beaver):

sudo apt install -y docker-ce=5:19.03.* docker-ce-cli=5:19.03.* containerd.io=1.3.*

Set up XFS quotas

edit

XFS is required to support disk space quotas for Elasticsearch data directories. Some Linux distributions such as RHEL and CentOS already provide XFS as the default file system. On Ubuntu, we recommend that you set up an XFS file system first.

Disk space quotas set a limit on the amount of disk space an Elasticsearch cluster node can use. Currently, quotas are calculated by a static ratio of 1:32, which means that for every 1 GB of RAM a cluster is given, a cluster node is allowed to consume 32 GB of disk space.

Using LVM, mdadm, or a combination of the two for block device management is possible, but the configuration is not covered here, and it is not supported by Elastic Cloud Enterprise.

You must use XFS on all allocators.

Example: Set up XFS on a single, pre-partitioned block device named /dev/xvdg1.

Format the partition:
```
sudo mkfs.xfs /dev/xvdg1
```

Create the /mnt/data/ directory as a mount point:

sudo install -o $USER -g $USER -d -m 700 /mnt/data

Add an entry to the /etc/fstab file for the new XFS volume. The default filesystem path used by Elastic Cloud Enterprise is /mnt/data.
```
/dev/xvdg1	/mnt/data	xfs	defaults,nofail,x-systemd.automount,prjquota,pquota  0 2
```

Regenerate the mount files:

sudo systemctl daemon-reload
sudo systemctl restart local-fs.target

Update the configurations settings

edit

Stop the Docker service:
```
sudo systemctl stop docker
```
Enable cgroup accounting for memory and swap space.
1. In the /etc/default/grub file, ensure that the GRUB_CMDLINE_LINUX= variable includes these values:
```
cgroup_enable=memory swapaccount=1 cgroup.memory=nokmem
```
2. Update your Grub configuration:
```
sudo update-grub
```

Configure kernel parameters

cat <<EOF | sudo tee -a /etc/sysctl.conf
# Required by Elasticsearch 5.0 and later
vm.max_map_count = 262144
# enable forwarding so the Docker networking works as expected
net.ipv4.ip_forward = 1
# Make sure the host doesn't swap too early
vm.swappiness=1
EOF

Apply the settings:
```
sudo sysctl -p
```

Adjust the system limits.

Add the following configuration values to the /etc/security/limits.conf file. These values are derived from our experience with the Elastic Cloud hosted offering and should be used for Elastic Cloud Enterprise as well.

If you are using a user name other than elastic, adjust the configuration values accordingly.

*                soft    nofile         1024000
*                hard    nofile         1024000
*                soft    memlock        unlimited
*                hard    memlock        unlimited
elastic          soft    nofile         1024000
elastic          hard    nofile         1024000
elastic          soft    memlock        unlimited
elastic          hard    memlock        unlimited
root             soft    nofile         1024000
root             hard    nofile         1024000
root             soft    memlock        unlimited

If you did not create the mount point earlier (if you did not set up XFS), create the /mnt/data/ directory as a mount point:
```
sudo install -o $USER -g $USER -d -m 700 /mnt/data
```
If you set up a new device with XFS earlier:
1. Mount the block device (change the device name if you use a different device than /dev/xvdg1):
```
sudo mount /dev/xvdg1
```
2. Set the permissions on the newly mounted device:
```
sudo chown $USER:$USER /mnt/data
```
Create the /mnt/data/docker directory for the Docker service storage:
```
sudo install -o $USER -g $USER -d -m 700 /mnt/data/docker
```

Configure the Docker daemon options

edit

Docker creates a bridge IP address that can conflict with IP addresses on your internal network. To avoid an IP address conflict, change the --bip=172.17.42.1/16 parameter in our examples to something that you know will work. If there is no conflict, you can omit the --bip parameter. The --bip parameter is internal to the host and can be set to the same IP for each host in the cluster. More information on Docker daemon options can be found in the dockerd command line reference.

Update /etc/systemd/system/docker.service.d/docker.conf. If the file path and file do not exist, create them first.

[Unit]
Description=Docker Service
After=multi-user.target

[Service]
Environment="DOCKER_OPTS=-H unix:///run/docker.sock --data-root /mnt/data/docker --storage-driver=overlay2 --bip=172.17.42.1/16 --raw-logs --icc=false"
ExecStart=
ExecStart=/usr/bin/dockerd $DOCKER_OPTS

Apply the updated Docker daemon configuration:

Reload the Docker daemon configuration:
```
sudo systemctl daemon-reload
```
Restart the Docker service:
```
sudo systemctl restart docker
```
Enable Docker to start on boot:
```
sudo systemctl enable docker
```
Enable your user to communicate with the Docker subsystem by adding it to the docker group:
```
sudo usermod -aG docker $USER
```

Recommended: Tune your network settings.

Create a 70-cloudenterprise.conf file in the /etc/sysctl.d/ file path that includes these network settings:

cat << SETTINGS | sudo tee /etc/sysctl.d/70-cloudenterprise.conf
net.ipv4.tcp_max_syn_backlog=65536
net.core.somaxconn=32768
net.core.netdev_max_backlog=32768
SETTINGS

Pin the Docker version to ensure that the package does not get upgraded:
```
echo "docker-ce hold" | sudo dpkg --set-selections
```
Reboot your system to ensure that all configuration changes take effect:
```
sudo reboot
```
After rebooting, verify that your Docker settings persist as expected:
```
sudo docker info | grep Root
```
If the command returns Docker Root Dir: /mnt/data/docker, then your changes were applied successfully and persist as expected.

If the command returns Docker Root Dir: /var/lib/docker, then you need to troubleshoot the previous configuration steps until the Docker settings are applied successfully before continuing with the installation process. For more information, see Custom Docker daemon options in the Docker documentation.
Repeat these steps on other hosts that you want to use with Elastic Cloud Enterprise or follow the steps in the next section to start installing Elastic Cloud Enterprise.

« Configure your operating system Red Hat Enterprise Linux (RHEL) and CentOS »