Reference on gNMIc Operator

API Reference

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

Cluster

API Version: operator.gnmic.dev/v1alpha1

ClusterSpec

Field	Type	Required	Default	Description
`replicas`	int32	Yes	-	Number of gNMIc pods
`image`	string	Yes	-	Container image
`api`	APISpec	Yes	-	API configuration
`grpcTunnel`	GRPCTunnelConfig	No	-	gRPC tunnel server configuration
`resources`	ResourceRequirements	No	-	Pod resources
`env`	[]EnvVar	No	-	Environment variables

APISpec

Field	Type	Required	Default	Description
`restPort`	int32	Yes	-	REST API port
`gnmiPort`	int32	No	-	gNMI server port
`tls`	ClusterTLSConfig	No	-	TLS configuration

ClusterTLSConfig

Field	Type	Required	Default	Description
`issuerRef`	string	No	-	cert-manager Issuer name for certificates
`useCSIDriver`	bool	No	false	Use cert-manager CSI driver instead of projected volumes
`bundleRef`	string	No	-	Additional CA bundle for client certificate verification

GRPCTunnelConfig

Field	Type	Required	Default	Description
`port`	int32	Yes	-	Port for the gRPC tunnel server
`tls`	ClusterTLSConfig	No	-	TLS configuration for the tunnel
`service`	ServiceConfig	No	-	Kubernetes service configuration

ServiceConfig

Field	Type	Required	Default	Description
`type`	ServiceType	No	LoadBalancer	Kubernetes service type (ClusterIP, NodePort, LoadBalancer)
`annotations`	map[string]string	No	-	Annotations to add to the service

ClusterStatus

Field	Type	Description
`readyReplicas`	int32	Number of ready replicas
`pipelinesCount`	int32	Number of enabled pipelines referencing this cluster
`targetsCount`	int32	Total unique targets across all pipelines
`subscriptionsCount`	int32	Total unique subscriptions across all pipelines
`inputsCount`	int32	Total unique inputs across all pipelines
`outputsCount`	int32	Total unique outputs across all pipelines
`conditions`	[]Condition	Standard Kubernetes conditions

Cluster Conditions

Type	Description
`Ready`	All replicas are ready and configured
`CertificatesReady`	TLS certificates are issued (when TLS enabled)
`ConfigApplied`	Configuration successfully applied to pods

Pipeline

API Version: operator.gnmic.dev/v1alpha1

Helm Chart

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

This page documents all configuration options available in the gNMIc Operator Helm chart.

Installation

# From OCI registry
helm install gnmic-operator oci://ghcr.io/gnmic/operator/charts/gnmic-operator \
 --namespace gnmic-system \
 --create-namespace

# From source
helm install gnmic-operator ./helm \
 --namespace gnmic-system \
 --create-namespace

Values

Image Configuration

Parameter	Description	Default
`image.repository`	Container image repository	`ghcr.io/gnmic/operator`
`image.tag`	Container image tag	Chart’s `appVersion`
`image.pullPolicy`	Image pull policy	`IfNotPresent`
`imagePullSecrets`	Image pull secrets	`[]`

image:
 repository: ghcr.io/gnmic/operator
 tag: "0.1.0"
 pullPolicy: IfNotPresent

imagePullSecrets:
 - name: my-registry-secret

Deployment Configuration

Parameter	Description	Default
`replicaCount`	Number of operator replicas	`1`
`nameOverride`	Override the chart name	`""`
`fullnameOverride`	Override the full resource name	`""`

replicaCount: 1
nameOverride: ""
fullnameOverride: "my-operator"

Service Account

Parameter	Description	Default
`serviceAccount.create`	Create a service account	`true`
`serviceAccount.annotations`	Annotations for the service account	`{}`
`serviceAccount.name`	Name of the service account	Generated from fullname

serviceAccount:
 create: true
 annotations:
 eks.amazonaws.com/role-arn: arn:aws:iam::123456789:role/my-role
 name: "gnmic-operator"

Pod Configuration

Parameter	Description	Default
`podAnnotations`	Annotations for the operator pod	`{}`
`podSecurityContext`	Security context for the pod	`{runAsNonRoot: true}`
`securityContext`	Security context for the container	See below
`nodeSelector`	Node selector for pod scheduling	`{}`
`tolerations`	Tolerations for pod scheduling	`[]`
`affinity`	Affinity rules for pod scheduling	`{}`

podAnnotations:
 prometheus.io/scrape: "true"

podSecurityContext:
 runAsNonRoot: true

securityContext:
 allowPrivilegeEscalation: false
 capabilities:
 drop:
 - "ALL"

nodeSelector:
 node-role.kubernetes.io/infra: ""

tolerations:
 - key: "dedicated"
 operator: "Equal"
 value: "infra"
 effect: "NoSchedule"

affinity:
 podAntiAffinity:
 preferredDuringSchedulingIgnoredDuringExecution:
 - weight: 100
 podAffinityTerm:
 labelSelector:
 matchLabels:
 app.kubernetes.io/name: gnmic-operator
 topologyKey: kubernetes.io/hostname

Resources

Parameter	Description	Default
`resources.limits.cpu`	CPU limit	`500m`
`resources.limits.memory`	Memory limit	`256Mi`
`resources.requests.cpu`	CPU request	`10m`
`resources.requests.memory`	Memory request	`64Mi`

resources:
 limits:
 cpu: 1000m
 memory: 512Mi
 requests:
 cpu: 100m
 memory: 128Mi

Leader Election

Parameter	Description	Default
`leaderElection.enabled`	Enable leader election	`true`

Leader election ensures only one controller instance is active when running multiple replicas.