Skip to content

Operations Runbook

This guide covers operational procedures for running Armada in production environments.

  • Jira Cloud instance (Jira Software, Jira Service Management)
  • Node.js 18+ (for local development)
  • Docker (for containerized deployment)
  • Atlassian Forge CLI installed
Terminal window
# Verify Forge credentials
forge settings list
# Check app installation status
forge app list
# Verify environment configuration
forge variables list --environment production
  • Jira admin permissions for app installation
  • API token generated from Atlassian account
  • Storage quotas reviewed and allocated
  • User permissions configured appropriately

Terminal window
# Deploy to development
forge deploy --environment development
# Verify deployment
forge logs --environment development
# Install on test site
forge install --upgrade --site your-site.atlassian.net --product Jira
  1. Pre-deployment validation

    Terminal window
    npm run validate # Run typecheck, lint, and tests
    npm run build # Build all resources
  2. Deploy to production

    Terminal window
    forge deploy --environment production
  3. Post-deployment verification

    Terminal window
    # Check app status
    forge app status
    # View production logs
    forge logs --environment production
  4. Update Marketplace listing (if version changed)

    • Increment version in manifest.yml
    • Update release notes
    • Publish to marketplace

MetricDescriptionAlert Threshold
Campaign success rate% of campaigns completing successfully< 95%
Average campaign durationTime from launch to completion> 72 hours
Auto-nudge effectiveness% of nudged issues updated< 50%
API error rateFailed Jira API calls> 1%
Storage utilizationCampaign state storage usage> 80%
Terminal window
# View recent logs
forge logs --environment production --tail 100
# Filter by severity
forge logs --environment production --filter error
# Search for specific campaign
forge logs --environment production --search PROJ-123
Terminal window
# Check app health
curl https://your-site.atlassian.net/rest/forge-Health/1.0/health
# Expected response
{
"status": "UP",
"components": {
"storage": "UP",
"jiraApi": "UP",
"compassApi": "UP"
}
}

  1. Immediate actions

    Terminal window
    # View detailed errors
    forge logs --environment production --filter error --tail 500
    # Check Jira API status
    # Verify app permissions
  2. Common causes

    • Jira API rate limiting → Implement exponential backoff
    • Permission changes → Re-install app
    • Storage quota exceeded → Archive old campaigns
  3. Resolution steps

    • Clear campaign state cache
    • Restart affected workflows
    • Notify affected users
Terminal window
# Check storage utilization
# Navigate to Fleet > Settings in Armada panel
# Archive old campaigns
# 1. Export campaign data to JSON
# 2. Delete old campaign state
# 3. Keep parent issue for audit trail
  1. Re-install the app:

    Terminal window
    forge install --upgrade --site your-site.atlassian.net
  2. Verify scopes in manifest.yml match required permissions

  3. Check user has appropriate Jira admin rights


Campaign data is stored in:

  1. Jira issue properties (campaign state)
  2. Forge Storage (fleet config, templates)
Terminal window
# Export fleet configuration
# Available in Fleet > Settings > Export
# Export campaign data
# Available in Campaign Status > Export
  1. Fleet configuration loss

    • Import from previously exported JSON
    • Recreate teams and settings from documentation
  2. Campaign state corruption

    • Delete corrupted state via Armada UI
    • Re-sync by fetching current issue status
    • Lost history cannot be recovered (stateless by design)

ComponentLimitScaling Strategy
Campaign children400 per campaignUse sub-campaigns
Fleet teams50 per installationMultiple fleets
Mission templates100 per installationArchive old templates
Storage total32KB per propertyChunked storage enabled
  • Jira REST API: 100 requests/minute (adjustable)
  • Batch size: 10 issues per request
  • Retry with exponential backoff: 1s, 2s, 4s, 8s

  • Weekly: Log review and cleanup
  • Monthly: Capacity assessment
  • Quarterly: Security audit and updates
  1. Review changelog for breaking changes
  2. Test in development environment
  3. Schedule maintenance window
  4. Deploy during low-usage period
  5. Verify all features working
  6. Monitor for 24 hours post-update

RoleContactResponse Time
Technical Support[email protected]24 hours
Security Issues[email protected]4 hours
Enterprise Support[email protected]1 hour
Sales[email protected]24 hours

  1. Level 1: Check documentation and logs
  2. Level 2: Submit support ticket
  3. Level 3: Contact account manager
  4. Level 4: Emergency escalation to engineering lead