Jennifer88huang commented on a change in pull request #4263: [docs] Documentation on configuring functions runtime URL: https://github.com/apache/pulsar/pull/4263#discussion_r283182170
########## File path: site2/docs/functions-runtime.md ########## @@ -0,0 +1,148 @@ +--- +id: functions-runtime +title: Configure Functions runtime +sidebar_label: Configure Functions runtime +--- + +Currently, Pulsar Functions supports running functions in three runtimes. + +- *Thread*: Invoke functions in threads in Functions Worker. +- *Process*: Invoke functions in processes forked by Functions Worker. +- *Kubernetes*: Submit functions as Kubernetes StatefulSets by Functions Worker. + +## Configure Thread runtime + +*Thread* runtime is the most simplest runtime to configure. At most of the time, you don't need +to configure anything. You can customize the thread group name by setting following settings: + +```yaml +threadContainerFactory: + threadGroupName: "Your Function Container Group" +``` + +*Thread* runtime only supports Java language. + +## Configure Process runtime + +Similar as *Thread* runtime, at most of the time, you don't need to configure anything special when +enabling *Process* runtime. + +```yaml +processContainerFactory: + # the directory for storing the function logs + logDirectory: + # change the jar location only when you put the java instance jar in a different location + javaInstanceJarLocation: + # change the python instance location only when you put the python instance jar in a different location + pythonInstanceLocation: + # change the extra dependencies location: + extraFunctionDependenciesDir: +``` + +Currently Pulsar supports running Java, Python, and Go functions in Process runtime mode. + +## Configure Kubernetes runtime + +Configuring Kubernetes runtime is as simple as configuring the other two runtimes. You can just uncomment Review comment: @jiazhai Thank you very much for your information. When you ''uncomment" sth in code, you actually want to enable some configuration options; in some cases, you just disable it with "comment", that's why we use comment lines in code. Here I want to tell @sijie, he could use "enable" / "disable" or other similar words to replace "uncomment"/"comment" in technical writing. When he explains the meaning, he will realize it. ---------------------------------------------------------------- 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
