mcvsubbu commented on a change in pull request #3975: ReadTheDocs documentation for Table Configs, Monitoring, and Deployment URL: https://github.com/apache/incubator-pinot/pull/3975#discussion_r269769855
########## File path: docs/in_production.rst ########## @@ -17,51 +17,127 @@ .. under the License. .. -Running Pinot in production +Running Pinot in Production =========================== -Installing Pinot ----------------- - Requirements ~~~~~~~~~~~~ -* Java 8+ -* Several nodes with enough memory -* A working installation of Zookeeper +You will need the following in order to run pinot in production: -Recommended environment -~~~~~~~~~~~~~~~~~~~~~~~ - -* Shared storage infrastructure (such as NFS) -* Regular Zookeeper backups -* HTTP load balancers (such as nginx/haproxy) +* Hardware for controller/broker/servers as per your load +* Working installation of Zookeeper that Pinot can use. We recommend setting aside a path within zookpeer and including that path in pinot.controller.zkStr. Pinot will create its own cluster under this path (cluster name decided by pinot.controller.helixClusterName) +* Shared storage mounted on controllers (if you plan to have multiple controllers for the same cluster). Alternatively, an implementation of PinotFS that the Pinot hosts have access to. +* HTTP load balancers for spraying queries across brokers (or other mechanism to balance queries) +* HTTP load balancers for spraying controller requests (e.g. segment push, or other controller APIs) or other mechanisms for distribution of these requests. Deploying Pinot ---------------- +~~~~~~~~~~~~~~~ + +In general, when deploying Pinot services, it is best to adhere to a specific ordering in which the various components should be deployed. This deployment order is recommended in case of the scenario that there might be protocol or other significant differences, the deployments go out in a predictable order in which failure due to these changes can be avoided. -Direct deployment of Pinot -~~~~~~~~~~~~~~~~~~~~~~~~~~ +The ordering is as follows: -Deployment of Pinot on Kubernetes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#. pinot-controller +#. pinot-broker +#. pinot-server +#. pinot-minion Managing Pinot --------------- +~~~~~~~~~~~~~~ Creating tables -~~~~~~~~~~~~~~~ +--------------- Updating tables -~~~~~~~~~~~~~~~ +--------------- Uploading data -~~~~~~~~~~~~~~ +-------------- Configuring realtime data ingestion -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------------- Monitoring Pinot ~~~~~~~~~~~~~~~~ +Pinot exposes several metrics to monitor the service and ensure that pinot users are not experiencing issues. In this section we discuss some of the key metrics that are useful to monitor. A full list of metrics is available in the `Metrics <customizations.html#metrics>`_ section. Review comment: we dont have a 'full list' so to speak. so maybe we should remove this? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
