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

Request access

Cortex Framework version 7 is in public preview. To request access to the GitHub repository, see Request access.

Prepare your Google Cloud target project

Prior to the deployment, you need to provision a target project to host the Dataform repository and execution environment.

Clone the repository

Clone the Google Cloud Cortex Framework repository by following the steps in this section.

  1. Open the Cortex Framework GitHub repository using the link provided in your access confirmation email (after requesting access).

  2. Clone the source code and download the installation artifacts with the following command:

    # Please ensure that the access request has been processed
# before executing this command, otherwise it will result in 404 error

git clone LINK_PROVIDED_IN_YOUR_ACCESS_CONFIRMATION_EMAIL

cd DIRECTORY

Installation artifacts

Before proceeding, confirm that the Cortex Framework artifacts obtained with the previous step are present in your local directory.

Install uv

uv is an extremely fast Python package manager, written in Rust. Cortex Framework uses it to have consistent, isolated, and high-performance deployments, reducing errors and accelerating installation times.

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

  2. Execute the following command for activation of an empty Python virtual environment:

uv sync

Configure Google Cloud SDK command line interface

Before running the deployment, configure your Google Cloud CLI environment to point to your specific target project.

# The ID of your Google Cloud Project
export PROJECT_ID="YOUR_PROJECT_ID"

# Set current project and quota project
gcloud config set project YOUR_PROJECT_ID
gcloud auth application-default set-quota-project YOUR_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 the Cortex Framework in action.
  • Deployment: Follow step-by-step instructions to configure and deploy the Cortex Framework for your enterprise data.