Skip to main content
Version: v1

Campaign Management Component

Overview​

Campaign Management is a vital functionality within the AosEdge platform, designed to streamline and optimize the deployment of updates for services, layers and components (later we refer to those as update items for simplicity) across an extensive network of connected devices.

General​

Campaign Initialization​

A campaign starts after either:

  • The validation process is successfully finished
  • Fleet Owner decides to start the campaign when the validation set is not defined

Update Types​

All SOTA (Software Over The Air) and FOTA (Firmware Over The Air) updates are deployed using the campaign management mechanism.

Campaign Base flow​

Campaign Types and Flows​

Unit-Unit-Sets for Campaign​

For all campaign types, unit sets are used with the following configurations:

  1. Canary Deployment

    • 2 unit-sets created automatically
    • Defined percentage of the fleet as a "small" set
    • Remaining units as a "big" set

  2. Blue/Green Deployment

    • 2 unit-sets created automatically
    • Based on even/odd system UID

  3. Rolling Deployment

    • Unit-Unit-Sets are created manually
    • Order of sets is defined within the campaign

Note: For new units added to the fleet, the campaign set is setup automatically, supporting the logic above. Automatically created sets can be modified manually.

Canary Release Approach​

Process:

  1. Install new version on predefined small unit-set
  2. Wait for update results (predefined period)
  3. Install new version for all units that go online
  4. If issues occur, rollback to previous version when possible

Blue/Green Deployment​

Steps:

  1. Split units into two equal sections (blue and green)
  2. Install new version on all "blue" units
  3. Monitor results for predefined period
  4. Deploy to "green" units if successful

Rolling Deployment​

Process:

  1. Split units into defined sets
  2. Deploy to first set
  3. Monitor results
  4. Continue with subsequent sets
  5. Maintain defined time breaks between deployments

Campaign Management Interface​

Campaign States​

Campaign Capabilities​

Fleet Owner is able to have next capabilities to do within Campaign Management subsystem.

Unit Sets Management​

Feature: Automatic Unit Sets Definition

  • Automatically create predefined unit sets when fleet is created
  • Configure unit distribution for different campaign types:
    • Canary Deployment Sets:
      • Small set (defined % of fleet) - Green colored
      • Big set (remaining units) - Blue colored
    • Blue/Green Sets:
      • Blue set (even system UID units)
      • Green set (odd system UID units)
  • Each unit belongs to exactly one set per campaign type

Campaign Creation and Configuration​

Feature: Campaign Setup and Management

  • Create campaigns after successful validation
  • Configure campaign parameters:
    • Select update item
    • Choose campaign type (Canary, Blue/Green, Rolling)
    • Define unit sets (for Rolling campaigns)
    • Set start date
    • Configure stop conditions (error rate thresholds)
    • Set failure behavior (rollback or delete)
  • View campaign forecast information:
    • Number of units to be updated
    • Predicted update duration
    • Resource impact estimates
  • Modify automatically created unit sets if needed
  • Delete campaigns (only before start)

Campaign Templates​

Feature: Template Management

  • Save campaign configurations as templates
  • Create campaigns from existing templates
  • Configure template parameters:
    • Campaign type
    • Unit-Sets configuration
    • Start rules
    • Stop conditions
    • Set as default template
  • UI support for template management

Campaign Control​

Feature: Runtime Campaign Management

  • Pause running campaigns
  • Resume paused campaigns
  • Monitor campaign progress

Campaign Monitoring​

Feature: Real-time Campaign Statistics

  • View campaign details:
    • Update item information
    • Campaign type and configuration
    • Unit-Set details
    • Success rate statistics
    • Failure rate statistics
    • Pending updates count
    • Campaign status (waiting/started/paused/finished)
    • Estimated completion time

Fleet Modification Support​

Feature: Dynamic Campaign Adjustment

  • Automatic campaign recalculation on fleet changes:
    • Unit removal
    • Unit addition
    • Bulk unit operations
  • Real-time update of:
    • Campaign forecasts
    • Progress statistics
    • Unit-Set distributions

User Interface​

Feature: Campaign Management UI

  • Comprehensive interface for:
    • Campaign creation and configuration
    • Template management
    • Campaign monitoring and control
    • Unit-Set management

Campaign Flow​

The diagram shows the complete update deployment workflow:

  1. Update Preparation and Validation

    • Fleet Owner uploads new update item
    • Validation System automatically creates validation batch
    • Fleet Owner approves validation batch
    • System executes validation and reports results

  2. Campaign Creation and Approval

    • Upon successful validation, Fleet Owner creates campaign
    • System generates deployment sets
    • Campaign configuration includes type, unit sets, timing, and thresholds
    • Fleet Owner reviews and approves campaign

  3. Campaign Execution

    • Fleet Owner initiates campaign start
    • System deploys updates set by set
    • Continuous monitoring of deployment metrics
    • Automatic threshold breach detection

  4. Monitoring and Control

    • Real-time status reporting
    • Automatic campaign pause on threshold breach
    • Fleet Owner decision points for continue/rollback
    • Statistics gathering throughout deployment

  5. Campaign Completion

    • Successful completion with final statistics
    • Or failure handling with rollback execution
    • Final status report to Fleet Owner

This workflow ensures controlled, monitored deployment of updates with proper validation and safety measures.