operator-framework / operator-framework/java-operator-sdk
Allow just registerPredicate for the polling to be overridden/configured for PerResourcePollingDependentResources
还没有人认领这个 Issue。
- 主要语言
- Java
- 星标
- 944
- 派生
- 242
- 平均合并
- 1 天 4 小时
- 30 天内合并 PR
- 43
描述
Is your feature request related to a problem? Please describe.
When using the PerResourcePollingDependentResource and you do not want polling (yet) for certain resources, it is hard to discover and cumbersome that you need to override the createEventSource method (which happens to be the only implemented method of that class) just to add the single line withRegisterPredicate(mypredicate::test) to the PerResourcePollingConfigurationBuilder-builder (which also happens to be the only configuration property that is not already out-of-the-box overridable when using PerResourcePollingDependentResource).
This has the additional downside that if the code for PerResourcePollingDependentResource.createEventSource is improved, we'd have to update our overridden method accordingly because we want the same behaviour, just only with the registerPredicate.
Describe the solution you'd like
A pollingRegisterPredicate method on PerResourcePollingDependentResource that could be overridden and by default returns null. Eg
@Override
protected Predicate<MyResource> pollingRegisterPredicate() {
return resource -> "someType".equals(resource.getSpec().type());
}
PerResourcePollingDependentResource could then use this method to configure the registerPredicate when setting op the polling event source.
Additionally, documenting the fact that by default polling is started for every resource (even if the depending reconciler has informer filters) and how this could be adjusted would greatly help new consumers.
Alternatively, an annotation @PollingRegisterPredicate could be added to your class that would then get picked up by PerResourcePollingDependentResource.
Describe alternatives you've considered
For our case (see below), it would also work if the polling picks up on the genericFilter/onAddFilter in the @ControllerConfiguration/@Informer annotations on the depending reconciler, so that the polling does not start if no event is processed by the reconciler.
We recognize that his may be too specific to our use case which may not apply to other people and is also more complex than exposing the existing registerPredicate a bit more which would also be more generic.
Additional context
Our use case is that we have a reconciler with a PerResourcePollingDependentResource which polls an external system. Our reconciler should only reconcile specific resources within a kind (eg based on a static type field). We achieve this by adding a genericFilter to the @ControllerConfiguration/@Informer annotation:
@ControllerConfiguration(informer = @Informer(genericFilter = PredicateClass.class) ...)
We noticed that, even for resources not being handled by the reconciler, polling was being started and the external system was being queried. This puts load on the operator and the external system for resource we know will never need something to happen in the external system.
This behaviour is not (clearly) documented and required some digging around to discover that PerResourcePollingConfigurationBuilder has the method withRegisterPredicate which to control this behaviour, but this method is not used by the PerResourcePollingDependentResource.
To use this register predicate, it's therefor required to override the createEventSource method of PerResourcePollingDependentResource, just to add the register predicate:
@Override
protected ExternalResourceCachingEventSource<MyInfo, MyResource> createEventSource(EventSourceContext<MyResource> context) {
return new PerResourcePollingEventSource<>(
resourceType(),
context,
new PerResourcePollingConfigurationBuilder<>(this, getPollingPeriod())
.withCacheKeyMapper(this)
.withName(name())
.withRegisterPredicate(resource -> "someType".equals(resource.getSpec().type())) // <--- only difference with original method
.build());
}
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先阅读 PerResourcePollingDependentResource.createEventSource 和 PerResourcePollingConfigurationBuilder.withRegisterPredicate,以了解现有的轮询设置。添加 issue 中描述的可重写 pollingRegisterPredicate 行为,保留当前的默认轮询行为,并记录 register predicate 如何与 informer 过滤器和资源轮询交互。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java
- 领域
- backend-api-design
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 48/100