Install AlloyDB Omni

Select a documentation version:

This quickstart shows you how to install AlloyDB Omni that can run in any UNIX-based environment which supports container runtimes.

For an overview of AlloyDB Omni, see AlloyDB Omni overview.

Before you begin

The following table lists minimum hardware and software requirements for AlloyDB Omni.

OS/Platform	Minimum hardware	Minimum software
Linux	x86-64 or Arm (*) CPU with AVX2 support 2 GB of RAM 10 GB of disk space	Debian based OS (Ubuntu, etc) or RHEL 9 Linux kernel version 5.3 or higher Cgroupsv2 enabled Docker Engine 20.10+ or Podman 4.2.0+
macOS	Intel CPU with AVX2 support or M-chip 2GB of RAM 10 GB of disk space	Docker Desktop 4.20 or higher
(*) Arm support is in Preview.

AlloyDB Omni runs in a container. Install a container runtime like Docker or Podman on your machine before installing AlloyDB Omni.

Use the docker run command to create a new container with AlloyDB Omni named my-omni:
```
  docker run --name my-omni \
    -e POSTGRES_PASSWORD=NEW_PASSWORD \
    -d google/alloydbomni:15.5.5
```
Replace NEW_PASSWORD with a password to assign the new container's postgres user after its creation.

Note: By default, AlloyDB Omni stores your data on the container itself, and not on your host file system. The data directory is deleted once you delete your AlloyDB Omni container. To mount a data directory stored on your host file system, see instructions in Customize your AlloyDB Omni installation.
Connect to containerized AlloyDB Omni using psql:
```
  docker exec -it my-omni psql -h localhost -U postgres
```
The terminal window displays psql login text that ends with a postgres=# prompt.

Use the docker run command to create a new container with AlloyDB Omni named my-omni:
```
  podman run --name my-omni \
    -e POSTGRES_PASSWORD=NEW_PASSWORD \
    -d google/alloydbomni:15.5.5
```
Replace NEW_PASSWORD with a password to assign the new container's postgres user after its creation.

Note: By default, AlloyDB Omni stores your data on the container itself, and not on your host file system. The data directory is deleted once you delete your AlloyDB Omni container. To mount a data directory stored on your host file system, see instructions in Customize your AlloyDB Omni installation.
Connect to containerized AlloyDB Omni using psql:
```
podman exec -it my-omni psql -h localhost -U postgres
```
The terminal window displays psql login text that ends with a postgres=# prompt.

To clean up the AlloyDB Omni container you created during this quickstart, use these steps:

Stop your AlloyDB Omni container named my-omni:
```
  docker container stop my-omni
```
Delete your AlloyDB Omni container named my-omni:
```
  docker container rm my-omni
```

Stop your AlloyDB Omni container named my-omni:
```
  podman container stop my-omni
```
Delete your AlloyDB Omni container named my-omni:
```
  podman container rm my-omni
```

For instructions how to install AlloyDB Omni in a new container for production usage, go to the Customize your AlloyDB Omni installation page.