Azure - Chroma — ContextQMD

import { Callout, Danger } from '/snippets/callout.mdx';

<Callout> Chroma Cloud, our fully managed hosted service is here. [Sign up for free](https://trychroma.com/signup?utm_source=docs-azure). </Callout>

A Simple Azure Deployment

You can deploy Chroma on a long-running server, and connect to it remotely.

For convenience, we have provided a very simple Terraform configuration to experiment with deploying Chroma to Azure.

<Danger> Chroma and its underlying database [need at least 2GB of RAM](/guides/performance/single-node#results-summary). When defining your VM size for the template in this example, make sure it meets this requirement. </Danger> <Danger> By default, this template saves all data on a single volume. When you delete or replace it, the data will disappear. For serious production use (with high availability, backups, etc.) please read and understand the Terraform template and use it as a basis for what you need, or reach out to the Chroma team for assistance. </Danger>

Step 1: Install Terraform

Download Terraform and follow the installation instructions for you OS.

Step 2: Authenticate with Azure

terminal

az login

Step 3: Configure your Azure Settings

Create a chroma.tfvars file. Use it to define the following variables for your Azure Resource Group name, VM size, and location. Note that this template creates a new resource group for your Chroma deployment.

text

resource_group_name = "your-azure-resource-group-name"
location            = "your-location"
machine_type        = "Standard_B1s"

Step 4: Initialize and deploy with Terraform

Download our Azure Terraform configuration to the same directory as your chroma.tfvars file. Then run the following commands to deploy your Chroma stack.

Initialize Terraform:

terminal

terraform init

Plan the deployment, and review it to ensure it matches your expectations:

terminal

terraform plan -var-file chroma.tfvars

Finally, apply the deployment:

terminal

terraform apply -var-file chroma.tfvars

After a few minutes, you can get the IP address of your instance with

terminal

terraform output -raw public_ip_address

Step 5: Chroma Client Set-Up

<Tabs> <Tab title="Python" icon="python"> Once your Azure VM instance is up and running with Chroma, all you need to do is configure your `HttpClient` to use the server's IP address and port `8000`. Since you are running a Chroma server on Azure, our [thin-client package](./python-thin-client) may be enough for your application.

python

import chromadb

chroma_client = chromadb.HttpClient(
    host="<Your Chroma instance IP>",
    port=8000
)
chroma_client.heartbeat()

</Tab> <Tab title="TypeScript" icon="js"> Once your Azure VM instance is up and running with Chroma, all you need to do is configure your `ChromaClient` to use the server's IP address and port `8000`.

typescript

import { ChromaClient } from "chromadb";

const chromaClient = new ChromaClient({
  host: "<Your Chroma instance IP>",
  port: 8000,
});
chromaClient.heartbeat();

</Tab> <Tab title="Rust" icon="rust"> Once your Azure VM instance is up and running with Chroma, you can point the Rust client at the server's address and port `8000`.

rust

use chroma::{ChromaHttpClient, ChromaHttpClientOptions};

let mut options = ChromaHttpClientOptions::default();
options.endpoint = "http://<Your Chroma instance IP>:8000".parse()?;

let chroma_client = ChromaHttpClient::new(options);
chroma_client.heartbeat().await?;

</Tab> </Tabs>

Step 5: Clean Up (optional).

To destroy the stack and remove all Azure resources, use the terraform destroy command.

shell

terraform destroy -var-file chroma.tfvars

<Danger> This will destroy all the data in your Chroma database, unless you've taken a snapshot or otherwise backed it up. </Danger>

Observability with Azure

Chroma is instrumented with OpenTelemetry hooks for observability. We currently only export OpenTelemetry traces. These should allow you to understand how requests flow through the system and quickly identify bottlenecks. Check out the observability docs for a full explanation of the available parameters.

To enable tracing on your Chroma server, simply define the following variables in your chroma.tfvars:

text

chroma_otel_collection_endpoint          = "api.honeycomb.com"
chroma_otel_service_name                 = "chromadb"
chroma_otel_collection_headers           = "{'x-honeycomb-team': 'abc'}"