Skip to content

Commit

Permalink
Prepare for 0.13.0 release
Browse files Browse the repository at this point in the history
Signed-off-by: Marko Strukelj <[email protected]>
  • Loading branch information
mstruk committed Jul 7, 2023
1 parent 1aad01c commit ab7c676
Show file tree
Hide file tree
Showing 29 changed files with 80 additions and 33 deletions.
10 changes: 5 additions & 5 deletions .travis/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,14 @@ elif [[ "$arch" != 'ppc64le' ]]; then
EXIT=$?
exitIfError

clearDockerEnv
mvn -e -V -B clean install -f testsuite -Pkafka-3_3_2
EXIT=$?
exitIfError

# Excluded by default to not exceed Travis job timeout
if [ "$SKIP_DISABLED" == "false" ]; then

clearDockerEnv
mvn -e -V -B clean install -f testsuite -Pkafka-3_3_2
EXIT=$?
exitIfError

clearDockerEnv
mvn -e -V -B clean install -f testsuite -Pkafka-3_2_3 -DfailIfNoTests=false -Dtest=\!KeycloakKRaftAuthorizationTests
EXIT=$?
Expand Down
47 changes: 47 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,53 @@ Release Notes
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.
Expand Down
2 changes: 1 addition & 1 deletion examples/consumer/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<groupId>io.strimzi</groupId>
<artifactId>oauth</artifactId>
<relativePath>../../pom.xml</relativePath>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>kafka-oauth-examples-consumer</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion examples/docker/kafka-oauth-strimzi/kafka/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<groupId>io.strimzi.oauth.docker</groupId>
<artifactId>kafka-oauth-docker-strimzi</artifactId>
<relativePath>../pom.xml</relativePath>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>kafka-oauth-docker-strimzi-kafka</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion examples/docker/kafka-oauth-strimzi/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<groupId>io.strimzi.oauth.docker</groupId>
<artifactId>kafka-oauth-docker-parent</artifactId>
<relativePath>../pom.xml</relativePath>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>kafka-oauth-docker-strimzi</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion examples/docker/kafka-oauth-strimzi/zookeeper/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<groupId>io.strimzi.oauth.docker</groupId>
<artifactId>kafka-oauth-docker-strimzi</artifactId>
<relativePath>../pom.xml</relativePath>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>kafka-oauth-docker-strimzi-zookeeper</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion examples/docker/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>io.strimzi.oauth.docker</groupId>
<artifactId>kafka-oauth-docker-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
<packaging>pom</packaging>

<properties>
Expand Down
2 changes: 1 addition & 1 deletion examples/docker/spring/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<groupId>io.strimzi.oauth.docker</groupId>
<artifactId>kafka-oauth-docker-spring</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
Expand Down
4 changes: 2 additions & 2 deletions examples/docker/strimzi-kafka-image/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
<groupId>io.strimzi.oauth.docker</groupId>
<artifactId>kafka-oauth-docker-parent</artifactId>
<relativePath>../pom.xml</relativePath>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<groupId>org.example</groupId>
<artifactId>kafka-oauth-docker-strimzi-kafka</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>

<packaging>pom</packaging>

Expand Down
2 changes: 1 addition & 1 deletion examples/producer/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<groupId>io.strimzi</groupId>
<artifactId>oauth</artifactId>
<relativePath>../../pom.xml</relativePath>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>kafka-oauth-examples-producer</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion oauth-client/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>io.strimzi</groupId>
<artifactId>oauth</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>kafka-oauth-client</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion oauth-common/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>io.strimzi</groupId>
<artifactId>oauth</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>kafka-oauth-common</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion oauth-keycloak-authorizer/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>io.strimzi</groupId>
<artifactId>oauth</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>kafka-oauth-keycloak-authorizer</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion oauth-server-plain/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>io.strimzi</groupId>
<artifactId>oauth</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>kafka-oauth-server-plain</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion oauth-server/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>io.strimzi</groupId>
<artifactId>oauth</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>kafka-oauth-server</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>io.strimzi</groupId>
<artifactId>oauth</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
<packaging>pom</packaging>

<licenses>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/common/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>common</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/docker/hydra-import/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite-docker-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/docker/kafka/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite-docker-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/docker/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/hydra-test/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>hydra-test</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/keycloak-auth-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>keycloak-auth-tests</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/keycloak-authz-kraft-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>keycloak-authz-kraft-tests</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/keycloak-authz-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>keycloak-authz-tests</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/keycloak-authz-zk-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>keycloak-authz-zk-tests</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/keycloak-errors-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>keycloak-errors-tests</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/mock-oauth-server/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>mock-oauth-server</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/mockoauth-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>
</parent>

<artifactId>mockoauth-tests</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion testsuite/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>io.strimzi.oauth.testsuite</groupId>
<artifactId>kafka-oauth-testsuite</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.13.0</version>

<packaging>pom</packaging>

Expand Down

0 comments on commit ab7c676

Please sign in to comment.