Skip to content

Commit fb9dc1a

Browse files
authored
docs: sync timeout docs improvement (operator-framework#1586)
1 parent cf89edf commit fb9dc1a

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

docs/documentation/patterns-best-practices.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ advised to put such state into a separate resource meant for this purpose such a
105105
Kubernetes Secret or ConfigMap or even a dedicated Custom Resource, which structure can be more
106106
easily validated.
107107

108-
## Stopping (or not) Operator in case of Informer Errors
108+
## Stopping (or not) Operator in case of Informer Errors and Cache Sync Timeouts
109109

110110
It can
111111
be [configured](https://github.com/java-operator-sdk/java-operator-sdk/blob/2cb616c4c4fd0094ee6e3a0ef2a0ea82173372bf/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java#L168-L168)
@@ -120,4 +120,6 @@ that is when a resource cannot be deserialized. The typical use case for changin
120120
is watched by a controller. In is better to start up the operator, so it can handle other namespaces while there
121121
might be a permission issue for some resources in another namespace.
122122

123-
123+
The `stopOnInformerErrorDuringStartup` has implication on [cache sync timeout](https://github.com/java-operator-sdk/java-operator-sdk/blob/114c4312c32b34688811df8dd7cea275878c9e73/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java#L177-L179)
124+
behavior. If true operator will stop on cache sync timeout. if `false`, after the timeout the controller will start
125+
reconcile resources even if one or more event source caches did not sync yet.

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ default boolean stopOnInformerErrorDuringStartup() {
170170
}
171171

172172
/**
173-
* Timeout for cache sync in milliseconds. In other words source start timeout. Note that is
173+
* Timeout for cache sync. In other words source start timeout. Note that is
174174
* "stopOnInformerErrorDuringStartup" is true the operator will stop on timeout. Default is 2
175175
* minutes.
176176
*/

0 commit comments

Comments
 (0)