Epic Goal

The controller-runtime's object cache is one of the major contributor to high memory consumption in gitops-operator. Controller-runtime library supports few options to optimise the cache. The goal of this epic is to explore those in gitops-operator.

Why is this important?

Some customers are concerned about the huge memory footprint of the operator, especially on bigger clusters.

Scenarios

1. ...

Other Considerations

This epic focuses on cache optimisation only. Other potential optimisations in the reconciliation or other parts of the code, to reduce memory consumption are out of scope.

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.