ClientGroup

ClientGroup names a set of clients so that Policies can target them.

API versionkudurru.io/v1alpha1
KindClientGroup
ScopeNamespaced
Resourceclientgroups.kudurru.io
Short namescg
Subresourcesstatus

Columns of kubectl get clientgroups:

ColumnTypeValue
MEMBERSinteger.status.members
READYstring.status.conditions[?(@.type=="Ready")].status

Spec

ClientGroupSpec defines which clients belong to the group.

FieldTypeDescription
spec.clients[]objectItems: at most 1000
spec.clients[].cidrstring
spec.clients[].clientIDstringClientID matches DoT SNI / DoH path client identifiers (v0.2).
spec.clients[].commentstring
spec.clients[].hostnamestring
spec.clients[].ipstring
spec.clients[].macstringMAC matches through an inventory source such as UniFi (v0.2).
spec.clients[].namestring
spec.clients[].nameGlobstring
spec.sourcesobjectClientGroupSources lets an integration add members (v0.2).
spec.sources.integrationRefobjectObjectRef points at another kudurru object. Namespace is omitted for cluster-scoped kinds and for same-namespace references.
spec.sources.integrationRef.namestringRequired.
Length: at least 1
spec.sources.integrationRef.namespacestring

Status

ClientGroupStatus is the observed state of a client group.

FieldTypeDescription
status.conditions[]ConditionList type: map, keyed by type
status.membersinteger
status.observedGenerationintegerFormat: int64

Example

config/samples/kudurru.io_v1alpha1_clientgroup.yaml:

apiVersion: kudurru.io/v1alpha1
kind: ClientGroup
metadata:
  name: kids
  namespace: dns
spec:
  clients:
    - cidr: 10.0.20.0/24
      name: Kids VLAN
    - hostname: "ps5*"

Source: site/content/reference/crds/clientgroup.md