InfraJournal

InfraJournal automatically documents infrastructure configurations by parsing the essential files that users already maintain, such as Docker Compose, Nginx, and Caddy configuration files. This tool creates a comprehensive infrastructure inventory, capturing important components like services, networks, volumes, domains, endpoints, and dependencies, along with any warnings and architecture decision records. With its local-first approach, InfraJournal ensures a read-only scanning process that does not require a Docker daemon, cloud credentials, or network access.

Key Issues Addressed

Infrastructure management can often lead to fragmented knowledge, where crucial information resides in various Compose files, proxy configurations, unorganized notes, or within individual team members' recollections. InfraJournal addresses these challenges by consolidating documentation generation directly from the existing configuration files, avoiding the need for maintaining separate documentation. The tool parses configurations, retaining source locations and providing transparency regarding inferred links and documentation gaps.

Core Features

InfraJournal, as of version 0.1.3, offers a wealth of features that enhance infrastructure management:

• Docker Compose Inventory: Captures services, images, ports, networks, health checks, and more.
• Nginx Configuration Support: Parses server blocks, server_names, and related directives.
• Caddy Configuration Support: Handles site addresses and proxy configurations.
• Deterministic Dependency Graph: Displays services, networks, domains, and their relationships, complete with supporting evidence.
• Stable Documentation Snapshots: Generates content-addressed JSON snapshots with a structured schema for ongoing reference.
• Diagnostics and Reporting: More than 40 stable codes cover various potential issues such as parse failures and duplicate ports.
• Local Dashboard Access: Features a visual interface to explore the documentation and architecture map without external connections.

Example Usage

Users can execute commands in the command line to generate documents and observe service dependencies as follows:

# Scan for configurations
infrajournal scan

# Generate Markdown documentation
infrajournal generate

# Check for drift in the infrastructure configuration
infrajournal check

# Start the interactive local dashboard
infrajournal ui

Security and Privacy Considerations

InfraJournal operates entirely on a local machine, ensuring that it does not interact with external services or expose sensitive information. The scanning process respects the environment's integrity by skipping symlinks that lead outside the specified scan root and does not read any sensitive environment values or Docker secrets.

For developers and DevOps professionals seeking better organization and clarity in their infrastructure management, InfraJournal provides a powerful solution that simplifies documentation and enhances operational transparency.