This is an automated email from the ASF dual-hosted git repository.
mmarshall pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new fe502c6d2b4 PIP-250: Document proxy_version protocol update (#531)
fe502c6d2b4 is described below
commit fe502c6d2b486a90c30fe1d6f3ff88ef7102bc6f
Author: Michael Marshall <[email protected]>
AuthorDate: Fri Apr 21 13:24:30 2023 -0500
PIP-250: Document proxy_version protocol update (#531)
* PIP-250: Document proxy_version protocol update
* Clarify that the field is optional, even for proxies
* Update docs/developing-binary-protocol.md
Co-authored-by: Anonymitaet <[email protected]>
---------
Co-authored-by: tison <[email protected]>
Co-authored-by: Anonymitaet <[email protected]>
---
docs/developing-binary-protocol.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/developing-binary-protocol.md
b/docs/developing-binary-protocol.md
index 0721a9b86b4..8eae8e94691 100644
--- a/docs/developing-binary-protocol.md
+++ b/docs/developing-binary-protocol.md
@@ -145,6 +145,7 @@ Fields:
* `original_principal`: Added by the proxy. Regular clients are not expected
to supply this value. When set and when authorization is enabled, the
`auth_data` must map to one of the `proxyRoles` in the broker.conf.
* `original_auth_method`: Added by the proxy. Regular clients are not
expected to supply this value.
* `original_auth_data`: Added by the proxy when configured to do so. Regular
clients are not expected to supply this value.
+ * `proxy_version`: Added by the proxy. The proxy rejects `Connect` commands
with this field present. Regular clients are not expected to supply this value.
When authentication and authorization are enabled in the broker, only one of
the configured `proxyRoles` has permission to supply this field. To be backward
compatible, the broker does not require a `proxyRole` to supply this field.
```protobuf
message CommandConnected {
