Changelog

Console 1.29.1​

Release date: 2024-11-28

Fixes 🔨​

• Fixed an issue where configuring Google OIDC without a scope was throwing an Exception.

Console 1.29.0​

Release date: 2024-11-25

• Breaking Changes 💣
  • Changes to Conduktor.io Labels
  • Local Users Password policy update
• Features ✨
  • Conduktor Chargeback
  • Console Homepage
  • Consumer Group pages overhaul
  • Self-Service Topic Catalog visibility
  • Self-Service New Topic Policy Allowed Keys
  • More Audit Log CloudEvents into Kafka
  • Expanded Terraform Provider
• Quality of Life improvements
• Fixes 🔨

Breaking Changes 💣​

Changes to Conduktor.io Labels​

We have moved the conduktor.io labels previously available on Connector and Topic resources to new locations.

We recognize this change breaches the API contract and have carefully considered its implications. We remain committed to minimizing breaking changes and will continue to do our best to ensure that such changes are rare and well-justified.

As we expand the number of Conduktor-related features, this separation reduces the risk of conflicts, simplifies resource management, and provides flexibility for future improvements:

• Labels used for sorting and filtering throughout the product
• Conduktor-specific annotations used to drive behaviors on the resources

Topic Resource

• metadata.labels.'conduktor.io/description' → metadata.description
• metadata.labels.'conduktor.io/description.editable' → metadata.descriptionIsEditable

Connector Resource

• metadata.labels.'conduktor.io/auto-restart-enabled' → metadata.autoRestart.enabled
• metadata.labels.'conduktor.io/auto-restart-frequency' → metadata.autoRestart.frequencySeconds

Their associated values have been automatically migrated under the new names.

Important Note for CLI Users​

Applying YAML files with old conduktor.io labels will fail in Conduktor Console 1.29. Be sure to update your YAML files to reflect the new labels.

Example error for outdated YAML:

