Skip to content

RDoc-2530 added the Kafka ETL API and Studio pages "setup workflow" and "prerequisites for a secure Kafka server" sections#2468

Open
reebhub wants to merge 3 commits into
ravendb:mainfrom
reebhub:RDoc-2530
Open

RDoc-2530 added the Kafka ETL API and Studio pages "setup workflow" and "prerequisites for a secure Kafka server" sections#2468
reebhub wants to merge 3 commits into
ravendb:mainfrom
reebhub:RDoc-2530

Conversation

@reebhub

@reebhub reebhub commented May 28, 2026

Copy link
Copy Markdown
Contributor

Issue link

RDoc-2530

Additional description

  • Added the Kafka ETL API and Studio pages a "setup workflow" and a "prerequisites for a secure Kafka server" sections, explaining the setup routes when the Kafka cluster does or doesn't use ACL.
  • Note a difference between the Studio page of v7.2 and others: in v7.2 it is explained how to extract task scripts transactional IDs from the ongoing tasks view, and from older versions how to extract it from exception messages.

Type of change

  • Content - docs
  • Content - cloud
  • Content - guides
  • Content - start pages/other
  • New docs feature (consider updating /templates or readme)
  • Bug fix
  • Optimization
  • Other

Changes in docs URLs

  • No changes in docs URLs
  • Articles are restructured, URLs will change, mapping is required (update /scripts/redirects.json file, set Documents Moved PR label)

Changes in UX/UI

  • No changes in UX/UI
  • Changes in UX/UI (include screenshots and description)

@reebhub reebhub requested a review from poissoncorp May 28, 2026 05:22
// Authentication via SASL/PLAIN over SSL/TLS
ConnectionOptions = new Dictionary<string, string>
{
{ "security.protocol", "SASL_SSL" },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please describe the options used here - at least a bit - what each one means and what's the expected/recommended value set

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

KafkaConnectionSettings = new KafkaConnectionSettings
{
BootstrapServers = "broker.example.com:9092",
UseRavenCertificate = true

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation should address the concern that RavenDB's cluster server certificate has only server-auth EKU, so it cannot be used for client communication. Are we using different one here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


If enabled, RavenDB will export to the target machine/s the cluster-wide
certificate defined during setup, and secure its connection with them.
If enabled, the Kafka connection runs over SSL/TLS, and RavenDB authenticates to Kafka using the cluster-wide certificate defined during setup.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

* **Note**, however, that to complete the process you still need to register RavenDB's
exported certificate in [Kafka's truststore](https://kafka.apache.org/documentation/streams/developer-guide/security.html)
on the target machine/s.
* **Note**, however, that to complete the process you still need to register RavenDB's cluster-wide certificate

@poissoncorp poissoncorp Jun 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's highlight it - extremely important

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

exported certificate in [Kafka's truststore](https://kafka.apache.org/documentation/streams/developer-guide/security.html)
on the target machine/s.
* **Note**, however, that to complete the process you still need to register RavenDB's cluster-wide certificate
in [Kafka's truststore](https://kafka.apache.org/documentation/streams/developer-guide/security.html) on the target machine/s.

@poissoncorp poissoncorp Jun 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want a word or two about kafka truststore, or it'd be a domain overstretch (documenting Kafka)?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right
added a few words in the same warning frame

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants