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.
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: ldap-check
spec:
interval: 30
ldap:
- name: ldap-org
url: ldap://apacheds.ldap.svc.cluster.local:10389
username:
# value: uid=admin,ou=system
valueFrom:
secretKeyRef:
name: ldap-credentials
key: USERNAME
password:
valueFrom:
secretKeyRef:
name: ldap-credentials
key: PASSWORD
bindDN: ou=users,dc=example,dc=com
userSearch: "(&(objectClass=organizationalPerson))"
FieldDescriptionSchemeRequired
nameName of the checkstringYes
bindDNBindDN to use in querystringYes
userSearchUserSearch to use in querystringYes
nameName of the check, must be unique within the canarystringYes
descriptionDescription for the checkstring
iconIcon for overwriting default icon on the dashboardstring
labelsLabels for checkmap[string]string
testEvaluate whether a check is healthyExpression
displayExpression to change the formatting of the displayExpression
transformTransform data from a check into multiple individual checksExpression
metricsMetrics to export from[]Metrics
Connection
connectionPath of existing connection e.g. connection://alertmanager/instance/ Mutually exclusive with username, password, url
Connection
urle.g. ldap://apacheds.ldap.svc:10389
Mutually exclusive with connection
string
username Mutually exclusive with connection EnvVar
password Mutually exclusive with connection EnvVar
skipTLSVerifySkip check of LDAP server TLS certificatesbool