[incubator-openwhisk-package-kafka] branch master updated: deprecate messageHubProduce and kafkaProduce actions (#265)

[cs...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

csantanapr pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-package-kafka.git


The following commit(s) were added to refs/heads/master by this push:
     new e6a2c2e  deprecate messageHubProduce and kafkaProduce actions (#265)
e6a2c2e is described below

commit e6a2c2e219ef65f8932579a201567574aff0c6bf
Author: Adnan Baruni <ab...@users.noreply.github.com>
AuthorDate: Thu Apr 26 00:09:09 2018 -0500

    deprecate messageHubProduce and kafkaProduce actions (#265)
---
 README.md         | 6 ++++++
 installCatalog.sh | 3 ++-
 installKafka.sh   | 3 ++-
 3 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 22cd60e..03c6e9a 100644
--- a/README.md
+++ b/README.md
@@ -307,6 +307,9 @@ $ wsk trigger update myTopicTrigger -p isJSONData false -p isBinaryKey true -p i
 ```
 
 ### Producing messages to Message Hub
+
+The `/messaging/messageHubProduce` Action is deprecated and will be removed at a future date. To maintain optimal performance, migrate your usage of the `/messaging/messageHubProduce` Action to use a persistent connection when data is produced to Message Hub.
+
 If you would like to use an OpenWhisk action to conveniently produce a message to Message Hub, you can use the `/messaging/messageHubProduce` action. This action takes the following parameters:
 
 |Name|Type|Description|
@@ -327,6 +330,9 @@ wsk action invoke /messaging/messageHubProduce -p kafka_brokers_sasl "[\"kafka01
 ```
 
 ### Producing messages to a generic Kafka instance
+
+The `/messaging/kafkaProduce` Action is deprecated and will be removed at a future date. To maintain optimal performance, migrate your usage of the `/messaging/kafkaProduce` Action to use a persistent connection when data is produced to Kafka.
+
 If you would like to use an OpenWhisk action to conveniently produce a message to a generic Kafka instance, you can use the `/messaging/kafkaProduce` action. This action takes the following parameters:
 
 |Name|Type|Description|
diff --git a/installCatalog.sh b/installCatalog.sh
index 791a2b4..3976dc5 100755
--- a/installCatalog.sh
+++ b/installCatalog.sh
@@ -107,6 +107,7 @@ $WSK_CLI -i --apihost "$EDGEHOST" action update --kind nodejs:6 messagingWeb/mes
 $WSK_CLI -i --apihost "$EDGEHOST" action update messaging/messageHubProduce "$PACKAGE_HOME/action/messageHubProduce.py" \
     --auth "$AUTH" \
     --kind python:3 \
-    -a description 'Produce a message to Message Hub' \
+    -a deprecated true \
+    -a description 'Deprecated - Produce a message to Message Hub' \
     -a parameters '[ {"name":"kafka_brokers_sasl", "required":true, "description": "Array of Message Hub brokers"},{"name":"user", "required":true, "description": "Message Hub username"},{"name":"password", "required":true, "description": "Message Hub password", "type":"password"},{"name":"topic", "required":true, "description": "Topic that you wish to produce a message to"},{"name":"value", "required":true, "description": "The value for the message you want to produce"},{"name":"key", " [...]
     -a sampleInput '{"kafka_brokers_sasl":"[\"kafka01-prod01.messagehub.services.us-south.bluemix.net:9093\"]", "username":"someUsername", "password":"somePassword", "topic":"mytopic", "value": "This is my message"}'
diff --git a/installKafka.sh b/installKafka.sh
index 2fe271e..e8b8dd9 100755
--- a/installKafka.sh
+++ b/installKafka.sh
@@ -108,6 +108,7 @@ $WSK_CLI -i --apihost "$EDGEHOST" action update --kind nodejs:6 messagingWeb/kaf
 $WSK_CLI -i --apihost "$EDGEHOST" action update messaging/kafkaProduce "$PACKAGE_HOME/action/kafkaProduce.py" \
     --auth "$AUTH" \
     --kind python:3 \
-    -a description 'Produce a message to a Kafka cluster' \
+    -a deprecated true \
+    -a description 'Deprecated - Produce a message to a Kafka cluster' \
     -a parameters '[ {"name":"brokers", "required":true, "description": "Array of Kafka brokers"},{"name":"topic", "required":true, "description": "Topic that you want to produce a message to"},{"name":"value", "required":true, "description": "The value for the message you want to produce"},{"name":"key", "required":false, "description": "The key for the message you want to produce"},{"name":"base64DecodeValue", "required":false, "description": "If true, the message will be produced with [...]
     -a sampleInput '{"brokers":"[\"127.0.0.1:9093\"]", "topic":"mytopic", "value": "This is my message"}'

-- 
To stop receiving notification emails like this one, please contact
csantanapr@apache.org.