Documentation

Welcome to the gNMIc Operator documentation. This guide will help you deploy and manage gNMIc telemetry collectors on Kubernetes.

What is gNMIc Operator?

gNMIc Operator is a Kubernetes operator that manages the lifecycle of gNMIc collectors. It allows you to:

Deploy gNMIc collectors as StatefulSets with automatic service discovery
Configure targets, subscriptions, inputs and outputs using Kubernetes Custom Resources
Scale horizontally with automatic target distribution across pods
Update configuration dynamically without pod restarts

It automates a lot of the “side quests” you have to go through to build a telemetry pipeline(TLS certificates, scaling out, load balancing,…)

gNMIc Operator integrates seamlessly with other Operators (e.g: CertManager, Prometheus Operator,…)

Resource	Description
Cluster	A gNMIc collector deployment (StatefulSet + Services)
Pipeline	Connects targets, subscriptions, inputs and outputs together
Target	A network device to collect telemetry from
TunnelTargetPolicy	A network device to collect telemetry from
TargetProfile	Shared configuration for targets (credentials, TLS)
Subscription	Defines what data to collect (paths, mode, interval)
Output	Where telemetry data is sent (Prometheus, Kafka, etc.)
Input	External data sources (Kafka, NATS) and relays between clusters
TargetSource	An autodiscovery targetmechanism

Get up and running with gNMIc Operator

Core concepts and architecture of gNMIc Operator

Detailed guides for configuring gNMIc Operator resources

Advanced configuration and operational topics

Learn by starting with ready made examples

API reference and configuration options