module · SaaS / Business

Confluence

Atlassian Confluence Cloud — spaces, pages, users, restrictions

Namespace: weave confluence Env: CONFLUENCE_URL

Commands

State kinds

SaaS / Business

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.

Confluence REST API

Variable	Description	Status
CONFLUENCE_URL	Required for authentication.	required
CONFLUENCE_USER	Required for authentication.	required
CONFLUENCE_TOKEN	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave confluence --help
weave doctor   # reports CONFLUENCE_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
page	✓	·	·	·	·	·	·
resources	·	·	·	·	✓	✓	✓
space	·	✓	·	·	·	·	·
user	·	✓	·	·	·	·	·

Commands

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

find (1)

find page

read

Find a Confluence page by title or id.

weave confluence find page <identifier>

list (2)

list spaces

read

List spaces.

weave confluence list spaces <arg>

list users

read

List users (Confluence Cloud user search).

weave confluence 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/confluence/.

resources

snapshot diff apply

confluence resources — field-level apply via REST.

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

State file skeleton

module: confluence
kind: resources
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.

Resources audit

Snapshot, diff, and apply resources.

weave confluence snapshot resources
$EDITOR .weave-state/confluence/resources.yaml
weave confluence diff resources
weave confluence apply resources

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
confluence_resources	weave confluence snapshot/diff/apply resources Round-trip via weave state.

Troubleshooting & source

Missing credentials

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

Unexpected behaviour from a state apply

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