$ conduktor apply -f topic.yaml
Could not apply resource Topic/click.event-stream.avro: Invalid value for: body (Couldn't decode key. at 'metadata.labels.conduktor.io/description')

Local Users Password policy update​

Passwords for console Local Users configured through YAML and environment variables must comply with a new password policy. This change enforces the following password requirements:

• At least 8 characters in length
• Includes at least 1 uppercase letter, 1 lowercase letter, 1 number, and 1 special symbol

Passwords set in existing installations that do not meet these requirements will prevent Console from starting, throwing a startup error in the logs like this:

2024-11-21T14:25:47,434Z [console] ERROR zio-slf4j-logger - zio.Config$Error$InvalidData: (Invalid data at admin: Password must contain at least 8 characters including 1 uppercase letter, 1 lowercase letter, 1 number and 1 special symbol)

Local Users previously created with the UI are not impacted.
Update the passwords in your YAML or environment variables to meet the new policy before upgrading.

Features ✨​

Conduktor Chargeback: Track and Allocate Costs & Resource Consumption​

Conduktor Chargeback allows organizations to track and allocate costs & usage associated with Kafka resources to different teams or departments based on their data consumption and processing, facilitating cost accountability and management.

Check the dedicated Quickstart to get started with Chargeback.

Console Homepage​

The cluster homepage have been redesigned to present you with the most useful information in one single view:

• The health of your Kafka Cluster with a few key metrics and graphs
• The state of Console Indexing modules for this Kafka Cluster
• Quick access to your most recently viewed resources

Consumer Group pages overhaul​

Consumer group details page is now organized in a way that helps understand the status of your Consumer Group more easily:

• Topics tab shows the Consumer Group info grouped by its subscribed Topics
• Members tab shows the Consumer Group info grouped by its active members

Both Topics and Members lists can be explored further down to individual member/topic-partition assignments.

On top of that graphs are now directly available in the resource page for Lag and Time Lag, as well as a dedicated tab to manage Alerts.

Self-Service Topic Catalog visibility​

You can now choose which Topics should be visible in the Topic Catalog by annotating their YAML.

---
apiVersion: kafka/v2
kind: Topic
metadata:
  cluster: shadow-it
  name: click.event-stream.avro
  catalogVisibility: PUBLIC # or PRIVATE
spec:
  ...

It is also possible to change the default Topic Catalog visibility of all Topics of an Application Instance directly
Check the associated documentation.

Self-Service New Topic Policy Allowed Keys​

We have added a new constraint AllowedKeys to our Self-Service Topic Policy that restricts the properties that can be configured on a Topic.

---
# Limits the Topic spec.configs to only have retention.ms and cleanup.policy keys
apiVersion: self-service/v1
kind: TopicPolicy
metadata:
  name: "generic-dev-topic"
spec:
  policies:
    spec.configs:
      constraint: AllowedKeys
      keys:
        - retention.ms
        - cleanup.policy

This works in conjunction with existing constraints and ensures your Application Teams will only define properties that are allowed by the Central Team.
Read more about our Topic Policy constraints.

More Audit Log CloudEvents into Kafka​

We have made more events available for the Audit Log Publisher:

• IAM.User.Logout
• IAM.User.Login
• Kafka.ConsumerGroup.Duplicate
• Kafka.ConsumerGroup.Delete
• Kafka.ConsumerGroup.Update ( when we reset the offset of the consumer group )

A full list of all the exported audit log event types is published on the Audit Log page.

Expanded Terraform Provider: Kafka Cluster, Schema Registry, Kafka Connect​

We've expanded the scope of our Terraform provider, you can now create additional resources: Kafka cluster with schema registry, and Kafka connect clusters using Terraform. With this version also comes some additional small fixes as requested by the community, see the dedicated provider releases page for the full list.

All examples are available in our provider repo such as the below snippet for a Confluent Kafka cluster and schema registry (with mTLS) definition.

resource "conduktor_kafka_cluster_v2" "confluent" {
  name = "confluent-cluster"
  labels = {
    "env" = "staging"
  }
  spec {
    display_name      = "Confluent Cluster"
    bootstrap_servers = "aaa-aaaa.us-west4.gcp.confluent.cloud:9092"
    properties = {
      "sasl.jaas.config"  = "org.apache.kafka.common.security.plain.PlainLoginModule required username='admin' password='admin-secret';"
      "security.protocol" = "SASL_PLAINTEXT"
      "sasl.mechanism"    = "PLAIN"
    }
    icon                         = "kafka"
    ignore_untrusted_certificate = false
    kafka_flavor = {
      type                     = "Confluent"
      key                      = "yourApiKey123456"
      secret                   = "yourApiSecret123456"
      confluent_environment_id = "env-12345"
      confluent_cluster_id     = "lkc-67890"
    }
    schema_registry = {
      type                         = "ConfluentLike"
      url                          = "https://bbb-bbbb.us-west4.gcp.confluent.cloud:8081"
      ignore_untrusted_certificate = false
      security = {
        type              = "SSLAuth"
        key               = <<EOT
-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----
EOT
        certificate_chain = <<EOT
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
EOT
      }
    }
  }
}

Quality of Life improvements​

• Improved the performance of the Automatic deserializer
• Improved the performance of the Schema Registry indexing process
• Added support for Google Cloud Identity group claims
• Added License expiry warning in the UI when there is less than 30 days left

Fixes 🔨​

• Fixed an issue where Custom Deserializers weren't working as expected
• Fixed an issue where the ManageClusters permission wasn't working as expected
• Fixed an issue that prevented creating a KafkaCluster and a Topic on that newly declared KafkaCluster in a single CLI apply command
• Fixed /health/readiness endpoint to return HTTP 503 when the Postgres DB is down
• Fixed an issue where the Message Count wasn't updated to 0 when emptying a topic
• Fixed an issue where the Pause/Resume button wasn't visible when a connector was in the Failed state
• Fixed an issue where the Topic creation failure reason wasn't shown in the UI
  • This helps understand why Topic Creation is rejected (useful for Gateway and Self-Service Topic Policies), and how to modify the topic create request to meet the policy requirements

Gateway 3.4.0​

Release date: 2024-11-15

Upcoming Breaking change: Local Users 💣​

Today, the token as the password for local Gateway service accounts contains all the necessary information. As a result, the SASL username is not used during the authentication phase.

In release 3.5.0, we will strictly enforce that the username and the token matches. This will help reduce inconsistencies and avoid unexpected behavior.

For this release 3.4.0, we'll only raise the following warning in the logs:

2024-08-27T18:15:29 [WARN] - Inconsistency detected for plain authentication. Username applicationA is not consistent with validated token created for application-A. SASL configuration should be changed accordingly.

Features ✨​

• Correct Offsets on Concentrated Topics

Correct Offsets on Concentrated Topics​

Concentrated Topics were reporting the offsets of the underlying backing topic. This caused Lag and Message Count metrics to be invalid.

Correct offsets can now be enabled per ConcentrationRule.

---
kind: ConcentrationRule
metadata:
  name: myapp-concentrated
spec:
  pattern: myapp-.*
  physicalTopics:
    delete: myapp-concentrated
  autoManaged: false
  offsetCorrectness: true

This feature is experimental and comes with a number of limitations that are important to understand beforehand.

General fixes 🔨​

• Fixed an issue impacting live consumption from concentrated topics within Console
• Fixed an issue with upserts in API V2 relating to service accounts (reporting updated when the status should be not changed)
• Fixed an issue related to Kafka 3.7 client support, ensuring topic id's for alias and concentrated topics are distinct from their underlying topics
• Fixed an issue whereby audit logs were not being captured during cluster switching
• Fixed an issue with SQL topics when parsing topic names containing "-"

Known issues​

• We are aware of an issue with kcat when the new environment variable GATEWAY_MIN_BROKERID is not aligned with the first BrokerId of your Kafka cluster
  • As a workaround, you can either define GATEWAY_MIN_BROKERID to your first Kafka BrokerId or use kcat with the -E flag

Console 1.28.0​

Release date: 2024-10-14

• Features ✨
  • Conduktor SQL
  • Monitoring improvements
  • New CLI/API resource Alert
  • Shareable Filters
  • Tags becomes Labels
  • Publish Audit Log CloudEvents into Kafka
  • Logging API
• Quality of Life improvements
• Fixes 🔨

Features ✨​

Conduktor SQL​

Index data from Kafka topics in a database to enable data to be queried from the UI, API or CLI using SQL.

This allows you to troubleshoot, sample, analyze, aggregate and join data through:

• Querying Kafka message data
• Querying Kafka metadata (such as the offset, partition and timestamp)

Read the dedicated guide on configuring SQL.

Query through the UI

Query through the API & CLI

CLI (upgrade to v0.3.1):

conduktor sql 'select * from "kafka-cluster-dev_customer_orders"' -n 2

API:

curl \
 --header "Authorization: $token" \
 --request POST 'localhost:8080/api/public/sql/v1/execute?maxLine=2' \
 --data 'select * from "kafka-cluster-dev_customer_orders"'

Important information regarding SQL

To use the feature there is a dependency on provisioning a new database. As a user, you have the choice of which topics you wish to index. Learn more about this and how to configure SQL using the dedicated guide.

We encourage you to use this feature in non-production environments and give us feedback.

Monitoring improvements​

We are migrating our Monitoring dashboards into their respective resource pages for a more integrated experience.

This migration will happen over the next few releases with our objective to remove the existing, generic Monitoring pages:

• Overview will be refactored into Home page
• Cluster Health dashboards and alerts will move under Brokers page
• Topic monitoring will be integrated with Topics page
• Apps monitoring will be integrated with Consumer Groups pages
• Alerts will be integrated as tabs in all the resource pages, similar to the recent changes for Kafka Connect

For this 1.28.0 release we are migrating the Topic monitoring and Cluster Health pages.

Topic Monitoring​

The 3 existing graphs have been moved to the Topic details. We have also added a new graph to track the number of records in the topic.

• Produce Rate and Consume Rate
• Disk Usage
• Records (new)

Cluster Health​

The charts and alerts are now available under the Brokers page with cleaner graphs.

• Produce Rate and Consume Rate
• Disk Usage
• Partitions Count
• Offline, Under Replicated and Under Min ISR Partitions

We have removed two metrics that were not always calculated correctly since the removal of the JMX integration back in release 1.15 (May 2023).

• Active Controller Count
• Unclean Leader Election

New CLI/API resource Alert​

Alerts can now be created via the API or CLI in addition to the UI.
See below for example config, and check the Alerts documentation for more details.

---
apiVersion: console/v2
kind: Alert
metadata:
  cluster: local-julien
  name: my-alert
spec:
  type: TopicAlert
  topicName: wikipedia-parsed-DLQ
  metric: MessageCount
  operator: GreaterThan
  threshold: 0

Starting today, we recommend you use the new alerts available under Brokers and Topics pages.

Shareable Filters​

Filters in the Topic Consume view are now shareable. This brings a number of benefits:

• Improved collaboration: Share pre-defined views to ensure users are looking at the same subset of data
• Time savings: Speed up troubleshooting and analysis with repeatable filters that share the same or similar criteria
• Consistency and accuracy: Standardized filters across teams and departments reduce the risk of errors or discrepancies that can occur when individuals manually create filters

After you've finished configuring filters on a topic, you now have an option to save the filter either as a Private or an Organization filter.

Anyone can then load Organization filters from the dedicated section.

Tags Become Labels​

With the introduction of the Self-service resource manifests, we brought customers a means to annotate all their resources with labels. Labels are more structured than the existing Conduktor tags, thereby allowing for more precise filtering capabilities, as can be seen in the Topic Catalog.

In this release, we'll perform an automatic migration from Tags to Labels.

Tags written with the naming convention <key>/<value> will automatically be added as similar labels:

• <key>: <value>

If there is a conflict such as; a topic containing tags with the same key, that already has the target label, or is not written with this naming convention, then they will be created with a tag- prefix as follows:

tag-<value>: true

Here's an example of how tags will be migrated into labels:

# Tags defined on topic:
- format/avro
- project/supplychain
- team/delivery
- color/blue
- color/red
- wikipedia
- non-prod

# Resulting topic labels after migration
labels:
  format: avro
  project: supplychain
  team: delivery
  tag-color/blue: true # Because conflict on "color"
  tag-color/red: true # Because conflict on "color"
  tag-wikipedia: true # Because wikipedia is not a key value pair
  tag-non-prod: true # Becuase non-prod is not a key value pair

The Topic list and Topic details page have been modified to use labels instead of tags.

We plan to bring this capability on all resources (Connectors, Service Accounts, Consumer Groups, ...) over the next few releases.
Let us know which resource you would like to see covered first.

Publish AuditLog CloudEvents into Kafka​

It is now possible to publish Console Audit Log events into a Kafka topic directly for any further use you may have for them, such as maintaining your own audit trail in other systems.

The exportable audit log events have more detail compared to the current UI events, providing additional information about the event that has taken place.

The events conform to the CloudEvents specification, a vendor-neutral format that follows the following structure:

{
    "specversion" : "1.0",
    "type" : "com.github.pull_request.opened",
    "source" : "https://github.com/cloudevents/spec/pull",
    "subject" : "123",
    "id" : "A234-1234-1234",
    "time" : "2018-04-05T17:31:00Z",
    "comexampleextension1" : "value",
    "comexampleothervalue" : 5,
    "datacontenttype" : "text/xml",
    "data" : "<much wow=\"xml\"/>"
}

An example Conduktor event would look like:

{
	"source": "//kafka/kafkacluster/production/topic/website-orders",
	"data": {
		"eventType": "Kafka.Topic.Create",
		// Additional event specific data...
		"metadata": {
			"name": "website-orders",
			"cluster": "production"
		}
		// Additional event specific metadata...
	},
	"datacontenttype": "application/json",
	"id": "ad85122c-0041-421e-b04b-6bc2ec901e08",
	"time": "2024-10-10T07:52:07.483140Z",
	"type": "AuditLogEventType(Kafka,Topic,Create)",
	"specversion": "1.0"
}

Specify the target Kafka cluster and topic using the environment variables CDK_AUDITLOGPUBLISHER_CLUSTER & CDK_AUDITLOGPUBLISHER_TOPICNAME and events will start being produced to the destination topic.

A full list of all the exported audit log event types is published on the Audit Log page.

Logging API​

Adjust the log level of Console without requiring a restart. We've added a new API endpoint to support targeted changes to log levels dynamically. Check the associated documentation for the full list of capabilities.

curl -X PUT 'http://localhost:8080/api/public/debug/v1/loggers/io.conduktor.authenticator/DEBUG' \
  -H "Authorization: Bearer $API_KEY"

Quality of Life improvements​

• Updated design and color theme
• Added navigation breadcrumb
• Enhanced error messages throughout the product
• Improved the connector 90 days heatmap
• Declaring an ApplicationInstance with resources ending in * will now fail with this error message
  • Could not apply resource ApplicationInstance/my-app-inst: resource name 'appA-*' is not allowed. Use name 'appA-' with patternType PREFIXED instead

Fixes 🔨​

• Fixed an issue with Topic Policy constraint Range where max value wasn't inclusive and min could greater than max
• Fixed an issue where Topic Policies were not enforced on Topic configuration changes in Console
• Added an error message when using the copy to clipboard button (for API Keys for instance) fails
• Added checks on local user creation emails
• Added new optional environment variable CDK_SSO_OAUTH2_0_OPENID_METADATADOCUMENT to modify the default discovery .well-known end-point
• Fixed an issue where Avro messages using logical type UUID couldn't be deserialized properly
• Fixed an issue with Cluster configuration page requiring platform.certificates.create permission to perform the TLS check
• Fixed an issue with "Remove user from group" button which is now disabled for users added by external group mapping
• Prevented the deletion of a group when it is owner of an Application
• Fixed an issue with the "New version" button in the banner that was still showing despite being on the latest version
• Fixed an issue where connections to the AWS glue schema registry would disconnect after a certain time and struggle to reconnect
• Fixed an issue where the "Reprocess message" feature was converting empty string headers to null value
• Fixed all critical and high CVE in console-cortex image
• Fixed an issue with the metric under_replicated_partitions when topics have confluent.placement.constraints property

Gateway 3.3.2​

Release date: 2024-10-07

Fixes 🔨​

• Fixed an issue where the Producer Rate Limiting Policy would not honor its configuration.

Console 1.27.1​

Release date: 2024-09-25

Fixes 🔨​

• Improved performance of RBAC resolution when there is a large number of permissions

Gateway 3.3.1​

Release date: 2024-09-25

General fixes 🔨​

• Fixed an issue where Gateway would close the client connection upon receiving certain API Keys in parallel of the initial Metadata Request

Console 1.27.0​

Release date: 2024-09-14

• Features ✨
  • Kafka Connect Configuration Wizard
  • Alerts for Kafka Connect
  • Self-service: Limited Ownership mode
  • Quality of Life improvements
• Fixes 🔨
• Deprecation Warning: Upcoming migration from Tags to Labels

Features ✨​

Kafka Connect Configuration Wizard​

We are very excited to introduce our Configuration Wizard for Kafka Connect which is taking full advantage of the Kafka Connect Validate API:

• Form is generated with structured configuration groups
• Much nicer error handling, attached to each individual field
• Embedded documentation that helps you understand which fields are required and what are their expected and default values
• Ability to toggle advanced configuration to visualize only the most important fields
• Ability to switch seamlessly between Form View and JSON View at any time.

Give it a try and let us know what you think!

Alerts for Kafka Connect​

On top of the Kafka Connect Graphs we shipped last release, we now have added the ability to create alerts on them.

Self-service: Limited Ownership mode​

To help organizations transition to Self-service more easily, we have added a new attribute on ApplicationInstance to let Platform Teams decide the level of autonomy to give to Application Teams.

• ApplicationInstance resources configured with ownershipMode: ALL, which is the default, delegates all permissions related to that resource to the Application Team
• ApplicationInstance resources configured with ownershipMode: LIMITED delegates only a subset of the available permissions to the Application Team

This is especially useful if you already have a centralized repository and existing workflow for Topic creation. You may want to provide Self-service capabilities while still forcing your Application Teams to go through your pipeline for Topic Creation, instead of Self-service.

• Read more about Limited Ownership mode
• Get Started with Self-service today!

Quality of Life improvements​

• Self-service: External Group Mapping is now available for ApplicationGroup
• The Login page now steers users towards their OIDC provider rather than basic auth when OIDC is enabled

Fixes 🔨​

• Fixed an issue on Consumer group reset offset with the ToDatetime strategy
• Fixed an issue with Console indexing that could occur when deleting and recreating subject
• Fixed a recent regression with default replication factor when creating a topic
• Fixed a recent regression with Broker feature "Similar config" calculation
• Fixed a UI issue when Application Instance was created without any resources
• Fixed several issues around Microsoft Teams Integration to support Teams Workflow webhooks (Step by step guide)
• Fixed Kafka Connect client to use HTTP Proxy JVM configuration
• Switching Kafka cluster from the Topic details page now redirects to the Topic List
• Console doesn't override the client.id property anymore

Deprecation Warning: Upcoming migration from Tags to Labels 💣​

With the introduction of the Self-service resource manifests, we brought customers a means to annotate all their resources with labels. Labels are more structured than the existing Conduktor tags, thereby allowing for more precise filtering capabilities, as can be seen in the Topic Catalog.

In an upcoming release, we'll perform an automatic migration from Tags to Labels.

Tags written with the naming convention <key>/<value> will automatically be added as similar labels:

• <key>: <value>

If there is a conflict such as; a topic containing tags with the same key, that already has the target label, or is not written with this naming convention, then they will be created as follows:

tag-<value>: true

Here's an example of how tags will be migrated into labels:

# Tags:
- format/avro
- project/supplychain
- team/delivery
- color/blue
- color/red
- wikipedia
- non-prod

# Result
labels:
  format: avro
  project: supplychain
  team: delivery
  tag-color/blue: true # Because conflict on "color"
  tag-color/red: true # Because conflict on "color"
  tag-wikipedia: true
  tag-non-prod: true

⚠️ Conduktor can help you rename tags through Customer Support
Between now and the migration, we can help you rename your tags for a smooth transition to labels.

Contact us as soon as possible if you would like support.

Gateway 3.3.0​

Release date: 2024-09-05

Upcoming Breaking change 💣​

Today, the token as the password for local Gateway service accounts contains all the necessary information. As a result, the SASL username is not used during the authentication phase.

In an upcoming release, we will strictly enforce that the username and the token matches. This will help reduce inconsistencies and avoid unexpected behaviors.

This breaking change is due for release 3.5.0.
For this release 3.3.0, and next product release 3.4.0, we'll only raise the following warning in the logs:

2024-08-27T18:15:29 [WARN] - Inconsistency detected for plain authentication. Username applicationA is not consistent with validated token created for application-A. SASL configuration should be changed accordingly.

Features ✨​

• New V2 APIs and CLI support
• Support for HTTPS APIs
• Better UX for ACLs and superUsers
• Encryption Enhancements and Support Clarification

New V2 APIs and CLI support​

We’re excited to introduce our new Gateway API, designed for seamless integration with our CLI. This update allows you to deploy Gateway resources using infrastructure-as-code with straightforward, clearly defined concepts:

• Interceptor
• GatewayServiceAccount
• GatewayGroup
• ConcentrationRule
• AliasTopic
• VirtualCluster

Check the CLI reference to get started, and the resources reference for more information on each concept.

---
apiVersion: gateway/v2
kind: GatewayGroup
metadata:
  name: groupB
spec:
  members:
    - name: user1
    - name: user2
---
apiVersion: gateway/v2
kind: Interceptor
metadata:
  name: enforce-partition-limit
  scope:
    group: groupB
spec:
  pluginClass: io.conduktor.gateway.interceptor.safeguard.CreateTopicPolicyPlugin
  priority: 100
  config:
    numPartition:
      action: BLOCK
      max: 9
      min: 9
    topic: .*

$ conduktor apply -f gateway.yml
GatewayGroup/groupB: Created
Interceptor/enforce-partition-limit: Created

$ conduktor delete GatewayGroup groupB
The group groupB is still used by the following interceptor(s): enforce-partition-limit

Note: API V1 is still available, but we recommend that new users and those with simple Gateway configurations begin using the V2 API as soon as possible. We will announce a deprecation plan in the coming weeks and notify you in advance of which Gateway version will be the last to support the V1 APIs.

Support for HTTPS APIs​

It is now possible to configure HTTPS and mTLS authentication on the Gateway HTTP APIs. Check the HTTP section of the Environment Variables page for more details.

Better UX for ACLs and superUsers​

To coincide with the clearly defined concepts established in API V2, we are making changes to ACLs management in Gateway.

• ACLs and Super Users on the Gateway (excluding Virtual Clusters) must be configured through Environment Variables.
• ACLs and Super Users on Virtual Clusters must now be driven explicitly through API/CLI.

Enable ACLs for Gateway (excl. Virtual Clusters)​

Configure both environment variables:

GATEWAY_ACL_ENABLED=true # default false
GATEWAY_SUPER_USERS=alice,bob

If GATEWAY_SUPER_USERS is not set, it will default to GATEWAY_ADMIN_API_USERS for backward compatibility.

Enable ACLs for Virtual Clusters​

Example configuration:

---
apiVersion: gateway/v2
kind: VirtualCluster
metadata:
  name: "mon-app-A"
spec:
  aclEnabled: "true" # defaults to false
  superUsers:
  - username1
  - username2

Encryption Enhancements and Support Clarification​

Field-Level Encryption: Preserving Message Format to Enhance Usability​

When applying field-level encryption prior to 3.3.0, the encryption plugin would convert the message to JSON, and re-apply the schema format when the message was read back through the decryption plugin.

In Gateway 3.3.0, we now preserve the schema format for Avro messages - meaning the same schema is used in the backing topic, and the data can be read directly from Kafka or without the decryption plugin at all.

Read more about this change to the default behaviour, and how to configure it.

Fields which cannot be encrypted in-place (effectively any non-string field) have their encrypted value placed in the headers, and the field itself is given a default masking value. The default values are clarified below:

Note that the same default values are now used across all relevant plugins when manipulating a non-string field - Data Masking, Partial Decrypt, and Encrypt on Fetch.

Attempt to apply encryption to a message more than once will now fail​

If any of the encryption headers are detected in a message when encryption is about to be applied, then the encryption operation will fail. This is because applying encryption twice (or more) is currently not reversible.

Deprecated support for Schema Based (tag) encryption with Protobuf​

Note this is no longer supported, and the Gateway will now throw an exception if the encryption plugin attempts to apply schema (tag) based processing to a Protobuf message.

Note that any data previously written in this mode can still be read back - as the decrypt does not use the schemas at all, rather it uses the message header to know what was encrypted.

General fixes 🔨​

• Large double values (where > Float Max) are now supported in field-level encryption for Avro and Protobuf
• Bytes and fixed fields now properly supported in field-level encryption for Avro
• Avro unions of two or more values (rather than just a value and a null) are now supported in field-level encryption for Avro
• Schema (tag) based encryption now checks and fails if its config is invalid
• It is not possible to encrypt the headers which the encryption plugin uses to manage its decryption process (as this would render the data unrecoverable)
• Improved log messages for Interceptors that reject actions, such as TopicPolicyPlugin
• Several improvements to the LargeMessage & LargeBatch Interceptors
• Fixed an issue where KCache topic initialization would fail silently and leave Gateway in an unusable state
• Added a new Environment Variable GATEWAY_MIN_BROKERID (default 0) that allows for determinist mapping of brokers and ports
• Improved network stability during Gateway scaling or Kafka topology changes
• Added support for overriding Kafka Producer properties used for Audit Log topic with GATEWAY_AUDIT_LOG_KAFKA_ environment variables
• Removed metric gateway.brokered_active_connections. This was equal to portCount with port mapping and always 1 in host mapping
• Changed metric gateway.request_expired tags: nodeHost/nodePort are replaced by nodeId/clusterId
• Fix default value for GATEWAY_UPSTREAM_THREAD config. The new intended default (number of CPU) previously was (2 x number of CPU).
• Fixed an issue with GATEWAY_ADVERTISED_SNI_PORT that wasn't working properly
• Add log level for io.confluent packages in default log configuration
• Add default value to non mandatory configruation value for min and max bytes in FetchPolicyInterceptor
• Fix an issue with Concentrated Topics creation with Redpanda

Known issues​

• We are aware of an issue with kcat when the new environment variable GATEWAY_MIN_BROKERID is not aligned with the first BrokerId of your Kafka cluster.
  • As a workaround, you can either define GATEWAY_MIN_BROKERID to your first Kafka BrokerId or use kcat with the -E flag
• It is not possible to add Service Accounts to GatewayGroups using API V2 unless they are previously declared as GatewayServiceAccount.
  • This is not a wanted behavior, especially for OAuth or Delegated Kafka Authentication where declaring a GatewayServiceAccount should not be needed. We'll address this issue in a follow-up release
  • API V1 (user-mapping) is not impacted
• If you perform a rolling upgrade to 3.3.0, Gateway nodes in earlier versions will show the following error in the logs: [ERROR] [KafkaCache:1007] - Failed to deserialize a value org.apache.avro.AvroTypeException: Expected field name not found: clusterId
  • This is fine and will not cause any further problems
• If you use Virtual Clusters and ACLs: After updating to 3.3.0, you must manage VirtualCluster's ACL and superUsers through V2 API.

Gateway 3.2.2​

Release date: 2024-08-28

Upcoming Breaking change 💣​

Today, the token as the password for local Gateway service accounts contains all the necessary information. As a result, the SASL username is not used during the authentication phase.
In an upcoming release, we will strictly enforce that the username and the token matches. This will help reduce inconsistencies and avoid unexpected behaviors.

This breaking change is due for release 3.5.0.
For this hotfix release 3.2.2, and next product releases 3.3.0 and 3.4.0s, we'll only raise the following warning in the logs:

2024-08-27T18:15:29 [WARN] - Inconsistency detected for plain authentication. Username applicationA is not consistent with validated token created for application-A. SASL configuration should be changed accordingly.

General fixes 🔨​

• Fixed a severe authentication issue with Gateway generated tokens that could lead to a different user being authenticated, effectively causing elevated privileges under certain conditions.
• Fixed an issue where GATEWAY_SNI_HOST_SEPARATOR couldn't be set to the value -
• Fixed an issue where GATEWAY_SNI_HOST_SEPARATOR wasn't properly taken in account
• Fixed an issue with GATEWAY_ADVERTISED_SNI_PORT that wasn't working properly

Console 1.26.0​

Release date: 2024-08-14

Features ✨​

• Manage Connectors using the CLI
• Self-service support for Connectors
• Enhanced UI & Alerts for Kafka Connect
• Quality of Life improvements
• Deprecation Warning: Upcoming migration from Tags to Labels

Manage Connectors using the CLI​

Continuing with the Infra-as-code approach, we are happy to introduce CLI support for Connectors, providing an efficient and automated way to manage your Kafka Connect resources.

---
apiVersion: kafka/v2
kind: Connector
metadata:
  connectCluster: kafka-connect
  name: click.my-connector
  labels:
    conduktor.io/auto-restart-enabled: true
    conduktor.io/auto-restart-frequency: 600
spec:
  config:
    connector.class: 'org.apache.kafka.connect.tools.MockSourceConnector'
    tasks.max: '1'
    topic: click.pageviews

Self-service support for Connectors​

Application Teams can now manage their Connectors with Self-service.
From now on, you can grant ownership to connectors on Self-service Application Instance.

---
apiVersion: self-service/v1
kind: ApplicationInstance
metadata:
  application: "clickstream-app"
  name: "clickstream-dev"
spec:
  cluster: "shadow-it"
  serviceAccount: "sa-clicko"
  resources:
    - type: CONNECTOR
      connectCluster: shadow-connect
      patternType: PREFIXED
      name: "click."

Enhanced UI & Graphs for Kafka Connect​

We have revisited the Kafka Connect UI in multiple ways to improve your experience:

• Connect Cluster selection screen with a preview of Connector status
• New graphs demonstrating the state of your Connector over time

Support for High Availability (HA) Console​

Multiple Console instances can now be deployed in parallel to achieve high availability.

This applies to the deployment of conduktor-console, while conduktor-console-cortex is currently limited to a single instance. The design ensures minimal impact on the cluster by assigning only one instance to handle the indexing of Kafka data used for performance monitoring.

Quality of Life improvements​

• The checkbox to skip TLS verification is now always visible
• The YAML for Topic object now allows number in spec.configs. Previously it was mandatory to quote all numbers.
• Self-service Topic Policies are now visible in the UI

Fixes 🔨​

• Topic Policies from Self-service are now properly enforced from the UI, as well as both the API and CLI
• Fix Kafka Connect Cluster list showing invalid number of running tasks

Deprecation Warning: Upcoming migration from Tags to Labels 💣​

With the introduction of the Self-service resource manifests, we brought customers a means to annotate all their resources with labels. Labels are more structured than the existing Conduktor tags, thereby allowing for more precise filtering capabilities, as can be seen in the Topic Catalog.

In an upcoming release, we'll perform an automatic migration from Tags to Labels.

Tags written with the naming convention <key>/<value> will automatically be added as similar labels:

• <key>: <value>

If there is a conflict such as; a topic containing tags with the same key, that already has the target label, or is not written with this naming convention, then they will be created as follows:

tag-<value>: true

Here's an example of how tags will be migrated into labels:

# Tags:
- format/avro
- project/supplychain
- team/delivery
- color/blue
- color/red
- wikipedia
- non-prod

# Result
labels:
  format: avro
  project: supplychain
  team: delivery
  tag-color/blue: true # Because conflict on "color"
  tag-color/red: true # Because conflict on "color"
  tag-wikipedia: true
  tag-non-prod: true

⚠️ Conduktor can help you rename tags through Customer Support
Between now and the migration, we can help you rename your tags for a smooth transition to labels.

Contact us as soon as possible if you would like support.

Gateway 3.2.1​

Release date: 2024-07-31

General fixes 🔨​

• Fixed an issue when either GATEWAY_ACL_ENABLED or GATEWAY_ACL_STORE_ENABLED was enabled resulting in ACLs being enforced in undesirable scenarios.

Gateway 3.2.0​

Release date: 2024-07-19

Breaking Changes 💣​

Two new backing topics are required for Gateway​

In the next release (3.3), we'll bring a new API as well as support in the Conduktor CLI to manage Gateway concepts using infra-as-code approach.

In preparation for this upcoming release, we are replacing some weakly-defined concepts in favor of strongly-defined concepts. The following are now clearly captured in the topics mentioned below:

• Virtual Clusters that existed only through creation of UserMappings or Interceptors targeting
• GatewayGroups that existed only through UserMappings

As a result, 2 new topics will now be created once you upgrade to Gateway 3.2:

• _conduktor_gateway_vclusters
• _conduktor_gateway_groups

If you are happy with the default names, you have nothing to do. If you want to control the name of those topics, use the 2 new environment variables:

• GATEWAY_VCLUSTERS_TOPIC
• GATEWAY_GROUPS_TOPIC

Check the associated Documentation for more information.

Changes to ACL support on Gateway​

With Gateway 3.1 we removed our dedicated ACL interceptor in favor of a new environment variable GATEWAY_ACL_STORE_ENABLED. This variable was enabling ACLs in all scenarios, whether you used Virtual Clusters or not.

Changes for Gateway 3.2​

With Gateway 3.2, we are adding a new environment variable GATEWAY_ACL_ENABLED and modifying the behavior of the existing variable GATEWAY_ACL_STORE_ENABLED.

From now on, the variables works as follow:

Preview for Gateway 3.3​

In the next release, we will enhance ACLs to restore and expand the full set of features available before version 3.1. This will be achieved through the introduction of a CLI and APIs, making concepts like VirtualCluster first-class citizens.

Enable ACLs for Gateway (excl. Virtual Clusters)​

Configure both environment variables:

GATEWAY_ACL_ENABLED=true
GATEWAY_SUPER_USERS=alice,bob

Enable ACLs for Virtual Clusters​

---
apiVersion: gateway/v2
kind: VirtualCluster
metadata:
  name: "mon-app-A"
spec:
  aclEnabled: true # defaults to false
  superUsers:
  - username1
  - username2

This will effectively render GATEWAY_ACL_STORE_ENABLED obsolete.

General fixes 🔨​

• Fixed an issue with Field-level Avro encryption/decryption relating to numeric fields:
  • When using partial decryption with Avro schema registry, any numeric values (int, long, float, double) that are not being decrypted will instead be masked with the minimum (most negative) value for the numeric type
  • This is to ensure the field is compliant with the original type in the Avro schema
• Fixed an issue with the ClientIdRequired Policy that wasn't properly overriding the ClientId
• Fixed an issue to ensure all active connections are closed, and clients transition quicker to the new cluster during cluster switching

Console 1.25.1​

Release date: 2024-07-23

Breaking Changes 💣​

New docker image name​

We have renamed the Console docker image to conduktor/conduktor-console to clarify our product naming.
Please modify your installation to reflect this change as we will now stop publishing a conduktor/conduktor-platform image.

docker pull conduktor/conduktor-console:1.25.1

Features ✨​

• Conduktor Console IaC Compatible
  • Manage Cluster Connections
  • Short lived token generation on startup
  • Admin and Application Tokens
• Shareable Message Page
• Large Messages Support
• Topic Catalog Details Page
• Audit Last Activity of Users
• Quality of Life improvements

Conduktor Console IaC Compatible​

Console is now able to be fully deployed through an IaC approach with the following additions to Console 1.25 and CLI 0.2.7.

Manage Cluster Connections​

Manage your Console resource lifecycle with the addition of the KafkaCluster, KafkaConnectCluster and KsqlDBCluster objects to our IaC approach using the Conduktor CLI.

Checkout the example below and find the full definition at Console Resources Reference documentation.

---
apiVersion: console/v2
kind: KafkaCluster
metadata:
  name: cloud-kafka
spec:
  displayName: "Cloud Kafka"
  icon: "kafka"
  color: "#000000"
  bootstrapServers: "localhost:9092"
  properties:
    sasl.jaas.config: org.apache.kafka.common.security.plain.PlainLoginModule required username="admin" password="admin-secret";
    security.protocol: SASL_SSL
    sasl.mechanism: PLAIN
  schemaRegistry:
    url: http://localhost:8080
    security:
      type: BasicAuth
      username: some_user
      password: some_user

Short lived token generation on startup​

When spinning up Console, a token is needed to access the API. Previoulsy this had to be done in the UI which would not allow full IaC. Now, we have the conduktor login command which leverages the admin credentials to generate an API token, and allow the rest of the commands you may need to startup. This is expanded upon in the docs.

Admin and Application Tokens​

In addition to the startup token, you can now generate tokens for the appropriate scope, for admin and application level tokens. The docs will walk you through this.

Shareable Message Page​

Individual messages can now be accessed from a unique URL! Now you can link directly to a specific Kafka message for review or investigation, be that for sharing with a teammate, or commenting on a Jira ticket.

From within the Consume page, select a message and use the 'Share' button to navigate to the standalone page. The standalone message page shows the key, value, metadata and headers in a single view. Switch between the JSON view or table view, and utilize jq for additional filtering of the value.

Large Messages Support​

We have put a limit on the message sizes that are sent to the browser in the Consume page (100Kb). From now on, when a message is larger than this size, we'll provide you with a link to access the individual message - this mitigates performance issues and still provides a path for troubleshooting, and sharing, large messages.

Topic Catalog Details Page​

Expose contextual documentation about your Kafka Topics that exist in your organization with the Topic Details page. This helps democratize data to enhance its understanding and usage, and facilitate collaboration through a shared knowledge base.

You can choose to open or lock editing of descriptions within the UI using specific annotations. Check the Topic Resource documentation for more information.

Audit Last Activity of Users​

You can now audit the last activity date of users in Console.

From within the Settings > Users page, you will see a new column 'Last login'. Note that the user login event is also captured in the Audit Log.

Quality of Life improvements​

• Introduced an intermediate screen for Kafka Connect, allowing you to segment Connectors by each Connect cluster
• Within a Connect cluster, introduced an icon for each connector that clarifies if auto-restart is enabled
• Topic Catalog Search is now case-insensitive
• Improved error message when trying to delete an ApplicationInstance that is referenced elsewhere
• Improved error message when assign ownership on resources already owned by another ApplicationInstance
• CLI delete command can now be applied at the file level, simliar to resource creation through apply -f you can now delete -f

Fixes 🔨​

• Fixed an error that occurred when configuring a KsqlDBCluster in the UI
• Fixed a UI issue that caused several dropdowns components to look wrong
• Fixed an error message where expected and actual topic replication factor were inverted in the CLI
• When deleting a Kafka Cluster from Console, the Indexed data is now properly deleted as well
• Upgrade dependencies vulnerable to CVE-2024-21634

Gateway 3.1.1​

Release date: 2024-06-20

General fixes 🔨​

• Performance is improved when using a large number of interceptors (backported in 3.0.5)
• Pre-create folders when using RocksDB as a cache backend
• Moved the Schema Id to the headers when using field level encryption with Avro

Console 1.24.1​

Release date: 2024-06-24

Fixes 🔨​

• Fixed a UI issue on Self-service Application Catalog and Topic Policies pages
• Fixed a UI issue on Topic Catalog when listing topics created with empty configs
• Fixed an issue with KqlDB connection test button
• Fixed an issue with the new delete users from group endpoint definition in OpenAPI spec

Gateway 3.1.0​

Release date: 2024-06-05

AclsInterceptorPlugin removed​

Kafka ACLs are now fully integrated in the Core Features of Conduktor Gateway.
If you were using the AclsInterceptorPlugin, make sure to enable ACLs while upgrading the Gateway to 3.1.0.
To enable ACLs set the environment variable GATEWAY_ACL_STORE_ENABLED=true.

Features​

• Concentrated Topics can now be created with auto-managed flag. Backing topics will be automatically created and extended.
• Added support for Azure Managed Identity for Kafka authentication
• Added an optional configuration for SNI routing to define the separator to use when building host domain for brokers
• Added more context relative to interceptors in Audit logs
• Added the client & version (kafka-client, librdkafka, ...) of the client in the Audit logs on CONNECTED event

General fixes 🔨​

• Added Schema Registry validation on encryption plugins
• Fixed an issue where the KMS Key would not be created if it didn't exist
• Fixed an issue with logger API

Gateway 3.0.5​

Release date: 2024-06-04

Performance improvements 🚀​

• Performance is improved when using a large number of interceptors

Console 1.24.0​

Release date: 2024-06-19

Breaking Changes 💣​

New docker image name​

We have renamed the Console docker image to conduktor/conduktor-console to clarify our product naming. Final warning! This is the last version where we publish our images using both names. Please modify your installation to reflect this change in advance of us deprecating the name conduktor/conduktor-platform.

docker pull conduktor/conduktor-console:1.24.0

Change in ApplicationInstance Resource Type from GROUP to CONSUMER_GROUP​

We have renamed the resource type in ApplicationInstance from GROUP to CONSUMER_GROUP. This change is intended to prevent confusion with the newly introduced resources ApplicationGroup and Group.

---
kind: ApplicationInstance
spec:
  resources:
    - type: CONSUMER_GROUP        # Previously: GROUP
      name: "click."
      patternType: PREFIXED

Features ✨​

• Self-service
  • Subject
  • ApplicationGroup
  • Topic Catalog
• Manage Groups and Users using the CLI
• Topic list columns Produce Rate and Last Activity
• Active Data Policies in Topic Consume page
• Quality of Life improvements
• Fixes 🔨

Self-service​

There's a host of new functionality available providing a truly powerful self-service release. This comes from the addition of two new resources: Subject and ApplicationGroup

Application Teams can now manage their Subject resource lifecycle through IaC with the addition of the Subject object.

A new concept, ApplicationGroup lets Application Teams fully organize themselves within their Application scope to restrict who can do what over their resources within Console UI. It's a form of delegated RBAC.

Checkout the definitions below and find the full list of resource definitions via the Resource Reference documentation.

Subject​

This creates a Subject in the Schema Registry.

---
apiVersion: v1
kind: Subject
metadata:
  cluster: shadow-it
  name: myPrefix.topic-value
spec:
  schemaFile: schemas/topic.avsc # relative to conduktor CLI execution context
  format: AVRO
  compatibility: FORWARD_TRANSITIVE

ApplicationGroup​

Create an Application Group to directly reflect how your Application operates. You can create as many Application Groups as required to restrict or represent the different teams that use Console on your Application, e.g.:

• Support Team with only Read Access in Production
• DevOps Team with extended access across all environments
• Developers with higher permissions in Dev

# Permissions granted to Console users in the Application
---
apiVersion: v1
kind: ApplicationGroup
metadata:
  application: "clickstream-app"
  name: "clickstream-support"
spec:
  displayName: Support Clickstream
  description: |
    Members of the Support Group are allowed:
      Read access on all the resources
      Can reset offsets
  permissions:
    - appInstance: clickstream-app-dev
      resourceType: TOPIC
      patternType: "LITERAL"
      name: "*" # All owned & subscribed topics
      permissions: ["topicViewConfig", "topicConsume"]
    - appInstance: clickstream-app-dev
      resourceType: GROUP
      patternType: "LITERAL"
      name: "*" # All owned consumer groups
      permissions: ["consumerGroupReset", "consumerGroupView"]
  members:
    - alice@company.org
    - bob@company.org

Topic Catalog​

We're expanding on the Topic Catalog, to help teams discover Kafka Topics within your organization. You can now filter on all the topics based on user-defined, business metadata. Looking to request access to another applications resources? You can now generate the required ApplicationInstancePermission snippet that grants the necessary access to Topics belonging to another Application.

Manage Groups and Users using the CLI​

Manage your Console Group and Permissions lifecycle through IaC with the addition of the Group and User objects.
Checkout the example below and find the full definition via the Resource Reference documentation.

---
apiVersion: v2
kind: Group
metadata:
  name: developers-a
spec:
  displayName: "Developers Team A"
  description: "Members of the Team A - Developers"
  externalGroups: 
    - "LDAP-GRP-A-DEV"
  members:
    - member1@company.org
    - member2@company.org
  permissions:
    - resourceType: TOPIC
      cluster: shadow-it
      patternType: PREFIXED
      name: toto-
      permissions:
        - topicViewConfig
        - topicConsume
        - topicProduce

Topic list columns Produce Rate and Last Activity​

We added two new columns to the Topic List to help you troubleshoot and understand Kafka better: Produce Rate & Last Activity.

Values are computed once per Indexing (i.e. every 30s);

• Produce Rate is calculated from the two most recent offset values provided by our indexer.

• Last Activity is set to Datetime.now() if the latest offsets have changed since the last Indexing

Active Data Policies in Topic Consume page​

When exploring topics, fields masked by active Data Policies are now displayed in a different color, while the policy name is also now visible on hover.

Quality of Life improvements​

Topic pages

• You can now see all subjects associated to the Schema Id of the current message from the Message Viewer panel
• Added message Compression Type metadata in the Message Viewer panel
• Added buttons to navigate to previous and next message in the Message Viewer panel. Also works with the arrow keys
• The "Generate once" feature in the Produce tab now generates much more realistic, randomized messages, especially for Registry schemas and JSON

Other pages

• Added a button to force re-balance active Consumer Groups in the Consumer Group details page
• Added a "Test connection" button when adding a KsqlDB cluster in Settings
• Added KsqlDB query Start From selector, equivalent to the SET 'auto.offset.reset' command
• Added an icon in the Kafka Connect list to inform that auto-restart feature is active

API

• When returning a Forbidden error, the missing permissions are listed in the error message
• New endpoint to add user to a group by email

Conduktor CLI
Update your Conduktor CLI to 0.2.5

• Env Variable changed from CDK_TOKEN to CDK_API_KEY to set your Admin or Application API Key
• Added support for Subject field spec.schemaFile. Previous versions of the CLI will only accept spec.schema inlined.

Fixes 🔨​

• Clean monitoring metrics related to brokers that are unreachable
• Fix support of Avro byte arrays encoded as base64 when producing messages
• Fix bulk import of users in case a user already exist
• Fix user creation when the user is not admin but has the right permissions
• Fix class name selector when navigating from one interceptor to another
• External group mapping: support extraction of roles from both string array and comma separated string
• Fix preview of consumer group offset reset when selecting a specific offset
• Data masking: trim name of policy and fix encoding for URL
• Monitoring: show error in UI if cortex is unreachable
• Fix schema that disappeared from the form input when schema was invalid
• Prevent the creation of an application instance with resources that overlaps
• Fix permissions when 2 application instances define resources on the same cluster
• Fixed an issue where apiVersion was displayed at the end using the CLI

Gateway 3.0.4​

Release date: 2024-05-22

Performance improvements 🚀​

• Consumer group membership is no longer loaded synchronously
• Optimize hostname resolution for ACL

General fixes 🔨​

• GATEWAY_DOWNSTREAM_THREAD and GATEWAY_UPSTREAM_THREAD are now correctly gathering the number of cores
• in LargeMessageHandlingPlugin plugin, honor correctly the localCacheExpireAfterWriteInSeconds property

Gateway 3.0.3​

Release date: 2024-05-09

General fixes 🔨​

• Fixed an issue impacting the vault configuration key uri when special characters (i.e -) are present in the hostname.

Gateway 3.0.2​

Release date: 2024-05-07

General fixes 🔨​

• Fixed a race condition when closing connections (i.e. when Gateway detects a broker is removed from the cluster) that was causing restarts/timeouts
• Fix duplicated key exception when rebuilding fetch request with duplicated topics
• FIX NPE when handling expired ApiVersions requests
• Added a check to validate schema registry connection and provide more meaningful errors for schema-based encryption
• Added a check against defaultAlgorithm used in the encryption interceptor to ensure it's a valid enum value, and avoid overriding with defaults
• Fixed an issue with externalStorage set to true in the encryption interceptor that was failing to store headers in a separate internal topic
• Ensure that if the encryption algorithm is changed, a new entry appears in the internal topic used to store headers
• Default namespace is now applied properly on schema-based encryption
• Added support encryption/decryption of AVRO bytes and enums types

Console 1.23.0​

Release date: 2024-05-03

Future Breaking Changes 💣​

New docker image name​

We have renamed the Console docker image to conduktor/conduktor-console to clarify our product naming.

We will publish newer versions using both names for this release and the next release only. Please modify your installation to reflect this change in advance of us deprecating the name conduktor-platform.

docker pull conduktor/conduktor-console:1.23.0

Features ✨​

• Conduktor Console
  • Future Breaking Changes 💣
    • New docker image name
  • Features ✨
    • Self-service
      • Topic
      • TopicPolicy
      • Topic Catalog
      • Application API Keys
    • Editable columns on the Consume Page
    • Quality of Life improvements
  • Fixes 🔨

Self-service​

There's a host of new functionality available providing our first truly powerful self-service release. This comes from the addition of two new resources (Topic, TopicPolicy), application tokens, a topic catalog and service account synchronization.

Application Teams can now manage their Topic resource lifecycle through IaC with the addition of the Topic object, and they can do this safely with Platform Teams putting in place a Topic Policy to restrict expensive configurations and enforce naming standards.

Checkout the definitions below and find the full list of resource definitions via the Resource Reference documentation.

Topic​

This creates a Topic in the defined cluster.

---
apiVersion: v2
kind: Topic
metadata:
  cluster: shadow-it
  name: click.event-stream.avro
spec:
  replicationFactor: 3
  partitions: 3
  configs:
    min.insync.replicas: '2'
    cleanup.policy: delete
    retention.ms: '60000'

TopicPolicy​

TopicPolicy lets Platform Team define governance rules to restrict Application Teams to create Topics with misconfigurations. This is also useful to enforce naming convention or metadata annotation by Application Teams.

---
apiVersion: "v1"
kind: "TopicPolicy"
metadata:
  name: "click-naming-rule"
spec:
  policies:
    metadata.name:
      constraint: Match
      pattern: ^click\.(?<event>[a-z0-9-]+)\.(avro|json)$
    spec.replication.factor:
      constraint: OneOf
      values: ["3"]
    spec.configs.retention.ms:
      constraint: Range
      max: 604800000  # 7d 
      min: 3600000    # 1h

Topic Catalog​

We've introduced the Topic Catalog, to help teams discover Kafka Topics within your organization. Quickly get visbility on ownership and business metadata on your choice for topics.

Add topics to applications to see them appear within the catalog across all your clusters, searchable by name and labels.

Application API Keys​

Generate ApplicationInstance API Keys to create any ApplicationInstance scoped resources. Only ApplicationInstancePermission and Topic are supported at the moment.

Use this Key with the CLI to use it manually or within CI/CD pipelines.

In addition, Service Account's ACLs are now synchronized with the permissions from ApplicationInstance and ApplicationInstancePermission resources.

Read More about Self-service

Editable columns on the Consume Page​

You can now customise the columns you want to display in the Consume Page. Let us know if there's any additional metadata you want to see!

Quality of Life improvements​

Topic pages

• SchemaId is now displayed from the Message Viewer panel
• Header count is now displayed from the Message Viewer panel
• The More Options "..." button has been moved so that it's available from every Topic details tab
• Added a check to prevent producing empty keys to a compacted topic
• Added an "Add partitions" button in Partitions tab

Schema Registry pages

• The current schema is now inside a read-only area
• Increased the width of the side panel when creating/updating schemas
• Full height is used in the panel to show/edit the schema

Kafka Connect pages

• Kafka Connect List can now be sorted by the number of Tasks
• Removing a Connector now properly redirects the user to the Connector list instead of the Configuration tab of the deleted Connector
• Topics column is now sourced from more configuration keys (kafka.topic, kafka.topics, topic, topics)

Settings

• Permissions on KafkaConnect and ksqlDB now properly display the name instead of the UUID
• Adding Users to Groups can now be done from the User details page directly
• Added the Group name in the UI to be used in the API or CLI

Other

• Added Gateway version on the Interceptor List page
• Added a configuration option to toggle OIDC logout when logging out from Console
• Searching in screens now trims whitespace from the text supplied

Fixes 🔨​

• Fixed an issue with the Test Connection button that didn't work after a successful response
• Fixed an issue with the indexing of Confluent Cloud Managed Connect
• Fixed an issue with the Kafka Connect List where filter by Connect Cluster wouldn't work in some cases
• Fixed an issue with the Schema Registry indexer not properly handling a retriable HTTP error (GOAWAY)
• Fixed an issue with the timezone selector scrolling when resetting offsets for a Consumer Group by timestamp
• Fixed an issue with SSO in Azure environments for users who are members of a large amount of Azure groups
• The following fixes have also been back-ported in 1.22.1
  • Fixed an issue where two ACLs of the same name but with different pattern types (PREFIXED and LITERAL) were merged to the same group within the UI
  • Fixed an issue with OIDC login that could cause an expired session to become stuck and prevent login attempts
  • Fixed an issue with ksqlDB caused by not escaping the Stream or Table name in the query

Console 1.22.1​

Release date: 2024-04-18

Features ✨​

• Added support for Azure Managed Identity for Kafka authentication
• Implement OIDC logout. You may need to update your OIDC configuration to allow the root page of Console as a possible redirect URI

Fixes 🔨​

• Fixed an issue where two ACLs with the same name but with different pattern type (PREFIXED and LITERAL) were merged in the same group in the UI.
• Fixed an issue with OIDC login that could cause an expired sessions to become stuck and prevent login in again.
• Fixed an issue with ksqlDB caused by not escaping the Stream or Table name in the query.

Console 1.21.3​

Release date: 2024-04-18

Features ✨​

• Added support for Azure Managed Identity for Kafka authentication
• Implement OIDC logout. You may need to update your OIDC configuration to allow the root page of Console as a possible redirect URI

Fixes 🔨​

• Fixed an issue where two ACLs with the same name but with different pattern type (PREFIXED and LITERAL) were merged in the same group in the UI.
• Fixed an issue with OIDC login that could cause an expired sessions to become stuck and prevent login in again.

Gateway 3.0.1​

Release date: 2024-04-15

General fixes 🔨​

• Fixed some issues with Encryption when the value is a tombstone.
• Fixed some inconsistencies between the OpenAPI Spec and the actual implementation.
• Fixed a memory leak when using the default GATEWAY_UPSTREAM_CONNECTION_POOL_TYPE.
• Added a startup check to prevent an incompatible configuration: GATEWAY_UPSTREAM_CONNECTION_POOL_TYPE=ROUND_ROBIN with delegated authentication.

Console 1.22.0​

Release date: 2024-04-03

Future Breaking Changes 💣​

New docker image name​

We have renamed the Console docker image to conduktor/conduktor-console to clarify our product naming.

We will publish newer versions using both names for the next two releases only. Please modify your installation to reflect this change in advance of us deprecating the name conduktor-platform.

docker pull conduktor/conduktor-console:1.22.0

Features ✨​

• Conduktor Console
  • Future Breaking Changes 💣
    • New docker image name
  • Features ✨
    • Topic as a Service becomes Self-service
    • Conduktor CLI
    • Custom Deserializers
  • Fixes 🔨

Topic as a Service becomes Self-service​

Self-service is a replacement for Topic as a Service. It is more centered towards a GitOps way of working, though we have performed a migration for existing TaaS applications to ensure a seamless transition to the new model:

• Applications + Environments are migrated to Application and ApplicationInstance
• Cross Application accesses are migrated to ApplicationInstancePermission
• The Application list becomes Application Catalog
• At the moment, we decided that we should control everything from the CLI only. The UI will remain Read-Only for now, but the intention is to bring back UI-driven operations in a future release.

Read More about Self-service

To start using Self-service, you must download our Conduktor CLI which lets you deploy resource files in Console.

Conduktor CLI​

Console now has a CLI! Get Started with it today.

For now, we only support the following resources:

• Application
• ApplicationInstance
• ApplicationInstancePermission

Our objective is to let Application Teams and Central Teams manage both Console resources (Clusters, Groups, Permission, Self-service resources, DataPolicies, Alerts, ...) and Kafka resources (Topics, Subjects, Connectors, ...) using a common definition mechanism.

More to come, automate everything!

---
apiVersion: "v1"
kind: "ApplicationInstance"
metadata:
  application: "clickstream-app"
  name: "clickstream-app-dev"
spec:
  cluster: "shadow-it"
  service-account: "sa-clickstream-dev"
  resources:
    - type: TOPIC
      name: "click."
      patternType: PREFIXED
    - type: GROUP
      name: "click."
      patternType: PREFIXED

Custom Deserializers​

Console's support for Custom Deserializers is finally here!
A picture is worth a thousand words:

Check our dedicated How-To guide Installing and Configuring Custom Deserializers.

Fixes 🔨​

• Fixed an issue with controller metrics in Monitoring when the Kafka cluster is using KRaft
• Added support for Broker, Connect, and ksqlDB id field and TLS authentication in the YAML configuration file and Environment variables. This implies you might have a duplicate Connect instance if you use a YAML file with an ID for your Connect cluster. Check the Environment Variables page for more details
• Added new configurations to tune indexing batching and parallelization.s
• Fixed an issue with Azure PostgreSQL preventing the Schema Registry page from displaying properly

Gateway 3.0.0​

Release date: 2024-03-20

This major release of the Gateway brings functionality around targeting your interceptors more specifically, adding additional data quality & filtering tools and a host of rework under the hood for improved reliability & robustness. This can be seen in the form of reworked authorization to more closely align with what you're used to in the existing Kafka world and a more intuitive experience when working with the enhanced functionality Conduktor brings in concentrated and alias topics.

Features​

Interceptor Targeting​

Interceptors can now target more specifically than the previous scopes of vcluster and username. They can now be targeted at the global, vcluster, group(new), or service account level. Below are some areas and examples where targeting interceptors brings great power in their flexibility.

Apply interceptors on groups, across several service accounts, without duplicating the interceptor​

On a given Kafka cluster, each application may have different policy requirements.

Applications could be part of an organization's domain (finance, HR, Sales, etc.) or grouped by another dimension, such as data sensitivity. Platform teams will want to manage rules that apply to multiple applications at a "group" level.

Override behavior at a more specific service account, or group level​

Rather than apply interceptors across a wider domain, they may want to zoom in and target a specific application to override the wider defaults.

Examples:

A project from a domain is more advanced and doesn't need the safeguarding protections applied to the wider group.

• They know how to size topics correctly and are allowed a higher limit on partitions for topic creation, than the rest of the group
• Everyone is required to have compression enforced by default, but for this specific team they are allowed to remove it to meet a low latency requirement

Data quality validation rules across fields, using CEL​

Validate data across fields using Common Expression Language. Before we could define rules for fields within a schema, a great way to ensure data quality catching the data before it hits the cluster. Now, we can relate fields to each other. We can bring together data quality and business rules within our schema.

An example for age and email checks in our schema:

{
  "fields": [
    {
      "name": "age",
      "type": "int",
      "minimum": 18
    },
    {
      "name": "email",
      "type": "string",
      "format": "email"
    }
  ],
  "metatadata": {
    "rules": [
      {
        "name": "old people",
        "expression": "age >= 40 && email.endsWith('yahoo.com')",
        "message": "yahoo.com emails are allow only for people older that 40"
      }
    ]
  }
}

Filter messages on topics, using CEL​

Topic filtering can now be done with a simple plugin rather than building yet another pipeline. Effortlessly tailor message filtering rules to your use cases, ensuring only the most relevant data reaches your consumers.

Similar to how we allow you to filter data using SQL, you can now use CEL. By leveraging CEL expressions, you gain the flexibility to filter messages based on various attributes such as record key, value, partition, timestamp, header, and offset, offering unparalleled control over your data consumption.

Suppose you want to filter messages where the timestamp is greater than a certain threshold and the record key matches a specific pattern. With the enhanced CEL topic filtering feature, achieving this becomes straightforward as posting a plugin with the config:

{
  "virtualTopic": "your-topic-name",
  "expression": "record.timestamp > 1616400000000 && record.key.startsWith('prefix_')"
}

Topic multiplexing enhancements​

Several enhancements have been made when working with concentrated topics for topic multiplexing. Concentration can now be achieved on the default vcluster, passthrough. UX has been adjusted from using patterns only in favor of concentration rules, which have a dedicated part of the API.

Alias topic enhancements​

Alias topics (dedicated to referencing another topic within your cluster, see the docs for more) have been reworked for a more intuitive experience. Alias topics no longer replace the physical topic during interactions, but are seen as another topic. This will help in use cases related to migration, when applications use different topic names, and when exposing more topics within vclusters.

Default vcluster rework​

The default vcluster, passthrough, now has users associated with it by default rather than being rejected. This behavior can be reverted through configuration; see the docs for more.

General fixes 🔨​

• Fixed an issue that was prefixing consumer group names with Gateway in certain virtual clusters
• Simplified the security protocol experience, dropping the need for GATEWAY_MODE(s) to be defined, instead using Kafka standard security protocols or DELEGATED security protocols. Refer to the docs for more
• Less noisy metrics
• Configuration topics are now prefixed with the clusterID to prevent unintentional
• The PUT HTTP verb is now supported throughout the API
• ARM build is now available for the distro and distro-less images, to provide more flexibility to your deployment machine choices

Console 1.21.1​

Release date: 2024-03-05

Fixes 🔨​

• Resolved a problem causing a blank screen after login in certain situations, preventing users from accessing Console.

Console 1.21.0​

Release date: 2024-02-26

Future Breaking Changes 💣​

New docker image name​

To clarify our product naming we have renamed the Console docker image to conduktor/conduktor-console.

We will publish newer versions using both names for the next three releases only. Please modify your installation to reflect this change in advance of us deprecating the name conduktor-platform.

docker pull conduktor/conduktor-console:1.21.0

Features ✨​

• ksqlDB
• Metrics available via Prometheus
• Smart tables for Connect and Schema Registry
• Add Local Users from the UI
• Fixes

ksqlDB​

Say hello to seamless integration with ksqlDB for you and your team on Conduktor Console.
Grant permission to whom can access the interface to create queries, setup new connections and visualise the existing connections.

Now you can:

• Browse ksqlDB clusters that are connected to Console
• Visualize all the currently running queries as well as write your own queries or executes statements
• Visualize and act on the running Streams (resulting from CREATE STREAM statements) with the Streams tab
• Visualize and act on the running Streams (resulting from CREATE TABLE statements) with the Tables tab
• Show all the Persistent and Push queries currently running on the ksqlDB Cluster with the Queries tab
• Execute Pull and Pull Queries (SELECT) and Statements (CREATE, DESCRIBE, DROP, ...) with the Editor tab

More info about kSQL is available on their website.

For more information checkout the docs.

Subscribe to metrics via the Prometheus endpoint​

Gain deeper insights into your system's performance with metrics now readily available via the Prometheus endpoint. No need for yet another system to monitor, seamlessly integrate metrics directly into your external log system in the Prometheus format, allowing for effortless monitoring and optimization of Conduktor within your systems.

You can monitor metrics such as under replicated partitions, total & failed connector tasks and consumer group lags. For the full list of available metrics checkout the docs.

Smart tables for Kafka Connect and Schema Registry subjects​

Get the answers you need quicker with the new tables. Sort by what matters, be that subject name, version count, latest version and more! For Connect there's all the usual suspects: source/sink, topics, the connect cluster and importantly the state (e.g. Failed, Paused). Quickly find which connectors are failing with just one click.

Choose what columns to hide the noise. Filter on name, tags and other resource metatdata such as consumer group state.

Add Local Users from the UI​

Don't have SSO ? Now you can add Users directly from the Users & Groups page in Settings, instead of modifying the config file and restarting the Console.

Fixes 🔨​

• Added support for complex union-type avro messages in Console Producer
• Fixed a blank screen issue after login due to case-sensitivity bug with email address
• Fixed an issue where Message Reprocessing didn't work after refreshing the page
• Resolved an issue with MSK role assumption
• Fixed an issue with custom certificates for Schema Registry and Kafka Connect
• Fixed several issues improving indexing performance on large clusters
• Increased cortex ingestion limits for large clusters
• Fixed an issue that occurs when Group: ACLs are present

Gateway 2.6.1​

Release date: 2024-02-14

General fixes 🔨​

• GATEWAY_SECURED_METRICS=false would not allow to access the prometheus metrics without security. This is now fixed.

Gateway 2.6.0​

Release date: 2024-02-12

Schema based encryption​

You can now define your encryption requirement directly within your Schemas.

Here is an example using json schema where we specify that we want to encrypt the password and visa fields, with their corresponding keySecretId. We also tag the location field as PII and GDPR.

{
  "$id": "https://example.com/person.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Customer",
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "username": { "type": "string" },
    "password": { "type": "string", "conduktor.keySecretId": "password-secret"},
    "visa": { "type": "string", "conduktor.keySecretId": "visa-secret" },
    "address": {
      "type": "object",
      "properties": {
        "location": { "type": "string", "conduktor.tags": ["PII", "GDPR"] },
        "town": { "type": "string" },
        "country": { "type": "string" }
      }
    }
  }
}

