Skip to content

fix: spoke README terraform-docs and tfvars gitignore #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JG-Cloud merged 2 commits into from
May 22, 2026
Merged

fix: spoke README terraform-docs and tfvars gitignore #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
046f47b
docs: enhance readme with inputs and outputs for spoke module
JG-Cloud May 22, 2026
7378490
fix: update .gitignore to include tfvars and exclude example files
JG-Cloud May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@
# terraform lock file
.terraform.lock.hcl

# terraform tfvars
*.tfvars

# exclude tfvars.example files as they are meant to be checked in as examples
!*.tfvars.example

# Crash log files
crash.log
crash.*.log
Expand Down
22 changes: 22 additions & 0 deletions modules/spoke/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,26 @@ module "spoke" {
See `examples/spoke/spoke-workload-eks/` and `examples/spoke/spoke-workload-ecs/` for complete boundary policy examples.

<!-- BEGIN_TF_DOCS -->
## Providers

| Name | Version |
| ---- | ------- |
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 6.0.0 |

## Inputs

| Name | Description | Type | Default | Required |
| ---- | ----------- | ---- | ------- | :------: |
| <a name="input_agent_space_arn"></a> [agent\_space\_arn](#input\_agent\_space\_arn) | ARN of the Agent Space from the hub module output. Scopes this role's trust policy to that specific Agent Space — no other Agent Space in the hosting account can assume it. | `string` | n/a | yes |
| <a name="input_permissions_boundary_arn"></a> [permissions\_boundary\_arn](#input\_permissions\_boundary\_arn) | Optional ARN of a permissions boundary policy to attach to the cross-account role. See examples/spoke/ for EKS and ECS boundary policy examples. | `string` | `null` | no |
| <a name="input_role_name"></a> [role\_name](#input\_role\_name) | Name for the cross-account IAM role created in this workload account. | `string` | `"DevOpsAgentCrossAccountRole"` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources. | `map(string)` | `{}` | no |

## Outputs

| Name | Description |
| ---- | ----------- |
| <a name="output_role_arn"></a> [role\_arn](#output\_role\_arn) | ARN of the cross-account IAM role. Pass this to the hub module's secondary\_accounts map as cross\_account\_role\_arn. |
| <a name="output_role_iam_id"></a> [role\_iam\_id](#output\_role\_iam\_id) | IAM ID of the cross-account role. Needed when attaching inline policies directly. |
| <a name="output_role_name"></a> [role\_name](#output\_role\_name) | Name of the cross-account IAM role. |
<!-- END_TF_DOCS -->
Loading