Bump some dependencies and update the RELEASE_NOTES (strimzi#206)

* Bump some dependencies versions in examples and testsuite Signed-off-by: Marko Strukelj <[email protected]> * Update RELEASE_NOTES.md Signed-off-by: Marko Strukelj <[email protected]> * Try fix Travis CI failures Signed-off-by: Marko Strukelj <[email protected]> * Try fix Travis CI failures Signed-off-by: Marko Strukelj <[email protected]> --------- Signed-off-by: Marko Strukelj <[email protected]>
mstruk · Oct 5, 2023 · 9fb1888 · 9fb1888
1 parent 1f826e3
commit 9fb1888
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 2 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,9 +1,79 @@
 Release Notes
 =============
 
+0.14.0
+------
+
+### Use Kafka 3.6.0
+
+Kafka 3.6.0 has slightly changed how exceptions thrown from plugin extensions are wrapped into KafkaException.
+Whereas before these exceptions were set as cause on the received KafkaException, there is now another KafkaException in between.
+For example, what was before 3.6.0 a 'KafkaException caused by LoginException' is now (since 3.6.0) 'KafkaException caused by KafkaException caused by LoginException'.
+
+This change of behavior may affect your Kafka client applications, as they may have to change the exception handling logic to act on the final cause in a chain of causes. 
+
+See [PR 205](https://github.com/strimzi/strimzi-kafka-oauth/pull/205)
+
+### Fix logging of principal extraction configuration at startup
+
+See [PR 202](https://github.com/strimzi/strimzi-kafka-oauth/pull/202)
+
+### Support disabling the Accept header when requesting Json Web Key Sets
+
+Some authorization servers have issues with `Accept: application/json` request header. This fix addresses that.
+
+See [PR 201](https://github.com/strimzi/strimzi-kafka-oauth/pull/201)
+
 0.13.0
 ------
 
+### KeycloakRBACAuthorizer has been superseded by KeycloakAuthorizer and works in both Zookeeper and KRaft mode
+
+While `KeycloakRBACAuthorizer` can still be used in Zookeeper mode, for the future you should migrate your configuration to use `KeycloakAuthorizer`:
+
+In your `server.properties` use:
+```
+authorizer.class.name=io.strimzi.kafka.oauth.server.authorizer.KeycloakAuthorizer
+```
+
+As part of supporting KRaft mode the grants mapping logic has changed slightly. Rather than using the access token as a unit of grant, the user id is now used. 
+This results in better sharing of the grants between sessions of the same user, and should also reduce the number of grants held in cache, and the number of refresh requests to the Keycloak server.
+
+Due to these changes additional configuration options have been added:
+* `strimzi.authorization.grants.max.idle.time.seconds` specifies the time after which an idle grant in the cache can be garbage collected
+* `strimzi.authorization.grants.gc.period.seconds` specifies an interval in which cleaning of stale grants from grants cache is performed
+
+Also, as a result the option `strimzi.authorization.reuse.grants` now defaults to `true`, and no longer to `false`.
+
+See [PR 188](https://github.com/strimzi/strimzi-kafka-oauth/pull/188)
+
+### Option `strimzi.oauth.metric.reporters` added to supersede `metric.reporters` in OAuth metric
+
+Due to integration difficulties of OAuth metrics with Kafka metrics system the OAuth has to instantiate its own copy of metric reporters.
+It turns out that some metric reporters don't work correctly when instantiated multiple times. To address that, we no longer use Kafka's `metric.reporters` configuration.
+
+If `strimzi.oauth.metric.reporters` is not set OAuth metrics will still instantiate a default `org.apache.kafka.common.metrics.JmxReporter` if any OAuth metrics are enabled.
+In order to install some other metric reporter in addition to `JmxReporter` both have to be listed.
+Also, the suggested way to configure it on the Kafka broker is to set it as an env variable, rather than a property in `server.properties` file: 
+```
+export OAUTH_ENABLE_METRICS=true
+export STRIMZI_OAUTH_METRIC_REPORTERS=org.apache.kafka.common.metrics.JmxReporter,org.some.package.SomeReporter
+bin/kafka-server-start.sh config/server.properties
+```
+
+See [PR 193](https://github.com/strimzi/strimzi-kafka-oauth/pull/193)
+
+### Principal extraction from nested username claim was added
+
+It is now possible to use JsonPath query to target nested attributes when extracting a principal.
+For example:
+```
+oauth.username.claim="['user.info'].['user.id']"
+oauth.fallback.username.claim="['user.info'].['client.id']"
+```
+
+See [PR 194](https://github.com/strimzi/strimzi-kafka-oauth/pull/194)
+
 ### Fixed json-path handling of null
 
 This change introduces a backwards incompatible change in how queries using `equals` or `not equals` comparison to `null` are handled.

diff --git a/examples/docker/spring/pom.xml b/examples/docker/spring/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>2.5.13</version>
+        <version>2.6.15</version>
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
 
@@ -21,7 +21,7 @@
         <plugins.resources.version>3.1.0</plugins.resources.version>
         <fabric8-docker-plugin.version>0.40.2</fabric8-docker-plugin.version>
 
-        <spring.boot.oauth.version>2.5.13</spring.boot.oauth.version>
+        <spring.boot.oauth.version>2.6.8</spring.boot.oauth.version>
     </properties>
 
     <licenses>