Self-hosted docs

Runbooks and Procedures

Step-by-step guides for common operational scenarios and game-day exercises.

docs.cyiro.comproduction-ready guidance

Route policy simulation runbook

How to test failover policies before applying them to production routes.

Step 1: Create simulation workspace with production-like configuration
Step 2: Define test scenarios (latency degradation, provider outage, policy violation)
Step 3: Run simulation with dry-run flag to see predicted behavior
Step 4: Review simulation results and adjust policies as needed
Step 5: Apply approved policies to staging environment for validation
Command: cyiro simulate failover --workspace prod-sim --scenario latency-degradation --dry-run

Outage game-day checklist

Preparedness checklist for handling provider outages and failover scenarios.

✅ Verify all routes have approved fallback endpoints
✅ Confirm failover policies are active and properly configured
✅ Check circuit breaker thresholds are appropriate for current traffic
✅ Ensure monitoring dashboards are accessible and up-to-date
✅ Confirm team communication channels are operational
✅ Verify rollback procedures are documented and tested
✅ Check that manual override capabilities are available

Latency game-day checklist

Checklist for responding to latency degradation incidents.

✅ Identify affected routes and current latency metrics
✅ Check if latency is provider-wide or route-specific
✅ Review historical latency patterns for comparison
✅ Verify failover thresholds are appropriate for current SLOs
✅ Test manual failover procedure for critical routes
✅ Communicate expected impact to stakeholders
✅ Document all actions taken and decisions made

Cost-spike game-day checklist

Checklist for responding to unexpected cost increases.

✅ Identify routes with abnormal cost patterns
✅ Check for token usage anomalies or model changes
✅ Review cost control policies and thresholds
✅ Verify budget alerts are properly configured
✅ Test cost containment playbooks
✅ Communicate potential financial impact to finance team
✅ Document root cause and preventive measures

Unsafe-output game-day checklist

Checklist for containing and mitigating unsafe model outputs.

✅ Identify affected routes and output patterns
✅ Activate containment playbooks for high-risk routes
✅ Review guardrail policies and safety thresholds
✅ Test manual intervention procedures
✅ Communicate incident to security and compliance teams
✅ Document containment actions and policy adjustments
✅ Schedule post-incident review with all stakeholders

Watcher-noise reduction checklist

Strategies for reducing false positives and alert fatigue from watchers.

Review watcher configurations for appropriate sensitivity
Adjust polling intervals based on change frequency
Implement debouncing for high-frequency changes
Add filtering for known benign changes
Set up watcher health monitoring and alerting
Document watcher tuning procedures
Establish regular review cadence for watcher performance

Incident triage SLA checklist

Service level agreements for incident response and triage.

P1 Incidents: Acknowledge within 5 minutes, initial response within 15 minutes
P2 Incidents: Acknowledge within 15 minutes, initial response within 30 minutes
P3 Incidents: Acknowledge within 30 minutes, initial response within 1 hour
P4 Incidents: Acknowledge within 1 hour, initial response within 4 hours
Escalation: Automatic escalation if SLA targets are missed
Communication: Regular updates every 30 minutes for P1/P2 incidents
Resolution: Post-incident review within 24 hours for all severity levels

Playbooks incident templates

Pre-defined templates for common incident response scenarios.

Provider outage response: Step-by-step failover and communication procedures
Policy violation containment: Isolation and remediation workflows
Cost spike mitigation: Resource optimization and alerting strategies
Security incident response: Evidence preservation and escalation protocols
Performance degradation: Diagnostic and recovery procedures
Custom templates: Create and version-control your own incident workflows

Release checklist templates

Standardized checklists for release verification and QA procedures.

Docs domain verification checklist

Release checklist for documentation domain verification.

✅ Verify docs.cyiro.com domain resolves correctly
✅ Check DNS records for proper configuration
✅ Test domain redirect from www to non-www
✅ Verify SSL certificate is valid and up-to-date
✅ Test domain accessibility from multiple regions
✅ Check domain health in monitoring dashboards

Navigation regression QA checklist

Checklist for testing navigation functionality before release.

✅ Test all main navigation links
✅ Verify dropdown menus work correctly
✅ Check mobile navigation responsiveness
✅ Test navigation on different screen sizes
✅ Verify active state styling for current page
✅ Check breadcrumb navigation where applicable
✅ Test keyboard navigation accessibility

Mobile menu QA checklist

Comprehensive testing for mobile menu functionality.

✅ Test menu toggle button visibility and functionality
✅ Verify menu opens and closes smoothly
✅ Check menu items are accessible and tappable
✅ Test menu behavior on orientation change
✅ Verify menu accessibility with screen readers
✅ Check menu performance on low-end devices
✅ Test menu with different viewports and zooms

