Skip to main content

Kubernetes

Once you have successfully installed SigNoz on Kubernetes, the following sections provide an overview of the activities that are required to successfully operate SigNoz.

Stop/Start

To stop the running SigNoz cluster:

helm -n platform uninstall "my-release"

To start/resume the running SigNoz cluster:

helm -n platform install "my-release"

Note: The newly created release aka SigNoz cluster should mount to the existing persistent volume as long as the namespace and the release name* matches to the old one.

Upgrade

Use the steps below to upgrade to the latest:

  1. Fetch the latest chart information from the Helm repositories
helm repo update
  1. Upgrade to the latest available version of the chart
helm -n platform upgrade my-release signoz/signoz
info

To override values in a Helm chart, you can also use the values/-f flag. See the Helm Upgrade page of the Helm documentation for more details.

In case you wish to upgrade the SigNoz cluster to a specific version, follow the steps below:

  1. List the available SigNoz Helm charts with their version and supported app version.
helm search repo signoz --versions

The output should look similar to the following:

NAME                CHART VERSION   APP VERSION DESCRIPTION
signoz/signoz 0.2.5 0.10.2 SigNoz Observability Platform Helm Chart
signoz/signoz 0.2.3 0.10.1 SigNoz Observability Platform Helm Chart
signoz/signoz 0.2.2 0.10.0 SigNoz Observability Platform Helm Chart
signoz/signoz 0.2.1 0.10.0 SigNoz Observability Platform Helm Chart
signoz/signoz 0.2.0 0.10.0 SigNoz Observability Platform Helm Chart
signoz/signoz 0.1.4 0.9.2 SigNoz Observability Platform Helm Chart
signoz/clickhouse 23.4.0 22.4.5 A Helm chart for ClickHouse
signoz/clickhouse 23.3.3 22.4.5 A Helm chart for ClickHouse
  1. Run the following command to install the chart version 0.2.5 running SigNoz version 0.10.2 with the release name my-release and namespace platform:
helm -n platform upgrade my-release signoz/signoz --version 0.2.5
warning
  • Be careful with breaking changes across versions!
  • There might be misconfiguration caused by version mismatch.

Uninstall

To uninstall/delete the my-release resources:

helm -n platform uninstall "my-release"

See the Helm docs for documentation on the helm uninstall command.

The command above removes all the Kubernetes components associated with the chart and deletes the release except for ClickHouse CRD resources due to finalizers.

To delete resources accociated to ClickHouseInstallations instance:

kubectl -n platform patch \
clickhouseinstallations.clickhouse.altinity.com/my-release-clickhouse \
-p '{"metadata":{"finalizers":[]}}' --type=merge

Deletion of the StatefulSet doesn't cascade to deleting associated PVCs. To delete them:

kubectl -n platform delete pvc -l app.kubernetes.io/instance=my-release

At last, clean up the namespace:

kubectl delete namespace platform
info

Replace my-release and platform from above instructions with appropriate release name and SigNoz namespace respectively.

Remove the Sample Application

Use the command below to remove the sample application:

curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-delete.sh \
| HOTROD_NAMESPACE=sample-application bash