Skip to content

Document migration from the current configuration model to v2 #1758

@MrAlias

Description

@MrAlias

OBI v1.0 requires the v2 configuration model, and the current configuration surface is not acceptable for v1.

That means we need explicit migration guidance for users moving from the current configuration model to v2.

Goal

Provide migration documentation that makes it practical for existing users to move to v2 without reverse-engineering config changes from code or examples.

Scope

The migration guidance should include:

  • renamed, removed, or restructured configuration fields
  • changed defaults with user-visible impact
  • behavior changes that require attention during upgrade
  • examples of equivalent old and new configurations
  • guidance for validating migrated configurations

Tasks

  • Identify the user-visible configuration differences between the current model and v2
  • Document renamed, removed, and restructured fields
  • Document changed defaults and other behavior changes that affect existing users
  • Provide concrete old-to-new configuration examples
  • Document how users should validate a migrated configuration
  • Publish migration guidance in the appropriate user-facing location(s)
  • Link the migration guide from the v1.0 release epic and release notes

Acceptance Criteria

  • A user can migrate from the current configuration model to v2 using published documentation
  • All known breaking or user-visible config changes are documented
  • The migration guide includes concrete examples
  • Maintainers agree the migration documentation is sufficient for v1.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions