Documentation Index

Complete navigation guide for all SG Provisioner documentation.

Table of Contents

📚 Getting Started (Read First)

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

README.md

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.md

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.md

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.md

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.md

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.md

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

SECURITY.md

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

SECURITY_GUIDELINES.md

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.md

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.md

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

FEEDBACK.md

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.md

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.md

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.md

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.md

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

RELEASE_NOTES.md

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

ROADMAP.md

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.md → USER_GUIDE.md

Understand configuration options → CONFIGURATION.md

Choose the right scenario → SCENARIOS.md

Customize rules with overrides → CONFIGURATION.md (Override System section)

Set up IAM permissions → IAM_PERMISSIONS.md

Implement security best practices → SECURITY_GUIDELINES.md

Read SG IDs from Parameter Store → INTEGRATION_EXAMPLES.md (Discovering Security Group IDs section)

Integrate with EC2, RDS, ECS, Lambda → INTEGRATION_EXAMPLES.md

Integrate with CI/CD pipelines → INTEGRATION_EXAMPLES.md (CI/CD Pipeline Integration section)

Update the Docker image or modify configuration → UPDATE_PROCEDURES.md

Migrate from existing security groups → MIGRATION_GUIDE.md

Troubleshoot an issue → TROUBLESHOOTING.md

Get support → SUPPORT.md

Submit feedback or feature requests → FEEDBACK.md

📝 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.md for documentation changes in each version.

Last Updated: 2026-05

Copyright © 2025 Axon Tech Labs. All rights reserved.

See LICENSE.txt for terms and conditions.