diff --git a/docs/modules/ROOT/pages/includes/quarkus-operator-sdk.adoc b/docs/modules/ROOT/pages/includes/quarkus-operator-sdk.adoc index 8ef2bee0e..35ef39248 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-operator-sdk.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-operator-sdk.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.crd.validate]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.crd.validate[quarkus.operator-sdk.crd.validate]` + [.description] -- Whether the operator should check that the CRD is properly deployed and that the associated `CustomResource` implementation matches its information before registering the associated controller. @@ -28,6 +29,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.crd.generate]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.crd.generate[quarkus.operator-sdk.crd.generate]` + [.description] -- Whether the extension should automatically generate the CRD based on `CustomResource` implementations. @@ -44,6 +46,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.crd.apply]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.crd.apply[quarkus.operator-sdk.crd.apply]` + [.description] -- Whether the extension should automatically apply updated CRDs when they change. When running on DEV mode, the CRD changes will always be applied automatically. @@ -60,6 +63,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.crd.versions]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.crd.versions[quarkus.operator-sdk.crd.versions]` + [.description] -- Comma-separated list of which CRD versions should be generated. @@ -76,6 +80,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.crd.output-directory]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.crd.output-directory[quarkus.operator-sdk.crd.output-directory]` + [.description] -- The directory where the CRDs will be generated, defaults to the `kubernetes` directory of the project's output directory. @@ -92,6 +97,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.crd.generate-all]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.crd.generate-all[quarkus.operator-sdk.crd.generate-all]` + [.description] -- Whether the extension should generate all CRDs even if some are not tied to a Reconciler. @@ -108,6 +114,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.crd.generate-in-parallel]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.crd.generate-in-parallel[quarkus.operator-sdk.crd.generate-in-parallel]` + [.description] -- Whether the CRDs should be generated in parallel. Please note that this feature is experimental and it may lead to unexpected results. @@ -124,6 +131,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.generation-aware]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.generation-aware[quarkus.operator-sdk.generation-aware]` + [.description] -- Whether controllers should only process events if the associated resource generation has increased since last reconciliation, otherwise will process all events. Sets the default value for all controllers. @@ -140,6 +148,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.disable-rbac-generation]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.disable-rbac-generation[quarkus.operator-sdk.disable-rbac-generation]` + [.description] -- Whether Role-Based Access Control (RBAC) resources generated by the Kubernetes extension should be augmented by this extension. @@ -156,6 +165,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.start-operator]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.start-operator[quarkus.operator-sdk.start-operator]` + [.description] -- Whether the operator should be automatically started or not. Mostly useful for testing scenarios. @@ -172,6 +182,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.close-client-on-stop]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.close-client-on-stop[quarkus.operator-sdk.close-client-on-stop]` + [.description] -- Whether the injected Kubernetes client should be stopped when the operator is stopped. @@ -188,6 +199,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.stop-on-informer-error-during-startup]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.stop-on-informer-error-during-startup[quarkus.operator-sdk.stop-on-informer-error-during-startup]` + [.description] -- Whether the operator should stop if an informer error (such as one caused by missing / improper RBACs) occurs during startup. @@ -204,6 +216,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.fail-on-version-check]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.fail-on-version-check[quarkus.operator-sdk.fail-on-version-check]` + [.description] -- Whether to fail or emit a debug-level (warning-level when misalignment is at the minor or above version level) log when the extension detects that there are misaligned versions. @@ -226,6 +239,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.activate-leader-election-for-profiles]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.activate-leader-election-for-profiles[quarkus.operator-sdk.activate-leader-election-for-profiles]` + [.description] -- The list of profile names for which leader election should be activated. This is mostly useful for testing scenarios where leader election behavior might lead to issues. @@ -242,6 +256,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.enable-ssa]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.enable-ssa[quarkus.operator-sdk.enable-ssa]` + [.description] -- The optional Server-Side Apply (SSA) related configuration. @@ -258,6 +273,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.generate-with-watched-namespaces]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.generate-with-watched-namespaces[quarkus.operator-sdk.generate-with-watched-namespaces]` + [.description] -- An optional list of comma-separated watched namespace names that will be used to generate manifests at build time if controllers do *NOT* specify a value individually. See `BuildTimeControllerConfiguration++#++generateWithWatchedNamespaces` for more information. @@ -274,6 +290,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.concurrent-reconciliation-threads]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.concurrent-reconciliation-threads[quarkus.operator-sdk.concurrent-reconciliation-threads]` + [.description] -- The max number of concurrent dispatches of reconciliation requests to controllers. @@ -290,6 +307,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.termination-timeout-seconds]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.termination-timeout-seconds[quarkus.operator-sdk.termination-timeout-seconds]` + [.description] -- Amount of seconds the SDK waits for reconciliation threads to terminate before shutting down. @@ -306,6 +324,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.namespaces]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.namespaces[quarkus.operator-sdk.namespaces]` + [.description] -- An optional list of comma-separated namespace names all controllers will watch if they do not specify their own list. If a controller specifies its own list either via the `io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration` annotation or via the associated `application.properties` property, that value will be used instead of the operator-level default value that this configuration option provides. @@ -324,6 +343,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.concurrent-workflow-threads]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.concurrent-workflow-threads[quarkus.operator-sdk.concurrent-workflow-threads]` + [.description] -- The max number of concurrent workflow processing requests. @@ -340,6 +360,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.cache-sync-timeout]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.cache-sync-timeout[quarkus.operator-sdk.cache-sync-timeout]` + [.description] -- How long the operator will wait for informers to finish synchronizing their caches on startup before timing out. @@ -357,6 +378,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.generation-aware]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.generation-aware[quarkus.operator-sdk.controllers."controllers".generation-aware]` + [.description] -- Whether the controller should only process events if the associated resource generation has increased since last reconciliation, otherwise will process all events. @@ -373,6 +395,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.generate-with-watched-namespaces]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.generate-with-watched-namespaces[quarkus.operator-sdk.controllers."controllers".generate-with-watched-namespaces]` + [.description] -- An optional list of comma-separated watched namespace names that will be used to generate manifests at build time. @@ -397,6 +420,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.namespaces]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.namespaces[quarkus.operator-sdk.controllers."controllers".namespaces]` + [.description] -- An optional list of comma-separated namespace names the controller should watch. If this property is left empty then the controller will watch all namespaces. The value can be set to "JOSDK_WATCH_CURRENT" to watch the current (default) namespace from kube config. Constant(s) can be found in at `io.javaoperatorsdk.operator.api.reconciler.Constants`". @@ -413,6 +437,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.finalizer]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.finalizer[quarkus.operator-sdk.controllers."controllers".finalizer]` + [.description] -- The optional name of the finalizer for the controller. If none is provided, one will be automatically generated. @@ -429,6 +454,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.retry.max-attempts]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.retry.max-attempts[quarkus.operator-sdk.controllers."controllers".retry.max-attempts]` + [.description] -- How many times an operation should be retried before giving up @@ -445,6 +471,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.retry.interval.initial]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.retry.interval.initial[quarkus.operator-sdk.controllers."controllers".retry.interval.initial]` + [.description] -- The initial interval that the controller waits for before attempting the first retry @@ -461,6 +488,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.retry.interval.multiplier]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.retry.interval.multiplier[quarkus.operator-sdk.controllers."controllers".retry.interval.multiplier]` + [.description] -- The value by which the initial interval is multiplied by for each retry @@ -477,6 +505,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.retry.interval.max]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.retry.interval.max[quarkus.operator-sdk.controllers."controllers".retry.interval.max]` + [.description] -- The maximum interval that the controller will wait for before attempting a retry, regardless of all other configuration @@ -493,6 +522,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.selector]]`link:#quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.selector[quarkus.operator-sdk.controllers."controllers".selector]` + [.description] -- An optional list of comma-separated label selectors that Custom Resources must match to trigger the controller. See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more details on selectors. diff --git a/pom.xml b/pom.xml index 1cb9ab868..bd76ab49a 100644 --- a/pom.xml +++ b/pom.xml @@ -13,7 +13,7 @@ Quarkus - Operator SDK - Parent 3.2.4.Final - 4.4.1 + 4.4.2 :git:git@github.com:quarkiverse/quarkus-operator-sdk.git