Documentation Index

This is a comprehensive guide to all Strata documentation and resources. Use this index to find what you need quickly.

πŸš€ Getting Started

Resource

Purpose

For Whom

README.md

Project overview, quick start, key features

Everyone

Getting Started Guide

Step-by-step setup and first deployment

New users

Features Overview

Practical rundown of what strata does

Users evaluating strata

VS Code Extension README

Extension features, installation, usage

VS Code users

οΏ½ Reference

Resource

Purpose

GLOSSARY.md

Terminology and core concepts used throughout strata

οΏ½πŸ“– User Guides

Core Concepts

Guide

Purpose

Workspace Model

Understanding the workspace structure

Deployment Configuration

Defining deployments

Environments

Managing environment-specific configs

Providers & Remote Infrastructure

Setting up cloud providers

Networking & Firewalls / Firewall

Network configuration

DNS & Routing

DNS setup and management

Modules & Reusability

Creating reusable components

Namespaces & Multi-Tenancy

Isolating deployments

Resources

Defining infrastructure resources

Workflow Orchestration

Defining deployment workflows

Operational Guides

Guide

Purpose

Commands Reference

Complete CLI command documentation

Validation & Error Handling

How validation works and error resolution

Building Deployments

Pre-deployment artifact generation

Deploying Infrastructure

End-to-end deployment operations

Deployment Approval Gates

Pausing deployments for approval/review

Managing Environments

Environment composition and overrides

Environment Inspection

Query outputs, state, and drift

Multi-Repository Setup

Version pinning and promotion workflows

Service Deployment

Deploy individual services/modules

Secrets, Variables & Features

Resolution pattern for all three

Deployment Audit Trail

Tracking changes and compliance

Troubleshooting

Common issues and solutions

Advanced Topics

Guide

Purpose

Scaffolding Templates

Creating files, bundles, and multi-tenant fleet scaffolds

Policy Engine

Built-in policies and custom rules

Lifecycle Hooks

Pre/post deployment scripts

SBOM & Supply Chain

Bill of materials generation

Drift Detection

Finding configuration drift

πŸ—οΈ Architecture & Design Decisions

Decision Records (ADRs)

Every significant architectural decision is documented as an ADR. Status indicators:

  • βœ… Accepted β€” Approved and implemented

  • πŸ”„ Proposed β€” Under review

  • ⏸️ Deferred β€” Planned but not yet implemented

  • ❌ Deprecated β€” Superseded by newer decisions

ADR

Title

Status

Purpose

0001

Kubernetes-style YAML schema

βœ… Accepted

Model structure and validation

0002

Python + Click CLI (not compiled)

βœ… Accepted

Tool implementation language

0003

Layered architecture

βœ… Accepted

Code organization and dependencies

0004

Exit code convention

βœ… Accepted

Standard exit codes (0/1/2/3/4) with lock conflict signal

0005

Secret resolution at build time

βœ… Accepted

When/how secrets are injected

0006

Policy engine

βœ… Accepted

Validation rules and enforcement

0007

Deployment state locking

βœ… Accepted

Concurrent deployment prevention

0008

Infrastructure drift detection

⏸️ Deferred

Detecting config vs. state differences

0009

SBOM extended sources

βœ… Accepted

Supply chain / Bill of materials

0010

Rename repositories β†’ remotes

βœ… Accepted

Terminology clarification

0011

Promotion strategies

βœ… Accepted

Cross-environment version progression

0012

Rename customer β†’ tenant

βœ… Accepted

Terminology update

0013

Auto-generated secrets

βœ… Accepted

Automatic secret creation & seeding

0014

Onboarding experience

βœ… Accepted

Getting-started walkthrough

0015

Dependency graph

βœ… Accepted

File reference visualization

0016

Console REPL

βœ… Accepted

Interactive shell

0017

Jinja2 templates

βœ… Accepted

YAML templating

0017b

Tag-based release workflow

⏸️ Deferred

Git tag conventions

0018

Deployment audit traceability

βœ… Accepted

Change tracking & SIEM

0019

Terraform build output

βœ… Accepted

Artifact generation

0020

Lifecycle phases

βœ… Accepted

Pre/post hooks (27 phases)

0021

Deployment manifests

βœ… Accepted

Build & deploy artifacts

0022

SIEM integration (Splunk HEC)

βœ… Accepted

Audit log forwarding

0023

Pluggable provisioners

βœ… Accepted

Custom infrastructure provisioners

0024

Environment composition (flat merge)

βœ… Accepted

Multi-file environment merging

πŸ’» Developer Documentation

Extension (VS Code)

Resource

Purpose

VS Code Extension README

User-facing extension documentation

Extension DEVELOPMENT.md

Development setup, building, debugging

Extension Changelog

Version history and features

CLI (Python)

Resource

Purpose

Code Architecture

Codebase structure and layers

Contributing

Resource

Purpose

GOVERNANCE.md

Project governance & decision-making

CODE_OF_CONDUCT.md

Community expectations

SECURITY.md

Reporting security issues

SUPPORT.md

Getting support and reporting issues

πŸ“š Examples & Tutorials

Resource

Purpose

examples/

Working examples for common scenarios

config/aws-eks/

AWS EKS example deployment

config/azure-aks/

Azure AKS example deployment

config/gcp-gke/

Google GKE example deployment

config/hetzner-compose/

Docker Compose example

config/kamatera-swarm/

Docker Swarm example

πŸ”— External Resources

Community & Support

Resource

Purpose

Link

GitHub Issues

Bug reports & feature requests

https://github.com/huybrechtsxyz/strata/issues

GitHub Discussions

Questions & community chat

https://github.com/huybrechtsxyz/strata/discussions

GitHub Wiki

Community-contributed content

https://github.com/huybrechtsxyz/strata/wiki