The encryption configuration now supports defaults to simplify your setups

{
    "defaultKeySecretId": "myDefaultKeySecret",
    "defaultAlgorithm": {
      "type": "TINK/AES128_EAX",
      "kms": "IN_MEMORY"
    },
    "tags": [ "PII", "ENCRYPTION", "GDPR" ]
}

KMS now use cloud managed identities by default​

To prevent setting up manual connectivity, KMS are now using cloud managed identity by default

• AWS
• AZURE
• GCP

Cache KMS Time to Live​

You can now cache the KMS keys for a certain amount of time. This is useful to reduce the number of calls to your KMS.

keyTtlMs: The key's time to live in milliseconds. Default is 1 hour, disable the cache by setting it to 0

Override Header Injections​

Header config can now be further enforced with overrides, the plugin now supports overrideIfExists with default set to false. When set to true, the plugin will override the header if it already exists in the request. This can be useful for if a required piece of metadata is missing in the header, you can add something automatically whilst ignoring the ones that have set the value.

SSL Principal Extraction​

The SSL principal extraction is now configurable with GATEWAY_SSL_PRINCIPAL_MAPPING_RULES it will follow the same rules as Kafka.

General Fixes 🔨​

• Quieter responses to Prometheus by not publishing HTTP quantiles in the response
• Topic configuration is now returned in all Gateway modes
• Additional tools have been added to the base image to help with setup and debug: lsof, iotop, htop, iftop

