io.streamthoughts.jikkou.kafka.transform.KafkaTopicMinReplicasTransformation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jikkou-extension-kafka Show documentation
There is a newer version: 0.31.0
Show newest version
/*
 * Copyright 2023 StreamThoughts.
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.streamthoughts.jikkou.kafka.transform;

import static io.streamthoughts.jikkou.JikkouMetadataAnnotations.JIKKOU_IO_TRANSFORM_PREFIX;
import static io.streamthoughts.jikkou.kafka.internals.KafkaTopics.NO_REPLICATION_FACTOR;

import io.streamthoughts.jikkou.api.annotations.AcceptsResource;
import io.streamthoughts.jikkou.api.annotations.ExtensionEnabled;
import io.streamthoughts.jikkou.api.annotations.Priority;
import io.streamthoughts.jikkou.api.config.ConfigProperty;
import io.streamthoughts.jikkou.api.config.Configuration;
import io.streamthoughts.jikkou.api.error.ConfigException;
import io.streamthoughts.jikkou.api.model.HasItems;
import io.streamthoughts.jikkou.api.model.HasMetadata;
import io.streamthoughts.jikkou.api.model.HasPriority;
import io.streamthoughts.jikkou.api.transform.ResourceTransformation;
import io.streamthoughts.jikkou.kafka.models.V1KafkaTopic;
import io.streamthoughts.jikkou.kafka.models.V1KafkaTopicSpec;
import java.util.Optional;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * This transformation can be used to enforce a minimum number of replicas for a kafka topic.
 */
@Priority(HasPriority.HIGHEST_PRECEDENCE)
@AcceptsResource(type = V1KafkaTopic.class)
@ExtensionEnabled(value = false)
public class KafkaTopicMinReplicasTransformation implements ResourceTransformation {

    public static final String JIKKOU_IO_KAFKA_MIN_REPLICAS = JIKKOU_IO_TRANSFORM_PREFIX + "/kafka-min-replicas";

    public static final ConfigProperty MIN_REPLICATION_FACTOR_CONFIG = ConfigProperty
            .ofInt("minReplicationFactor");

    private short minReplicationFactor;

    /**
     * {@inheritDoc}
     **/
    @Override
    public void configure(@NotNull Configuration config) throws ConfigException {
        minReplicationFactor = MIN_REPLICATION_FACTOR_CONFIG.getOptional(config)
                .orElseThrow(() -> new ConfigException(
                        String.format("The '%s' configuration property is required for transformation class: %s",
                                MIN_REPLICATION_FACTOR_CONFIG.key(),
                                KafkaTopicMinReplicasTransformation.class.getName()
                        )
                )).shortValue();
    }

    /**
     * {@inheritDoc}
     **/
    @Override
    public @NotNull Optional transform(@NotNull V1KafkaTopic resource,
                                                     @NotNull HasItems resources) {
        V1KafkaTopicSpec spec = resource.getSpec();
        Short replicas = spec.getReplicas();
        if (isLessThanMinReplicas(replicas)) {
            V1KafkaTopicSpec newSpec = spec.withReplicas(minReplicationFactor);
            resource = HasMetadata.addMetadataAnnotation(resource,
                    JIKKOU_IO_KAFKA_MIN_REPLICAS,
                    minReplicationFactor
            );
            return Optional.of(resource.withSpec(newSpec));
        }
        return Optional.of(resource);
    }

    private boolean isLessThanMinReplicas(@Nullable Short replicas) {
        return replicas != null && !replicas.equals(NO_REPLICATION_FACTOR) && replicas < minReplicationFactor;
    }
}