Skip to content

Migration Procedures

This document provides detailed procedures for migrating between different storage strategies and configurations.

Overview

The Open Resource Broker supports migration between different storage backends and configuration formats. This guide covers:

  • Storage strategy migration
  • Configuration format migration
  • Data backup and recovery
  • Rollback procedures

Storage Strategy Migration

Supported Migrations

The plugin supports migration between:

  • JSON file storage <-> SQLite database
  • Single file <-> Multi-file storage
  • Local storage <-> Network storage

Migration Command

Use the built-in migration command:

# Migrate from JSON to SQLite
orb storage migrate --source json --target sqlite

# Migrate with backup
orb storage migrate --source json --target sqlite --backup

Pre-Migration Checklist

Before starting migration:

  1. Backup existing data 

    # Create backup
cp -r data/ data-backup-$(date +%Y%m%d)

  2. Stop active operations

  3. Ensure no active machine requests

  4. Stop any scheduled operations

  5. Verify source data integrity 

    orb storage test

Migration Steps

  1. Prepare target storage 

    # Initialize target storage
orb storage init --type sqlite

  2. Run migration 

    # Execute migration
orb storage migrate --source json --target sqlite --verify

  3. Verify migration 

    # Test target storage
orb storage test --type sqlite

# Compare data counts
orb requests list --count

  4. Update configuration 

    # Update config to use new storage
orb config update --storage-type sqlite

Post-Migration Verification

After migration:

  1. Test basic operations 

    orb templates list
orb requests list

  2. Verify data integrity 

    orb storage validate

  3. Test provider operations 

    orb providers health

Configuration Migration

Legacy Configuration Support

The plugin maintains backward compatibility with legacy configuration formats while supporting new formats.

Migration Tools

Use configuration migration tools:

# Convert legacy config
orb config migrate --from legacy --to current

# Validate migrated config
orb config validate

Rollback Procedures

If migration fails or issues arise:

  1. Stop the application
  2. Restore from backup 
    rm -rf data/
cp -r data-backup-YYYYMMDD/ data/
  3. Revert configuration changes
  4. Restart with original settings

Troubleshooting

Common migration issues:

  • Data corruption: Use backup and retry
  • Permission errors: Check file permissions
  • Storage conflicts: Ensure target storage is empty
  • Configuration errors: Validate configuration syntax

Best Practices

  • Always create backups before migration
  • Test migration in non-production environment first
  • Monitor system during migration
  • Have rollback plan ready
  • Document migration steps and results