Skip to main content

AOF Documentation Index

Complete documentation for the Agentic Ops Framework (AOF).

📚 Documentation Structure​

Main README​

Getting Started​

  • Getting Started - 5-minute quickstart guide
    • Installation options (cargo, binary, source)
    • API key configuration
    • First agent creation and execution
    • Common troubleshooting

Core Concepts​

  • Core Concepts - Understanding AOF fundamentals
    • Agents - Single AI assistants
    • AgentFleets - Teams of agents
    • AgentFlows - Workflow automation
    • Tools - MCP, Shell, HTTP, integrations
    • Models - Multi-provider support
    • Memory - Context persistence

Tutorials (Step-by-Step)​

  1. Build Your First Agent (15 min)

    • Agent definition and configuration
    • Adding tools (Shell, MCP)
    • Memory management
    • Deployment and testing

  2. Create a Slack Bot (20 min)

    • Slack app setup
    • Event handling
    • Human-in-the-loop approvals
    • Interactive features

  3. Incident Response Flow (30 min)

    • PagerDuty integration
    • Auto-diagnostics
    • Conditional remediation
    • Post-incident analysis

Reference Documentation​

  • Agent YAML Spec - Complete Agent specification

    • Metadata fields
    • Model configuration
    • Instructions best practices
    • All tool types (Shell, HTTP, MCP, Slack, GitHub, etc.)
    • Memory types and configuration
    • Complete examples

  • AgentFlow YAML Spec - Complete AgentFlow specification

    • 8 trigger types (Webhook, Schedule, Slack, GitHub, etc.)
    • 9 node types (Agent, Fleet, HTTP, Shell, Conditional, etc.)
    • Connections and conditions
    • Variable interpolation
    • Error handling

  • aofctl CLI Reference - Complete CLI command reference

    • Agent commands (apply, get, run, chat, exec, logs, etc.)
    • Fleet commands (create, scale, exec, status)
    • Flow commands (apply, run, status, visualize)
    • Config management
    • Examples and troubleshooting

Examples (Copy-Paste Ready)​

Production-Ready Examples:​

  1. kubernetes-agent.yaml

    • Interactive K8s cluster management
    • Safe kubectl execution
    • Pod/deployment troubleshooting

  2. github-pr-reviewer.yaml

    • Automated code review
    • Security scanning
    • Best practices enforcement
    • Automated PR comments

  3. incident-responder.yaml

    • PagerDuty webhook integration
    • Intelligent diagnostics
    • Auto-remediation with approvals
    • Incident tracking

  4. slack-bot-flow.yaml

    • Conversational K8s assistant
    • Interactive approvals
    • Daily reports
    • Slash commands

  5. daily-report-flow.yaml

    • Scheduled cluster health reports
    • Weekly summaries
    • Custom on-demand reports

📖 Recommended Reading Path​

For First-Time Users:​

  1. Start with Project README - Understand what AOF is
  2. Follow Getting Started - Get up and running
  3. Read Core Concepts - Understand the building blocks
  4. Try First Agent Tutorial - Hands-on practice

For Production Deployment:​

  1. Review Agent Spec - Understand all options
  2. Study Examples - See production patterns
  3. Read AgentFlow Spec - Learn workflow automation
  4. Check CLI Reference - Master the tools

For Specific Use Cases:​

🎯 Documentation by Role​

DevOps Engineers​

Essential reading:

SRE Teams​

Essential reading:

Platform Engineers​

Essential reading:

🔍 Quick Reference​

Common Tasks​

TaskDocumentation
Install AOFGetting Started
Create first agentFirst Agent Tutorial
Add kubectl toolsAgent Spec - Tools
Build Slack botSlack Bot Tutorial
Setup auto-remediationIncident Response Tutorial
Schedule workflowsAgentFlow Spec - Schedule Trigger
CLI commandsaofctl Reference

YAML Quick Reference​

ResourceSpec DocExample
Agentagent-spec.mdkubernetes-agent.yaml
AgentFleetagent-spec.mdComing soon
AgentFlowagentflow-spec.mdslack-bot-flow.yaml

Model Providers​

ProviderFormatEnv VariableDocs
OpenAIopenai:gpt-4OPENAI_API_KEYAgent Spec
Anthropicanthropic:claude-3-5-sonnet-20241022ANTHROPIC_API_KEYAgent Spec
Ollamaollama:llama3NoneAgent Spec
Groqgroq:llama-3.1-70b-versatileGROQ_API_KEYAgent Spec

🛠️ Tool Documentation​

Tool TypeDescriptionDocs
ShellExecute terminal commandsAgent Spec - Shell
HTTPREST API requestsAgent Spec - HTTP
MCPModel Context Protocol serversAgent Spec - MCP
SlackSlack integrationAgent Spec - Slack
GitHubGitHub APIAgent Spec - GitHub
PagerDutyIncident managementAgent Spec - PagerDuty

📝 Contributing​

Documentation Contributions​

  • Fix typos or improve clarity
  • Add missing examples
  • Update outdated information
  • Translate to other languages

Example Contributions​

See Examples README for guidelines.

🆘 Getting Help​

  1. Check documentation - Search this index
  2. Review examples - See examples
  3. Troubleshooting - Check each tutorial's troubleshooting section
  4. GitHub Issues - Report bugs or request features
  5. Discussions - Ask questions

📊 Documentation Coverage​

✅ Complete​

  • Main README
  • Getting Started guide
  • Core Concepts
  • 3 comprehensive tutorials
  • Complete Agent YAML reference
  • Complete AgentFlow YAML reference
  • Complete CLI reference
  • 5 production-ready examples

🚧 Coming Soon​

  • AgentFleet tutorial
  • Advanced patterns guide
  • Performance tuning guide
  • Security best practices
  • Migration from other frameworks
  • API documentation (if REST API is added)

🔄 Documentation Updates​

Last updated: 2024-01-20

Recent Changes​

  • Added complete reference documentation
  • Added 5 production examples
  • Added 3 step-by-step tutorials
  • Added quickstart guide

Questions? Start with Getting Started or jump to a Tutorial.

Building something? Check the Examples for copy-paste templates.

Need details? See the Reference Documentation.