Skip to content

Make table wider in Pinot configs documentation #13142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ebyhr merged 1 commit into from
Jul 11, 2022
Merged

Make table wider in Pinot configs documentation #13142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions docs/src/main/sphinx/connector/pinot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,27 +37,27 @@ Configuration properties

The following configuration properties are available:

============================================= ========== ==============================================================================
Property name Required Description
============================================= ========== ==============================================================================
``pinot.controller-urls`` Yes A comma separated list of controller hosts. If Pinot is deployed via
`Kubernetes <https://kubernetes.io/>`_ this needs to point to the controller
service endpoint. The Pinot broker and server must be accessible via DNS as
Pinot returns hostnames and not IP addresses.
``pinot.segments-per-split`` No The number of segments processed in a split. Setting this higher reduces the
number of requests made to Pinot. This is useful for smaller Pinot clusters.
``pinot.request-timeout`` No The timeout for Pinot requests. Increasing this can reduce timeouts if DNS
resolution is slow.
``pinot.controller.authentication.type`` No Pinot authentication method for controller requests. Allowed values are
``NONE`` and ``PASSWORD`` - defaults to ``NONE`` which is no authentication.
``pinot.controller.authentication.user`` No Controller username for basic authentication method.
``pinot.controller.authentication.password`` No Controller password for basic authentication method.
``pinot.broker.authentication.type`` No Pinot authentication method for broker requests. Allowed values are
``NONE`` and ``PASSWORD`` - defaults to ``NONE`` which is no
authentication.
``pinot.broker.authentication.user`` No Broker username for basic authentication method.
``pinot.broker.authentication.password`` No Broker password for basic authentication method.
============================================= ========== ==============================================================================
========================================================= ========== ==============================================================================
Property name Required Description
========================================================= ========== ==============================================================================
``pinot.controller-urls`` Yes A comma separated list of controller hosts. If Pinot is deployed via
`Kubernetes <https://kubernetes.io/>`_ this needs to point to the controller
service endpoint. The Pinot broker and server must be accessible via DNS as
Pinot returns hostnames and not IP addresses.
``pinot.segments-per-split`` No The number of segments processed in a split. Setting this higher reduces the
number of requests made to Pinot. This is useful for smaller Pinot clusters.
``pinot.request-timeout`` No The timeout for Pinot requests. Increasing this can reduce timeouts if DNS
resolution is slow.
``pinot.controller.authentication.type`` No Pinot authentication method for controller requests. Allowed values are
``NONE`` and ``PASSWORD`` - defaults to ``NONE`` which is no authentication.
``pinot.controller.authentication.user`` No Controller username for basic authentication method.
``pinot.controller.authentication.password`` No Controller password for basic authentication method.
``pinot.broker.authentication.type`` No Pinot authentication method for broker requests. Allowed values are
``NONE`` and ``PASSWORD`` - defaults to ``NONE`` which is no
authentication.
``pinot.broker.authentication.user`` No Broker username for basic authentication method.
``pinot.broker.authentication.password`` No Broker password for basic authentication method.
========================================================= ========== ==============================================================================

If ``pinot.controller.authentication.type`` is set to ``PASSWORD`` then both ``pinot.controller.authentication.user`` and
``pinot.controller.authentication.password`` are required.
Expand Down