ModelMapper alternative in kubernetes-client-openapi-operator

[ayushghosh]

While using io.micronaut.kubernetes:micronaut-kubernetes-operator we have access to the java client to use the ModelMapper to add the model.

However while using, implementation("io.micronaut.kubernetes:micronaut-kubernetes-client-openapi-operator")
We don't use the k8s java client, so whats the plan or approach we should use here, so we have to add the client back for this.

I am using for a custom resource, and it complains about

could not be loaded: XXmodels.v1.V1Task is not supported
io.micronaut.context.exceptions.BeanInstantiationException: Bean definition [XX.TaskOperator] could not be loaded: XXmodels.v1.V1Task is not supported

I also can't add ModelMapper.addModelMap as the types are incompatible.

[graemerocher]

@msupic you know anything about this?

[msupic]

To use a custom resource (for example, CronTab) in micronaut-kubernetes-client-openapi-operator you would need to add the following classes:

package com.example.custom;

import io.micronaut.context.annotation.BootstrapContextCompatible;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.http.annotation.Consumes;
import io.micronaut.http.annotation.Get;
import io.micronaut.http.annotation.PathVariable;
import io.micronaut.http.annotation.QueryValue;
import io.micronaut.http.client.annotation.Client;
import io.micronaut.kubernetes.client.openapi.reactor.annotation.KubernetesClientApiReactor;
import reactor.core.publisher.Mono;

@KubernetesClientApiReactor
@BootstrapContextCompatible
@Client("kubernetes")
public interface CronTabApiReactor {

    @Get("/apis/stable.example.com/v1/crontabs")
    @Consumes({"application/json", "application/json;stream=watch"})
    Mono<V1CronTabList> listCronTabForAllNamespaces(
            @QueryValue("pretty") @Nullable String pretty,
            @QueryValue("allowWatchBookmarks") @Nullable Boolean allowWatchBookmarks,
            @QueryValue("continue") @Nullable String _continue,
            @QueryValue("fieldSelector") @Nullable String fieldSelector,
            @QueryValue("labelSelector") @Nullable String labelSelector,
            @QueryValue("limit") @Nullable Integer limit,
            @QueryValue("resourceVersion") @Nullable String resourceVersion,
            @QueryValue("resourceVersionMatch") @Nullable String resourceVersionMatch,
            @QueryValue("timeoutSeconds") @Nullable Integer timeoutSeconds,
            @QueryValue("watch") @Nullable Boolean watch
    );

    @Get("/apis/stable.example.com/v1/namespaces/{namespace}/crontabs")
    @Consumes({"application/json", "application/json;stream=watch"})
    Mono<V1CronTabList> listNamespacedCronTab(
            @PathVariable("namespace") String namespace,
            @QueryValue("pretty") @Nullable String pretty,
            @QueryValue("allowWatchBookmarks") @Nullable Boolean allowWatchBookmarks,
            @QueryValue("continue") @Nullable String _continue,
            @QueryValue("fieldSelector") @Nullable String fieldSelector,
            @QueryValue("labelSelector") @Nullable String labelSelector,
            @QueryValue("limit") @Nullable Integer limit,
            @QueryValue("resourceVersion") @Nullable String resourceVersion,
            @QueryValue("resourceVersionMatch") @Nullable String resourceVersionMatch,
            @QueryValue("timeoutSeconds") @Nullable Integer timeoutSeconds,
            @QueryValue("watch") @Nullable Boolean watch
    );
}

and

package com.example.custom;

import io.micronaut.core.annotation.Nullable;
import io.micronaut.http.annotation.Consumes;
import io.micronaut.http.annotation.Get;
import io.micronaut.http.annotation.PathVariable;
import io.micronaut.http.annotation.QueryValue;
import io.micronaut.http.client.annotation.Client;
import io.micronaut.kubernetes.client.openapi.watcher.WatchEvent;
import io.micronaut.kubernetes.client.openapi.watcher.annotation.KubernetesClientApiWatcher;
import reactor.core.publisher.Flux;