Gateway 2.5.2​

Release date: 2024-02-08

General fixes 🔨​

• PUT can be used in both the User API and the Interceptor API to create resources when they don't already exist

Gateway 2.5.1​

Release date: 2024-02-07

General fixes 🔨​

• Append data quality error reporting to the the header produced in the Dead Letter Queue
• Added a swagger endpoint at /swagger

Gateway 2.5.0​

Release date: 2024-01-22

Schema-based data contract validation​

Check and enforce data quality at the schema level, preventing outages from missing or badly formatted records.

Gateway can now validate payloads against specific constraints for AvroSchema and Protobuf using the same validations provided by JsonSchema, such as:

• Number: minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf
• String: minLength, maxLength, pattern, format
• Collections: maxItems, minItems

If criteria are not met then informative feedback is provided such as, name is too short (1 < 3), hobbies has too few items (3 < 5) as well as the topic and field level information.

Example: Without validation

{
  "namespace": "schema.avro",
  "type": "record",
  "name": "User",
  "fields": [
    {"name": "name", "type": "string"},
    {"name": "age", "type": "int"},
    {"name": "email", "type": "string"}
}

Example: With validation

{
  "namespace": "schema.avro",
  "type": "record",
  "name": "User",
  "fields": [
    {"name": "name", "type": "string", "minLength": 3, "maxLength": 50},
    {"name": "age", "type": "int", "minimum": 18},
    {"name": "email", "type": "string", "format": "email"}
}

Sounds interesting, try it out for yourself with this demo or come chat to us for proper evaluation.

This can be combined with the SQL data quality producer plugin described below, or standalone.

SQL data quality checks on produce​

Check data quality with a SQL statement before it hits the cluster, ensure the data produced is valid.

If we want our cars topic only to allow messages where the cars are red AND younger than 2020, we can write this out as a SQL statement in the plugin's config, and post it to the Gateway, e.g.

{
  "statement": "SELECT * FROM cars WHERE color = 'red' and record.key.year > 2020",
  "action": "BLOCK_WHOLE_BATCH",
  "deadLetterTopic": "dead-letter-topic"
}

Messages not meeting this criteria should have the whole batch blocked, however, we also have the option to block only the bad messages, or allow them in and log the action in the audit log.

Rejected messages will throw up informative feedback on why the data quality is insufficient such as record is not produced because year is not > 2020, or because color is not red. These error messages will also added to the message header.

We also have a demo for you to try yourself.

Set config fields using environment variables​

Be able to alias all interceptor config fields using environment variables.

Set client ID on action​

ClientId is an optional field that helps identify applications within your Kafka. Requiring this is set presents opportunities such as speedier debugging by narrowing down which applications affect which messages, or quota management.

Rather than simply block messages that don't have it set, you can instead choose to override the message metadata to set one. This can be done on all Kafka verbs i.e. produce, consume, admin actions and more.

ARM build​

Conduktor Gateway is now available in an ARM build, not just AMD, to provide more flexibility to your deployment machine choices.

Interceptor API Upsert Support​

The interceptor API will now upsert (create if doesn't exist, update if exists) when making PUT calls.

General fixes 🔨​

• Fixed support for additional Kafka topic configuration properties such as retention.ms = -1

Gateway 2.4.0​

Release date: 2024-01-15

User management unification​

We refactored all authentication process to unify some concern accross all authentication mechanism in Gateway.

Previously, the gateway user was defined differently depending of your authentication choice (mTls, SASL plain, SASK Oauthbearer, Delegated). This made user management and interceptor targeting complex.

Today we've uncoupled the authentication process from the user identification to leverage the UserMapping added in Gateway 2.2.0, for all authentication processes.

All sucessfull authentication process will result in a Principal based on exhanged credentials (See information below to know how principal is detected based on your choice). This principal will be used to search in UserMapping the associated gateway user and it's information.

You can now easily create and manage Gateway users, associate them to your authentication provider and define gateway information in the same fashion.

New authentication flow :

API change​

The following UserMapping http API's now provide an optional body field principal to be able to define the principal for a mapping.

• /userMappings/v1
• /userMappings/v1/vcluster/{vcluster}

FAQ​

- Do I need to recreate all my users?

No, you don't. This new unified flow is compatible with existing credentials and if a mapping doesn't exist it will detect the Gateway User based on authentication information. User mapping will always have priority over authentication specific information like claims for SASL with Oauthbearer. That means that you can start managing your users with UserMapping while keeping your existing credentials.

- What is the principal extracted for my authentication ?

Here is the list by authentication mechanism that will be used as source for the principal:

- Is a principal and username the same thing?

No, depending on your authentication provider, the principal (the authorization id exchanged and validated) could be complex to manage. To solve this issue, a UserMapping defines a username and a principal.

• principal is the field used to search for a user based on an authentication
• username is the field to identify and target a user for Gateway processes (ACL, Interceptor targeting, ...)

By default if a principal is not defined when creating a UserMapping we define that the principal is the same as username.

Concentrated topics​

Logical partitions are no longer automatically remapped to another partition when their backing partitions are deleted.

Virtual clusters​

Virtual clusters are currently under rework and this release introduces some deprecations:

• We removed flags for Virtual topics no longer used
• We remove the ability to mark a real topic as physically deleted (a legacy product feature)
• We removed some string interpolation in the real topic concentration that were unused
• We deprecated some fields in the response of the internal APIs (these APIs will probably go away in the next release)

General fixes 🔨​

• Concentration: Fix transaction support (but the support is still a bit experimental)
• Concentration: Fix retention not emulated on policy=compacted,deleted
• Concentration: Fix retention emulation issue that could cause some message to reappear after decreasing retention
• Disabled auto topic creation in more scenarios

Gateway 2.3.2​

Release date: 2024-01-11

General fixes 🔨​

• ACL would not be applied in GATEWAY_SECURITY mode.

Gateway 2.3.1​

Release date: 2023-12-21

Enhancements​

Gateway mode​

You can now choose to setup your gateway in one of the following mode

• KAFKA_SECURITY where your credentials and ACL handled your target Kafka cluster
• GATEWAY_SECURITY where your credentials and ACL handled by Gateway
• VCLUSTER where your virtual clusters, credentials and ACL handled by Gateway

Previous GATEWAY_FEATURE_FLAGS_SINGLE_TENANT and GATEWAY_FEATURE_FLAGS_MULTI_TENANCY are migrated automatically.

ACL fixes​

Few ACL ordering/conflict patterns are now resolved. We are now following KIP679

Better error management​

Upon duplicate UserMapping creation we are now returning a STATUS_CODE_CONFLICT error code (or 409).

Gateway and Broker config​

Gateway properties are now visible in the broker properties page

General fixes 🔨​

• We renamed DuplicateResourcesPlugin into DuplicateMessagesPlugin to better reflect the intent of the plugin.

Console 1.20.0​

Release date: 2023-12-12

Features ✨​

• UI Navigation Overhaul
• Sort, Filter and Customize the Topic List & Consumer Group List
• Import records from CSV
• Other features and improvements
• Fixes

UI Navigation Overhaul​

Transition more seamlessly between different areas of the Console with a new UI experience. Everything Kafka related can now be accessed from the side bar, making it easier to navigate directly to your desired location in even fewer clicks. This change consolidates the app experience and puts all of Conduktor's power at your fingertips!

Sort, Filter and Customize the Topic List & Consumer Group List​

It probably looks underwhelming on the surface, but trust us... it's big! 🚀

On the menu:

• Sortable columns (size, messages count, partitions, ...). You can now sort by what matters to you. For example, the highest message count or the most partitions.
• Instant results. We are not querying Kafka, so it's fast whether you have 10 topics or 1,000 topics.
• Choose the columns that matter and hide away the ones that don't.
• Filters on name, tags and other resource metadata such as consumer group state.

Need more? Give us feedback on smart tables.

Import records from CSV​

Need to dump previously exported data back into Kafka? See how your application responsds to pre-prepared test data? We (finally) got you covered! From within a topic, navigate to the producer tab to utilize the new import CSV functionality.

Give us feedback on this feature.

Other features and improvements​

When adding a filter to search in a specific field, the input is now an autocomplete text field instead of a dropdown list. It's now even quicker to create your own filters on the fly!

The Table view quick filter buttons now generates Simple Filters instead of advanced JS filters.

Say goodbye to internal UUIDs! URLs are now taking advantage of the user-defined technical id making sharable links all the more readable with colleagues.

Fixes 🔨​

• Hide Provider tab secrets on the Cluster Configuration page
• Adding an ACL in the Service Account page now adds the entry at the bottom of the list
• Modifying filters in Topic Consume page or Topic/ConsumerGroup Lists page now resets the view to page 1
• Removed labels (member_host, consumer_id and client_id) in monitoring metrics to limit data points duplication generated during consumer group re-balances. This could cause ingestion limit issues in Cortex for large deployments
• Fixed an issue where wrong data could be displayed when recreating a different cluster with the same technical id
• Added support for Console certificates when making calls to Gateway API
• Optimized Memory configuration -XX:+UseContainerSupport -XX:MaxRAMPercentage=70 -XX:MaxDirectMemorySize=100m
• And many more UI fixes throughout the product

Gateway 2.3.0​

Release date: 2023-11-30

Features ✨​

Passthrough enhanced API UX​

New API paths have been added to the API for when GW is in the default Passthrough mode. This simplifies some of the interceptor paths by removing the need to include /vcluster/passthrough/.

Simple secret management​

Previously secrets had to be defined in the configuration of interceptors. Now, secrets can be stored on the client side setup in an environment variable which can be used by the interceptor.

Before

{
...
    "additionalConfigs": {
      "schema.registry.url": "yourUrl",
      "basic.auth.credentials.source": "some_source",
      "keySecretId": "password-secret"
    }
...
}

New option

{
...
    "additionalConfigs": {
      "schema.registry.url": "${SR_URL}",
      "basic.auth.credentials.source": "${SR_BASIC_AUTH_CRED_SRC}",
      "basic.auth.user.info": "${SR_BASIC_AUTH_USER_INFO}"
    }
...
}

Enhancements​

Encryption​

You now have the option of storing encryption configuration within a topic, rather than in the headers of the messages. This is a design option to be considered. Storing in the topic requires less storage, but now messages are no longer self-sufficient and will depend on this topic data. Set the environment variable for the name of the topic to be used and you're good to go. See the docs for more.

Audit log filtering​

Finding an issue or a specific event in your Kafka isn't always straightforward, especially on many physical, or virtual, clusters. With enriched properties of the audit log we can now filter on;

• Topic names
• APIKeys
• VCluster names
• Usernames
• Consumer Group Ids
• topicPartitions

General fixes 🔨​

• Changed behaviour for field level actions to be more lenient. Gateway will ignore fields that don't match the encryption or masking interceptor configuration, rather than throwing an exception
• Changed behaviour for Oauth authorisation to be more secure. Gateway will prioritise Conduktor user-mappings when looking for which vcluster to connect to, if no user-mapping exists it fallback on claims, if no claim exist, the authorisation fails.
• Fixed some typos in logs
• Bumped some internal versions to reduce CVE risk
• Fixed an issue that prevented the use of large message support on MSK
• Reduced image size through some optimisations
• Product analytics startup event restored, minimal Gateway start data is collected on launch to enhance product development. This can be deactivated with the environemnt variable
• Removed stack trace dumps on Safeguard catches
• Fixed SQL topics in single-tenant Gateway mode
• Further fixes for our Helm chart deployment options

Gateway 2.2.2​

Release date: 2023-11-15

Features ✨​

Full message encryption​

Conduktor Gateway gives you the flexibility and power of field-level encryption. However, sometimes you just want the simplicity of having the whole message encrypted. With the latest release you can now use the encryption plugin to encrypt the entire message at once.

Config for the interceptor requires connection to your KMS, or built-in, as well as how you wish to encrypt.

{
  "name": "fullMessage",
  "priority": 1,
  "pluginClass": "io.conduktor.gateway.interceptor.EncryptPlugin",
  "config": {
    "topic": ".*",
    "payload": {
      "keySecretId": "myKeySecretId",
      "algorithm": {
        "type": "AES_GCM",
        "kms": "IN_MEMORY"
      }
    }
  }
}

With a simple interceptor added we can acheive full message encryption.

Fixes​

Feedback to altering concentrated topics​

Concentrated topics will provide clear error messaging if you try to modify them. As concentrated topics from Conduktor are protected, in order to avoid disrupting a topic that is the source to several different applications, modifying anything other than retention.ms is prohibited. Now feedback is provided when attempting to do so.

General fixes 🔨​

• sql topics are now visible in Console when using passthrough mode
• More rigorous masking of potential secrets in logs
• More persistent garbage collection of consumer groups
• More performance when running many interceptors at once

Gateway 2.2.1​

Release date: 2023-11-07

Features ✨​

ACL Support​

We now support ACL in virtual clusters, just enable AclsInterceptorPlugin and you're in an ACL protected world! All your acl pipeline will work out of the box.

You can follow our ACL Demo

Aditional metrics for auditing​

Additional metrics for Kafka API keys to aid in auditing and debugging applications. Two new metrics are available via the Prometheus endpoint, the total errors per API key and the current inflight API keys, both are available on virtual cluster and username level. Checkout the monitoring docs for more!

gateway_current_inflight_apiKeys_total{apiKeys="Metadata",username="anonymous",vcluster="passthrough",} 10598.0

Cache​

Cache moved from core to the CacheInterceptorPlugin plugin

General fixes 🔨​

• There are some request types with fire and forget pattern. In such scenarios Gateway now behaves better
• Various performance and memory improvements from; threading model, task queue and cache refinements
• Less verbose logging

Console 1.19.2​

Release date: 2023-11-23

Fixes 🔨​

• Fixed an issue with the Reset Offset Preview in the Consumer Groups details showing incorrect target offsets
• Fixed an issue with Service Account page where prefix ACLs were saved incorrectly (prefix-* instead of prefix-)
• Fixed an issue with Service Account page where forcing an operation to "Not Set" caused an error on save
• Fixed an issue with Audit Log after upgrading from 1.18 and previous versions
• Fixed a UI issue where ACLs could not be deleted by non-Admin group members
• Fixed multiple UI issues with Topic As a Service
• Added new configurations for better OIDC support (allow-unsigned-id-tokens and preferred-jws-algorithm)

Console 1.19.1​

Release date: 2023-11-09

Fixes 🔨​

• Massive improvement over the indexing time of your cluster. This is especially notable if you have a large number of consumer groups (> 200) on your Kafka cluster.
• Fixed an issue where Gateway Interceptors could be created/deleted by all users instead of Admin group members.
• Fixed an issue where Monitoring didn't work for non-Admin group members.
• Fixed an issue that occurred when deleting a user from Console.
• Fixed a UI issue where ACLs were not editable by non-Admin group members.
• Fixed a UI issue where user could not pick the Kafka Connect cluster when creating a new Connector.

Gateway 2.2.0​

Release date: 2023-10-27

Features ✨​

Usage metrics per topic and vcluster​

The gateway.bytes_exchanged.topic metric now shows the total bytes exchanged, for a specific topic. This can be measured on fetch or produce.

gateway_bytes_exchanged_topic_total{vcluster="vcluster-test", topic="topic-test", apiKeys="Fetch"}

Field level decryption​

Decryption can now be performed on a field level basis enabling encryption of several fields and then selective decryption of fields depending on the user (application).

Fields can be defined in the decryption interceptor configuration;

      "fields": [
         "visa",
         "sales.account.username"
      ]

OAuth principal to vcluster mapping​

When you don't have the luxury to specify claims, we now provide the ability to map Oauth principals to vclusters, for usernames, through the Gateway API.

For example; here you are mapping the username, conduktor to the vcluster, my-vcluster.

curl --location ‘host:port/admin/userMappings/v1/vcluster/my-vcluster’ \
--header ‘Content-Type: application/json’ \
--user “admin:conduktor” \
--data ‘{
    “username”: “conduktor”
}’

This is documented within the API docs also.

General fixes 🔨​

• Patched ACLs visibility to be isolated across vclusters
• Consistent use of trailing slashes in the API calls, will now work including the / or ignoring it is supported
• Set Gateway's GID in the distro baseimage to 1000, to aid in container management and interactions
• Fixed an issue with create topic policy enforcement compatability on different compression types
• When running clusters with several thousand topics Gateway application performance has been improved
• Better SSL support during cluster switching

Console 1.19.0​

Release date: 2023-10-30

Features ✨​

• Conduktor Console
  • Features ✨
    • Consume live messages
    • Consume messages infinitely
    • Consume between dates (and obtain count statistics)
    • Provider Integrations within Conduktor Console
    • Conduktor Gateway Integration
    • Aiven Cloud Integration
    • Confluent Cloud Integration
    • YAML and Environment Variables for Clusters
    • Better memory configuration
  • Fixes 🔨

Consume live messages​

You can now consume live messages from within the topic consume screen. Simply set the limit filter to None and you'll see new records flowing as they are being produced. Streaming data is beautiful, isn't it? 😉

Consume messages infinitely​

We have finally said goodbye to the 5000 records limitation! If you wish to consume 100k records, 10M records, or even an entire topic, it's now possible! Note that for performance reasons, your browser will only store the most recent 5000 records available for browsing, or for use via the export feature.

Warning, we're not responsible for the sudden spike in your billing for Bytes-Out.

Consume between dates (and obtain count statistics)​

If you want to know how many messages were produced between two datetimes, you know have a new limit option dedicated for this. Simply apply the following filters:

• Show from: {datetime}
• Limit: {datetime}

It works particularly well in conjunction with filters, whereby you can now count how many messages matched your filters and how many total messages were produced between those dates.

Note that in the example below, 190 records matches the filter conditions, out of the total 10,522 consumed.

Provider Integrations within Conduktor Console​

Connect with your Kafka Provider to manage their benefits directly in Conduktor Console. With this first iteration, we bring features to Console that are only available with the provider's APIs.

Conduktor Gateway Integration​

You can now connect our other product artefact, Conduktor Gateway, to the Conduktor Console. This enables you to configure interceptors on Gateway virtual clusters through a dedicated set of pages accessible via the Gateway Interceptors tab.

Note that you will need to be connected to a Gateway cluster to utilize this feature. You can explore interactive demos below:

• Configure end-to-end encryption on Kafka topics
• Enforcing governance on configurations when creating topics

Aiven Cloud Integration​

We now support the following resources from Aiven Cloud:

• Manage Service Accounts
• Manage ACLs

To manage Aiven resources, navigate to the Service Accounts screen when connected to an Aiven Kafka cluster.

Confluent Cloud Integration​

We now support the following resources from Confluent Cloud:

• Manage Service Accounts & ACLs
• Manage API Keys

To manage Confluent Cloud resources, navigate to the Service Accounts screen when connected to a Confluent Cloud Kafka cluster.

YAML and Environment Variables for Clusters​

Kafka Clusters, Schema Registry and Kafka Connects configurations are now properly synced when configured from Yaml and Environment Variables (ie. GitOps way)

clusters:
  - id: ccloud
    name: Confluent Cloud ABCD
    bootstrapServers: lkc-abcd.europe-west1.gcp.confluent.cloud:9092
    properties: |
      security.protocol=SASL_SSL
      sasl.mechanism=PLAIN
      sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required \
        username='<CLUSTER-API-KEY>' \ 
        password='<CLUSTER-API-PASSWORD>';
    kafkaflavor: # Optional, for Service Accounts & Api Key support
      type: Confluent
      key: "<GLOBAL-API-KEY>"
      secret: "<GLOBAL-API-SECRET>"
      confluentEnvironmentId: "env-abcd"
      confluentClusterId: "lkc-abcd"
    schemaRegistry:
      url: http://abcd.europe-west1.gcp.confluent.cloud/
      security:
        username: <REGISTRY-API-KEY>
        password: <REGISTRY-API-PASSWORD>
    kafkaConnects:
      - id: kafka-connect-1
        name: Connect 1
        url: http://kafka-connect-1:8083/
        security:
          username: username
          password: password
    

Previously, configuring clusters using Yaml or Environment Variables was acting as INSERT-only (ie. Not Gitops).

We still recommend the use of Console API to maintain your Cluster configurations

Better memory configuration​

RUN_MODE is gone!
We now rely on container CGroups limits and use up to 80% of container memory limit for JVM max heap size. Our settings are the following

-XX:+UseContainerSupport -XX:MaxRAMPercentage=80

What does it mean for you?
You now only need to care about the limits that you set to your container.
Read this article to understand what this is about.

Fixes 🔨​

• Optimized the AdminClient instances usage across Console, by reusing a shared instance as much as possible. This will hugely decrease the number of AdminClient authentications.
• Fixed an issue on Consumer Group details where unassigned partitions were showing as part of an active member
• Fixed an issue on Consumer Group Page where pagination and search didn't work together properly
• Fixed an issue with JS filters when keys contain special characters like '.' or '-' (Use value["custom.key"] instead of value.custom.key)
• Fixed an issue where Console Group description could not be updated
• Added a message and link to documentation when browsing monitoring while it's not configured
• Fixed an issue that sometimes forced users to cleanup their browser cache after restarting Console
• Removed output logs that were not useful and added others
• Added flushing metrics on AWS S3 or Azure Blob Storage when cortex shuts down, preventing monitoring data loss during restarts or updates
• Added support for array in Environments Variables (ie. CDK_SSO_OAUTH2_0_SCOPES=scope1,scope2)
• Added support for Cortex configuration overrides (mounting a file in /opt/override-configs/cortex.yaml)

Gateway 2.1.6​

Release date: 2023-10-06

Features ✨​

Support Vault login/password​

When configuring the connection to the Vault Key Management System (KMS), you have two options for authentication: using a token, or a username password pair. You can choose one of the following methods based on your security requirements and environment:

• uri
• token (Token auth method)
• username (Userpass auth method)
• password (Userpass auth method)
• version

Add black/whitelist of properties​

Define which properties can or cannot be modified by safeguarding the configuration of the alter topic and alter broker policies. You can now define which parts of the config cannot be modified, and what do to when an attempt to change them happens. e.g. if you want retention time for topics on this virtual cluster to not be modified, you can add them to the blacklist.

Enhanced Gateway caching​

Fixed an issue where part of the caching functionality available in GW could lead to a memory leak in certain conditions. It can now also support consumption of multiple topics mixing between those that are cached or not cached.

Improved handling of invalid Kafka properties​

Previously, when invalid Kafka properties (variables, including custom, with prefix KAFKA_) were detected Gateway may fail to start. Now, they are logged as invalid with a WARN and excluded from the connection properties.

Additional debugging tools​

The Gateway distro image version now runs with a gateway user, rather than running as root. The recommendation for production where security is required remains the distroless image variant.

An additional debug API documentation is available at /debug', with the same login credentials as the admin API. This proivdes admins with additional debug and maintenance operations such as changing the Java logger level or interacting with topic mappings.

General fixes 🔨​

• Fixed an issue where consumer group policy and limit commit offset policy might not be enforced
• Fixed an issue where some scenarios could lead to inconsistant partitions on concentrated topics
• Improved handling on some Kafka properties to WARN
• Safer SSL Keystore loading. Gateway will now shutdown when provided keystore is invalid. This behavior will apply at startup and when keystore is reloaded over time
• Display username in audit for expired tokens. When a token expires or there is an error, we now set username as the username rather than anonymous

Console 1.18.4​

Release date: 2023-10-18

Fixes 🔨​

• Fixed an issue that prevented Console to function properly with PgBouncer
• Fixed an issue where properties (default.api.timeout.ms & request.timeout.ms) were mistakenly overridden, leading to possible timeouts on large Kafka Clusters
• (1.18.3) Fixed a performance issue on the Topic List page, leading to possible timeouts on large Kafka Clusters

Console 1.18.2​

Release date: 2023-10-04

Fixes 🔨​

• Fixed an issue on the Consumer Group List page that caused the page to timeout with a high number of consumer groups.

Gateway 2.1.5​

Release date: 2023-09-22

Features ✨​

Addition of a consumer group policy​

You can now ensure smooth Kafka consumer group operation by enforcing naming policies on groupId, clientId and policies on timeouts.

Consistent vcluster name in passthrough mode​

Historically when running in Passthrough mode, we had a unique vcluster for each user. Now all users will share the same vcluster named passthrough.

Expired token error includes username​

When a token was expired or another token error, we always set username as anonymous. Now, if a token has expired, we'll set username with it's username claim info.

General fixes 🔨​

• Fix a bug where we could surface internal headers on concentrated topics which would confuse Kafka streams
• Fix a bug in CreateTopics verb handling when validate_only = true, we would create the actual topic
• ProducerRateLimitingPolicy now requires maximumBytesPerSecond to be explicitly set
• Caching interceptor now better handles transaction markers
• When creating interceptors with empty config this is now surfaced as an error

Gateway 2.1.4​

Release date: 2023-09-13

Features ✨​

Support OAuth SASL Mechanism​

We now support OAuth allowing you to connect clients without having to change from your existing authentication setup. For more info on setup checkout the docs or contact us directly.

Security provider / FIPS​

New encryption security providers are now available when encrypting data. The security provider is set via a feature flag GATEWAY_SECURITY_PROVIDER, and the options available are:

• Bouncy Castle
• Bouncy Castle with FIPS
• Conscrypt

You can now be FIPS compliant when doing field level encryption

REST Audit​

All admin API calls are now logged in the audit log.

Dynamic port allocation​

When not defined the GATEWAY_PORT_COUNT variable is now computed on the fly, rather than static allocation on start. Note that the recommended production value is double the number of Kafka brokers.

Support all properties when protecting topics​

When putting interceptors in place to protect the creation of topics, or altering of topics, we have expanded our support for policies to be defined by all properties in the Kafka topic configs.

SCRAM Passthrough​

Gateway's passthrough mode has been expanded to support SASL_SCRAM.

General fixes 🔨​

• More clarity to some of our logging error messages, more clear what to do for a failure
• Improved garbage collection to clean up topic mappings upon deletion
• Fixed an issue with virtual topics not behaving correctly in Passthrough mode
• Improved API handling on Passthrough mode with better feedback when incorrectly attempting virtual cluster operations
• Fixed a formatting issue when requesting details on an interceptor from the internal API
• Improved handling when doing mass deletes in parallel
• Fixed an issue with priorities on interceptors

Gateway 2.1.2​

Release date: 2023-09-01

General fixes 🔨​

• More detailed API responses from the admin API. 201 & 203 codes now returned, as well as additional messages on create and deletion of resources
• Fixed an issue fetching offsets for invalid partitions
• Fixed an issue to more thoroughly delete topics
• Improved robustness when creating or deleting topics at higher throughputs
• Fixed an issue with consumer groups on deletes

Console 1.18.1​

Release date: 2023-09-26

Fixes 🔨​

• Increased timeout from 30s to 5m when indexing snapshots (used for caching list pages) of Kafka clusters
• Fixed a DB issue that prevented authentication to succeed when the generated token was longer than 255 characters
• Fixed an issue with cortex (conduktor/conduktor-platform-cortex) when console (conduktor/conduktor-platform) is configured with HTTPS
• Fixed an issue where LDAP users could not see or configure Alerts under certain circumstances

Console 1.18.0​

Release date: 2023-09-11

This release contains several breaking changes so please read the entire release note prior to installation.

Important changes to our internal architecture ❗​

We are cleaning up our Docker image to bring you a simpler, lighter, and generally more operable product.

• We have extracted the 'Storage & Alerting' aspect of the Monitoring Solution from the base Console image and moved it to a dependency image
  • If you didn't use Monitoring, no further action is required from your part
  • If you used Monitoring, read the documentation to understand how to deploy and configure the dependency image conduktor/conduktor-platform-cortex:1.18.0
• We have removed the embedded Postgres Database from the Docker image
• We have removed Testing from the base image
• We have rewritten our authentication module. If you have any issue with authentication using LDAP or OIDC with this new release Contact Conduktor Support

Features ✨​

User Friendly Filters​

We have completely revamped our filtering UX in the Consume page to be more aligned with your day-to-day use cases. Now you can search your topics by combining any of the following filtering mechanisms.

Simple Filters​

Search for any text in your messages either in your Key, or Value, using basic operators like "equals" or "contains".

Field Filters​

If your message is JSON, Avro or Protobuf, find values from specific fields. Operators can match the selected field type.

Advanced Filters​

For when you require more complex rules, Advanced Filters will give you the full power of JS to construct your own custom filters.

New Design for Service Accounts & Kafka ACLs​

We've overhauled Kafka ACLs and service account management. Visualize, create and edit your Kafka ACLs right within the UI with a simple but powerful design. Pair this with our market leading RBAC capability to empower only those that need it .

Reduced Memory Footprint​

As a result of our improvements to our internal architecture, we are happy to share that we have lowered our hardware requirements.
If you are currently deployed in prod using RUN_MODE=nano or RUN_MODE=small, please update the RUN_MODE based on your available memory after looking at our documentation.
If you are using higher RUN_MODE, you can free up some memory and save on infrastructure costs.
Visit our System Requirements page to see the changes.

Fixes 🔨​

• Fixed a UI issue where Add Partitions wasn't possible when using Firefox
• Fixed some UI issues with Kafka Connect and RBAC
• Added the "Last Indexed Date" info in the Consumer Groups List, to inform the user about the snapshot age
• Fixed an issue where Consumer Groups Details was populated from the snapshot, instead of AdminClient calls
• Fixed an issue where the Delete Consumer Group modal remained opened after deleting the Group
• Fixed an issue where users with Empty Topic permission were also allowed to Create Topics on the same scope
• Fixed an issue where users were logged out of Console when trying to access Datamasking without permission

Gateway 2.1.1​

Release date: 2023-08-25

General fixes 🔨​

• Moved configuration of mTLS to the environment variable level, checkout the docs for more
• Improved some API responses to more clearly reference virtual clusters and interceptors
• Fixed an issue listing offsets with latest version of Confluent, 7.5.0
• Improved handling for scenarios where topics are altered outside of Gateway

Gateway 2.1.0​

Release date: 2023-08-25

General features​

mTLS support for clients to Gateway​

Gateway now supports mTLS connetions between clients and the Gateway. We are constantly expanding our offering to meet the demands of our customer's environments and are excited to bring mTLS compatability.

Metrics on Prometheus​

Gateway exposes several health metrics on the available endpoint to help you monitor the health of your deployment. Checkout the docs for the available metrics on our docs site. If there are any you would need or like to see don't hesitate to submit a feature request on our public roadmap.

General fixes 🔨​

• Fixed an issue with token generation where a small percentage generated would be invalid, requiring an early regeneration
• Improved handling of timeout errors: Clients will now be better informed when timeout issues occur.

Gateway 2.0.1​

Release date: 2023-08-21

General fixes 🔨​

• Improved error handling on start: When faced with issues to do with missing keystores or inadequately configured port count, we'll throw you some better error messages
• Improved robustness of memory handling during network outages
• Improved robustness for the audit log
• Improved robustness when scaling
• Renamed GATEWAY_HOST to GATEWAY_ADVERTISED_HOST : Don't worry it will still work with the old value too!
• Include token detail on expiry: When tokens expire the token detail is provided in the expiry message

Console 1.17.3​

Release date: 2023-08-21

Features ✨​

• Replace the alert threshold column with the full underlying query in the 'Alerts' table.
• When creating alerts, you can now type in the dropdown selection of the resource (e.g. topic name, consumer group name) to improve usability when creating/editing alerts.

Fixes 🔨​

• Fix a case whereby saving alert did not preserve the consumer group name filter. Instead, saving or editing an existing alert would default to 'all consumer groups'.
• Fix N/A representation of delay (lag/s) for consumer groups in 'Apps Monitoring' to be more helpful. Lag is now labelled as 'infinite' in cases whereby lag exists in the group, but no new data is being received and no members exist in the consumer group.
• Remove the default alert 'No consumer group should be more than 3 minutes behind' for new clusters added to your environment. This was causing false positives in customers environments (e.g. non-production groups) and therefore it's advised to set alerts on explicit groups you wish to be alerted on. For existing clusters, if the alert is causing you to be notified on groups you do not wish for, then it's recommended to deactivate this alert.

Known issues ⚙️​

• Upon adding a new Kafka Cluster, Built-in Alerts & Custom Alerts are not working. You must restart Conduktor after adding the Kafka Cluster for changes to take effect.

Gateway 2.0.0​

Release date: 2023-08-18

General features ✨​

Passthrough security for a simple setup experience​

You have several options when connecting your clients to Gateway. We have added the option for Passthrough security for a simple, quick setup experience. With Passthrough security Gateway passes the existing credentials straight through to the backing cluster with no further checks. This is likely what you will use out of the box.

API overhaul for an improved developer experience​

Our admin API for creating virtual clusters, adding plugins and more has been overhauled for a much simpler and more consistent experience. It is available on your local http server for the version you are running or check it out online! developers.conduktor.io.

Simple OOTB load balancer​

A simple load balancer that will randomly select an instance of Gateway as connections are routed, allowing you to get started without having to setup any load balancer from the start.

Log Datetime format configurable to suit your setup​

Date time format of log can now be updated using the LOG4J2_TIME_FORMAT env var (Default is set to yyyy-MM-dd'T'HH:mm:ss.SSSZ). Options for patterns are available on the log4j site.

Troubleshooter & Distroless product variants now available​

Gateway is now available with an additional variant of the image, the default image now has enhanced debug tools embedded (curl / kcat / nc / kafka cli) to help with your setup and everyday usage. For those who want the top level of security a distroless variant is also available where needed to meet tighter security requirements in production.

Conduktor Data Security​

Encryption for partners​

When working with external partners sharing data can be difficult, time consuming or costly. Gateway now offers a straightfoward solution to this industry problem, encrypting field-level data for certain Kafka consumers only. By creating a username with the 'consume' encryption plugin, it allows you organization to share data with external partners, without the need to duplicate data or make additional architecture changes.

Encryption and Masking support for non-string fields​

Gateway encryption now supports values beyond type string, this is available for avro, protobuf and json formats.

Support for dynamic secret keys​

Gateway can now support dynamic secret keys, in this way you can delete keys for decryption thereby cryptographically shredding this data forever.

    "fields": [
    {
        "fieldName": "password",
        "keySecretId": "hcvault://vault:8200/transit/keys/secret-for-{{record.value.name}}"
     }
    ]

Conduktor Governance​

Additional header injection fields​

New fields for the header injection plugin including; Virtual cluster name, Username, Client id, Gateway instance ip, Gateway Version, ApiKey version, Timestamp (this is the timestamp of the injection).

Enhanced error reporting​

When interacting with several of the Goverance features to safeguard your Kafka the topic(s) that are affected are returned in the error message back to you. This detail is provided in the topic creation, topic alter, produce and limit join group policies.

'Request parameters do not satisfy the configured policy. Topic 'cars' with retention.ms is '5184000000', must not be greater than '432000000'

Conduktor Optimize​

Reduced costs for multi-az deployments​

Kafka clusters are often distributed across multiple availability zones (AZ), especially in Cloud deployments. Kafka offers some facilities to reduce expensive cross-DC traffic. (see KIP-392, KIP-881). We've introduced awareness of the, configurable, rack id, allowing you to limit Gateway to only choose nodes in the same rack as the target broker.

Console 1.17.2​

Release date: 2023-08-04

Fixes 🔨​

• Fixed an issue on the consumer group list screen which could inflate the number of members in a group. This was a result of migrating to the internal 'snapshot' cache for improved performance, and missing a case whereby we did not clean up old consumer group members.

Known issues ⚙️​

• Upon adding a new Kafka Cluster, Built-in Alerts & Custom Alerts are not working. You must restart Conduktor after adding the Kafka Cluster for changes to take effect.

Console 1.17.1​

Release date: 2023-07-28

Features ✨​

Overhauled RBAC (Role-Based Access Control)​

Our new RBAC has finally arrived! The previous roles 'Editor' and 'Viewer' have been remapped to granular permissions for each associated resource.

You can now precisely configure everything Conduktor & Kafka related to perfectly fit your requirements.

More details can be found on the docs site.

Give us feedback on this feature here.

Public APIs & Support for Automation​

We have opened Conduktor to being controlled using APIs.

The first iteration covers the following resources:

• Manage Clusters
• Manage Users, Groups and their respective Permissions (linked with our new RBAC!)

To start using the Conduktor API, navigate to API Keys in Settings and generate a new API Key.

Open API documentation portal is available on /docs of your deployment (i.e. http://localhost:8080/docs).

Fow now, only members of the Admin group can generate API Keys and access the API.

Give us feedback on what you would like to see in the API next here. You can also refer to the docs here.

The following example lists the permissions associated to your group "project-a".

curl -X GET http://localhost:8080/public/v1/groups/project-a/permissions -H "Authorization: Bearer {token}"
[
    {
        "resourceType": "Topic",
        "clusterId": "local",
        "topicPattern": "projectA-*",
        "permissions": [
            "topicConsume",
            "topicViewConfig"
        ]
    },
    {
        "resourceType": "ConsumerGroup",
        "clusterId": "local",
        "consumerGroupPattern": "projectA-*",
        "permissions": [
            "consumerGroupView"
        ]
    }
]

Major performance boost to both the Topic and Consumer Group List pages​

Topic List and Consumer Group List are now served by snapshots which lead to a huge performance boost!

To limit the impact on your Kafka Cluster, we have switched from direct AdminClient calls to an intermediate snapshot that we refresh every 30seconds behind the scenes.

You should see a major performance improvement when listing your Topics and Consumer Groups, especially in larger environments. The snapshot serves all of your users which will drastically reduce the number of AdminClient calls in parallel and is updated every 30s.

Service Accounts Page​

A new "Service Accounts" item is available in the menu under ACLs. This is a new presentation of the ACLs, grouped by Service Accounts to drastically improve readability. For now it's read-only, so continue to use the ACLs page if you want to Create/Delete ACLs.

Let us know if you want more from this feature by providing feedback.

Table View in Consume with Quick Filters​

When you click a message in the Consume page, you will now see the Table Structure view of the message.

This works for most serializers that render JSON-compatible structures.

Along with each key-value line, you will also have the option to build a filter directly from the message data.

Precision regarding the timestamp timezone​

In order to prevent confusion regarding the timestamp of the message, we have renamed the column 'Timestamp' to 'Timestamp (Local)'. This shows the timestamp in your browser's timezone configuration.

To further alleviate any doubt, you can also mouse over the timestamp in the Consume page, which will present you with the ISO DateTime in UTC.

Fixes 🔨​

• Fixed a UI issue where Clusters configurations that use Kerberos or Oauth did not render properly
• Fixed a regression where Kafka password was displayed in the logs
• Disabled IPV6 listener in the docker image
• Fixed a bug preventing to access Consumer Group Details page from the Consumer Groups tab in Topics Details page
• Added Connection Pooling to reduce the number of active connections to the database by 25%
• Removed an error message in Broker page when there was no partition on the cluster
• Added support for Amazon RDS Proxy

Known issues ⚙️​

• Upon adding a new Kafka Cluster, Built-in Alerts & Custom Alerts are not working. You must restart Conduktor after adding the Kafka Cluster for changes to take effect.

Console 1.16.3​

Release date: 2023-07-03

Features ✨​

Config ID maps to technicalID​

When configuring initial setup using a .YAML, the id value will now map to the technicalID of the cluster setup.

clusters:
  - id: eastern-horizon
    name: My Local Kafka Cluster
    color: '#0013E7'
    bootstrapServers: kafka:9093

Set idle session timeout​

Configurable maximum session lifetime for authentication was introduced in 1.16.1. You can now additionally set a value for idle session timeout. This will log your users out of Conduktor if they are inactive for a user-defined period of time. Read about how to use these new configurations in the docs.

Fixes 🔨​

• Large topic list handling. Some of our latest and greatest work wasn't playing nicely when the number of topics was high, we've fixed that
• Improved offline environments. Some customers were experiencing issues when using completely offline environments, we've made some improvements to error handling, the error messages displayed and how we work with timeouts
• Connector restart history. One of our latest features for automatic connector restarts gave you all the lovely history so you can see what's going on, perhaps too much ;). We've refined this so that each connector only displays it's own history
• Connect first cluster improvements. When connecting your first cluster there were a few too many buttons available to click, which didn't take you where you wanted to go. We have disabled more of those to make it even clearer on how to get connected
• App version label restored. Some of you have noticed the app version label in the UI was removed and want it back, we hear you. You'll now find the current version of Console back where it was before, in the bottom left corner of the UI
• Squashed a bug with trailing slashes getting stuck on blank pages
• Improved error handling for tokens expiring
• Fixed a bug that prevented you to browse consumer groups with an empty name

Console 1.16.1​

Release date: 2023-06-16

Features ✨​

• Automatic connector restarts
• New home experience
• Configurable max session lifetime
• New 'by broker' view
• Show offsets in consumer group details

Automatic connector restarts (Beta feature)​

Failed Connector tasks could already be restarted from within Console at the click of a button.

Simply navigate to the instance of interest, click into it and from here you can manually restart.

Being able to manually restart from our UI without having to look elsewhere in your Kafka ecosystem is powerful, but we now have the ability for automatic connector restarts to be enabled!

You can configure Console to attempt to restart failed tasks as frequently as every ten minutes. If they are failing more frequently than this we suspect you have bigger issues to look into. 👀

And if that wasn't enough, we even differentiate between automatic and manual restarts within the connector.RestartedTask audit event.

New Home experience​

The Console home experience has been reworked to get you where you want to go quickly!

From the homepage you can now jump straight into connecting your clusters, viewing your most recent topics, or managing users, groups and permissions. You will also find a few more handy quick links 👀

Configurable max session lifetime​

You can now configure the maximum session lifetime for your users. This means your users will be forced to re-authenticate after a maximum period that you define.

See the documentation on how to configure this value. Note that the current default value is set to 3 days.

New 'by broker view'​

We have now added a new view in the Topics > Partitions tab that enables you to see a breakdown of partition leaders and partition replicas at a broker level.

Show offsets in Consumer Group details​

The Consumer Group details page has now been enriched with the 'End Offset' and the 'Committed Offset' for each Topic and Partition.

Fixes 🔨​

• Fix the JQ filter in Console
• Fix showing metrics for consumer groups with blank name
• Slack channel alerting now supports 500 channels, previously it was restricted at 100

Monitoring​

Features ✨​

Object storage support for external storage​

You can now configure monitoring to export data to other additional object storage providers such as GCS, Azure and Swift. This builds on what was previously only support for S3.

Fixes 🔨​

Alert channel list increased to 500​

• Fixed an issue when settting up alerts you could only pick from the first 100 channels that were available, now the list allows selection from up to 500.

Console 1.15.0​

Release date: 2023-05-15

Conduktor version 1.15.0 is now available, introducing various new features and optimizations. This release brings an enhanced Audit experience to Enterprise customers, data export functionality into Console, and organization-wide tagging of resources. See the full list of changes and release notes below.

Important changes ❗​

• Note that in 1.15.0, the Testing application will no longer be started by default in the on-premise deployment. This provides a performance optimization for those customers that are not currently using Testing. If you wish to start Testing alongside Conduktor, you should set an explicit environment variable. See the documentation for more information.

Features ✨​

Give us feedback here

• Admin

  • Audit Log has been completely revamped and enriched. Events now contain relevant contextual information (upon click), and logs can now be filtered by a range of criteria (user, resource type, resource name, event, cluster and date).

• Console

  • Tags are now organization-wide, meaning visibility of this additional metadata is shared amongst colleagues in your organization. See the docs for more information.
  • You can now export data in either CSV or JSON format via the Consumer view. See the docs for information on how.
  • When using multiple JS filters in the Consumer view, these are now combined with logical AND instead of OR.
  • New experience for showing statistics on each resource that enables more of the screen to be used for displaying data.
  • Cluster selection RBAC: Visibility of clusters that can be selected now depends on the users data permissions applied through RBAC.

• Testing

  • Testing is now disabled by default when starting Conduktor. To start Testing alongside Conduktor, you should set an explicit environment variable. See the documentation for more information.

• Monitoring

  • All monitoring metrics are now provided without any agent dependencies. See the previous release notes for more information.

Fix 🔨​

• Platform

  • CVEs fixes

• Console

  • Support negative lag in consumer groups (cases whereby the last committed offset is greater than the latest offset)
  • Security fix to stop exposing cluster configuration inside the UI.

• Monitoring

  • Computation of URP metric is set to 0 if we find confluent.log.placement.constraints in the cluster config or confluent.placement.constraints in the topic config. This avoids raising a false positive alert in case of a multi-region Confluent cluster. Note this logic will also be applied in Console in the next release.

• Governance

  • Do not show error toast in Data Masking when a user/group no longer exists in a policy.

• Admin

  • Accept "/" character in consumer group name

Console 1.14.0​

Release date: 2023-04-17

Conduktor version 1.14.0 is now available, introducing various new features and enhancements. This release includes performance improvements in the Console for loading Kafka data, support for MS Teams integration, the ability to add SSO users to your organization before their first login, and a simple onboarding wizard for easy setup. Important changes in this version include the requirement to update the configuration to define a root administrator. Check out the full list of changes below and update to Conduktor 1.14.0 to enjoy these new features and improvements.

Important changes ❗​

• This version requires a configuration update to ensure you have root administrator defined. This is mandatory for initialization of the platform, therefore you MUST update your configuration prior to upgrading. See the documentation for detailed instructions.

Features ✨​

Give us feedback here

• Platform

  • See important changes above. You must ensure you have a root administrator defined in your platform configuration. See the docs for detailed instructions.
  • New onboarding wizard to help setup your environment for a new installation. This can be used to configure license, organization, database and SSO (Oauth2/LDAP) from inside the Conduktor UI. See docs.
  • Added a memory available check at startup to prevent platform running in cases whereby the memory available is less than the memory required by the RUN_MODE being used.

• Console

  • Long resource names are now wrapped to ensure the full string is always visible in the table.
  • We have improved the performance of loading topic names and associated metadata in the topic list screen.
  • We have improved the performance for loading subjects from schema registry.

• Admin

  • It's now possible to add an SSO user to your organization before their first login. This allows you to allocate appropriate permissions prior to their first login. See docs.
  • Notifications screen is now 'Integrations', with support added for Microsoft Teams. See docs

• Monitoring

  • Request confirmation from users when deleting alerts.
  • Reduced verbosity of logs from the topic scanner.
  • Integration of Microsoft Teams notifications for alerting.

Fix 🔨​

• Platform

  • Clean some embedded PostgreSQL temporary files on container restart to prevent database startup error in some edge cases.
  • Remove Content-Length header on web-socket requests, mitigating web-socket issues with some reverse proxy like Envoy.

• Console

  • Fix dropdown selectors in dark mode theme.
  • Consumer: pretty print Protobuf records

• Testing

  • Fix variable definition export.
  • Fix deletion of linked tasks.

• Admin

  • Every admin of the platform is now able to delete a user.
  • Initialize organization during platform startup.
  • For users in Trial, the upgrade license button is no longer crashing the UI.

Console 1.13.2​

Release date: 2023-03-31

Conduktor version 1.13.2 is now available, bringing bug fixes and improvements for the Platform, Console, and Admin solutions. The Platform fixes include addressing a regression related to the platform database connection default schema and fetching OIDC user information during login. The Console now supports references in schemas and fixes the color of the cluster name in dark mode. The Admin solution has reduced verbosity in logs and eliminated cluster configuration leakage. Update to Conduktor 1.13.2 to benefit from these bug fixes and enhancements.

Fix 🔨​

• Platform

  • Fix regression on platform database connection default schema used if changed from PostgreSQL default
  • Now fetch OIDC user infos endpoint for user email claim if not present in ID Token during login.

• Console

  • Support references in Schemas
  • Dark mode: fix color of cluster name in cluster dropdown

• Admin

  • Logs: reduce verbosity and avoid cluster configuration leakage