Skip to main content

Kubernetes

Follow the steps on this page to install SigNoz on Kubernetes with Helm.

The SigNoz Helm chart will install the following components into your Kubernetes cluster:

  • Query Service (backend service)
  • Web UI (Frontend)
  • ClickHouse (datastore)
  • OpenTelemetry collector
  • Alert Manager

Prerequisites

  • You must have a Kubernetes cluster.

  • You must have kubectl access to your cluster.

  • The following table describes the hardware requirements that are needed to install SigNoz on Kubernetes:

    ComponentMinimal RequirementsRecommended
    Memory4 GB16 GB
    CPU2 cores4 cores
    Storage10 GB50 GB

Install SigNoz on Kubernetes with Helm

  1. Add the SigNoz Helm repository to your client with name signoz by running the following command:
helm repo add signoz https://charts.signoz.io
  1. Verify that the repository is accessible to the Helm CLI by entering the following command:
helm repo list
  1. Use the kubectl create ns command to create a new namespace. SigNoz recommends you use platform for your new namespace:
kubectl create ns platform
  1. Run the following command to install the chart with the release name my-release and namespace platform:
helm --namespace platform install my-release signoz/signoz

Note that the above command installs the latest stable version of SigNoz. To install a different version, you can use the --set flag to specify the version you wish to install. The following example command installs SigNoz version 0.7.1:

  helm --namespace platform install my-release signoz/signoz \
--set frontend.image.tag="0.7.1" \
--set queryService.image.tag="0.7.1"
info
  • If you use the --set flag, ensure that you specify the same versions for the frontend and queryService images. Specifying different versions could lead the SigNoz cluster to behave abnormally.
  • Do not use the latest or master tags in a production environment. Specifying these tags could install different versions of SigNoz on your cluster and could lead to data loss.
  1. You can access SigNoz by setting up port forwarding and browsing to the specified port. The following kubectl port-forward example command forwards all connections made to localhost:3301 to <signoz-frontend-service>:3301:
export SERVICE_NAME=$(kubectl get svc --namespace platform -l "app.kubernetes.io/component=frontend" -o jsonpath="{.items[0].metadata.name}")

kubectl --namespace platform port-forward svc/$SERVICE_NAME 3301:3301

Verify the Installation

Using the kubectl -n platform get pods command, monitor the SigNoz deployment process. Wait for all the pods to be in running state:

kubectl -n platform get pods

(Optional) Install a Sample Application and Generate Tracing Data

Follow the steps in this section to install a sample application named HotR.O.D, and generate tracing data.

  1. Use the HotROD install script below to create a sample-application namespace and deploy HotROD application on it:
curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-install.sh \
| HELM_RELEASE=my-release SIGNOZ_NAMESPACE=platform bash
  1. Use the following command to generate load:
kubectl --namespace sample-application run strzal --image=djbingham/curl \
--restart='OnFailure' -i --tty --rm --command -- curl -X POST -F \
'locust_count=6' -F 'hatch_rate=2' http://locust-master:8089/swarm
  1. Browse to http://localhost:3301 and see the metrics and traces for your sample application.

  2. Use the following command to stop load generation:

kubectl -n sample-application run strzal --image=djbingham/curl \
--restart='OnFailure' -i --tty --rm --command -- curl \
http://locust-master:8089/stop

Go to Kubernetes Operate section for detailed instructions.

Next Steps