UNPKG

aiwg

Version:

Deployment tool and support utility for AI context. Copies agents, skills, commands, rules, and behaviors into the paths each AI platform reads (Claude Code, Codex, Copilot, Cursor, Warp, OpenClaw, and 6 more) so one source of truth works across 10 platfo

138 lines (100 loc) 5.96 kB
# ops-complete Overview ops-complete is the operational infrastructure layer for AIWG — a framework for AI agents working inside ops repositories (sysops, itops, devops, streamops). It formalizes patterns for executable runbooks, fleet inventory, and structured operational workflows, then extends them through four domain-specific extensions. ## What It Is Most AI coding assistants struggle in ops repositories because operational work differs fundamentally from application development: procedures must be idempotent and verifiable, commands may be destructive, and context spans multiple hosts or systems. ops-complete addresses this by providing: - A Kubernetes-inspired YAML artifact format for all operational documents - Enforcement rules that catch dangerous patterns (interactive commands, missing verification steps) - Agents that can execute runbooks with per-step verification - Templates for runbooks, incident reports, and troubleshooting trees - A composable extension system for domain-specific operations ## The YAML Metalanguage ops-complete is built natively on the AIWG YAML metalanguage. Every operational artifact uses a Kubernetes-style envelope: ```yaml apiVersion: ops.aiwg.io/v1 kind: OpsPlaybook metadata: name: deploy-auth-stack namespace: production labels: tier: web spec: # Desired state (kind-specific fields) status: # Observed state — written by the executor, not the author ``` The `kind` field determines the schema. Available kinds: | Kind | Purpose | Analogous To | |------|---------|--------------| | `OpsInventory` | Fleet topology: groups, hosts, variables | Ansible inventory | | `OpsCapability` | Reusable automation unit with I/O contract | Ansible role | | `OpsPlaybook` | DAG of capability invocations against inventory | Argo Workflows | | `OpsGate` | Human approval or quality checkpoint | AIWG HITL gate | | `OpsTarget` | Single host, VM, container, or named resource | Ansible host | | `OpsSchedule` | Time-based trigger | GitHub Actions schedule | | `OpsPipeline` | Composed sequence of playbooks | Argo WorkflowTemplate | | `OpsExtension` | Framework-dependent extension manifest | AIWG addon | All artifacts use structured `from:` references instead of template syntax like `{{ }}`, keeping every file valid YAML regardless of whether it has been rendered. ## Variable Resolution Variables resolve in a 3-level hierarchy (later levels override earlier): 1. **Framework defaults** — `OpsCapability` `defaults:` section 2. **Inventory/group** — `OpsInventory` group `vars:` 3. **Instance** — `OpsPlaybook` `vars:` or `OpsTarget` host `vars:` There is no deeper nesting. This keeps resolution predictable during AI-assisted execution. ## The Four Extensions Extensions require ops-complete and cannot run standalone. They add domain-specific agents, templates, and rules on top of the base framework. | Extension | Scope | |-----------|-------| | `sys` | Per-host hardware, OS, boot chains, fleet documentation | | `it` | Asset management, CMDB, service deployments, disaster recovery | | `dev` | CI/CD pipelines, build automation, fleet-wide tooling | | `stream` | Streaming infrastructure, transcoders, platform integrations | See `@$AIWG_ROOT/agentic/code/frameworks/ops-complete/docs/extensions-guide.md` for details on each extension. ## Core Components ### Rules | Rule | Level | Purpose | |------|-------|---------| | `ops-safety` | CRITICAL | Detect interactive commands; gate destructive operations | | `ops-documentation` | HIGH | Enforce executable, idempotent, verified procedure format | | `ops-cross-repo` | HIGH | Validate scope; enforce cross-repo reference format | | `ops-issue-tracking` | MEDIUM | Label conventions, dependency tracking, phased work | The `ops-safety` rule is the most important. It catches patterns like `read -p "Are you sure?"` in runbooks, commands that lack rollback steps, and procedures that modify production state without verification. ### Agents | Agent | Purpose | |-------|---------| | `ops-runbook-executor` | Execute runbooks step by step with verification at each step | | `ops-inventory` | Collect and reconcile fleet inventory | ### Skills | Skill | Purpose | |-------|---------| | `ops-verify` | Run post-procedure verification | | `ops-audit-trail` | Track files modified, backups created, commands run | ### Templates | Template | Purpose | |----------|---------| | `runbook.md` | Step-by-step procedure with prerequisite checks, steps, and verification | | `incident.md` | Incident report with timeline, impact assessment, and root cause analysis | | `troubleshooting.md` | Symptom-driven diagnosis tree | ## Relationship to Other Frameworks ops-complete is complementary to sdlc-complete, not a replacement. SDLC manages software lifecycle artifacts; ops-complete manages infrastructure artifacts. They can coexist in the same project — the artifact directories do not overlap. Forensics-complete can run within an ops context for incident response workflows. ## Creating Custom Extensions A minimal ops extension requires only an `ADDON.yaml` manifest placed in `agentic/code/extensions/<name>/`: ```yaml apiVersion: ops.aiwg.io/v1 kind: OpsExtension metadata: name: netops labels: domain: network-operations spec: extends: ops-complete description: "Network operations — switch configs, VLAN management, firewall rules" version: "1.0.0" capabilities: auto-discover ``` Auto-discovery scans for templates, rules, and skills in conventional subdirectories. Add them as needed. ## References - `@$AIWG_ROOT/agentic/code/frameworks/ops-complete/docs/quickstart.md` — Deploy and first steps - `@$AIWG_ROOT/agentic/code/frameworks/ops-complete/docs/extensions-guide.md` — Extension details - `@$AIWG_ROOT/docs/yaml-metalanguage.md` — Full YAML metalanguage specification - `@$AIWG_ROOT/agentic/code/frameworks/ops-complete/rules/RULES-INDEX.md` — All ops rules