pulsar-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From zhai...@apache.org
Subject [pulsar] branch master updated: Documentation: impove the doc 'Deploying and managing Pulsar Functions' (#3048)
Date Sun, 25 Nov 2018 04:23:10 GMT
This is an automated email from the ASF dual-hosted git repository.

zhaijia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 469ce55  Documentation: impove the doc 'Deploying and managing Pulsar Functions'
(#3048)
469ce55 is described below

commit 469ce55427287cbe17455184a608c9bebe059c40
Author: legendtkl <taokelu@gmail.com>
AuthorDate: Sun Nov 25 12:23:06 2018 +0800

    Documentation: impove the doc 'Deploying and managing Pulsar Functions' (#3048)
    
    when follow the doc Deploying and managing Pulsar Functions to do python udf function
create and deploy, we will encounter an exception as follow.
    ```
    $ bin/pulsar-admin functions trigger --tenant public --namespace default --name myfunc
--trigger-value "hello world"
    HTTP 408 Request Timeout
    ```
    The root cause is the python environment is not ready. To be specific, we should install
pulsar python client before do python udf function creating and deploy.
    
    Maybe we should point it out clearly in the doc as following, and that is what the PR
is doing.
    
    If you're going to deploy and trigger python user-defined functions, you should install
[the pulsar python client](http://pulsar.apache.org/docs/en/client-libraries-python/) first.
---
 site/docs/latest/functions/deployment.md                                | 2 ++
 site2/docs/functions-deploying.md                                       | 2 ++
 .../versioned_docs/version-2.1.0-incubating/functions-deploying.md      | 2 ++
 .../versioned_docs/version-2.1.1-incubating/functions-deploying.md      | 2 ++
 site2/website/versioned_docs/version-2.2.0/functions-deploying.md       | 2 ++
 5 files changed, 10 insertions(+)

diff --git a/site/docs/latest/functions/deployment.md b/site/docs/latest/functions/deployment.md
index aceb7b0..cca06ed 100644
--- a/site/docs/latest/functions/deployment.md
+++ b/site/docs/latest/functions/deployment.md
@@ -22,6 +22,8 @@ In order to deploy and manage Pulsar Functions, you need to have a Pulsar
{% pop
 
 If you're running a non-{% popover standalone %} cluster, you'll need to obtain the service
URL for the cluster. How you obtain the service URL will depend on how you deployed your Pulsar
cluster.
 
+If you're going to deploy and trigger python user-defined functions, you should install [the
pulsar python client](http://pulsar.apache.org/docs/en/client-libraries-python/) first.
+
 ## Command-line interface {#cli}
 
 Pulsar Functions are deployed and managed using the [`pulsar-admin functions`](../../reference/CliTools#pulsar-admin-functions)
interface, which contains commands such as [`create`](../../reference/CliTools#pulsar-admin-functions-create)
for deploying functions in [cluster mode](#cluster-mode), [`trigger`](../../reference/CliTools#pulsar-admin-functions-trigger)
for [triggering](#triggering) functions, [`list`](../../reference/CliTools#pulsar-admin-functions-list)
for listing deployed fu [...]
diff --git a/site2/docs/functions-deploying.md b/site2/docs/functions-deploying.md
index d6850df..2fa51ba 100644
--- a/site2/docs/functions-deploying.md
+++ b/site2/docs/functions-deploying.md
@@ -23,6 +23,8 @@ In order to deploy and manage Pulsar Functions, you need to have a Pulsar
cluste
 
 If you're running a non-[standalone](reference-terminology.md#standalone) cluster, you'll
need to obtain the service URL for the cluster. How you obtain the service URL will depend
on how you deployed your Pulsar cluster.
 
+If you're going to deploy and trigger python user-defined functions, you should install [the
pulsar python client](http://pulsar.apache.org/docs/en/client-libraries-python/) first.
+
 ## Command-line interface
 
 Pulsar Functions are deployed and managed using the [`pulsar-admin functions`](reference-pulsar-admin.md#functions)
interface, which contains commands such as [`create`](reference-pulsar-admin.md#functions-create)
for deploying functions in [cluster mode](#cluster-mode), [`trigger`](reference-pulsar-admin.md#trigger)
for [triggering](#triggering-pulsar-functions) functions, [`list`](reference-pulsar-admin.md#list-2)
for listing deployed functions, and several others.
diff --git a/site2/website/versioned_docs/version-2.1.0-incubating/functions-deploying.md
b/site2/website/versioned_docs/version-2.1.0-incubating/functions-deploying.md
index 4c96b3c..53d6598 100644
--- a/site2/website/versioned_docs/version-2.1.0-incubating/functions-deploying.md
+++ b/site2/website/versioned_docs/version-2.1.0-incubating/functions-deploying.md
@@ -24,6 +24,8 @@ In order to deploy and manage Pulsar Functions, you need to have a Pulsar
cluste
 
 If you're running a non-[standalone](reference-terminology.md#standalone) cluster, you'll
need to obtain the service URL for the cluster. How you obtain the service URL will depend
on how you deployed your Pulsar cluster.
 
+If you're going to deploy and trigger python user-defined functions, you should install [the
pulsar python client](http://pulsar.apache.org/docs/en/client-libraries-python/) first.
+
 ## Command-line interface
 
 Pulsar Functions are deployed and managed using the [`pulsar-admin functions`](reference-pulsar-admin.md#functions)
interface, which contains commands such as [`create`](reference-pulsar-admin.md#functions-create)
for deploying functions in [cluster mode](#cluster-mode), [`trigger`](reference-pulsar-admin.md#trigger)
for [triggering](#triggering-pulsar-functions) functions, [`list`](reference-pulsar-admin.md#list-2)
for listing deployed functions, and several others.
diff --git a/site2/website/versioned_docs/version-2.1.1-incubating/functions-deploying.md
b/site2/website/versioned_docs/version-2.1.1-incubating/functions-deploying.md
index c5d005d..c654189 100644
--- a/site2/website/versioned_docs/version-2.1.1-incubating/functions-deploying.md
+++ b/site2/website/versioned_docs/version-2.1.1-incubating/functions-deploying.md
@@ -24,6 +24,8 @@ In order to deploy and manage Pulsar Functions, you need to have a Pulsar
cluste
 
 If you're running a non-[standalone](reference-terminology.md#standalone) cluster, you'll
need to obtain the service URL for the cluster. How you obtain the service URL will depend
on how you deployed your Pulsar cluster.
 
+If you're going to deploy and trigger python user-defined functions, you should install [the
pulsar python client](http://pulsar.apache.org/docs/en/client-libraries-python/) first.
+
 ## Command-line interface
 
 Pulsar Functions are deployed and managed using the [`pulsar-admin functions`](reference-pulsar-admin.md#functions)
interface, which contains commands such as [`create`](reference-pulsar-admin.md#functions-create)
for deploying functions in [cluster mode](#cluster-mode), [`trigger`](reference-pulsar-admin.md#trigger)
for [triggering](#triggering-pulsar-functions) functions, [`list`](reference-pulsar-admin.md#list-2)
for listing deployed functions, and several others.
diff --git a/site2/website/versioned_docs/version-2.2.0/functions-deploying.md b/site2/website/versioned_docs/version-2.2.0/functions-deploying.md
index 3852d17..dc8bad1 100644
--- a/site2/website/versioned_docs/version-2.2.0/functions-deploying.md
+++ b/site2/website/versioned_docs/version-2.2.0/functions-deploying.md
@@ -24,6 +24,8 @@ In order to deploy and manage Pulsar Functions, you need to have a Pulsar
cluste
 
 If you're running a non-[standalone](reference-terminology.md#standalone) cluster, you'll
need to obtain the service URL for the cluster. How you obtain the service URL will depend
on how you deployed your Pulsar cluster.
 
+If you're going to deploy and trigger python user-defined functions, you should install [the
pulsar python client](http://pulsar.apache.org/docs/en/client-libraries-python/) first.
+
 ## Command-line interface
 
 Pulsar Functions are deployed and managed using the [`pulsar-admin functions`](reference-pulsar-admin.md#functions)
interface, which contains commands such as [`create`](reference-pulsar-admin.md#functions-create)
for deploying functions in [cluster mode](#cluster-mode), [`trigger`](reference-pulsar-admin.md#trigger)
for [triggering](#triggering-pulsar-functions) functions, [`list`](reference-pulsar-admin.md#list-2)
for listing deployed functions, and several others.


Mime
View raw message