Skip to content

Commit f399641

Browse files
committed
fix!: move minor+ version misalignment logging to debug-level
Fixes #1183
1 parent 3036eff commit f399641

File tree

4 files changed

+21
-6
lines changed

4 files changed

+21
-6
lines changed

core/deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/VersionAlignmentCheckingStep.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,8 @@ private void checkVersionCompatibility(BuildTimeOperatorConfiguration buildTimeC
6161
} else {
6262
final var diff = expectedVersion.diff(foundVersion);
6363
if (diff.compareTo(VersionDiff.MINOR) >= 0) {
64-
log.warn(message
64+
log.debug(message
6565
+ " by at least a minor version and things might not work as expected.");
66-
} else {
67-
log.debug(message);
6866
}
6967
}
7068
}

core/runtime/src/main/java/io/quarkiverse/operatorsdk/runtime/BuildTimeOperatorConfiguration.java

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public interface BuildTimeOperatorConfiguration {
6161
Boolean stopOnInformerErrorDuringStartup();
6262

6363
/**
64-
* Whether to fail or emit a debug-level (warning-level when misalignment is at the minor or above version level) log when
64+
* Whether to fail or emit a debug-level (when misalignment is at the minor or above version level) log when
6565
* the extension detects that there are misaligned versions.
6666
* <p/>
6767
* The following versions are checked for alignment:
@@ -70,6 +70,15 @@ public interface BuildTimeOperatorConfiguration {
7070
* <li>Fabric8 client version used by JOSDK vs. actually used Fabric8 client version</li>
7171
* <li>Fabric8 client version used by Quarkus vs. actually used Fabric8 client version</li>
7272
* </ul>
73+
* <p>
74+
* Checking the alignment of these versions used to be more important than it is now as it happened that attempting to use
75+
* this extension with differing versions of the client between JOSDK and Quarkus caused issues. Usually, this manifested
76+
* with otherwise unexplained issues when using native compilation (e.g. improper serialization of objects) so version
77+
* alignment check was implemented to help diagnose such issues.
78+
* </p>
79+
* Prior to version 7.3.0, this version alignment check was outputting warning-level information whenever versions were
80+
* mismatched at least at the minor level, sometimes causing confusion. Since issues caused by such misalignments have been
81+
* rare now that the project is more mature, it was decided to move these logs to debug-level instead.
7382
*/
7483
@WithDefault("false")
7584
Boolean failOnVersionCheck();

docs/modules/ROOT/pages/includes/quarkus-operator-sdk.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ endif::add-copy-button-to-config-props[]
334334

335335
[.description]
336336
--
337-
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.
337+
Whether to fail or emit a debug-level (when misalignment is at the minor or above version level) log when the extension detects that there are misaligned versions.
338338

339339
The following versions are checked for alignment:
340340

@@ -343,6 +343,10 @@ The following versions are checked for alignment:
343343
- Fabric8 client version used by Quarkus vs. actually used Fabric8 client version
344344

345345

346+
347+
Checking the alignment of these versions used to be more important than it is now as it happened that attempting to use this extension with differing versions of the client between JOSDK and Quarkus caused issues. Usually, this manifested with otherwise unexplained issues when using native compilation (e.g. improper serialization of objects) so version alignment check was implemented to help diagnose such issues. Prior to version 7.3.0, this version alignment check was outputting warning-level information whenever versions were mismatched at least at the minor level, sometimes causing confusion. Since issues caused by such misalignments have been rare now that the project is more mature, it was decided to move these logs to debug-level instead.
348+
349+
346350
ifdef::add-copy-button-to-env-var[]
347351
Environment variable: env_var_with_copy_button:+++QUARKUS_OPERATOR_SDK_FAIL_ON_VERSION_CHECK+++[]
348352
endif::add-copy-button-to-env-var[]

docs/modules/ROOT/pages/includes/quarkus-operator-sdk_quarkus.operator-sdk.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ endif::add-copy-button-to-config-props[]
334334

335335
[.description]
336336
--
337-
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.
337+
Whether to fail or emit a debug-level (when misalignment is at the minor or above version level) log when the extension detects that there are misaligned versions.
338338

339339
The following versions are checked for alignment:
340340

@@ -343,6 +343,10 @@ The following versions are checked for alignment:
343343
- Fabric8 client version used by Quarkus vs. actually used Fabric8 client version
344344

345345

346+
347+
Checking the alignment of these versions used to be more important than it is now as it happened that attempting to use this extension with differing versions of the client between JOSDK and Quarkus caused issues. Usually, this manifested with otherwise unexplained issues when using native compilation (e.g. improper serialization of objects) so version alignment check was implemented to help diagnose such issues. Prior to version 7.3.0, this version alignment check was outputting warning-level information whenever versions were mismatched at least at the minor level, sometimes causing confusion. Since issues caused by such misalignments have been rare now that the project is more mature, it was decided to move these logs to debug-level instead.
348+
349+
346350
ifdef::add-copy-button-to-env-var[]
347351
Environment variable: env_var_with_copy_button:+++QUARKUS_OPERATOR_SDK_FAIL_ON_VERSION_CHECK+++[]
348352
endif::add-copy-button-to-env-var[]

0 commit comments

Comments
 (0)