Skip to content

README.md

Latest commit

 

History

History
48 lines (34 loc) · 3.26 KB

README.md

File metadata and controls

48 lines (34 loc) · 3.26 KB
Raw

quartzctl - Capability Package

Reusable lifecycle automation for staged OpenTofu platforms, delivered as the quartz CLI.

quartzctl turns a top-level quartz.yaml plus ordered stage directories into a repeatable install, update, validation, and teardown workflow. It discovers stages, resolves dependencies, renders configuration and secrets, prepares cloud state backends, runs OpenTofu per stage, gates progress with health checks, and provides recovery commands for state, locks, kubeconfig, secrets, and workload restarts.

This directory contains the documentation package for delivery teams, capture teams, and proposal writers.

Quick Start

New to this? Start with the Onboarding Guide and the Template Package.

Evaluating for a capture? Start with the Capability Summary and Value Brief.

Capability Assets

Document Description Audience
Capability Summary Self-contained one-pager suitable for email distribution Delivery leads, capture managers
Reference Architecture CLI architecture, stage lifecycle, command surface, provider boundaries Solutions architects, platform engineers
Operating Model Day 0/1/2+ ownership, RACI, release and operations model Delivery teams, operations leads
Onboarding Guide Prerequisites to first successful staged install New delivery teams
Runbook Operational procedures for install, resume, state repair, teardown, and local development Operators, platform engineers
Troubleshooting Guide Decision-tree diagnosis for config, provider, OpenTofu, health-check, and teardown issues All practitioners
Template Package quartz.yaml and stage.yaml adaptation reference New program setup
Value Brief Delivery value, reuse argument, and proposal talking points Capture teams, proposals
Product Page Marketing-style narrative for internal or external capability pages Marketing, capture

Supporting References

Document Description
Repository README Primary command reference and configuration examples
Minimal Sample Small runnable configuration shape
OpenTofu Migration Migration notes for Terraform to OpenTofu
Config schema Authoritative Go structs for quartz.yaml
Command package Authoritative CLI command implementation

Maintenance

These documents reference actual commands, flags, config keys, and paths. When the CLI changes:

  1. Update the command tables when internal/cmd adds or removes commands or flags.
  2. Update config examples when structs in internal/config/schema change.
  3. Re-check stage behavior when internal/stages or internal/tofu changes.
  4. Keep examples aligned with docs/samples/minimal.

Ownership: The platform engineering team owns this package. Review quarterly or when the CLI command surface changes materially.