Installing Envoy

This guide provides instructions for installing Envoy, which acts as a front proxy for Deephaven. Select a single node within the Deephaven cluster for installation, ensuring it has network access to the other Deephaven services.

Note

Before you begin, it is critical to check the Deephaven version support matrix to identify the correct Envoy version compatible with your Deephaven instance. When updating to a new major version of Deephaven, an upgrade of Envoy may also be necessary.

While several installation methods exist, Deephaven recommends using the official pre-built Docker images for ease of configuration, management, and maintenance. Other supported methods include using apt-get for Ubuntu systems, building from source, or deploying as part of a cluster. For containerized environments where Docker is not preferred, Podman can be used as an alternative.

The following sections provide instructions for common installation methods. For comprehensive details or alternative methods, refer to the official Envoy installation documentation.

First, ensure that Docker (or Podman) is installed and running on the host, then download the Envoy proxy image that matches your Deephaven version.

Note

If using Podman, replace docker with podman in the commands below. For more details on Podman, see the Podman installation guide.

# For Docker
sudo docker pull envoyproxy/envoy:v1.29.4

# For Podman
sudo podman pull envoyproxy/envoy:v1.29.4

Important: Replace v1.29.4 with the specific Envoy version compatible with your Deephaven instance, as indicated in the Deephaven version support matrix.

On Ubuntu systems, you can install Envoy using apt-get:

sudo apt-get update
sudo apt-get install envoy

Ensure this installs a version of Envoy compatible with your Deephaven instance. You might need to add a specific repository or install a particular version. Check the Envoy installation documentation for Ubuntu-specific instructions if the default package is not suitable.

Other installation methods

Manual build from source

You can build Envoy from source by following the instructions on the official Envoy installation documentation. This method offers the most flexibility but is also the most complex.

Cluster-based deployment

For distributed or production environments, Envoy is typically deployed as part of a cluster.

Basic installation

For general manual installation steps beyond apt-get or building from source, refer to the Basic installation guide.