Install AlloyDB Omni

This page shows how to download and install AlloyDB Omni into your own Linux-based computing environment.

Before you begin

Before you install AlloyDB Omni, ensure you meet the following system requirements:

  • A virtual or physical machine running a Debian-based OS, such as Debian or Ubuntu, or Red Hat Enterprise Linux (RHEL) version 8 or higher.
  • A minimum of 2 CPUs, with x86/AMD64 architecture.
  • A minimum of 2 GB of RAM. For optimal performance, we recommend allocating 8 GB of RAM for each CPU.
  • At least 20 GB of available storage.
  • Unrestricted root access within the OS.
  • Docker version 20.10 or higher.
  • Linux kernel version 4.18 or higher. We recommend kernel version 5.3 or higher for best performance.

  • Linux cgroup v2 enabled.

    By default, cgroup v2 is enabled on most modern Linux systems. To check whether cgroup v2 is enabled, run stat -fc %T /sys/fs/cgroup/ in a shell. If cgroup v2 is enabled, the command output shows cgroup2fs.

    To enable cgroup v2 on RHEL 8, see Using cgroups-v2.

  • The Google Cloud CLI.

    If you do need to install the gcloud CLI, note that the step of running gcloud init is optional. Installing AlloyDB Omni does not require authentication with a Google account.

We recommend the use of a dedicated SSD storage device for storing your data. If you use a physical device for this purpose, we recommend attaching it directly to the host machine.

If you are installing AlloyDB Omni on a cloud platform, then we recommend using the following instance types:

  • On Google Cloud, we recommend n2-highmem instances.
  • On Amazon Web Services, we recommend R6i instances.
  • On Microsoft Azure, we recommend Ebsv5 instances.

Download and install AlloyDB Omni

  1. Download the container images that constitute AlloyDB Omni:

    docker pull gcr.io/alloydb-omni/pg-service:latest
docker pull gcr.io/alloydb-omni/memory-agent:latest

  2. Download additional files that you need to install AlloyDB Omni:

    gsutil cp -r gs://alloydb-omni-install/$(gsutil cat gs://alloydb-omni-install/latest) .
cd $(gsutil cat gs://alloydb-omni-install/latest)

  3. Run the installation script:

    tar -xzf alloydb_omni_installer.tar.gz && cd installer
sudo bash install_alloydb.sh

Special instructions for RHEL

If your machine runs RHEL, you must set the kernel parameter value to vm.swappiness=1 in the tuned service configuration file present in the /usr/lib/tuned/virtual-guest/tuned.conf directory. This ensures that the correct vm.swappiness value is retained across reboots of your machine.

Optional: Configure a new disk for AlloyDB Omni

If you are creating a new disk partition for AlloyDB Omni, we recommend that you create an ext4 filesystem on the new disk for optimal performance.

  1. To create an ext4 filesystem, use the following command:

    mkfs.ext4 -m 1 -F "$disk_path"

  2. To mount your disk, use the following command:

    mount --make-shared -o noatime,discard,errors=panic "$disk_path" "$disk_mountpoint"

What's next