Skip to content

Commit 5f46de0

Browse files
committed
Add help output
1 parent 5af67b1 commit 5f46de0

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,77 @@ See:
5656
5757
make build.docker-build
5858
59+
### Help output
60+
61+
Run the kafka-proxy server
62+
63+
Usage:
64+
kafka-proxy server [flags]
65+
66+
Flags:
67+
--auth-gateway-client-command string Path to authentication plugin binary
68+
--auth-gateway-client-enable Enable gateway client authentication
69+
--auth-gateway-client-log-level string Log level of the auth plugin (default "trace")
70+
--auth-gateway-client-magic uint Magic bytes sent in the handshake
71+
--auth-gateway-client-method string Authentication method
72+
--auth-gateway-client-param stringArray Authentication plugin parameter
73+
--auth-gateway-client-timeout duration Authentication timeout (default 10s)
74+
--auth-gateway-server-command string Path to authentication plugin binary
75+
--auth-gateway-server-enable Enable proxy server authentication
76+
--auth-gateway-server-log-level string Log level of the auth plugin (default "trace")
77+
--auth-gateway-server-magic uint Magic bytes sent in the handshake
78+
--auth-gateway-server-method string Authentication method
79+
--auth-gateway-server-param stringArray Authentication plugin parameter
80+
--auth-gateway-server-timeout duration Authentication timeout (default 10s)
81+
--auth-local-command string Path to authentication plugin binary
82+
--auth-local-enable Enable local SASL/PLAIN authentication performed by listener - SASL handshake will not be passed to kafka brokers
83+
--auth-local-log-level string Log level of the auth plugin (default "trace")
84+
--auth-local-param stringArray Authentication plugin parameter
85+
--auth-local-timeout duration Authentication timeout (default 10s)
86+
--bootstrap-server-mapping stringArray Mapping of Kafka bootstrap server address to local address (host:port,host:port(,advhost:advport))
87+
--debug-enable Enable Debug endpoint
88+
--debug-listen-address string Debug listen address (default "0.0.0.0:6060")
89+
--default-listener-ip string Default listener IP (default "127.0.0.1")
90+
--dynamic-listeners-disable Disable dynamic listeners.
91+
--external-server-mapping stringArray Mapping of Kafka server address to external address (host:port,host:port). A listener for the external address is not started
92+
--forbidden-api-keys intSlice Forbidden Kafka request types. The restriction should prevent some Kafka operations e.g. 20 - DeleteTopics
93+
-h, --help help for server
94+
--http-disable Disable HTTP endpoints
95+
--http-health-path string Path on which to health endpoint (default "/health")
96+
--http-listen-address string Address that kafka-proxy is listening on (default "0.0.0.0:9080")
97+
--http-metrics-path string Path on which to expose metrics (default "/metrics")
98+
--kafka-client-id string An optional identifier to track the source of requests (default "kafka-proxy")
99+
--kafka-connection-read-buffer-size int Size of the operating system's receive buffer associated with the connection. If zero, system default is used
100+
--kafka-connection-write-buffer-size int Sets the size of the operating system's transmit buffer associated with the connection. If zero, system default is used
101+
--kafka-dial-timeout duration How long to wait for the initial connection (default 15s)
102+
--kafka-keep-alive duration Keep alive period for an active network connection. If zero, keep-alives are disabled (default 1m0s)
103+
--kafka-max-open-requests int Maximal number of open requests pro tcp connection before sending on it blocks (default 256)
104+
--kafka-read-timeout duration How long to wait for a response (default 30s)
105+
--kafka-write-timeout duration How long to wait for a transmit (default 30s)
106+
--log-format string Log format text or json (default "text")
107+
--log-level string Log level debug, info, warning, error, fatal or panic (default "info")
108+
--proxy-listener-ca-chain-cert-file string PEM encoded CA's certificate file
109+
--proxy-listener-cert-file string PEM encoded file with server certificate
110+
--proxy-listener-keep-alive duration Keep alive period for an active network connection. If zero, keep-alives are disabled (default 1m0s)
111+
--proxy-listener-key-file string PEM encoded file with private key for the server certificate
112+
--proxy-listener-key-password string Password to decrypt rsa private key
113+
--proxy-listener-read-buffer-size int Size of the operating system's receive buffer associated with the connection. If zero, system default is used
114+
--proxy-listener-tls-enable Whether or not to use TLS listener
115+
--proxy-listener-write-buffer-size int Sets the size of the operating system's transmit buffer associated with the connection. If zero, system default is used
116+
--proxy-request-buffer-size int Request buffer size pro tcp connection (default 4096)
117+
--proxy-response-buffer-size int Response buffer size pro tcp connection (default 4096)
118+
--sasl-enable Connect using SASL/PLAIN
119+
--sasl-jaas-config-file string Location of JAAS config file with SASL username and password
120+
--sasl-password string SASL user password
121+
--sasl-username string SASL user name
122+
--tls-ca-chain-cert-file string PEM encoded CA's certificate file
123+
--tls-client-cert-file string PEM encoded file with client certificate
124+
--tls-client-key-file string PEM encoded file with private key for the client certificate
125+
--tls-client-key-password string Password to decrypt rsa private key
126+
--tls-enable Whether or not to use TLS when connecting to the broker
127+
--tls-insecure-skip-verify It controls whether a client verifies the server's certificate chain and host name
128+
129+
59130
### Usage example
60131
61132
build/kafka-proxy server --bootstrap-server-mapping "192.168.99.100:32400,0.0.0.0:32399"

0 commit comments

Comments
 (0)