Skip to content

DT-8886: Update Terraform provider registry documentation#12

Open
snirzango wants to merge 2 commits intomasterfrom
DT-8886
Open

DT-8886: Update Terraform provider registry documentation#12
snirzango wants to merge 2 commits intomasterfrom
DT-8886

Conversation

@snirzango
Copy link
Contributor

Jira: https://datafyio.atlassian.net/browse/DT-8886

Changes

  • Provider overview (docs/index.md): Added comprehensive provider description, prerequisites (org account + API token), getting started guide, resource relationship diagram, and authentication instructions
  • Account resource (docs/resources/account.md): Added detailed description, relationship to other resources, example with IAM role and token, and import instructions
  • Role ARN resource (docs/resources/role_arn.md): Added explanation of 1:1 relationship with accounts, IAM validation note, examples with account creation and Datafy IAM role module
  • Token resource (docs/resources/token.md): Added warnings about secret and attribute immutability, examples for tokens with/without expiration and AWS Secrets Manager integration
  • Autoscaling rule resource (docs/resources/autoscaling_rule.md): Added comprehensive rule syntax documentation covering JsonLogic subset, supported data variables, supported operators, constraints, and multiple examples
  • Data source docs: Updated all four data sources with improved descriptions and usage examples
  • Templates: Added templates/ directory with tfplugindocs templates for all resources, data sources, and provider index
  • Examples: Updated provider, role_arn data source, and autoscaling_rule resource examples

Test Plan

  • Verify documentation renders correctly on the Terraform Registry
  • Verify all example Terraform configurations are syntactically valid
  • Run make generate to confirm templates produce expected output

@snirzango snirzango requested a review from DimaGolomozy March 12, 2026 12:29
Copy link
Collaborator

@DimaGolomozy DimaGolomozy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

Comment on lines +47 to +53
## Import

Accounts can be imported using the account ID:

```shell
terraform import datafy_account.example 79c406c5-7b64-43f2-ba76-9b01e74e3d90
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we dont support import

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the Import section. Thanks for catching that!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the Import section. Thanks for flagging — import is not supported.

Comment on lines +103 to +110
### Supported Data Variables

| Variable | Description | Example |
|----------|-------------|---------|
| `instance_id` | AWS EC2 instance ID | `i-0abcd1234efgh5678` |
| `cluster_name` | Kubernetes cluster name | `prod-cluster` |
| `node_group_name` | Kubernetes node group name | `worker-nodegroup` |
| `tags` | Resource tags (key:value format) | `env:production` |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of listing it here.. i think its better to add a link to our doc page. so we could update a single place.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Replaced the detailed rule syntax section with a link to the Datafy documentation page so it can be maintained in one place.

Manages the AWS IAM role ARN associated with a Datafy account.
---

# datafy_role_arn (Resource)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use template data fields .Name

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done — switched to {{ .Name }} across all resource and data source templates.

Manages a Datafy access token for programmatic API access to a specific account.
---

# datafy_token (Resource)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{{ .Name }}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done — updated to use {{ .Name }} here and across all other templates for consistency.

…s for rule syntax, use template data fields

Co-Authored-By: Claude Opus 4.6 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants