Skip to main content

LDAP

The LDAP check:

  • Binds using the provided username and password to the LDAP host. It supports LDAP/LDAPS protocols.
  • Searches an object type in the provided bindDN.
icmp.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: ldap-pass
spec:
interval: 30
ldap:
- url: ldap://apacheds.canaries.svc.cluster.local:10389
name: ldap user login
username:
value: uid=admin,ou=system
password:
value: secret
bindDN: ou=users,dc=example,dc=com
userSearch: "(&(objectClass=organizationalPerson))"
- url: ldap://apacheds.canaries.svc.cluster.local:10389
name: ldap group login
username:
value: uid=admin,ou=system
password:
value: secret
bindDN: ou=groups,dc=example,dc=com
userSearch: "(&(objectClass=groupOfNames))"
FieldDescriptionScheme
bindDN*

BindDN to use in query

string

name*

Name of the check, must be unique within the canary

string

userSearch*

UserSearch to use in query

string

description

Description for the check

string

display

Expression to change the formatting of the display

Expression

icon

Icon for overwriting default icon on the dashboard

Icon

labels

Labels for check

map[string]string

metrics

Metrics to export from

[]Metrics

test

Evaluate whether a check is healthy

Expression

transform

Transform data from a check into multiple individual checks

Expression