Gitlab 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.

REST API

Variable	Description	Status
GITLAB_URL	Required for authentication.	required
GITLAB_TOKEN	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave gitlab --help
weave doctor   # reports GITLAB_URL 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
member	·	✓	·	·	·	·	·
project	·	✓	·	·	✓	✓	✓
user	✓	·	·	·	·	·	·

Commands

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

find (1)

find user

read

Find a user by username, email, or numeric id.

weave gitlab find user <identifier>

list (2)

list members

read

List members of a group (requires --group-id).

weave gitlab list members <arg>

list projects

read

List projects visible to the token.

weave gitlab list projects <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/gitlab/.

projects

snapshot diff apply

GitLab projects — name, description, visibility round-trip via PUT /projects/:id.

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

State file skeleton

module: gitlab
kind: projects
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.

Project metadata audit

Snapshot projects, edit fields, diff and apply.

weave gitlab snapshot projects
$EDITOR .weave-state/gitlab/<host>/projects.yaml
weave gitlab diff projects
weave gitlab apply projects

Look up one user

weave gitlab find user <username-or-id>

List projects

weave gitlab list projects

List group members

weave gitlab list members --group-id <group-id>

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
gitlab_project	weave gitlab snapshot/diff/apply projects Name, description, visibility via PUT /projects/:id.
gitlab_user	weave gitlab find user Username search via GET /users.

Troubleshooting & source

Missing credentials

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

Unexpected behaviour from a state apply

Re-run weave gitlab 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/gitlab. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.