πŸ“‹ Version-Specific Documentation

Current Version (v0.16.1)

🎯 Quick Navigation by Use Case

β€œI’m new to strata”

  1. Start: README.md

  2. Read: Getting Started Guide

  3. Try: Examples

  4. Reference: Features Overview

β€œI’m using the CLI”

  1. Reference: Commands

  2. Learn: Validation & Errors

  3. Configure: Workspace and Deployment

  4. Troubleshoot: Troubleshooting Guide

β€œI’m using the VS Code Extension”

  1. Install: VS Code Extension README

  2. Configure: Settings in the README

  3. Use: Chat, commands, tree views

  4. Troubleshoot: VS Code Extension README β€” Troubleshooting

β€œI want to contribute”

  1. Read: CONTRIBUTING.md

  2. Review: CODE_OF_CONDUCT.md

  3. Develop: Extension DEVELOPMENT.md (or CLI development)

  4. Reference: Architecture ADRs for design context

β€œI have a question or issue”

  1. Check: Troubleshooting

  2. Search: GitHub Issues

  3. Ask: GitHub Discussions

  4. Report: Use issue templates for bugs/features

β€œI need to integrate with strata”

  1. Learn: Commands Reference

  2. Understand: Exit Codes

  3. Use: JSON Output Format (if exists)

  4. Reference: Policy Engine for validation

πŸ“„ File Structure

strata/
β”œβ”€β”€ README.md                           # Project overview
β”œβ”€β”€ CONTRIBUTING.md                     # Contribution guidelines
β”œβ”€β”€ CHANGELOG.md                        # Release notes
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ README.md                       # Documentation index
β”‚   β”œβ”€β”€ config/                         # YAML model documentation
β”‚   β”‚   β”œβ”€β”€ workspace.md
β”‚   β”‚   β”œβ”€β”€ deployment.md
β”‚   β”‚   β”œβ”€β”€ environment.md
β”‚   β”‚   β”œβ”€β”€ provider.md
β”‚   β”‚   β”œβ”€β”€ network.md
β”‚   β”‚   β”œβ”€β”€ firewall.md
β”‚   β”‚   β”œβ”€β”€ dns.md
β”‚   β”‚   β”œβ”€β”€ module.md
β”‚   β”‚   β”œβ”€β”€ namespace.md
β”‚   β”‚   β”œβ”€β”€ resource.md
β”‚   β”‚   └── workflow.md
β”‚   β”œβ”€β”€ guides/                         # How-to guides
β”‚   β”‚   β”œβ”€β”€ features.md
β”‚   β”‚   β”œβ”€β”€ validation.md
β”‚   β”‚   β”œβ”€β”€ building.md
β”‚   β”‚   β”œβ”€β”€ deploying.md
β”‚   β”‚   β”œβ”€β”€ environments.md
β”‚   β”‚   β”œβ”€β”€ secrets.md
β”‚   β”‚   β”œβ”€β”€ audit.md
β”‚   β”‚   β”œβ”€β”€ policies.md
β”‚   β”‚   β”œβ”€β”€ lifecycle-hooks.md
β”‚   β”‚   β”œβ”€β”€ multi-repo.md
β”‚   β”‚   β”œβ”€β”€ sbom.md
β”‚   β”‚   β”œβ”€β”€ drift.md
β”‚   β”‚   └── troubleshooting.md
β”‚   β”œβ”€β”€ platform/                       # Platform reference
β”‚   β”‚   β”œβ”€β”€ getting-started.md
β”‚   β”‚   β”œβ”€β”€ commands.md
β”‚   β”‚   └── json-api.md
β”‚   β”œβ”€β”€ decisions/                      # Architecture Decision Records
β”‚   β”‚   β”œβ”€β”€ 0001-kubernetes-style-yaml-schema.md
β”‚   β”‚   β”œβ”€β”€ 0002-python-click-not-compiled-cli.md
β”‚   β”‚   └── ... (23 more ADRs)
β”‚   β”œβ”€β”€ examples/                       # Runnable examples
β”‚   └── vscode/                         # Extension documentation
β”œβ”€β”€ src/vscode/
β”‚   β”œβ”€β”€ README.md                       # User documentation
β”‚   β”œβ”€β”€ DEVELOPMENT.md                  # Developer guide
β”‚   └── CHANGELOG.md                    # Extension changelog
β”œβ”€β”€ .github/
β”‚   β”œβ”€β”€ CONTRIBUTING.md                 # (alt) Contribution guidelines
β”‚   β”œβ”€β”€ CODE_OF_CONDUCT.md
β”‚   β”œβ”€β”€ GOVERNANCE.md
β”‚   β”œβ”€β”€ SECURITY.md
β”‚   β”œβ”€β”€ SUPPORT.md
β”‚   β”œβ”€β”€ CONTRIBUTING.md
β”‚   β”œβ”€β”€ ISSUE_TEMPLATE/
β”‚   β”‚   β”œβ”€β”€ bug_report.md
β”‚   β”‚   β”œβ”€β”€ feature_request.md
β”‚   β”‚   └── documentation.md
β”‚   └── pull_request_template.md
└── config/                             # Example deployments
    β”œβ”€β”€ aws-eks/
    β”œβ”€β”€ azure-aks/
    β”œβ”€β”€ gcp-gke/
    β”œβ”€β”€ hetzner-compose/
    └── kamatera-swarm/

πŸ” Search Tips

πŸ“ž Support & Feedback

  • Questions? Ask in GitHub Discussions

  • Found a bug? Report in GitHub Issues

  • Have a feature idea? Use the feature request template

  • Security issue? Email security@example.com (see SECURITY.md)

Last updated: 2026-07-06
Strata Version: 0.16.1+
Documentation Status: πŸ“– Complete