LDAP

The LDAP check:

• Binds to an LDAP or LDAPS server using the configured username and password.
• Searches from the configured base DN.

ldap.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: ldap-pass
spec:
  schedule: "@every 5m"
  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))"

Field	Description	Scheme
bindDN*	Base DN for the LDAP search	string
name*	Name of the check, must be unique within the canary	string
connection	Connection reference or URL to use. Inline username and password can supply credentials when the check supports them	Connection
password		EnvVar
skipTLSVerify	Skip TLS certificate verification	boolean
url	If connection is specified and it also includes a url, this field will take precedence	string
username		EnvVar
userSearch	LDAP search filter	string
dependsOn	Checks that must complete before this check runs	[]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]
markFailOnEmpty	If a transformation or datasource returns empty results, the check should fail	boolean
metrics	Metrics to export from	[]Metrics
namespace	Namespace to insert the check result into when it differs from the canary namespace	string
relationships	Relationships that link check results to components or configs	Relationship
test	Evaluate whether a check is healthy	Expression
transform	Transform data from a check into multiple individual checks	Expression
transformDeleteStrategy	Status to apply to transformed checks when the source check no longer returns them	string