Getting Started

TrustGraph is a fully containerized knowledge platform. A full discussion of TrustGraph use cases can be found here.TrustGraph deploys in under a minute locally with Docker, Podman, or Minikube. TrustGraph can also be deployed directly in cloud environments. Current deployment options:

Container Depoloyment	Host Environment	Container Orchestration
Docker Compose	Local	Docker Engine
Podman Compose	Local	Podman Machine
Minikube	Local	Kubernetes
Kubernetes	AWS	Kubernetes
Kubernetes	Azure	Kubernetes
Kubernetes	Google Cloud	Kubernetes
Kubernetes	Scaleway	Kubernetes

tip

Before launching TrustGraph locally, be sure to have either the Docker Engine, Podman Machine, or Minikube installed and running on the host machine.

• Install the Docker Engine
• Install the Podman Machine
• Install Minikube

caution

TrustGraph has been tested on Linux and MacOS with Docker, Podman, and Minikube. Windows deployments have not been tested.

Install the TrustGraph CLI

pip3 install trustgraph-cli==<trustgraph-version>

note

The trustgraph-cli version must match the selected TrustGraph release version.

Full trustgraph-cli documentation can be found here.

Configuration Builder

TrustGraph is endlessly customizable by editing the YAML resource files. The Configuration Builder provides a tool for building a custom configuration that deploys with your selected orchestration method in your target environment.

• Configuration Builder 🚀

The Configuration Builder has 5 important sections:

• TrustGraph Version 🚢 : Select the version of TrustGraph you'd like to deploy
• Component Selection ✅ : Choose from the available deployment platforms, LLMs, graph store, VectorDB, chunking algorithm, chunking parameters, and LLM parameters
• Customization 🧰 : Customize the prompts for the LLM System, Data Extraction Agents, and Agent Flow
• Test Suite 🕵️ : Add the Test Suite to the configuration available on port 8888
• Finish Deployment 🚀 : Download the launch YAML files with deployment instructions

The Configuration Builder will generate the YAML files in deploy.zip. Once deploy.zip has been downloaded and unzipped, launching TrustGraph is as simple as navigating to the deploy directory and running:

docker compose up -d

tip

Docker is the recommended container orchestration platform for first getting started with TrustGraph.

When finished, shutting down TrustGraph is as simple as:

docker compose down -v

TrustGraph is fully containerized and is launched with a YAML configuration file. Unzipping the deploy.zip will add the deploy directory with the following subdirectories:

• docker-compose
• minikube-k8s
• gcp-k8s

note

As more integrations have been added, the number of possible combinations of configurations has become quite large. It is recommended to use the Configuration Builder to build your deployment configuration. Each directory contains YAML configuration files for the default component selections.

Launching TrustGraph

Navigate to the subdirectory for your chosen deployment method. You will then select a YAML file based on your desired model deployment and graph store combination. Once you've selected your YAML configuration file, you will run:

Docker

docker compose -f <config-file.yaml> up -d

Podman

podman compose -f <config-file.yaml> up -d

Minikube

kubectl apply -f <config-file.yaml>

Running TrustGraph

caution

Prior to launching TrustGraph, be sure to set all required environment varibles.

• Docker Environment Variables
• Kubernetes Environment Variables

While the trustgraph-cli downloads all the packages needed to run TrustGraph, there are slight differences in commands depending on whether you deploy with a Docker or Kubernetes approach. Refer to the below guides for a step-by-step process for running TrustGraph once deployed.

• TrustGraph with Docker
• TrustGraph with Minikube