Skip to content

cloudflare.md

Latest commit

 

History

History
121 lines (86 loc) · 2.91 KB

cloudflare.md

File metadata and controls

121 lines (86 loc) · 2.91 KB
Raw

Cloudflare Tool Examples

These examples show the intended runseal @tool cloudflare ... atom shapes and how repo wrappers can bind local policy around them.

Credential file

Cloudflare helpers read repo-local credentials from:

.local/secrets/cloudflare.env

Create the template with:

runseal :cloudflare init

The template is local operator state. Do not commit filled credential files.

Config

Inspect the configured defaults that wrappers will use:

runseal @tool cloudflare config json
runseal @tool cloudflare config get zone_name
runseal @tool cloudflare config get manage_host

Generic API Request

Use api request for a single authenticated Cloudflare API request when no more specific atom exists:

runseal @tool cloudflare api request GET /zones --query name=perish.uk

Send a JSON request body with --json:

runseal @tool cloudflare api request PATCH /zones/ZONE_ID/dns_records/RECORD_ID \
  --json '{"ttl":120}'

Zone And DNS Records

Fetch one zone by exact name:

runseal @tool cloudflare zone get --name perish.uk

List DNS records:

runseal @tool cloudflare zone dns-record list --zone-id ZONE_ID
runseal @tool cloudflare zone dns-record list --zone-id ZONE_ID --name runseal.perish.uk

Create or update one DNS record from explicit JSON:

runseal @tool cloudflare zone dns-record create --zone-id ZONE_ID \
  --json '{"type":"CNAME","name":"runseal","content":"example.com","proxied":true}'

runseal @tool cloudflare zone dns-record update --zone-id ZONE_ID --record-id RECORD_ID \
  --json '{"ttl":120}'

Rulesets And Redirect Rules

List and fetch rulesets:

runseal @tool cloudflare zone ruleset list --zone-id ZONE_ID
runseal @tool cloudflare zone ruleset get --zone-id ZONE_ID --ruleset-id RULESET_ID

Build one exact redirect rule payload locally:

runseal @tool cloudflare redirect-rule exact \
  --ref runseal_manage_sh_redirect \
  --description "Redirect runseal manage.sh to releases bucket asset" \
  --host runseal.perish.uk \
  --path /manage.sh \
  --target-url https://releases.runseal.perish.uk/manage.sh

Add or update the rule with the ruleset atoms:

runseal @tool cloudflare zone ruleset rule add \
  --zone-id ZONE_ID \
  --ruleset-id RULESET_ID \
  --json '{"action":"redirect"}'

runseal @tool cloudflare zone ruleset rule update \
  --zone-id ZONE_ID \
  --ruleset-id RULESET_ID \
  --rule-id RULE_ID \
  --json '{"description":"updated"}'

Wrapper Boundary

Prefer runseal :cloudflare ... for repo-owned operator flows such as manager redirect planning and reconciliation:

runseal :cloudflare manage-plan
runseal :cloudflare manage-inspect
runseal :cloudflare manage-ensure-redirect --dry-run

Use direct @tool cloudflare ... calls for one atomic API operation. Use the wrapper when the flow needs repo defaults, repeated calls, JSON shaping, or operator policy.