Install

• To ensure the best experience, we recommend using official templates through cloud platforms for one-click deployment of Syncause server, easily obtaining a stable and reliable runtime environment.
• Quick Start: AWS / GCP / Azure

Prerequisites

1. Requires at least 8 cores and 16GB of hardware resources. Disk resources depend on your monitoring scale, with a minimum of no less than 100GB.
2. To install Syncause server using Helm, please ensure the following operations are completed:
   • Kubernetes cluster operation permissions.
   • Install the latest stable version of Helm. For information on installing Helm, please refer to Installing Helm.
3. Network Firewall Configuration: Refer to Appendix 1: Network Port List for port opening instructions

tip

This configuration is for quick deployment and does not enable data persistence by default.

If you need to view more configuration options or perform quick deployment with data persistence on cloud platforms, please refer to the following documentation:

• Helm Common Configurations
• Quick deployment using Terraform on AWS / GCP / Azure (data persistence enabled by default)

Set up Helm Repository

info

Join the Waitlist to get the Helm repository address as soon as possible

Configure Syncause Components

Create the file syncause-values.yaml and define it according to your needs, then mount the configuration during the deployment phase.

global:
  baseURL: "http://xxx.xxx.xxx.xxx:31364"  # FIXME, change to the IP or domain address for browser access to Syncause-server, default access URL port is 31364

Deploy Syncause Helm Charts

Run the following command to deploy the Syncause server in the specified namespace.

helm install syncause syncause/syncause -n syncause --create-namespace \
-f syncause-values.yaml

Verification

Enter the following command to check if the pods have started successfully

kubectl get po -n syncause

Access Syncause Server

You can access the Syncause server in the following way, where NodeIP is the IP address of any node in the cluster.

• Syncause server address: http://<NodeIP>:31364; Default username/password: admin/Syncause2024@admin

Update Syncause Helm Charts Configuration

If your Syncause server configuration has updates, use the following command to update after updating the syncause-values.yaml file

helm upgrade syncause syncause/syncause -n syncause \
-f syncause-values.yaml

Uninstall Syncause Helm Charts

kubectl delete clickhouseinstallation syncause -nsyncause
helm uninstall syncause -n syncause
kubectl delete ns syncause

Appendix 1: Network Port List

• The Syncause server needs to expose the following ports to desktop browsers for access, all of which can be changed through deployment configuration:

Component Name	Open Port	Description
apo-front	31364	Syncause server frontend

• The Syncause server needs to expose the following ports to Syncause-one-agent nodes for data collection, all of which can be changed through deployment configuration:

Component Name	Open Port	Description
apo-collector	30044	For receiving trace sampling data
apo-vector	30310	For receiving and processing log data
apo-otel-collector-gateway	30317	For receiving observability data, OTLP gRPC protocol
apo-otel-collector-gateway	30319	For receiving K8s cluster data, OTLP gRPC protocol
apo-otel-collector-gateway	30321	For receiving metrics data
apo-backend	31363	For providing query API services