io.quarkiverse.operatorsdk.runtime.CRDConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of quarkus-operator-sdk Show documentation
The newest version!
package io.quarkiverse.operatorsdk.runtime;

import java.util.List;
import java.util.Optional;

import io.fabric8.kubernetes.client.CustomResource;
import io.quarkus.runtime.annotations.ConfigGroup;
import io.smallrye.config.WithDefault;

@ConfigGroup
public interface CRDConfiguration {

    String DEFAULT_OUTPUT_DIRECTORY = "kubernetes";
    String DEFAULT_VALIDATE = "true";
    String DEFAULT_VERSIONS = "v1";

    /**
     * Whether the operator should check that the CRD is properly deployed and that the associated
     * {@link CustomResource} implementation matches its information before registering the associated
     * controller.
     */
    @WithDefault(DEFAULT_VALIDATE)
    Boolean validate();

    /**
     * Whether the extension should automatically generate the CRD based on {@link CustomResource}
     * implementations.
     */
    Optional generate();

    /**
     * Whether the extension should automatically apply updated CRDs when they change.
     * When running on DEV mode, the CRD changes will always be applied automatically.
     */
    Optional apply();

    /**
     * Comma-separated list of which CRD versions should be generated.
     */
    @WithDefault(DEFAULT_VERSIONS)
    List versions();

    /**
     * The directory where the CRDs will be generated, defaults to the {@code kubernetes}
     * directory of the project's output directory.
     */
    Optional outputDirectory();

    /**
     * Whether the extension should generate all CRDs even if some are not tied to a Reconciler.
     */
    @WithDefault("false")
    Boolean generateAll();

    /**
     * Whether the CRDs should be generated in parallel. Please note that this feature is experimental
     * and it may lead to unexpected results.
     */
    @WithDefault("false")
    Boolean generateInParallel();

    /**
     * A comma-separated list of fully-qualified class names implementing custom resources to exclude from the CRD generation
     * process.
     */
    Optional> excludeResources();

    /**
     * A comma-separated list of paths where external CRDs that need to be referenced for non-generated custom resources.
     * Typical use cases where this might be needed include when custom resource implementations are located in a different
     * module than the controller implementation or when the CRDs are not generated at all (e.g. in integration cases where your
     * operator needs to deal with 3rd party custom resources).
     *
     * 
     * Paths can be either absolute or relative, in which case they will be resolved from the current module root directory.
     * 
     *
     * @since 6.8.4
     */
    Optional> externalCRDLocations();
}