Users can deploy TigerGraph single servers and clusters in Kubernetes on Docker Desktop locally, or on any cloud provider of their choice.
Known issue: TigerGraph 3.2 deployments on Kubernetes do not support backup or restore.
This is a quick start guide for deploying TigerGraph on Kubernetes with Google Kubernetes Engine (GKE).
This section describes the steps to deploy, verify, and remove a single-server deployment of TigerGraph on GKE.
Next, run the ./tg
script in the k8s
directory to generate the deployment manifest for a single-server deployment. A deploy
directory will be created automatically and you should find the manifest named tigergraph-gke.yaml
in the directory.
Step 2: Deploy manifest. Run kubectl apply
to create the deployment using the manifest you generated in Step1.
Run kubectl get pods
to confirm that the pods were created successfully:
Run kubectl describe service/tg-external-service
to find the IP address of the load balancer. You can then make curl calls to port 9000 to make sure that RESTPP is running:
You can also copy the IP address into your browser and visit port 14240 to make sure that GraphStudio is working.
You can use kubectl
to get a shell to the container or log in via ssh
To use GraphStudio, copy the IP address into your browser and visit port 14240.
Run the command below to delete all cluster resources:
Once your GKE cluster is ready, you can start following the below steps to deploy a TigerGraph cluster on Kubernetes.
You can customize your deployment by editing the kustomize.yaml
file in the gke
directory. The tg
script in the k8s
folder offers a convenient way to make common customizations such as namespace, TigerGraph version, as well as cluster size. Run ./tg -h
to view the help text on how to use the script.
Use the tg
script in the k8s
directory of the repo to create a Kubernetes manifest. Use -s
or --size
to indicate the number of nodes in the cluster. Use the --ha
option to indicate the replication factor of the cluster, and the partitioning factor will be the number of nodes divided by the replication factor.
For example, the following command will create a manifest that will deploy a 3*2 cluster with a replication factor of 2 and a partitioning factor of 3. The --version
flag specifies the version of TigerGraph to use for the deployment.
The command will create a directory named deploy
with the manifest inside.
Run kubectl apply
to create the deployment
Run kubectl get pods
to verify the pods were created successfully:
Run kubectl describe service/tg-external-service
to find the IP address of the load balancer for your GKE cluster. You can make a curl call to port 9000 to make sure that RESTPP is working:
You can also copy the IP address into your browser and visit port 14240 to make sure that GraphStudio is working.
You can use kubectl
to get a shell to the container or log in via ssh
To use GraphStudio, copy the IP address into your browser and visit port 14240.
Run the command below to delete all cluster resources:
The on your machine.
The is installed on your machine.
A running GKE cluster with nodes that meet the minimum for running TigerGraph.
You have .
Step 1: Generate deployment manifest. Clone the and change into the k8s
directory. You can edit the kustimization.yaml
file in the gke
folder to change the namespace and image name for your deployment. The default namespace is default
. No need to edit the files if no changes are needed.
Clone the and change into the k8s
directory:
This guide provides instructions to deploy a single-server TigerGraph instance to a local Kubernetes cluster via Docker Desktop.
Install Docker Desktop on your computer.
Enable the Docker Desktop Kubernetes engine. For more information, see Docker official documentation.
Verify that you have sufficient CPU, RAM and DISK for your TigerGraph deployment.
Download tigergraph-docker.yaml
. This is the file that describes your Kubernetes deployment.
Make sure that you have configured kubectl
to use the correct context. In this case, the name of the context should be docker-desktop
. Then run kubectl apply
to create the deployment. Replace <path_to_tigergraph.yaml>
with the path to the tigergraph-docker.yaml
file you downloaded in the step before.
Verify that the pods were created successfully:
The deployment maps port 9000 of the pod to port 30090 of localhost
. We can test that the REST API is up and running by making a curl call to port 30090:
Port 14240 of the pod is mapped to port 30240 of localhost
. Visit http://localhost:30240
to access GraphStudio.
Run the following command to delete all cluster resources:
This is a quickstart guide for deploying TigerGraph in Kubernetes on AWS's Elastic Kubernetes Service (EKS).
This section describes the steps to deploy, verify, and remove a single-server deployment of TigerGraph on EKS.
Next, run the ./tg
script in the k8s
directory to generate the deployment manifest for a single-server deployment. A deploy
directory will be created automatically and you should find the manifest named tigergraph-eks.yaml
in the directory.
Step 2: Deploy manifest. Run kubectl apply
to create the deployment using the manifest you generated in step1.
After you create the deployment, run kubectl get pods
to verify that the pods were created successfully.
Run kubectl describe service/tg-external-service
to find the IP address of the load balancer. You can then make curl calls to port 9000 to make sure that RESTPP is running:
You can also copy the IP address into your browser and visit port 14240 to make sure that GraphStudio is working.
You can use kubectl
to get a shell to the container or log in via ssh
To use GraphStudio, copy the IP address into your browser and visit port 14240.
Run the command below to delete all cluster resources:
This section describes the steps to deploy, verify, and remove a TigerGraph cluster in Kubernetes on EKS.
Clone the TigerGraph ecosystem repository and change into the k8s
directory:
You can customize your deployment by editing the kustomize.yaml
file in the aks
directory. The tg
script in the k8s
folder offers a convenient way to make common customizations such as namespace, TigerGraph version, as well as cluster size. Run ./tg -h
to view the help text on how to use the script.
Use the tg
script at in the k8s
directory of the repo to create a Kubernetes manifest. Use -s
or --size
to indicate the number of nodes in the cluster. Use the --ha
option to indicate the replication factor of the cluster; the partitioning factor will be the number of nodes divided by the replication factor.
For example, the following command will create a manifest that will deploy a 3*2 cluster with a replication factor of 2 and a partitioning factor of 3. The --version
flag specifies the version of TigerGraph to use for the deployment.
The command will create a directory named deploy
with the manifest inside.
Run kubectl apply
to create the deployment
Run kubectl get pods
to verify the pods were created successfully:
Run kubectl describe service/tg-external-service
to find the IP address of the load balancer for your EKS cluster. You can make a curl call to port 9000 to make sure that RESTPP is working:
You can also copy the IP address into your browser and visit port 14240 to make sure that GraphStudio is working.
You can use kubectl
to get a shell to the container or log in via ssh
To use GraphStudio, copy the IP address into your browser and visit port 14240.
Run the command below to delete all cluster resources:
This is a quickstart guide for deploying TigerGraph single servers and clusters in Kubernetes on Azure Kubernetes Service(AKS).
This section describes the steps to deploy, verify, and remove a single-server deployment of TigerGraph on AKS.
Next, run the ./tg
script in the k8s
directory to generate the deployment manifest for a single-server deployment. A deploy
directory will be created automatically and you should find the manifest named tigergraph-aks.yaml
in the directory.
Step 2: Deploy manifest. Run kubectl apply
to create the deployment using the manifest you generated in step 1.
After you create the deployment, run kubectl get pods
to verify that the pods were created successfully.
Run kubectl describe service/tg-external-service
to find the IP address of the load balancer. You can then make curl calls to port 9000 to make sure that RESTPP is running:
You can also copy the IP address into your browser and visit port 14240 to make sure that GraphStudio is working.
You can use kubectl
to get a shell to the container or log in via ssh
To use GraphStudio, copy the IP address into your browser and visit port 14240.
Run the command below to delete all cluster resources:
This section describes the steps to deploy, verify, and delete a TigerGraph cluster in Kubernetes on AKS.
You can customize your deployment by editing the kustomize.yaml
file in the aks
directory. The tg
script in the k8s
folder offers a convenient way to make common customizations such as namespace, TigerGraph version, as well as cluster size. Run ./tg -h
to view the help text on how to use the script.
Use the tg
script in the k8s
directory of the repo to create a Kubernetes manifest. Use -s
or --size
to indicate the number of nodes in the cluster. Use the --ha
option to indicate the replication factor of the cluster, and the partitioning factor will be the number of nodes divided by the replication factor.
For example, the following command will create a manifest that will deploy a 3*2 cluster with a replication factor of 2 and a partitioning factor of 3. The --version
flag specifies the version of TigerGraph to use for the deployment.
The command will create a directory named deploy
with the manifest inside.
Run kubectl apply
to create the deployment
Run kubectl get pods
to verify the pods were created successfully:
Run kubectl describe service/tg-external-service
to find the IP address of the load balancer for your AKS cluster. You can make a curl call to port 9000 to make sure that RESTPP is working:
You can also copy the IP address into your browser and visit port 14240 to make sure that GraphStudio is working.
You can use kubectl
to get a shell to the container or log in via ssh
To use GraphStudio, copy the IP address into your browser and visit port 14240.
Run the command below to delete all cluster resources:
Provision Kubernetes cluster on EKS with nodes that meet the to run TigerGraph.
and make sure your local kubectl
version is within one minor version's difference from the kubectl
version on your cluster.
cluster access.
Step 1: Generate deployment manifest. Clone the and change into the k8s
directory. You can edit the kustimization.yaml
file in the eks
folder to change the namespace and image name for your deployment. The default namespace is default
. No need to edit the files if no changes are needed.
Provision Kubernetes cluster on AKS with nodes that meet the to run TigerGraph.
and make sure your local kubectl
version is within one minor version's difference from the kubectl
version on your cluster.
.
Step 1: Generate deployment manifest. Clone the and change into the k8s
directory. You can edit the kustimization.yaml
file in the aks
folder to change the namespace and image name for your deployment. The default namespace is default
, and the default image is the official docker image for TigerGraph 3.2.0. No need to edit the files if no changes are needed.
Clone the and change into the k8s
directory: