This page shows you how to download and install AlloyDB Omni with
AlloyDB AI. AlloyDB AI
is a suite of features included with AlloyDB Omni that let you
build enterprise generative AI applications.
You can enable AlloyDB AI when you install
AlloyDB Omni.
AlloyDB Omni lets you integrate with
Vertex AI to query cloud-based ML models. Both editions of
AlloyDB Omni let you
work with online predictions and vector embeddings generated from ML models.
SERVICE_ACCOUNT_ID: the ID of the service
account that you created in the previous step. This includes the full
@PROJECT_ID.iam.gserviceaccount.com suffix.
For example: my-service@my-project.iam.gserviceaccount.com.
[[["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-08-25 UTC."],[[["\u003cp\u003eAlloyDB Omni, which includes AlloyDB AI features, can be downloaded and installed to build enterprise generative AI applications.\u003c/p\u003e\n"],["\u003cp\u003eInstalling AlloyDB Omni can be done following the Debian/Ubuntu installation guide, or you can further customize the installation.\u003c/p\u003e\n"],["\u003cp\u003eTo query cloud-based models with Vertex AI, you need to create a service account and download its JSON key, ensuring secure key management practices are followed.\u003c/p\u003e\n"],["\u003cp\u003eEnabling AlloyDB AI during installation requires specifying the data directory, private key file path, and Vertex AI region using the \u003ccode\u003esudo alloydb database-server install\u003c/code\u003e command.\u003c/p\u003e\n"],["\u003cp\u003eAfter installation, you can run, connect to, and manage AlloyDB Omni, as well as build generative AI applications using AlloyDB AI by registering and calling remote AI models.\u003c/p\u003e\n"]]],[],null,["# Install AlloyDB Omni with AlloyDB AI\n\nSelect a documentation version: 15.5.2keyboard_arrow_down\n\n- [Current (16.8.0)](/alloydb/omni/current/docs/install-with-alloydb-ai)\n- [16.8.0](/alloydb/omni/16.8.0/docs/install-with-alloydb-ai)\n- [16.3.0](/alloydb/omni/16.3.0/docs/install-with-alloydb-ai)\n- [15.12.0](/alloydb/omni/15.12.0/docs/install-with-alloydb-ai)\n- [15.7.1](/alloydb/omni/15.7.1/docs/install-with-alloydb-ai)\n- [15.7.0](/alloydb/omni/15.7.0/docs/install-with-alloydb-ai)\n- [15.5.5](/alloydb/omni/15.5.5/docs/install-with-alloydb-ai)\n- [15.5.4](/alloydb/omni/15.5.4/docs/install-with-alloydb-ai)\n- [15.5.2](/alloydb/omni/15.5.2/docs/install-with-alloydb-ai)\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 page shows you how to download and install AlloyDB Omni with\nAlloyDB AI. [AlloyDB AI](https://cloud.google.com/alloydb/ai)\nis a suite of features included with AlloyDB Omni that let you\nbuild enterprise generative AI applications.\n\nTo install AlloyDB Omni, see the following:\n\n- [Install AlloyDB Omni on Debian or Ubuntu](/alloydb/omni/15.5.2/docs/quickstart).\n\n- [Customize your AlloyDB Omni installation](/alloydb/omni/15.5.2/docs/install).\n\nYou can enable AlloyDB AI when you install\nAlloyDB Omni.\nAlloyDB Omni lets you integrate with\nVertex AI to query cloud-based ML models. Both editions of\nAlloyDB Omni let you\nwork with online predictions and vector embeddings generated from ML models.\n\nFor more information about the ML functionality of AlloyDB, see\n[Build generative AI applications](/alloydb/docs/vertex-ai).\n\nConfigure your AlloyDB Omni installation to query cloud-based models\n--------------------------------------------------------------------\n\nTo install AlloyDB Omni with the ability to query cloud-based\nmodels using Vertex AI, follow these steps:\n\n1. [Create a service account](/iam/docs/service-accounts-create) with\n Google Cloud.\n\n2. [Create a service account key](/iam/docs/keys-create-delete#creating), in\n JSON format, and download it.\n\n | **Note:** Service account keys are a security risk if not managed correctly. You are responsible for the security of the private key and for other operations described by [Best practices for managing service account keys](/iam/docs/best-practices-for-managing-service-account-keys). If you are prevented from creating a service account key, service account key creation might be disabled for your organization. For more information, see [Managing secure-by-default organization resources](/resource-manager/docs/secure-by-default-organizations).\n |\n |\n | If you acquired the service account key from an external source, you must validate it before use.\n | For more information, see [Security requirements for externally sourced credentials\"](/docs/authentication/external/externally-sourced-credentials).\n3. Store the key in a permanent location on your file system. It resides at this\n location for the lifetime of your AlloyDB Omni server.\n\n Note its location on your file system; you need it for the next step.\n4. Add Vertex AI Identity and Access Management (IAM) permissions to the\n appropriate project and service account.\n\n gcloud projects add-iam-policy-binding \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e \\\n --member=\"serviceAccount:\u003cvar translate=\"no\"\u003eSERVICE_ACCOUNT_ID\u003c/var\u003e\" \\\n --role=\"roles/aiplatform.user\"\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: the ID of your Google Cloud project.\n\n - \u003cvar translate=\"no\"\u003eSERVICE_ACCOUNT_ID\u003c/var\u003e: the ID of the service\n account that you created in the previous step. This includes the full\n `@`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`.iam.gserviceaccount.com` suffix.\n For example: `my-service@my-project.iam.gserviceaccount.com`.\n\n5. Follow all of the steps in [Customize your AlloyDB Omni installation](/alloydb/omni/15.5.2/docs/install),\n substituting the following for the\n `sudo alloydb database-server install` command:\n\n sudo alloydb database-server install \\\n --data-dir=\u003cvar translate=\"no\"\u003eDATA_DIR\u003c/var\u003e \\\n --enable-alloydb-ai=true \\\n --private-key-file-path=\u003cvar translate=\"no\"\u003eKEY_PATH\u003c/var\u003e \\\n --vertex-ai-region=\"\u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e\"\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003eDATA_DIR\u003c/var\u003e: the file system path that you want\n AlloyDB Omni to use for its data directory.\n\n - \u003cvar translate=\"no\"\u003eKEY_PATH\u003c/var\u003e: the file system path to the service account\n key that you downloaded in the previous step.\n\n - \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: a Google Cloud region---for example,\n `us-central1`. For a list of regions that support generative AI, see\n [Generative AI on Vertex AI locations](/vertex-ai/docs/generative-ai/learn/locations-genai).\n\nWhat's next\n-----------\n\n- [Run and connect to AlloyDB Omni](/alloydb/omni/15.5.2/docs/run-connect)\n- [Manage AlloyDB Omni](/alloydb/omni/15.5.2/docs/manage)\n- [Build generative AI applications using AlloyDB AI](/alloydb/omni/15.5.2/docs/model-endpoint-overview)\n- [Register and call remote AI models](/alloydb/omni/15.5.2/docs/model-endpoint-overview)"]]