Skip to content

Document how to onboard an existing organization into Terraform #52

Description

@Danielmoraisg

Summary

All resources support terraform import, but the realistic adoption path is an org that already exists in Pipefy: many pipes, each with dozens of phases, fields, and automations, plus tables, labels, webhooks, and relations. Importing all of that one terraform import at a time is not a workable story, and nothing in the docs covers onboarding.

Proposed work

  • Document the Terraform 1.5+ flow: import blocks plus terraform plan -generate-config-out=generated.tf, with a worked example that brings a full organization under management (org lookup, then each pipe with its phases, fields, and automations, then tables).
  • Config generation is only as good as Read, so this depends on Allow read to catch drift on the resources #36; generated config for attributes the provider never refreshes will be wrong or empty. Discovery across an org depends on the pipefy_organization data source (Data sources: pipefy_organization, pipe lookup by name, phase fields #49).
  • Document the import ID format per resource in the resource docs (today it is only discoverable from examples/resources/*/import.sh).
  • Build a helper (script or tools/ command) that, given an organization id, walks the API and emits the import blocks for everything in it: pipes, phases, fields, automations, and, as the resources land, labels, webhooks, field conditions, relations, tables, and table fields.

Notes

As new resources land, extend both the documented flow and the helper to cover them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions