Install AlloyDB Omni with AlloyDB AI

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.

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.

To install AlloyDB Omni, see the following:

• Install AlloyDB Omni on Debian or Ubuntu.

• Customize your AlloyDB Omni installation.

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.

For more information about the ML functionality of AlloyDB, see Build generative AI applications.

Configure your AlloyDB Omni installation to query cloud-based models

To install AlloyDB Omni with the ability to query cloud-based models using Vertex AI, follow these steps:

1. Create a service account with Google Cloud.

2. Create a service account key, in JSON format, and download it.

   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. 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.

3. Store the key in a permanent location on your file system. It resides at this location for the lifetime of your AlloyDB Omni server.

   Note its location on your file system; you need it for the next step.

4. Add Vertex AI Identity and Access Management (IAM) permissions to the appropriate project and service account.

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member="serviceAccount:SERVICE_ACCOUNT_ID" \
       --role="roles/aiplatform.user"

   Replace the following:

   • PROJECT_ID: the ID of your Google Cloud project.

   • 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: [e-mail].

5. Follow all of the steps in Customize your AlloyDB Omni installation, substituting the following for the sudo alloydb database-server install command:

   sudo alloydb database-server install \
       --data-dir=DATA_DIR \
       --enable-alloydb-ai=true \
       --private-key-file-path=KEY_PATH \
       --vertex-ai-region="LOCATION"

   Replace the following:

   • DATA_DIR: the file system path that you want AlloyDB Omni to use for its data directory.

   • KEY_PATH: the file system path to the service account key that you downloaded in the previous step.

   • LOCATION: a Google Cloud region—for example, us-central1. For a list of regions that support generative AI, see Generative AI on Vertex AI locations.

What's next

• Run and connect to AlloyDB Omni
• Manage AlloyDB Omni
• Build generative AI applications using AlloyDB AI
• Register and call remote AI models