Pricing posture QA checklist

Checklist for verifying pricing page accuracy and presentation.

✅ Verify all pricing tiers are displayed correctly
✅ Check feature comparisons are accurate
✅ Test pricing CTA buttons functionality
✅ Verify pricing tier descriptions match specifications
✅ Check for consistent terminology across tiers
✅ Test pricing page on different devices
✅ Verify request access flow works end-to-end

Security-model visual QA checklist

Visual verification checklist for security model documentation.

✅ Check all security diagrams are visible and legible
✅ Verify guardrail visualizations are accurate
✅ Test permission model diagrams render correctly
✅ Check security flow charts are properly formatted
✅ Verify all security icons are displayed properly
✅ Test security model on different screen sizes
✅ Check for visual consistency with design system

Docs sidebar QA checklist

Checklist for testing documentation sidebar functionality.

✅ Verify sidebar navigation hierarchy
✅ Test sidebar expansion/collapse behavior
✅ Check active page highlighting
✅ Verify sidebar search functionality
✅ Test sidebar responsiveness on different devices
✅ Check sidebar accessibility with keyboard navigation
✅ Verify sidebar links point to correct pages

Failover narrative QA checklist

Checklist for verifying failover documentation accuracy.

✅ Verify failover scenarios are documented correctly
✅ Check failover policy examples are accurate
✅ Test failover diagram visibility and clarity
✅ Verify failover SLO documentation is up-to-date
✅ Check failover procedure steps are complete
✅ Test failover documentation cross-references
✅ Verify failover terminology consistency

Accessibility smoke tests checklist

Quick accessibility verification for release candidates.

✅ Test keyboard navigation on all major pages
✅ Verify screen reader compatibility
✅ Check color contrast ratios meet WCAG standards
✅ Test form field accessibility and labels
✅ Verify image alt text presence and accuracy
✅ Check heading hierarchy is logical
✅ Test focus indicators are visible and clear

Staging route health checks checklist

Checklist for verifying route health in staging environment.

✅ Test all API endpoints respond correctly
✅ Verify route latency meets SLO targets
✅ Check error rates are within acceptable limits
✅ Test failover routes are functional
✅ Verify route authentication and authorization
✅ Check route monitoring and logging
✅ Test route performance under load

Final production signoff checklist

Comprehensive checklist for final production release approval.

✅ Verify all QA checklists are completed
✅ Check all critical tests are passing
✅ Verify deployment pipeline is green
✅ Confirm monitoring and alerting are operational
✅ Check rollback procedures are documented
✅ Verify release notes are accurate and complete
✅ Confirm all stakeholders have approved the release

Visual QA checklists

Device-specific visual verification procedures for different screen sizes.

Laptop 1366x768 checklist

Visual QA procedures for standard laptop resolution.

✅ Verify responsive layout adapts correctly
✅ Check navigation remains accessible
✅ Test content readability and spacing
✅ Verify CTA buttons are properly sized
✅ Check images and media scale appropriately
✅ Test interactive elements for proper touch targets
✅ Verify no horizontal scrolling required

Laptop 1440x900 checklist

Visual QA procedures for high-resolution laptop displays.

✅ Verify layout utilizes available space effectively
✅ Check typography scales appropriately
✅ Test grid systems and alignments
✅ Verify media queries trigger correctly
✅ Check for proper whitespace balance
✅ Test hover and focus states
✅ Verify color contrast meets accessibility standards

Desktop 1920x1080 checklist

Visual QA procedures for full HD desktop resolution.

✅ Verify maximum width containers work properly
✅ Check for proper content alignment
✅ Test large screen optimizations
✅ Verify navigation positioning
✅ Check for appropriate line lengths
✅ Test background and image scaling
✅ Verify no layout breaks or overlaps

Mobile 390x844 checklist

Visual QA procedures for mobile devices.

✅ Verify mobile-first layout works correctly
✅ Check touch targets meet minimum size requirements
✅ Test mobile navigation patterns
✅ Verify content stacking order
✅ Check for proper viewport scaling
✅ Test mobile-specific interactions
✅ Verify no horizontal overflow

Tablet 820x1180 checklist

Visual QA procedures for tablet devices in portrait orientation.

✅ Verify adaptive layout works correctly
✅ Check for proper touch target sizing
✅ Test tablet-specific navigation
✅ Verify content readability
✅ Check media queries for tablet breakpoints
✅ Test orientation change handling
✅ Verify no layout issues in portrait mode

Self-hosted docs for Guardrails for AI.