Providers on gNMIc Operator

HTTP

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

The general-purpose provider, and the escape hatch for everything not built in.

Basic configuration

apiVersion: operator.gnmic.dev/v1alpha1
kind: TargetSource
metadata:
 name: inventory
spec:
 interval: 5m
 source:
 type: HTTP
 http:
 url: https://inventory.example.com/api/devices
 auth:
 token:
 secretRef: { name: inventory, key: token }
 mapping:
 items: self.results
 name: item.hostname
 address: item.mgmt_ip
 target:
 profile: default

When the endpoint already returns the native list, omit mapping entirely.

Fields

Field	Type	Default	Description
`url`	string	required	Must start with `http://` or `https://`.
`method`	string	`GET`	`GET` or `POST`.
`body`	string		Sent with `POST` only.
`headers`	map		Added to every request. Headers set by `auth` win.
`auth`	object		One of `basic`, `token`, `header`. See below.
`tls`	object		For `https` URLs. See below.
`mapping`	object		How to read a document that is not the native list. See below.
`pagination`	object		How to follow a multi-page response. See below.

The request deadline is the TargetSource’s timeout, for all pages together.

Static

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

An inline inventory. It exists so a small fixed lab needs no second resource, and so the naming, pruning and conflict behaviour can be tried without any external system.

apiVersion: operator.gnmic.dev/v1alpha1
kind: TargetSource
metadata:
 name: lab
spec:
 source:
 type: Static
 static:
 devices:
 - name: leaf1
 address: 10.0.0.1
 - name: leaf2
 address: 10.0.0.2
 port: 57401
 profile: srlinux
 labels: { role: leaf }
 target:
 port: 57400
 profile: default

Field	Type	Description
`devices[].name`	string	Required.
`devices[].address`	string	Required. An IP or hostname without a port.
`devices[].port`	int	Overrides `target.port` for this device.
`devices[].profile`	string	Overrides `target.profile` for this device.
`devices[].labels`	map	Added to the `Target`.

Editing the list is a spec change and triggers a run at once.

ConfigMap and Secret

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

The in-cluster inventory: a list maintained by a human, by CI, or by a job that exports from somewhere else. A system that used to push targets into the operator should write a ConfigMap instead and point a TargetSource at it.

apiVersion: v1
kind: ConfigMap
metadata:
 name: lab-devices
data:
 devices.yaml: |
 - name: leaf1
 address: 10.0.0.1
 - name: leaf2
 address: 10.0.0.2
 labels:
 role: leaf
---
apiVersion: operator.gnmic.dev/v1alpha1
kind: TargetSource
metadata:
 name: lab
spec:
 source:
 type: ConfigMap
 configMap:
 name: lab-devices
 key: devices.yaml
 target:
 profile: default

type: Secret has the same shape under secret:. Use it when the document must not be readable by everyone who can read ConfigMaps.