Skip to main content
Version: 0.6.0

General options

You can customize the Function Mesh Worker service using functionsWorkerServiceCustomConfigs in the functions_worker.yml manifest. This table outlines available configurations.

NameTypeRequiredDefaultDescription
uploadEnabledbooleanNofalseEnable users to upload custom JAR or NAR packages of Pulsar functions, source, or sink connectors.
functionEnabledbooleanNotrueEnable the Pulsar Function API endpoint.
sinkEnabledbooleanNotrueEnable the sink API endpoint.
sourceEnabledbooleanNotrueEnable the source API endpoint.
extraDependenciesDirstringNo/pulsar/lib/The directory for dropping extra function dependencies.
volumeMountsList < V1VolumeMount >No[] (empty string)V1VolumeMount describes a mounting of a Volume within a container.
volumesList < V1Volume >No[] (empty string)The list of V1Volume that can be mounted by containers belonging to the Pulsar Function or connector Pod.
ownerReferenceV1OwnerReferenceNonullDefault configurations of the ownerReference.
allowUserDefinedServiceAccountName (deprecated)booleanNofalseEnable users to change the service account name with custom-runtime-options. This option is depreciated starting with Function Mesh v0.3.0. You can use the serviceAccountName in the trusted mode to set the service account.
defaultServiceAccountNamestringNo"" (empty string)The name of the service account to run the Pulsar Function or connector Pod.
imagePullPolicystringNo"IfNotPresent"The image pull policy for images to run Pulsar Function instances. By default, it is set to IfNotPresent.
functionRunnerImagesMap < String, String >No{} (empty string)The runner image to run the Pulsar Function instances.
imagePullSecretsList< V1LocalObjectReference >No[] (empty string)An optional list of references to secrets in the same namespace to pull images used by PodSpec.
labelsMap < String, String >No{} (empty string)Specify the labels being attached to a Pod that is created by the Function Mesh Operator for the cluster.
functionLabelsMap < String, String >No{} (empty string)Specify the labels being attached to a Function's Pod. When both functionLabels and labels are specified, functionLabels overrides labels.
sinkLabelsMap < String, String >No{} (empty string)Specify the labels being attached to a Sink's Pod. When both sinkLabels and labels are specified, sinkLabels overrides labels.
sourceLabelsMap < String, String >No{} (empty string)Specify the labels being attached to a Source's Pod. When both sourceLabels and labels are specified, sourceLabels overrides labels.
annotationsMap < String, String >No{} (empty string)Specify the annotations being attached to a Pod that is created by the Function Mesh Operator for the cluster.
functionAnnotationsMap < String, String >No{} (empty string)Specify the annotations being attached to a Function's Pod. When both functionAnnotations and annotations are specified, functionAnnotations overrides annotations.
sinkAnnotationsMap < String, String >No{} (empty string)Specify the annotations being attached to a Sink's Pod. When both sinkAnnotations and annotations are specified, sinkAnnotations overrides annotations.
sourceAnnotationsMap < String, String >No{} (empty string)Specify the annotations being attached to a Source's Pod. When both sourceAnnotations and annotations are specified, sourceAnnotations overrides annotations.
envMap < String, String >No{} (empty string)Specify the environment variables being attached to a Pod that is created by the Function Mesh Operator for the cluster.
functionEnvMap < String, String >No{} (empty string)Specify the environment variables being attached to a Function's Pod. When both functionEnv and env are specified, functionEnv overrides env.
sinkEnvMap < String, String >No{} (empty string)Specify the environment variables being attached to a Sink's Pod. When both sinkEnv and env are specified, sinkEnv overrides env.
sourceEnvMap < String, String >No{} (empty string)Specify the environment variables being attached to a Function's Pod. When both sourceEnv and env are specified, sourceEnv overrides env.
functionInitContainersList< V1alpha1FunctionSpecPodInitContainers >No[] (empty string)Specify the initContainers that is attached to the function Pod.
sourceInitContainersList< V1alpha1SourceSpecPodInitContainers >No[] (empty string)Specify the initContainers that is attached to the Source Pod.
sinkInitContainersList< V1alpha1SinkSpecPodInitContainers >No[] (empty string)Specify the initContainers that is attached to the Sink Pod.
jobNamespaceStringNodefaultThe Kubernetes namespace to run the function instances.
defaultResourcesResourcesNo
- CPU: 1 core
- RAM: 1GB
- Disk: 10GB
The default resources for each function instance. Available options are CPU (in unit of cores), RAM ( in unit of bytes), and disk (in unit of bytes).
enableTrustedModebooleanNofalseEnable the trusted mode. When the trusted mode is enabled, you can override some default configurations across the Pulsar cluster. For details about options supported in the trusted mode, see customizable options.