This index provides a structured overview of the available documentation.
- Setup Guide: Step-by-step instructions for installing and setting up InfraFoundry.
- Direnv Integration: How to configure and use
direnvfor automatic environment variable management.
- CLI Reference: Comprehensive reference for the
infracommand-line interface. - Validation: Guide to running pre-flight checks and validating configurations.
- Overview: High-level introduction to configuring InfraFoundry.
- Settings File Structure: Detailed specification of the settings file layout.
- YAML Only Config: Guide to using the pure YAML configuration approach.
- Per-Environment Credentials: Managing credentials specific to different environments.
- Secret Provider: Vaultwarden: Using Vaultwarden/Bitwarden for secrets.
- Secret Provider: AWS: Using AWS Secrets Manager for secrets.
- Secret Provider: Azure: Using Azure Key Vault for secrets.
- Policy Configuration: Defining and enforcing infrastructure policies.
- Separate Config Repo: Best practices for maintaining configurations in a separate repository.
- Notifications: Setting up and customizing system notifications.
- Blueprints: Using blueprints for reusable infrastructure patterns.
- Overview: Conceptual overview of the system architecture.
- Detailed Architecture: Deep dive into the architectural components and their interactions.
- State Management: Explanation of how InfraFoundry manages and tracks state.
- Secrets Architecture: Design and implementation of the secure secrets management system.
- Orchestrator: Architecture of the orchestration engine.
- Pluggable Runners: How the runner system supports multiple backends (Terraform, Ansible, etc.).
- Graphing: Details on dependency graphing and visualization capabilities.
- Design Principles: Core principles guiding the design of InfraFoundry.
- Design Principles Assessment: Evaluation of the architecture against the design principles.
- Architectural Patterns: Common software patterns employed in the codebase.
- Architecture Decision Records: Historical record of key architectural decisions.
- ISC to Kea Migration: Walkthrough for migrating DHCP services from ISC to Kea.
- DHCP VM Integration: Integrating DHCP services with Virtual Machines.
- Age Key Management: Managing Age encryption keys for secrets.
- SSH Authentication: Setting up and managing SSH authentication.
- Implementing Providers: Guide for creating new providers for InfraFoundry.
- Implementing Runners: Comprehensive guide for creating custom infrastructure tool runners.
- Runner Protocol Quick Reference: Quick reference for protocol-based runner system.
- Manager Patterns: implementation patterns for Manager classes.
- Event System: Documentation of the internal event system.
- Credential Loader: How the credential loading system works.
- Coding Standards: Style guides and standards for contributing code.
- CI/CD Testing: Strategies and setups for CI/CD pipelines.
- Release Automation & Security: Automated versioning, release management, governance validation, and security tooling.
- Implementing Secret Providers: Guide to adding new secret storage providers.
- Overview: Introduction to the runner subsystem.
- Ansible: Specifics of the Ansible runner implementation.
- Terraform: Specifics of the Terraform runner implementation.
- PyInfra: Specifics of the PyInfra runner implementation.
- Pulumi: Specifics of the Pulumi runner implementation (experimental).
- Env Example: Annotated example of environment configuration.
- Envrc Local: Example usage of local environment variables.
- Gitlab CI: Example GitLab CI workflow configuration.
- Custom Runner Example: Complete example of implementing a CloudFormation runner.
- OpnSense Parser: Documentation for the OpnSense configuration parser.
- Maintenance Report: Status and maintenance notes for the test suite.
- Project To-Do & Roadmap: Planned features and enhancements.
- Documentation Template: Standard template for new documentation files.
- Code Quality Analysis: Reports and metrics on code quality.