Skip to main content
The KloudMate Agent is an OpenTelemetry Collector distribution designed for simplified deployment across multiple platforms. Choose the installation method that matches your infrastructure.

Supported Platforms

The KloudMate Agent supports the following environments:

Linux

Debian/Ubuntu and RHEL/CentOS systems with systemd

Docker

Containerized deployment for host-level monitoring

Kubernetes

DaemonSet and Deployment for cluster monitoring

Windows

Windows Server 2016+ with service installation

Prerequisites

Before installing the KloudMate Agent, ensure you have:

Required

  • API Key: Obtain from KloudMate Settings
  • Collector Endpoint: Default is https://otel.kloudmate.com:4318
  • System Access: Root/administrator privileges for installation

Platform-Specific Requirements

  • Supported OS: Debian, Ubuntu, RHEL, CentOS, Rocky, AlmaLinux, Fedora, Amazon Linux
  • Architecture: x86_64 (amd64) or aarch64 (arm64)
  • systemd for service management
  • Package manager: apt-get, dnf, or yum
  • Docker Engine installed and running
  • Docker version 20.10+ recommended
  • Access to /var/run/docker.sock
  • Privileged container support (for host metrics)
  • Kubernetes 1.19+ cluster
  • Helm 3.8+ installed
  • kubectl access with cluster-admin permissions
  • cert-manager (optional, can be installed via dependencies)
  • Windows Server 2016 or later
  • Windows 10/11 (64-bit)
  • Administrator privileges
  • .NET Framework 4.5+ (usually pre-installed)

Quick Start

Get started with a one-line installation command for your platform:
KM_API_KEY="<YOUR_API_KEY>" KM_COLLECTOR_ENDPOINT="https://otel.kloudmate.com:4318" bash -c "$(curl -L https://cdn.kloudmate.com/scripts/install_linux.sh)"

What Gets Installed

The KloudMate Agent installation includes:
  • OpenTelemetry Collector: Core telemetry collection engine with custom distribution
  • Agent Manager: Lifecycle management and remote configuration capabilities
  • Service/Container: Platform-specific service registration (systemd, Docker daemon, Windows service)
  • Configuration Files: Default OpenTelemetry configuration with KloudMate extensions
  • Auto-Instrumentation (Kubernetes only): Automatic application instrumentation via operator

Architecture Modes

The agent operates in different modes depending on the deployment environment:
PlatformModeDescription
LinuxHost AgentRuns as systemd service, collects host metrics and logs
DockerContainer AgentContainerized with host volume mounts for system access
KubernetesDaemonSet + DeploymentDaemonSet for node metrics, Deployment for cluster-level monitoring
WindowsServiceWindows service for host monitoring

Configuration Management

The KloudMate Agent supports remote configuration through the KloudMate platform. After installation, you can manage agent configurations via the web interface without SSH access to your systems.
Configuration updates are automatically synchronized based on the KM_CONFIG_CHECK_INTERVAL setting (default: 30s).

Next Steps

Select your platform to continue with detailed installation instructions:

Linux Installation

Step-by-step guide for Debian/Ubuntu and RHEL-based systems

Docker Installation

Deploy as a container with custom volume mounts

Kubernetes Installation

Helm chart deployment with auto-instrumentation

Windows Installation

GUI installer for Windows systems

Getting Help

If you encounter issues during installation:

Build docs developers (and LLMs) love