[RFC] Tracking: API Changes and Deprecations

[Syspretor]

Overview

This is a long-term tracking issue for all API changes, deprecations, and breaking changes in the RBG project. It serves as a central reference for operators and contributors to understand the evolution of the RBG API surface across versions.

Scope

This issue tracks:

• Deprecations: API fields, enum values, or behaviors being phased out
• Breaking changes: Incompatible modifications to existing API contracts
• New API additions: Significant new fields, types, or CRDs
• Migration guides: Instructions for users to adapt to API changes

API Changes

v1alpha2

Change	Type	Status	Issue
Remove RecreateRBGOnPodRestart restart policy	Deprecation	In Progress	#339
Change default restartPolicy to RecreateRoleInstanceOnPodRestart for all patterns	Breaking Change	In Progress	#343
Remove RoleInstanceRestartPolicyType, unify to RestartPolicyType	Type Cleanup	In Progress	#343

v1alpha1

Change	Type	Status	Issue
Remove RecreateRBGOnPodRestart restart policy	Deprecation	In Progress	#339

Sub-issues

• RFC: Deprecate and remove RecreateRBGOnPodRestart restart policy #339 — Deprecate and remove RecreateRBGOnPodRestart restart policy
• [RFC] Change default restartPolicy to RecreateRoleInstanceOnPodRestart for all patterns #343 — Change default restartPolicy to RecreateRoleInstanceOnPodRestart for all patterns; remove redundant RoleInstanceRestartPolicyType

Guidelines for Contributors

When proposing API changes:

1. Create a dedicated RFC issue describing the motivation, proposal, and migration path
2. Link the RFC issue here as a sub-issue
3. Update the table above with the change summary and status
4. Ensure CRD manifests are regenerated (make manifests) and validation is updated