SG Provisioner Tool Documentation¶

Welcome to the SG Provisioner Tool documentation. This tool helps you provision and manage AWS Security Groups using scenario-based CloudFormation templates.

📚 Getting Started (Read First)¶

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

INDEX: Complete documentation index - Navigation guide for all SG Provisioner documentation with recommended reading order and quick navigation by task.
README: Quick start and overview - Your first stop. Covers what the tool does, common commands, scenario-based architecture, and AWS credentials setup. Read this first to understand the tool and get running in 15 minutes.
USER_GUIDE: Complete command reference - Comprehensive guide covering all 12 actions (validate-config, create-prov-template, create-security-groups, delete-security-groups, list-scenarios, show-scenario, etc.), deployment workflows, volume mounts, AWS credentials, and best practices. Essential reading for daily operations.

📖 Core Documentation (Essential)¶

Core references you’ll use frequently.

CONFIGURATION: Configuration parameters reference - Detailed explanation of YAML parameters, VPC source options (parameter-store vs direct), overrides (port_overrides, additional_ingress, additional_egress), and validation rules.
SCENARIOS: Scenario reference - Pre-built security group architectures (3-tier-web, 2-tier-web), custom scenario creation, tier definitions, rule structure, and the override system.

🔒 Security¶

Security documentation and best practices.

IAM_PERMISSIONS: Required AWS permissions - IAM policy for EC2, CloudFormation, and SSM operations.
SECURITY: Security overview - High-level security architecture and security group design principles.
SECURITY_GUIDELINES: Detailed security guidelines - Least-privilege rules, CIDR restrictions, avoiding open-to-world access, and security group design patterns.

🔧 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, and perform maintenance tasks.

🐛 Troubleshooting¶

Problem resolution.

TROUBLESHOOTING: Common issues and solutions - AWS credentials, configuration errors, CloudFormation errors, scenario validation failures, Docker errors, and deletion errors.

📊 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, CDK, or manual CloudFormation templates to the SG Provisioner.

📋 Reference¶

Version history and roadmap.

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, and upgrade notes for each version.
ROADMAP: Future features and plans - Planned features, enhancement requests, and product roadmap.

📚 Getting Started:

📖 Core Documentation:

🔒 Security:

🐛 Troubleshooting:

📊 Advanced Topics:

📋 Reference:

🎯 Quick Navigation by Task¶

I want to…¶

Get started quickly: → README → User Guide
Understand configuration options: → Configuration Reference
See available scenarios: → Scenarios Reference
Customize rules with overrides: → Configuration Reference (Overrides section)
Look up database ports: → Scenarios Reference (DB Tier section)
Implement security best practices: → Security Guidelines
Troubleshoot an issue: → Troubleshooting
Understand the architecture: → Application Architecture
Read SG IDs from Parameter Store: → Integration Examples
Integrate with EC2, RDS, ECS, Lambda: → Integration Examples
Update the Docker image or modify configuration: → Update Procedures
Migrate from existing security groups: → Migration Guide

📖 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
Security Guidelines - Security hardening

🏗️ Security Group Architecture Patterns¶

The SG Provisioner supports scenario-based architecture patterns:

Pattern 1: 3-Tier Web: Public, application, and database tiers with inter-tier references. See Scenarios Reference.
Pattern 2: 2-Tier Web: Public and database tiers for simpler architectures. See Scenarios Reference.

📝 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: {client}-{env}-{tenant_id}-{region}-sg

🔄 Documentation Updates¶

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