Jennifer88huang commented on a change in pull request #4229: [Doc] Documentation about deploying and configuring pulsar functions-worker URL: https://github.com/apache/pulsar/pull/4229#discussion_r282763444
########## File path: site2/docs/functions-worker.md ########## @@ -0,0 +1,260 @@ +--- +id: functions-worker +title: Deploy and manage functions worker +sidebar_label: Functions Worker +--- + +Pulsar `functions-worker` is the component to run Pulsar Functions in cluster mode. +This document describes the options, steps and configurations to set up Pulsar +`functions-worker`. + +Before continuing the documentation, please be noted with a few things: + +1. The `--- Service Urls---` lines in the following diagrams represents that Pulsar + service urls that Pulsar client and admin use to connect to a Pulsar cluster. + +## Deployment options + +Pulsar `functions-worker` is designed as a logic component. It can run as part of +a broker or as a complete different process in a different broker. This section +explores these two different options and how to configure them. + +### Run Functions-Worker with brokers + +The following diagram illustrates a deployment of functions-workers running along with +brokers. + + + +To enable functions-worker running as part of a broker, `functionsWorkerEnabled` should +be set to `true` in the broker configuration `broker.conf`. + +```conf +functionsWorkerEnabled=true +``` + +Changing `functionsWorkerEnabled` to `true` only tells broker to start functions-worker +as part of it. You need to configure `conf/functions_worker.yml` to customize your functions_worker. + +#### Configure Functions-Worker for running with brokers Review comment: ```suggestion #### Configure Functions-worker for running with brokers ``` ---------------------------------------------------------------- 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
