Prerequisites

This page guides you through the Cortex Framework deployment prerequisites. Take some time to configure each prerequisite before moving forward to the Demo deployment or the Production deployment.

Installation artifacts

Clone the Google Cloud Cortex Framework repository: https://github.com/GoogleCloudPlatform/cortex-framework:

git clone https://github.com/GoogleCloudPlatform/cortex-framework
cd cortex-framework

Install uv

uv is an extremely fast Python package manager, written in Rust. Cortex Framework uses it to have consistent, isolated, and high-performance build deployment environments and to reduce time to install.

Note: If you are running this command from Cloud Shell, uv is already installed and you can skip the step of installation

Install the manager package uv for Python virtual environments. Refer to uv installation instructions.

Synchronize required dependencies

Execute the following command for synchronization of dependencies and for activation of a Python virtual environment:

uv sync

Configure Google Cloud SDK command line interface

Note: If you are executing gcloud commands for the first time in your local environment, or if you are getting authentication issues, use these commands to ensure authentication of Google Cloud SDK.

gcloud auth login
gcloud auth application-default login

Prepare your Google Cloud project for Dataform hosting

Before running the deployment, you need to have access to a Google Cloud project with an attached billing account.

Note: This project is used as the default project for running gcloud commands and for hosting the Dataform repository. It is not automatically used as the target project in the Cortex Framework deployment itself. The deployment projects (such as build, source, and target projects) are configured separately in your deployment setup (for example, in the config/config.yaml file).

Next configure your Google Cloud CLI environment to point to your specific Google Cloud project.

# Set current project and quota project
gcloud config set project PROJECT_ID
gcloud auth application-default set-quota-project PROJECT_ID

Enable Google Cloud services

In this section we will enable the following Google Cloud services in your Google Cloud project:

• BigQuery API
• Dataform API
• Cloud Resource Manager API

Enable these Google Cloud services using Cloud Shell by executing the following command in your terminal:

Replace PROJECT_ID with your project ID.

gcloud config set project PROJECT_ID

gcloud services enable cloudresourcemanager.googleapis.com \
                       bigquery.googleapis.com \
                       dataform.googleapis.com \
                       --project=PROJECT_ID

Next steps

Ready to build and deploy? Explore the following guides to get your deployment up and running:

• Demo deployment: Deploy sample data in a matter of minutes to see Cortex Framework in action.
• Production deployment: Follow step-by-step instructions to configure and deploy Cortex Framework for your enterprise data.