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 |
|
|
macOS |
|
|
(*) 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.
Install AlloyDB Omni using Docker
Docker
Use the
docker run
command to create a new container with AlloyDB Omni namedmy-omni
: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 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 apostgres=#
prompt.
Podman
Use the
docker run
command to create a new container with AlloyDB Omni namedmy-omni
:podman 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 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 apostgres=#
prompt.
Clean up
To clean up the AlloyDB Omni container you created during this quickstart, use these steps:
Docker
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
Podman
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.