Ldap module · weave

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

LDAPv3

Variable	Description	Status
LDAP_HOST	Required for authentication.	required
LDAP_BIND_USER	Required for authentication.	required
LDAP_BIND_PASSWORD	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave ldap --help
weave doctor   # reports LDAP_HOST status

Capabilities

What this module can do, by entity and verb. ✓ means a working CLI surface; · means not (yet) wired.

Entity	find	list	show	do	snapshot	diff	apply
entry	✓	·	·	·	·	·	·
group	·	✓	·	·	·	·	·
user	·	✓	·	·	✓	✓	✓

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

find (1)

find entry

read

Find an LDAP entry by DN, uid, or mail.

weave ldap find entry <identifier>

list (2)

list groups

read

List groups under the configured base DN.

weave ldap list groups <arg>

list users

read

List users under the configured base DN.

weave ldap list users <arg>

snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diff → apply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/ldap/.

This module is on the thinner integration path — use snapshot / diff for audit; confirm apply per kind below before relying on writes.

users

snapshot diff apply

ldap users — field-level apply via REST.

Scope: —
Round-trip: Full round-trip — snapshot, diff, apply.

State file skeleton

module: ldap
kind: users
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

Users audit

Snapshot and diff users.

weave ldap snapshot users
$EDITOR .weave-state/ldap/users.yaml
weave ldap diff users
weave ldap apply users

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource	weave equivalent
ldap_users	weave ldap snapshot/diff/apply users Snapshot/diff for audit; confirm apply on the module page.

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including LDAP_HOST) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave ldap diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.

Open the source

The module lives at https://github.com/andy-broyles/weavewhatever/tree/main/src/weave/modules/ldap. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.