This quickstart shows you how to install AlloyDB Omni on your own environment in a few steps.
To install a production-ready AlloyDB Omni cluster in a Linux environment, see Install AlloyDB Omni on Debian or Ubuntu.
To preview a development edition of AlloyDB Omni that can run in any environment which supports Docker Desktop, see Install simplified AlloyDB Omni installation method.
Install AlloyDB Omni on Debian or Ubuntu
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, run
stat -fc %T /sys/fs/cgroup/
in a shell. If cgroup v2 is enabled, the command output showscgroup2fs
. - TCP port
5432
not 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 recommend
n2-highmem
instances. - On Amazon Web Services, we recommend
R6i
instances. - On Microsoft Azure, we recommend
Ebsv5
instances.
Install the AlloyDB Omni CLI and Docker on your Debian or Ubuntu machine:
curl https://us-apt.pkg.dev/doc/repo-signing-key.gpg | sudo apt-key add -
sudo apt update
echo "deb https://us-apt.pkg.dev/projects/alloydb-omni alloydb-omni-apt main" \ | sudo tee -a /etc/apt/sources.list.d/artifact-registry.list
sudo apt update
sudo apt-get -y install alloydb-cli docker.io
Use the command-line program to install and launch the AlloyDB Omni server software:
sudo alloydb database-server install
Connect to AlloyDB Omni using
psql
:sudo docker exec -it pg-service psql -h localhost -U postgres
The terminal window displays
psql
login text that ends with apostgres=#
prompt.
Preview a simplified AlloyDB Omni installation method
You can preview a simplified AlloyDB Omni installation method that uses open-source container-management
utilities, such as the docker
command, instead of the alloydb
command-line interface. To install this Preview, follow these steps:
Use the
docker run
command:sudo docker run --name my-omni \ -e POSTGRES_PASSWORD=NEW_PASSWORD \ -d google/alloydbomni
Replace
NEW_PASSWORD
with a password to assign the new container'spostgres
user after its creation.Connect to AlloyDB Omni using
psql
:sudo docker exec -it my-omni psql -h localhost -U postgres
The terminal window displays
psql
login text that ends with apostgres=#
prompt.
For more information, see Preview a simplified AlloyDB Omni installation method.