Getting Started on gNMIc Operator

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Kubernetes cluster (v1.25+)
kubectl configured to access your cluster
cert-manager

Installation Methods

Method 1: Quick Install (Recommended)

Download and apply the pre-built manifest from the release:

# Install a specific version
# This includes CRDs, RBAC, webhooks, and the operator deployment
kubectl apply -f https://github.com/gnmic/operator/releases/download/v0.1.0/install.yaml

Method 2: Using Kustomize

For more control over the installation, use kustomize with an overlay:

# Create a kustomization.yaml
cat <<EOF > kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
 - https://github.com/gnmic/operator/config/default?ref=v0.1.0
images:
 - name: controller
 newName: ghcr.io/gnmic/operator
 newTag: "0.1.0"
EOF

# Apply
kubectl apply -k .

Method 3: Using Helm

# Add the Helm repository (OCI)
helm install gnmic-operator oci://ghcr.io/gnmic/operator/charts/gnmic-operator --version 0.1.0

# Or with custom values
helm install gnmic-operator oci://ghcr.io/gnmic/operator/charts/gnmic-operator \
 --version 0.1.0 \
 --namespace gnmic-system \
 --create-namespace \
 --set resources.limits.memory=512Mi

For a complete list of Helm chart configuration options, see the Helm Chart Reference.

Quick Start

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks you through deploying a complete telemetry collection setup with gNMIc Operator.

Overview

We’ll create:

A TargetProfile with connection settings
A Target pointing to a network device
A Subscription defining what data to collect
An Output to send data to Prometheus
A Pipeline connecting everything together
A Cluster to run the gNMIc collectors

Step 1: Create a TargetProfile

The TargetProfile defines shared settings for connecting to devices:

apiVersion: operator.gnmic.dev/v1alpha1
kind: TargetProfile
metadata:
 name: default-profile
spec:
 # Reference to a Secret containing username/password
 credentialsRef: device-credentials
 # TLS without server certificate verification
 tls: {}
 # Connection timeout
 timeout: 10s

cat << 'EOF' | kubectl apply -f -
apiVersion: operator.gnmic.dev/v1alpha1
kind: TargetProfile
metadata:
 name: default-profile
spec:
 # Reference to a Secret containing username/password
 credentialsRef: device-credentials
 # TLS without server certificate verification
 tls: {}
 # Connection timeout
 timeout: 10s
EOF

Create the credentials secret:

Development Guide

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Tool	Version	Purpose
Go	1.25+	Compile the operator
Docker	20+	Build container images
kubectl	1.25+	Interact with the cluster
Kind	0.20+	Local Kubernetes cluster
Containerlab	0.54+	Lab topologies with real network devices
gNMIc CLI	0.38+	Configure lab nodes via gNMI Set

Repository Layout

.
├── api/v1alpha1/ # CRD type definitions and deepcopy methods
├── cmd/main.go # Operator entrypoint
├── config/
│ ├── crd/ # Generated CRD manifests
│ ├── default/ # Kustomize overlay that combines everything
│ ├── manager/ # Controller Deployment and Service
│ ├── rbac/ # ClusterRole, ServiceAccount, Bindings
│ ├── webhook/ # Webhook configuration
│ ├── certmanager/ # cert-manager Issuer and Certificate
│ └── samples/ # Example CRs
├── internal/
│ ├── controller/ # Reconcilers (Cluster, Pipeline, TargetState, …)
│ ├── gnmic/ # gNMIc client helpers (config builder, SSE, …)
│ ├── utils/ # Shared utilities
│ └── webhook/ # Admission webhook handlers
├── helm/ # Helm chart
├── lab/dev/ # Development lab (Containerlab topology + operator resources)
├── Dockerfile
└── Makefile

Initial Setup

Clone the repository and run the one-time setup that creates a Kind cluster, installs cert-manager, builds the operator image, loads it, and deploys it: