-
Notifications
You must be signed in to change notification settings - Fork 186
/
KubernetesDependentResource.java
311 lines (273 loc) · 12.8 KB
/
KubernetesDependentResource.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.client.dsl.Resource;
import io.javaoperatorsdk.operator.OperatorException;
import io.javaoperatorsdk.operator.ReconcilerUtils;
import io.javaoperatorsdk.operator.api.config.dependent.Configured;
import io.javaoperatorsdk.operator.api.config.informer.InformerConfiguration;
import io.javaoperatorsdk.operator.api.reconciler.Constants;
import io.javaoperatorsdk.operator.api.reconciler.Context;
import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
import io.javaoperatorsdk.operator.api.reconciler.dependent.GarbageCollected;
import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.DependentResourceConfigurator;
import io.javaoperatorsdk.operator.processing.dependent.AbstractEventSourceHolderDependentResource;
import io.javaoperatorsdk.operator.processing.dependent.Matcher.Result;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.updatermatcher.GenericResourceUpdaterMatcher;
import io.javaoperatorsdk.operator.processing.event.ResourceID;
import io.javaoperatorsdk.operator.processing.event.source.SecondaryToPrimaryMapper;
import io.javaoperatorsdk.operator.processing.event.source.informer.InformerEventSource;
import io.javaoperatorsdk.operator.processing.event.source.informer.Mappers;
@Ignore
@Configured(by = KubernetesDependent.class, with = KubernetesDependentResourceConfig.class,
converter = KubernetesDependentConverter.class)
public abstract class KubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
extends AbstractEventSourceHolderDependentResource<R, P, InformerEventSource<R, P>>
implements DependentResourceConfigurator<KubernetesDependentResourceConfig<R>> {
private static final Logger log = LoggerFactory.getLogger(KubernetesDependentResource.class);
private final ResourceUpdaterMatcher<R> updaterMatcher;
private final boolean garbageCollected = this instanceof GarbageCollected;
private KubernetesDependentResourceConfig<R> kubernetesDependentResourceConfig;
private final boolean usingCustomResourceUpdateMatcher;
@SuppressWarnings("unchecked")
public KubernetesDependentResource(Class<R> resourceType) {
super(resourceType);
usingCustomResourceUpdateMatcher = this instanceof ResourceUpdaterMatcher;
updaterMatcher = usingCustomResourceUpdateMatcher
? (ResourceUpdaterMatcher<R>) this
: GenericResourceUpdaterMatcher.updaterMatcherFor(resourceType);
}
@SuppressWarnings("unchecked")
@Override
public void configureWith(KubernetesDependentResourceConfig<R> config) {
this.kubernetesDependentResourceConfig = config;
var discriminator = kubernetesDependentResourceConfig.getResourceDiscriminator();
if (discriminator != null) {
setResourceDiscriminator(discriminator);
}
}
private void configureWith(String labelSelector, Set<String> namespaces,
boolean inheritNamespacesOnChange, EventSourceContext<P> context) {
if (namespaces.equals(Constants.SAME_AS_CONTROLLER_NAMESPACES_SET)) {
namespaces = context.getControllerConfiguration().getNamespaces();
}
var ic = informerConfigurationBuilder()
.withLabelSelector(labelSelector)
.withSecondaryToPrimaryMapper(getSecondaryToPrimaryMapper())
.withNamespaces(namespaces, inheritNamespacesOnChange)
.build();
configureWith(new InformerEventSource<>(ic, context));
}
// just to seamlessly handle GenericKubernetesDependentResource
protected InformerConfiguration.InformerConfigurationBuilder<R> informerConfigurationBuilder() {
return InformerConfiguration.from(resourceType());
}
@SuppressWarnings("unchecked")
private SecondaryToPrimaryMapper<R> getSecondaryToPrimaryMapper() {
if (this instanceof SecondaryToPrimaryMapper) {
return (SecondaryToPrimaryMapper<R>) this;
} else if (garbageCollected) {
return Mappers.fromOwnerReferences(false);
} else if (useNonOwnerRefBasedSecondaryToPrimaryMapping()) {
return Mappers.fromDefaultAnnotations();
} else {
throw new OperatorException("Provide a SecondaryToPrimaryMapper to associate " +
"this resource with the primary resource. DependentResource: " + getClass().getName());
}
}
/**
* Use to share informers between event more resources.
*
* @param informerEventSource informer to use
*/
public void configureWith(InformerEventSource<R, P> informerEventSource) {
setEventSource(informerEventSource);
}
@SuppressWarnings("unused")
public R create(R desired, P primary, Context<P> context) {
if (useSSA(context)) {
// setting resource version for SSA so only created if it doesn't exist already
var createIfNotExisting = kubernetesDependentResourceConfig == null
? KubernetesDependentResourceConfig.DEFAULT_CREATE_RESOURCE_ONLY_IF_NOT_EXISTING_WITH_SSA
: kubernetesDependentResourceConfig.createResourceOnlyIfNotExistingWithSSA();
if (createIfNotExisting) {
desired.getMetadata().setResourceVersion("1");
}
}
addMetadata(false, null, desired, primary, context);
final var resource = prepare(context, desired, primary, "Creating");
return useSSA(context)
? resource
.fieldManager(context.getControllerConfiguration().fieldManager())
.forceConflicts()
.serverSideApply()
: resource.create();
}
public R update(R actual, R desired, P primary, Context<P> context) {
if (log.isDebugEnabled()) {
log.debug("Updating actual resource: {} version: {}", ResourceID.fromResource(actual),
actual.getMetadata().getResourceVersion());
}
R updatedResource;
addMetadata(false, actual, desired, primary, context);
if (useSSA(context)) {
updatedResource = prepare(context, desired, primary, "Updating")
.fieldManager(context.getControllerConfiguration().fieldManager())
.forceConflicts().serverSideApply();
} else {
var updatedActual = updaterMatcher.updateResource(actual, desired, context);
updatedResource = prepare(context, updatedActual, primary, "Updating").update();
}
log.debug("Resource version after update: {}",
updatedResource.getMetadata().getResourceVersion());
return updatedResource;
}
@Override
public Result<R> match(R actualResource, P primary, Context<P> context) {
final var desired = desired(primary, context);
return match(actualResource, desired, primary, updaterMatcher, context);
}
@SuppressWarnings({"unused", "unchecked"})
public Result<R> match(R actualResource, R desired, P primary, Context<P> context) {
return match(actualResource, desired, primary,
(ResourceUpdaterMatcher<R>) GenericResourceUpdaterMatcher
.updaterMatcherFor(actualResource.getClass()),
context);
}
public Result<R> match(R actualResource, R desired, P primary, ResourceUpdaterMatcher<R> matcher,
Context<P> context) {
final boolean matches;
addMetadata(true, actualResource, desired, primary, context);
if (useSSA(context)) {
matches = SSABasedGenericKubernetesResourceMatcher.getInstance()
.matches(actualResource, desired, context);
} else {
matches = matcher.matches(actualResource, desired, context);
}
return Result.computed(matches, desired);
}
protected void addMetadata(boolean forMatch, R actualResource, final R target, P primary,
Context<P> context) {
if (forMatch) { // keep the current previous annotation
String actual = actualResource.getMetadata().getAnnotations()
.get(InformerEventSource.PREVIOUS_ANNOTATION_KEY);
Map<String, String> annotations = target.getMetadata().getAnnotations();
if (actual != null) {
annotations.put(InformerEventSource.PREVIOUS_ANNOTATION_KEY, actual);
} else {
annotations.remove(InformerEventSource.PREVIOUS_ANNOTATION_KEY);
}
} else if (usePreviousAnnotation(context)) { // set a new one
eventSource().orElseThrow().addPreviousAnnotation(
Optional.ofNullable(actualResource).map(r -> r.getMetadata().getResourceVersion())
.orElse(null),
target);
}
addReferenceHandlingMetadata(target, primary);
}
protected boolean useSSA(Context<P> context) {
if (usingCustomResourceUpdateMatcher) {
return false;
}
Optional<Boolean> useSSAConfig =
configuration().flatMap(KubernetesDependentResourceConfig::useSSA);
var configService = context.getControllerConfiguration().getConfigurationService();
// don't use SSA for certain resources by default, only if explicitly overriden
if (useSSAConfig.isEmpty() && configService.defaultNonSSAResource().contains(resourceType())) {
return false;
}
return useSSAConfig.orElse(context.getControllerConfiguration().getConfigurationService()
.ssaBasedCreateUpdateMatchForDependentResources());
}
private boolean usePreviousAnnotation(Context<P> context) {
return context.getControllerConfiguration().getConfigurationService()
.previousAnnotationForDependentResourcesEventFiltering();
}
@Override
protected void handleDelete(P primary, R secondary, Context<P> context) {
if (secondary != null) {
context.getClient().resource(secondary).delete();
}
}
@SuppressWarnings("unused")
public void deleteTargetResource(P primary, R resource, String key, Context<P> context) {
context.getClient().resource(resource).delete();
}
@SuppressWarnings("unused")
protected Resource<R> prepare(Context<P> context, R desired, P primary, String actionName) {
log.debug("{} target resource with type: {}, with id: {}",
actionName,
desired.getClass(),
ResourceID.fromResource(desired));
return context.getClient().resource(desired);
}
protected void addReferenceHandlingMetadata(R desired, P primary) {
if (addOwnerReference()) {
ReconcilerUtils.checkIfCanAddOwnerReference(primary, desired);
desired.addOwnerReference(primary);
} else if (useNonOwnerRefBasedSecondaryToPrimaryMapping()) {
addSecondaryToPrimaryMapperAnnotations(desired, primary);
}
}
@Override
@SuppressWarnings("unchecked")
protected InformerEventSource<R, P> createEventSource(EventSourceContext<P> context) {
if (kubernetesDependentResourceConfig != null) {
// sets the filters for the dependent resource, which are applied by parent class
onAddFilter = kubernetesDependentResourceConfig.onAddFilter();
onUpdateFilter = kubernetesDependentResourceConfig.onUpdateFilter();
onDeleteFilter = kubernetesDependentResourceConfig.onDeleteFilter();
genericFilter = kubernetesDependentResourceConfig.genericFilter();
var discriminator = kubernetesDependentResourceConfig.getResourceDiscriminator();
if (discriminator != null) {
setResourceDiscriminator(discriminator);
}
configureWith(kubernetesDependentResourceConfig.labelSelector(),
kubernetesDependentResourceConfig.namespaces(),
!kubernetesDependentResourceConfig.wereNamespacesConfigured(), context);
} else {
configureWith(null, context.getControllerConfiguration().getNamespaces(),
true, context);
log.warn(
"Using default configuration for {} KubernetesDependentResource, call configureWith to provide configuration",
resourceType().getSimpleName());
}
return eventSource().orElseThrow();
}
private boolean useNonOwnerRefBasedSecondaryToPrimaryMapping() {
return !garbageCollected && isCreatable();
}
protected void addSecondaryToPrimaryMapperAnnotations(R desired, P primary) {
addSecondaryToPrimaryMapperAnnotations(desired, primary, Mappers.DEFAULT_ANNOTATION_FOR_NAME,
Mappers.DEFAULT_ANNOTATION_FOR_NAMESPACE);
}
protected void addSecondaryToPrimaryMapperAnnotations(R desired, P primary, String nameKey,
String namespaceKey) {
var annotations = desired.getMetadata().getAnnotations();
annotations.put(nameKey, primary.getMetadata().getName());
var primaryNamespaces = primary.getMetadata().getNamespace();
if (primaryNamespaces != null) {
annotations.put(namespaceKey, primary.getMetadata().getNamespace());
}
}
protected boolean addOwnerReference() {
return garbageCollected;
}
@Override
protected R desired(P primary, Context<P> context) {
return super.desired(primary, context);
}
@Override
public Optional<KubernetesDependentResourceConfig<R>> configuration() {
return Optional.ofNullable(kubernetesDependentResourceConfig);
}
@Override
public boolean isDeletable() {
return super.isDeletable() && !garbageCollected;
}
}