---
title: Deploy Label Studio on Kubernetes
short: Install using Kubernetes
tier: opensource
type: guide
order: 69
order_enterprise: 0
meta_title: Deploy Label Studio on Kubernetes
meta_description: Deploy Label Studio on Kubernetes, such as on Amazon Elastic Container Service for Kubernetes, to create machine learning and data science projects in a scalable containerized environment.
section: "Install & Setup"
Deploy Label Studio on a Kubernetes Cluster using Helm 3. You can use this Helm chart to set up Label Studio for deployment onto a Kubernetes cluster and install, upgrade, and manage the application.
Your Kubernetes cluster can be self-hosted or installed somewhere such as Amazon EKS. See the Amazon tutorial on how to Deploy a Kubernetes Application with Amazon Elastic Container Service for Kubernetes for more about deploying an app on Amazon EKS.
If you want to install Label Studio on Kubernetes and you have unrestricted access to the internet from your K8s cluster, follow these steps.
If you use a proxy to access the internet from your Kubernetes cluster, or it is airgapped from the internet, see how to Install Label Studio without public internet access.
This chart has been tested and confirmed to work with the NGINX Ingress Controller and cert-manager. See Set up an ingress controller for Label Studio Kubernetes deployments for more on ingress settings with Label Studio.
Your Kubernetes cluster can be self-hosted or installed somewhere such as Amazon EKS.
To plan the capacity of your Kubernetes cluster, refer to these guidelines.
Label Studio has the following default configurations for resource requests, resource limits, and replica counts:
app:
replicas: 1
resources:
requests:
memory: 1024Mi
cpu: 1000m
limits:
memory: 6144Mi
cpu: 4000m
Before you make changes to these values, familiarize yourself with the Resource Management for Pods and Containers guidelines in the Kubernetes documentation.
If you choose to make changes to these default settings, consider the following:
| For this case | Adjust this |
|---|---|
| More than 10 concurrent annotators | Adjust the requests and limits for resources in the app pod |
| Increase fault tolerance | Increase the number of replicas of app pod |
| Production deployment (replicas) | Replicas equivalent or greater than the number of availability zones in your Kubernetes cluster |
Before installing Label Studio, prepare the Kubernetes cluster with kubectl.
Add the Helm chart repository to easily install and update Label Studio.
shell helm repo add heartex https://charts.heartex.com/ helm repo update heartex shell helm search repo heartex/label-studio To configure Label Studio to use TLS for end-client connections with PostgreSQL, do the following:
<PATH_TO_CA>, <PATH_TO_CLIENT_CRT> and <PATH_TO_CLIENT_KEY> with paths to your certificates:shell kubectl create secret generic <YOUR_SECRET_NAME> --from-file=ca.crt=<PATH_TO_CA> --from-file=client.crt=<PATH_TO_CLIENT_CRT> --from-file=client.key=<PATH_TO_CLIENT_KEY> Update your ls-values.yaml file with your newly-created Kubernetes secret:
!!! note
If POSTGRE_SSL_MODE: verify-ca, the server is verified by checking the certificate chain up to the root certificate stored on the client. If POSTGRE_SSL_MODE: verify-full, the server host name will be verified to make sure it matches the name stored in the server certificate. The SSL connection will fail if the server certificate cannot be verified. verify-full is recommended in most security-sensitive environments.
global:
pgConfig:
ssl:
pgSslMode: "verify-full"
pgSslSecretName: "<YOUR_SECRET_NAME>"
pgSslRootCertSecretKey: "ca.crt"
pgSslCertSecretKey: "client.crt"
pgSslKeySecretKey: "client.key"
Use Helm to install Label Studio on your Kubernetes cluster. Provide your custom resource definitions YAML file. Specify any environment variables that you need to set for your Label Studio installation using the --set argument with the helm install command.
!!! note
If you are deploying to a production environment, you should set the SSRF_PROTECTION_ENABLED: true environment variable. See Secure Label Studio.
From the command line, run the following:
helm install <RELEASE_NAME> heartex/label-studio -f ls-values.yaml
After installing, check the status of the Kubernetes pod creation:
kubectl get pods
Restart your Helm release by doing the following from the command line:
Identify the <RELEASE_NAME> of the latest Label Studio release:shell helm list
Restart the Label Studio app:shell kubectl rollout restart deployment/<RELEASE_NAME>-ls-app
To upgrade Label Studio using Helm, do the following.
ls-values.yaml file:yaml global: image: tag: "20210914.154442-d2d1935" shell helm repo update heartex shell helm upgrade <RELEASE_NAME> heartex/label-studio -f ls-values.yaml shell helm upgrade <RELEASE_NAME> heartex/label-studio -f ls-values.yaml --set global.image.tag=20210914.154442-d2d1935 ls-values.yaml. You must update the tag value when you upgrade or redeploy your instance to avoid version downgrades.To uninstall Label Studio using Helm, delete the configuration.
From the command line, run the following:
helm delete <RELEASE_NAME>