Merge pull request #5 from appvia/fix-pipeline-checks

fix: spoke README terraform-docs and tfvars gitignore

Author: JG-Cloud

.gitignore

@@ -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

modules/spoke/README.md

@@ -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 -->