Skip to content

docs: add additional module documentation#66

Merged
ssun3 merged 3 commits into
mainfrom
docs/add-documentation
Jun 4, 2025
Merged

docs: add additional module documentation#66
ssun3 merged 3 commits into
mainfrom
docs/add-documentation

Conversation

@ssun3
Copy link
Copy Markdown
Contributor

@ssun3 ssun3 commented May 27, 2025

Add additional documentation for Terraform AWS OIDC integration:

  • Architecture overview and system design
  • Hidden dependencies and prerequisites
  • Step-by-step setup guide
  • Examples analysis with security considerations
  • Security best practices and hardening guidelines
  • Troubleshooting guide and common issues

Additional improvements:

  • Fix GitLab environment mapping with clarifying documentation
  • Improve test isolation by using mock providers instead of real AWS/TLS providers
  • Enhance test coverage for custom provider configurations

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 27, 2025

Pull Request Review Status

  • 🖌 Terraform Format and Style: success
  • 🔍 Terraform Linting: success
  • 👮 Terraform Security Check: success
  • 👮 Terraform Security Checkov: success
  • 🔘 Terraform Tests: success
  • 🔧 Terraform Initialisation: success
  • 🤖 Terraform Validation: success
  • 🤖 Terraform Example Validation: success
  • 📖 Terraform Documentation: success
  • 🔖 Commitlint: success

Working Directory: modules/role
Pusher: @ssun3, Action: pull_request
Workflow Run Link: https://github.com/appvia/terraform-aws-oidc/actions/runs/15305488833

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 27, 2025

Pull Request Review Status

  • 🖌 Terraform Format and Style: success
  • 🔍 Terraform Linting: success
  • 👮 Terraform Security Check: success
  • 👮 Terraform Security Checkov: success
  • 🔘 Terraform Tests: success
  • 🔧 Terraform Initialisation: success
  • 🤖 Terraform Validation: success
  • 🤖 Terraform Example Validation: success
  • 📖 Terraform Documentation: success
  • 🔖 Commitlint: success

Working Directory: modules/remote_state
Pusher: @ssun3, Action: pull_request
Workflow Run Link: https://github.com/appvia/terraform-aws-oidc/actions/runs/15305488833

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 27, 2025

Pull Request Review Status

  • 🖌 Terraform Format and Style: success
  • 🔍 Terraform Linting: success
  • 👮 Terraform Security Check: success
  • 👮 Terraform Security Checkov: success
  • 🔘 Terraform Tests: success
  • 🔧 Terraform Initialisation: success
  • 🤖 Terraform Validation: success
  • 🤖 Terraform Example Validation: success
  • 📖 Terraform Documentation: success
  • 🔖 Commitlint: success

Working Directory: modules/provider
Pusher: @ssun3, Action: pull_request
Workflow Run Link: https://github.com/appvia/terraform-aws-oidc/actions/runs/15305488833

@ssun3 ssun3 force-pushed the docs/add-documentation branch 5 times, most recently from a230069 to 444fc2f Compare May 28, 2025 14:45
@ssun3 ssun3 requested review from m13t and removed request for m13t May 28, 2025 14:52
Comment thread modules/role/locals.tf
# GitLab includes environment info as separate JWT claims (environment, deployment_tier)
# rather than in the subject claim. Need to use custom claim conditions for environment-based access.
# setting this to empty string to avoid null value error for now.
subject_env_mapping = ""
Copy link
Copy Markdown
Contributor Author

@ssun3 ssun3 May 28, 2025

Choose a reason for hiding this comment

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

TODO in separate PR: Add subject_env_mapping support for GitLab. Since GitLab passes environment/deployment_tier as separate JWT claims (not in the subject), implementing this properly requires refactoring the module's claim parsing logic beyond just config changes. Setting to empty string for now.

@ssun3 ssun3 force-pushed the docs/add-documentation branch 2 times, most recently from 46f916f to 0abbb55 Compare May 28, 2025 16:11
@ssun3 ssun3 requested a review from m13t May 28, 2025 16:11
renovate Bot and others added 3 commits May 28, 2025 17:27
Add additional documentation for Terraform AWS OIDC integration:
- Architecture overview and system design
- Hidden dependencies and prerequisites
- Step-by-step setup guide
- Examples analysis with security considerations
- Security best practices and hardening guidelines
- Troubleshooting guide and common issues
Added documentation explaining that GitLab provides environment information
as separate JWT claims rather than in the subject claim, requiring custom
claim conditions for environment-based access control.
- Added mock providers for AWS and TLS in test files
- Enhanced custom provider test coverage
- Added tags to test resources for better organization
@ssun3 ssun3 force-pushed the docs/add-documentation branch from 0abbb55 to 0c4ba59 Compare May 28, 2025 16:28
@ssun3 ssun3 requested review from KashifSaadat and gambol99 June 2, 2025 16:07
Copy link
Copy Markdown
Collaborator

@m13t m13t left a comment

Choose a reason for hiding this comment

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

Great work!

@ssun3 ssun3 merged commit 6f7e151 into main Jun 4, 2025
36 checks passed
@ssun3 ssun3 deleted the docs/add-documentation branch June 4, 2025 10:13
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