Documentation Index¶

Complete navigation guide for all SG Provisioner documentation.

Table of Contents¶

📚 Getting Started (Read First)
📖 Core Documentation (Essential)
🔧 Operations (Day-to-Day Use)
🔒 Security & Compliance
🐛 Troubleshooting & Support
📊 Advanced Topics (Optional)
📋 Reference (As Needed)
🎯 Quick Navigation by Task
📖 Recommended Reading Order
📝 Documentation Conventions
🔄 Documentation Updates

📚 Getting Started (Read First)¶

Start here if you’re new to the SG Provisioner.

README ¶

Quick start and overview — Your first stop. Covers what the tool does, common commands, available scenarios, and AWS credentials setup. Read this first to understand the tool and get running quickly.

User Guide ¶

Complete command reference — Comprehensive guide covering all 12 actions, deployment workflows, volume mounts, AWS credentials, and best practices. Essential reading for daily operations.

📖 Core Documentation (Essential)¶

Core references you’ll use frequently.

Configuration Reference ¶

Configuration parameters reference — Detailed explanation of every YAML parameter (client, environment, security_groups, tags sections), VPC source options, override system, naming conventions, and validation rules.

Scenarios Reference ¶

Scenario reference — Pre-built security group architectures (3-tier and 2-tier), tier definitions, rule structure, port reference, and custom scenario creation guide.

🔧 Operations (Day-to-Day Use)¶

Operational guides for managing deployed infrastructure.

Update Procedures ¶

Update and maintenance procedures — How to update the Docker image, modify existing security group configurations, add new rules, perform drift detection, and replace deployments.

🔒 Security & Compliance¶

Security, permissions, and compliance documentation.

IAM Permissions ¶

Required AWS permissions — Complete IAM policy requirements for EC2, CloudFormation, and SSM operations. Includes least-privilege policies and permissions by action.

Security ¶

Security overview — Known vulnerabilities, security features, container security, and security update policy.

Security Guidelines ¶

Detailed security guidelines — Security group design principles, rule best practices, CIDR restrictions, CloudFormation security, Docker security, and compliance checklist.

🐛 Troubleshooting & Support¶

Problem resolution and getting help.

Troubleshooting ¶

Common issues and solutions — Comprehensive troubleshooting guide covering configuration errors, AWS credential issues, VPC resolution errors, CloudFormation errors, scenario errors, Docker errors, deletion errors, drift detection issues, and Parameter Store issues.

Support ¶

Support information — How to get help, support channels, SLA, license validation issues, and what information to include in support requests.

Feedback ¶

Feature requests and feedback — How to submit feature requests, vote on planned features, and provide documentation feedback.

📊 Advanced Topics (Optional)¶

Deep dives for advanced users and specific use cases.

Application Architecture ¶

Complete architecture documentation — Enterprise-grade technical documentation covering system architecture, design decisions, component architecture, security architecture, and deployment patterns. For architects and advanced users.

Integration Examples ¶

Integration examples — How to discover SG IDs from Parameter Store and use provisioned security groups with EC2, RDS, ECS/Fargate, Lambda, SageMaker, and CI/CD pipelines.

Migration Guide ¶

Migration guide — Migrating from manually created security groups, Terraform, AWS CDK, or manual CloudFormation templates to the SG Provisioner.

📋 Reference (As Needed)¶

Version history, roadmap, and feedback.

Sample Reports ¶

Sample HTML reports — Example pre-deployment review report and deployment report generated by the SG Provisioner.

Release Notes ¶

Version history and changes — Release history, new features, bug fixes, breaking changes, and upgrade notes for each version.

Roadmap ¶

Future features and plans — Planned features, enhancement requests, and product roadmap. See what’s coming next.

🎯 Quick Navigation by Task¶

I want to…¶

Get started quickly → README → User Guide

Understand configuration options → Configuration Reference

Choose the right scenario → Scenarios Reference

Customize rules with overrides → Configuration Reference (Override System section)

Set up IAM permissions → IAM Permissions

Implement security best practices → Security Guidelines

Read SG IDs from Parameter Store → Integration Examples (Discovering Security Group IDs section)

Integrate with EC2, RDS, ECS, Lambda → Integration Examples

Integrate with CI/CD pipelines → Integration Examples (CI/CD Pipeline Integration section)

Update the Docker image or modify configuration → Update Procedures

Migrate from existing security groups → Migration Guide

Troubleshoot an issue → Troubleshooting

Get support → Support

Submit feedback or feature requests → Feedback

📖 Recommended Reading Order¶

For New Users¶

README — Overview and quick start
User Guide — Complete command reference
Scenarios Reference — Understand scenario-based provisioning
Configuration Reference — Configuration parameters and overrides
Troubleshooting — Common issues

For Production Deployment¶

Configuration Reference — Production configuration
Scenarios Reference — Choose appropriate scenario
IAM Permissions — Security setup
Security Guidelines — Security hardening
Update Procedures — Maintenance procedures

For Security Teams¶

Security Guidelines — Security implementation
IAM Permissions — Least-privilege access
Security — Known vulnerabilities

For Developers Integrating with SG Provisioner¶

Integration Examples — Integration patterns
Scenarios Reference — Understand tier structure
Configuration Reference — Workload discriminator

📝 Documentation Conventions¶

UPPERCASE_WITH_UNDERSCORES.md — Main documentation files
All paths are relative to the docs/ directory
Code examples use bash syntax unless otherwise noted
AWS resource names follow the pattern: {company_prefix}-{env}-{tenant_id}-{region}-sg
SSM parameter paths follow the pattern: /sg/{sg-name}/{tier}/SecurityGroupId

🔄 Documentation Updates¶

This documentation is version-controlled and updated with each release. See Release Notes for documentation changes in each version.

Last Updated: 2026-05

See LICENSE.txt for terms and conditions.