@KubernetesClientApiWatcher
@Client("kubernetes")
public interface CronTabApiWatcher {

    @Get("/apis/stable.example.com/v1/crontabs")
    @Consumes({"application/json", "application/json;stream=watch"})
    Flux<WatchEvent<V1CronTab>> listCronTabForAllNamespaces(
            @QueryValue("pretty") @Nullable String pretty,
            @QueryValue("allowWatchBookmarks") @Nullable Boolean allowWatchBookmarks,
            @QueryValue("continue") @Nullable String _continue,
            @QueryValue("fieldSelector") @Nullable String fieldSelector,
            @QueryValue("labelSelector") @Nullable String labelSelector,
            @QueryValue("limit") @Nullable Integer limit,
            @QueryValue("resourceVersion") @Nullable String resourceVersion,
            @QueryValue("resourceVersionMatch") @Nullable String resourceVersionMatch,
            @QueryValue("timeoutSeconds") @Nullable Integer timeoutSeconds,
            @QueryValue("watch") @Nullable Boolean watch
    );

    @Get("/apis/stable.example.com/v1/namespaces/{namespace}/crontabs")
    @Consumes({"application/json", "application/json;stream=watch"})
    Flux<WatchEvent<V1CronTab>> listNamespacedCronTab(
            @PathVariable("namespace") String namespace,
            @QueryValue("pretty") @Nullable String pretty,
            @QueryValue("allowWatchBookmarks") @Nullable Boolean allowWatchBookmarks,
            @QueryValue("continue") @Nullable String _continue,
            @QueryValue("fieldSelector") @Nullable String fieldSelector,
            @QueryValue("labelSelector") @Nullable String labelSelector,
            @QueryValue("limit") @Nullable Integer limit,
            @QueryValue("resourceVersion") @Nullable String resourceVersion,
            @QueryValue("resourceVersionMatch") @Nullable String resourceVersionMatch,
            @QueryValue("timeoutSeconds") @Nullable Integer timeoutSeconds,
            @QueryValue("watch") @Nullable Boolean watch
    );
}

and

package com.example.custom;

import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.kubernetes.client.openapi.common.KubernetesObject;
import io.micronaut.kubernetes.client.openapi.model.V1ObjectMeta;
import io.micronaut.serde.annotation.Serdeable;

@Serdeable
public class V1CronTab implements KubernetesObject {

    @Nullable
    @JsonInclude(JsonInclude.Include.USE_DEFAULTS)
    private String apiVersion;

    @Nullable
    @JsonInclude(JsonInclude.Include.USE_DEFAULTS)
    private String kind;

    @Nullable
    @JsonInclude(JsonInclude.Include.USE_DEFAULTS)
    private V1ObjectMeta metadata;

    @Override
    public V1ObjectMeta getMetadata() {
        return metadata;
    }

    public void setMetadata(V1ObjectMeta metadata) {
        this.metadata = metadata;
    }

    @Override
    public String getApiVersion() {
        return apiVersion;
    }

    public void setApiVersion(String apiVersion) {
        this.apiVersion = apiVersion;
    }

    @Override
    public String getKind() {
        return kind;
    }

    public void setKind(String kind) {
        this.kind = kind;
    }
}

and

package com.example.custom;

import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.kubernetes.client.openapi.common.KubernetesListObject;
import io.micronaut.kubernetes.client.openapi.model.V1ListMeta;
import io.micronaut.serde.annotation.Serdeable;

import java.util.List;

@Serdeable
public class V1CronTabList implements KubernetesListObject {

    private List<V1CronTab> items;

    @Nullable
    @JsonInclude(JsonInclude.Include.USE_DEFAULTS)
    private String apiVersion;

    @Nullable
    @JsonInclude(JsonInclude.Include.USE_DEFAULTS)
    private String kind;

