This section shows you how to install AlloyDB Omni using the
AlloyDB Omni CLI in your Debian or Ubuntu environment.
System requirements
Ensure that you have a Linux machine that meets the following system
requirements:
A virtual or physical machine running a Debian-based OS, such as
Debian or Ubuntu.
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.
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, runstat -fc %T /sys/fs/cgroup/in a shell. If cgroup v2 is
enabled, the command output showscgroup2fs.
TCP port5432not in use by any other service.
If you are installing AlloyDB Omni on a cloud
platform, then we recommend using the following instance types:
On Google Cloud, we recommendn2-highmeminstances.
On Amazon Web Services, we recommendR6iinstances.
On Microsoft Azure, we recommendEbsv5instances.
Install the AlloyDB Omni CLI and Docker on your Debian or Ubuntu machine:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eAlloyDB Omni can be installed on Debian or Ubuntu environments using the AlloyDB Omni CLI, providing a quick setup for your own environment.\u003c/p\u003e\n"],["\u003cp\u003eSystem requirements for running AlloyDB Omni include a Debian-based OS, minimum 2 CPUs, 2 GB RAM (8 GB per CPU recommended), 20 GB storage, and Linux kernel 4.18 or higher.\u003c/p\u003e\n"],["\u003cp\u003eThe installation process involves installing the AlloyDB Omni CLI and Docker, followed by running a command to install and launch the AlloyDB Omni server software.\u003c/p\u003e\n"],["\u003cp\u003eConnecting to AlloyDB Omni is achieved via \u003ccode\u003epsql\u003c/code\u003e after the server software is launched, allowing users to interact with the database using a command-line prompt.\u003c/p\u003e\n"],["\u003cp\u003eFor optimal performance on cloud platforms, specific instance types are recommended, such as \u003ccode\u003en2-highmem\u003c/code\u003e on Google Cloud, \u003ccode\u003eR6i\u003c/code\u003e on Amazon Web Services, and \u003ccode\u003eEbsv5\u003c/code\u003e on Microsoft Azure.\u003c/p\u003e\n"]]],[],null,["# Install AlloyDB Omni\n\nSelect a documentation version: 15.5.2keyboard_arrow_down\n\n- [Current (16.8.0)](/alloydb/omni/current/docs/quickstart)\n- [16.8.0](/alloydb/omni/16.8.0/docs/quickstart)\n- [16.3.0](/alloydb/omni/16.3.0/docs/quickstart)\n- [15.12.0](/alloydb/omni/15.12.0/docs/quickstart)\n- [15.7.1](/alloydb/omni/15.7.1/docs/quickstart)\n- [15.7.0](/alloydb/omni/15.7.0/docs/quickstart)\n- [15.5.5](/alloydb/omni/15.5.5/docs/quickstart)\n- [15.5.4](/alloydb/omni/15.5.4/docs/quickstart)\n- [15.5.2](/alloydb/omni/15.5.2/docs/quickstart)\n\n\u003cbr /\u003e\n\n| **Note:** Your use of AlloyDB Omni is subject to the agreement between you and Google that governs Google Cloud offerings. If you do not have a Google Cloud account, or have not otherwise entered into an agreement with Google that governs Google Cloud offerings, please do not proceed or download this software until you have done so. To create a Google Cloud account, see [the Google Cloud homepage](/docs/get-started).\n\n\u003cbr /\u003e\n\nThis quickstart shows you how to install AlloyDB Omni on your own\nenvironment in a few steps.\n\n- To install a production-ready AlloyDB Omni cluster in a Linux environment, see [Install\n AlloyDB Omni on Debian or Ubuntu](#linux).\n\nInstall AlloyDB Omni on Debian or Ubuntu\n----------------------------------------\n\nThis section shows you how to install AlloyDB Omni using the\nAlloyDB Omni CLI in your Debian or Ubuntu environment. \n\n#### System requirements\n\nEnsure that you have a Linux machine that meets the following system\nrequirements:\n\n- A virtual or physical machine running a Debian-based OS, such as Debian or Ubuntu.\n- A minimum of 2 CPUs, with x86/AMD64 architecture.\n- A minimum of 2 GB of RAM. For optimal performance, we recommend allocating 8 GB of RAM for each CPU.\n- At least 20 GB of available storage.\n- Unrestricted root access within the OS.\n- Linux kernel version 4.18 or higher. We recommend kernel version 5.3 or higher for best performance.\n- Linux cgroup v2 enabled. By default, cgroup v2 is enabled on most modern Linux systems.\n To check whether cgroup v2 is enabled, run\n `stat -fc %T /sys/fs/cgroup/` in a shell. If cgroup v2 is\n enabled, the command output shows `cgroup2fs`.\n\n- TCP port `5432` not in use by any other service.\n- If you are installing AlloyDB Omni on a cloud platform, then we recommend using the following instance types:\n - On Google Cloud, we recommend `n2-highmem` instances.\n - On Amazon Web Services, we recommend `R6i` instances.\n - On Microsoft Azure, we recommend `Ebsv5` instances.\n\n1. Install the AlloyDB Omni CLI and Docker on your Debian or Ubuntu machine:\n\n curl https://us-apt.pkg.dev/doc/repo-signing-key.gpg | sudo apt-key add -\n sudo apt update\n echo \"deb https://us-apt.pkg.dev/projects/alloydb-omni alloydb-omni-apt main\" \\\n | sudo tee -a /etc/apt/sources.list.d/artifact-registry.list\n sudo apt update\n sudo apt-get -y install alloydb-cli docker.io\n\n2. Use the command-line program to install and launch the AlloyDB Omni\n server software:\n\n sudo alloydb database-server install\n\n3. Connect to AlloyDB Omni using `psql`:\n\n sudo docker exec -it pg-service psql -h localhost -U postgres\n\n The terminal window displays `psql` login text that ends with a\n `postgres=#` prompt.\n\nWhat's next\n-----------\n\n- [Run and connect to\n AlloyDB Omni](/alloydb/omni/15.5.2/docs/run-connect)\n\n- [Customize your AlloyDB Omni installation](/alloydb/omni/15.5.2/docs/install)"]]
