com.github.containersolutions.operator.api

Interface ResourceController<R extends io.fabric8.kubernetes.client.CustomResource>

public interface ResourceController<R extends io.fabric8.kubernetes.client.CustomResource>

Method Summary

Modifier and Type	Method and Description
Optional<R>	createOrUpdateResource(R resource) The implementation of this operation is required to be idempotent.
boolean	deleteResource(R resource) The implementation should delete the associated component(s).

Method Detail

deleteResource

boolean deleteResource(R resource)

The implementation should delete the associated component(s). Note that this is method is called when an object is marked for deletion. After its executed the default finalizer is automatically removed by the framework; unless the return value is false - note that this is almost never the case. Its important to have the implementation also idempotent, in the current implementation to cover all edge cases actually will be executed mostly twice.

Parameters:

resource -

Returns:

true - so the finalizer is automatically removed after the call. false if you don't want to remove the finalizer. Note that this is ALMOST NEVER the case.

createOrUpdateResource

Optional<R> createOrUpdateResource(R resource)

The implementation of this operation is required to be idempotent.

Returns:

The resource is updated in api server if the return value is present within Optional. This the common use cases. However in cases, for example the operator is restarted, and we don't want to have an update call to k8s api to be made unnecessarily, by returning an empty Optional this update can be skipped. However we will always call an update if there is no finalizer on object and its not marked for deletion.