    @Nullable
    @JsonInclude(JsonInclude.Include.USE_DEFAULTS)
    private V1ListMeta metadata;

    public V1CronTabList(List<V1CronTab> items) {
        this.items = items;
    }

    @Override
    public V1ListMeta getMetadata() {
        return metadata;
    }

    public void setMetadata(V1ListMeta metadata) {
        this.metadata = metadata;
    }

    @Override
    public List<V1CronTab> getItems() {
        return items;
    }

    public void setItems(List<V1CronTab> items) {
        this.items = items;
    }

    @Override
    public String getApiVersion() {
        return apiVersion;
    }

    public void setApiVersion(String apiVersion) {
        this.apiVersion = apiVersion;
    }

    @Override
    public String getKind() {
        return kind;
    }

    public void setKind(String kind) {
        this.kind = kind;
    }
}

and at the end

package com.example;

import com.example.custom.V1CronTab;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.env.Environment;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.kubernetes.client.openapi.informer.handler.Informer;
import io.micronaut.kubernetes.client.openapi.model.V1ObjectMeta;
import io.micronaut.kubernetes.client.openapi.operator.Operator;
import io.micronaut.kubernetes.client.openapi.operator.OperatorResourceLister;
import io.micronaut.kubernetes.client.openapi.operator.controller.reconciler.Request;
import io.micronaut.kubernetes.client.openapi.operator.controller.reconciler.ResourceReconciler;
import io.micronaut.kubernetes.client.openapi.operator.controller.reconciler.Result;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

@Requires(env = Environment.KUBERNETES)
@Operator(informer = @Informer(apiType = V1CronTab.class, namespace = "default"))
class CronTabReconciler implements ResourceReconciler<V1CronTab> {
    private static final Logger LOG = LoggerFactory.getLogger(CronTabReconciler.class);

    @Override
    @NonNull
    public Result reconcile(@NonNull Request request, @NonNull OperatorResourceLister<V1CronTab> lister) {
        LOG.info("Reconciling cron tab: {}", request);
        Optional<V1CronTab> cronTabOpt = lister.get(request);
        if (cronTabOpt.isPresent()) {
            V1CronTab cronTab = cronTabOpt.get();
            ....
        }
        return new Result(false);
    }
}

but I am going to investigate how to simplify this process using io.micronaut.kubernetes.client.openapi.reactor.api.CustomObjectsApiReactor and io.micronaut.kubernetes.client.openapi.watcher.api.CustomObjectsApiWatcher

[ayushghosh]

Thanks @msupic

I implemented the interfaces for Watcher and Reactor, still same Task/CronTab is not supported error.

I don't see them used in your code also in the operator, how are they hooked in.

Also using the usual io.micronaut.kubernetes:micronaut-kubernetes-operator, how can we watch all namespace, it always result in
java.lang.NullPointerException: Cannot invoke "io.kubernetes.client.informer.SharedIndexInformer.getIndexer()" because "sharedIndexInformer" is null

[msupic]

There are ApiReactorExecMethodProcessor and ApiWatcherExecMethodProcessor which registers io.micronaut.inject.ExecutableMethod instances from CronTabApiReactor and CronTabApiWatcher. It is important that CronTabApiReactor has @KubernetesClientApiReactor annotation and CronTabApiWatcher has @KubernetesClientApiWatcher annotation. If that works ok, methods from your classes will be registered here

abstract class ApiExecMethodProcessor<A extends Annotation> implements ExecutableMethodProcessor<A> {

    private final Map<String, Class<?>> beanTypes = new HashMap<>();
    private final Map<String, ExecutableMethod<?, ?>> globalExecMethods = new HashMap<>();
    private final Map<String, ExecutableMethod<?, ?>> namespaceExecMethods = new HashMap<>();

and then you can use the custom object in @Informer and @Operator

If you want to run for all namespaces, you have to set the namespace on the following way

@Informer(apiType = V1CronTab.class, namespace = Informer.ALL_NAMESPACES)