Skip to content

docs(modules): fix the datafusion-se README example and accelerators row - #354

Merged
aghassemlouei merged 1 commit into
google:mainfrom
digitalresistor:docs/datafusion-se-readme-example
Oct 24, 2026
Merged

aghassemlouei merged 1 commit into
google:mainfrom
digitalresistor:docs/datafusion-se-readme-example

Conversation

@digitalresistor

Copy link
Copy Markdown
Contributor

Description

The modules/datafusion-se module README now shows a working example and an accurate variables table.

  • The example pointed at the upstream modules/datafusion module instead of modules/datafusion-se.
  • The example read var.* values from the blueprints/fedramp-high/datafusion blueprint and depended on a KMS binding that it never declared.
  • The example heading said "Without CMEK", but the example depended on a CMEK binding.
  • The new example calls the datafusion-se module with placeholder values and the kms_key input, under the "Private instance with CMEK" heading.
  • A blank line between the type and the default of the accelerators variable made the tools/tfdoc.py script render default = null inside the type column and mark the variable as required. Removing the blank line fixes the row. Terraform already parsed the variable correctly, so the module behavior stays the same.

No issue exists for this change. A comparison against upstream Fabric during the sync in #311 surfaced it.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Deployment & Compliance Impact

  • Applicable Regimes:
    • US Region Restricted (e.g., Access Policy constraint)
    • FedRAMP Moderate
    • FedRAMP High
    • DoD IL4
    • DoD IL5
    • General / All
  • NIST 800-53r5 Controls: None. The change only touches documentation and variable formatting.

Checklist

Code Quality & Reusability

  • My code adheres to the Maximize Reusability principle. I have not redefined common elements and have reused existing base configurations and modules where possible.
  • I have checked that no existing module or configuration in modules/ or fast/stages-aw/ can be leveraged for this change.
  • My code follows the established naming conventions outlined in docs/naming-convention.md.

Documentation

  • I have updated the README.md of the modified module or blueprint.
  • I have added/updated documentation for inputs (variables) and outputs.

Security

  • My change adheres to GCP security best practices and the principle of least privilege.
  • I have ensured compliance with the targeted regime (FedRAMP Moderate, FedRAMP High, IL4, IL5, etc.).

Testing

  • I have tested my changes locally.
  • I have included details of my testing in this PR.

Testing Performed

  • terraform fmt -check passes for the modules/datafusion-se module.
  • The README example, copied into a scratch root module that calls the modules/datafusion-se module, passes terraform init -backend=false and terraform validate.
  • The tools/tfdoc.py script regenerates the variables table, and the tools/check_documentation.py script passes for all modules.
  • The tools/check_links.py script passes for the modules/datafusion-se module.

The README example for the modules/datafusion-se module pointed at the
upstream modules/datafusion module, read blueprint variables and
depended on a KMS binding that it never declared, under a heading that
said "Without CMEK". The example now calls the datafusion-se module
with placeholder values and the kms_key input, under a heading that
matches.

A blank line between the type and the default of the accelerators
variable made the tools/tfdoc.py script render the default inside the
type and list the variable as required. Removing the blank line fixes
the row, and the script regenerates the variables table.
@github-actions github-actions Bot added the Scope - Module Related to reusable Terraform modules in the modules directory label Oct 23, 2026
@aghassemlouei aghassemlouei added Documentation Improvements or additions to documentation Level of Effort - Low Quick, well-defined tasks with no unknowns; takes a few hours up to one day to complete Priority - Low Minor polish, typo fixes, or technical debt; nice to have; pick up when time permits labels Oct 24, 2026

@aghassemlouei aghassemlouei left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for fixing the modules/datafusion-se example and the accelerators variable table formatting. We validated the updated README.md example with terraform init and terraform plan (Plan: 3 to add, 0 to change, 0 to destroy) and verified tools/check_documentation.py.

@aghassemlouei
aghassemlouei merged commit 28429c0 into google:main Oct 24, 2026
16 checks passed
@aghassemlouei aghassemlouei mentioned this pull request Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation Level of Effort - Low Quick, well-defined tasks with no unknowns; takes a few hours up to one day to complete Priority - Low Minor polish, typo fixes, or technical debt; nice to have; pick up when time permits Scope - Module Related to reusable Terraform modules in the modules directory

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants