Epic Goal

• Update argocd-image-updater community docs (https://github.com/argoproj-labs/argocd-image-updater) based on the new image updater crd and controller, to provide overview of the new feature, guidance and instructions for users.

Why is this important?

• to clearly document the structure of the new crd, and the correct way to configure an application based on the crd.
• to provide guidance and best practices to users as to how to design image updater CR and applicatioins over all to benefit from the new feature.

Scenarios

• all application annotations used to configure image updater should be replaced with the corresponding cr, while trying to preserve the original intent.
• overview of the new cr and controller reconciliation
• sample CR resources for typical use cases
• current limitations and known issues

Other Considerations

• <Call out anything explicitly as Out of Scope?>
• <Call out internal and external dependencies?>
• <Are there any known previous works?>
• <Any unanswered questions?>

Definition of Ready

• The epic has been broken down into stories.
• Stories have been scoped.
• The epic has been stack ranked.

Definition of Done

• Code Complete:
  • All code has been written, reviewed, and approved.
• Tested:
  • Unit tests have been written and passed.
  • Integration tests have been completed.
  • System tests have been conducted, and all critical bugs have been fixed.
  • Tested on OpenShift either upstream or downstream on a local build.
• Documentation:
  • User documentation or release notes have been written.
• Build:
  • Code has been successfully built and integrated into the main repository / project.
• Review:
  • Code has been peer-reviewed and meets coding standards.
  • All acceptance criteria defined in the user story have been met.
  • Tested by reviewer on OpenShift.
• Deployment:
  • The feature has been deployed on OpenShift cluster for testing.
• Acceptance:
  • Product Manager or stakeholder has reviewed and accepted the work.