Kubernetes Operator

The best way to deploy Coroot into a Kubernetes or OpenShift cluster is by using the coroot-operator. The operator simplifies the deployment of all required components and enables scaling as needed. It supports the deployment of both Coroot Community and Enterprise editions.

Operator installation

Add the Coroot helm chart repo:

helm repo add coroot https://coroot.github.io/helm-charts
helm repo update coroot

Next, install the Coroot Operator:

helm install -n coroot --create-namespace coroot-operator coroot/coroot-operator

Coroot CR (Custom Resource)

To deploy Coroot, you need to create a Coroot resource. Below is an example specification of the Coroot custom resource. The operator continuously monitors these resources and adjusts the configuration if necessary. Additionally, the operator checks for new versions of Coroot components and automatically updates them unless you specify particular versions.

apiVersion: coroot.com/v1
kind: Coroot
metadata:
  name: coroot
  namespace: coroot
spec:
#  metricsRefreshInterval: 15s # Specifies the metric resolution interval.
#  apiKey: # The API key used by agents when sending telemetry to Coroot.
#  cacheTTL: 7d # Duration for which Coroot retains the metric cache.
#  authAnonymousRole: Admin # Allows access to Coroot without authentication if set.
#  authBootstrapAdminPassword: # Initial admin password for bootstrapping.
#  env: # Environment variables for Coroot.

#  service: 
#    type: # Service type (e.g., ClusterIP, NodePort, LoadBalancer).
#    port: # Service port number.
#    nodePort: # NodePort number (if type is NodePort).

#  communityEdition:
#    version: x.y.z # If unspecified, the operator will automatically update Coroot CE to the latest version.

#  enterpriseEdition: # Configurations for Coroot Enterprise Edition.
#    version: x.y.z # If unspecified, the operator will automatically update Coroot EE to the latest version.
#    licenseKey: COROOT-1111-111 # License key for Coroot Enterprise Edition.

#  agentsOnly: # Configures the operator to install only the node-agent and cluster-agent.
#    corootUrl: http://COROOT_IP:PORT/ # URL of the Coroot instance to which agents send metrics, logs, traces, and profiles.

#  nodeAgent:
#    version: x.y.z # If unspecified, the operator will automatically update the node-agent to the latest version.
#    priorityClassName: # Priority class for the node-agent pods.
#    update_strategy: # Update strategy for node-agent pods.
#    affinity: # Affinity rules for node-agent pods.
#    resources: # Resource requests and limits for the node-agent pods.
#      requests: 
#        cpu: 100m
#        memory: 200Mi
#      limits: 
#        cpu: 500m
#        memory: 1Gi
#    env: # Environment variables for the node-agent.

#  clusterAgent:
#    affinity: # Affinity rules for the cluster-agent.
#    resources: # Resource requests and limits for the cluster-agent pods.
#      requests:
#        cpu: 100m
#        memory: 200Mi
#      limits:
#        cpu: 500m
#        memory: 2Gi
#    env: # Environment variables for the cluster-agent.

#  prometheus:
#    affinity: # Affinity rules for Prometheus.
#    storage:
#      size: 10Gi # Volume size for Prometheus storage.
#      className: "" # If not set, the default storage class will be used.
#    resources: # Resource requests and limits for Prometheus.

#  clickhouse:
#    shards: 1 # Number of ClickHouse shards.
#    replicas: 1 # Number of replicas per shard.
#    keeper: # Configuration for the ZooKeeper or ClickHouse Keeper.
#      affinity: # Affinity rules for keeper pods.
#      storage:
#        size: 10Gi # Volume size for keeper storage.
#        className: "" # If not set, the default storage class will be used.
#    resources: # Resource requests and limits for keeper pods.
#    storage:
#      size: 10Gi # Volume size for EACH ClickHouse instance.
#      className: "" # If not set, the default storage class will be used.
#    affinity: # Affinity rules for ClickHouse pods.
#    resources: # Resource requests and limits for ClickHouse pods.

#  externalClickhouse: # Use an external ClickHouse instance instead of deploying one.
#    address: # Address of the external ClickHouse instance.
#    user: # Username for accessing the external ClickHouse.
#    password: # Password for accessing the external ClickHouse.
#    database: # Name of the database to be used.

#  replicas: 1 # Number of Coroot StatefulSet pods.

#  postgres: # Store configuration in a Postgres db instead of SQLite (required if replicas > 1).
#    connectionString: "postgres://coroot:password@127.0.0.1:5432/coroot?sslmode=disable"