Update Samples and documentation #140

TsuyoshiUshio · 2020-06-19T12:24:27Z

I update and refactor the whole samples.

What I did?

Create Custom Container with Documentation
Update Sample to Azure Functions Host V3 based
Update Sample with Cardinality with Confluent Cloud
Wrote a QuickStart Documentation for each language
Implement Cardinality for Python binding library
Provide DevContainer environment for each language

Review Direction

Sorry guys, this PR becomes big. However, the change for each language is not that big.
Could you help me to review it for language experts?

Python for @Hazhzeng

Could you have a look at the change of

/binding-library/python
/samples/python

Java/TypeScript for @mhoeger

Could you have a look a the change of

/samples/javascript
/samples/typescript

Java for @amamounelsayed

/binding-library/python
/samples/java
/samples/container

Overview/Structure for @anirudhgarg

/samples/README.md
You can find each samples.

TODO

Update Java binding library (Other repo)
Update Python binding library (Other repo)
PowerShell will come today (PowerShell doesn't use DevContainer. Customer is Windows-based)
Update README.md on the top page to add information on the language supports.
CI for validating language samples.

…n into tsushi/pythoncardinality

samples/README.md

Hazhzeng

Nits to make the documentation better, otherwise LGTM :)

binding-library/python/azure/functions_extensions/kafka/kafka.py

samples/python/KafkaTriggerMany/main.py

samples/python/library/README.md

samples/container/kafka-function/README.md

amamounelsayed · 2020-06-19T23:10:26Z

samples/container/kafka-function/src/main/java/com/contoso/kafka/TriggerFunction.java

+     * @param kafkaEventData
+     * @param context
+     */
+    // @FunctionName("KafkaTrigger-Java")


Do you mind remove the comments? Are e waiting for the java library to be deployed?

I have two functions KafkaTrigger-Java and KafkaTrigger-Java-Many The first one is a sample for accessing local clusters with Cardinality.ONE. The second one is a sample for accessing Confluent Cloud with Cardinality.MANY. For the other samples, I comment out the second one, since a lot of getting started customers don't have a Confluence Cloud. So I keep a sample for local Kafka Cluster and comment out the sample for Confluence Cloud. This sample is for Docker, It aims to deploy to the Function App. That means it can't access the local cluster. So I comment out the local cluster sample and enable the Confluent Cloud sample. Should I remove the local cluster sample instead?

samples/java/README.MD

amamounelsayed · 2020-06-19T23:16:52Z

samples/java/src/main/java/com/contoso/kafka/TriggerFunction.java

-                context.getLogger().info(message);
-            }    
-    }
+    // @FunctionName("KafkaTrigger-Java-Many")


Why did we comment it?

We have three sample functions. KafkaOutput, Kafka-Trigger-Java, and Kafka-Trigger-Java-Many. The Kafka-Trigger-Java-Many is the sample for Cardinality.MANY and Confluent Cloud. So not many client don't have the Confluent Cloud account. Instead, for the others, it accesses to the local cluster that the DevContainer automatically starts.
That is why I comment on the Kafka-Trigger-Java-Many not to throw an error if the customer doesn't configure Confluent Cloud settings, but I wanted to provide some complex use-case samples.

amamounelsayed · 2020-06-19T23:17:36Z

samples/javascript/UsersTrigger/function.json

-            "topic": "%KafkaTopic%",
-            "brokerList": "%KafkaBroker%",
-            "consumerGroup": "%KafkaConsumerGroup%",
+            "topic": "users",


Should we return the %% values?

amamounelsayed · 2020-06-19T23:18:33Z

samples/python/KafkaTrigger/function.json

-          "topic": "test_topic",
-          "brokerList": "localhost:9092",
-          "consumerGroup" : "default"
+          "topic": "users",


Should we add %% values?

samples/typescript/kafka-trigger/UsersTriggerMany/function.json

samples/README.md

anirudhgarg

Have suggested some text changes to the Samples/Readme.cmd

mhoeger

Some comments, mostly nit-picking comments! Thanks!

binding-library/java/Readme.md

samples/javascript/README.md

samples/javascript/UsersTriggerMany/index.js

samples/typescript/kafka-trigger/README.md

Co-authored-by: Anirudh Garg <anirudhgarg@gmail.com>

…ctions-kafka-extension into tsushi/pythoncardinality

TsuyoshiUshio · 2020-06-25T23:01:10Z

If this PR has been merged, I'll merge this PR. The PR for change on the azure-functions-python-library repo.
Azure/azure-functions-python-library#62

I already fix all of the point of him

TsuyoshiUshio added 12 commits June 15, 2020 09:54

Commit for share

a302a65

commit for merge

6a5c621

Merge branch 'dev' of github.com:Azure/azure-functions-kafka-extensio…

fc26e2c

…n into tsushi/pythoncardinality

adding container

a7d24e4

Merge branch 'dev' of github.com:Azure/azure-functions-kafka-extensio…

48c9cef

…n into tsushi/pythoncardinality

Update Java document and samples

285d276

Add documentation for .net

3b6dd3e

add container documentation

84c38d8

javascript document and sample update

9bbd81d

update python doc and samples

3808464

TypeScript and more

1f50e17

Debugger assume that there is requirements.txt

2905923

TsuyoshiUshio requested review from anirudhgarg, mhoeger, Hazhzeng and amamounelsayed June 19, 2020 12:24

amamounelsayed reviewed Jun 19, 2020

View reviewed changes

samples/README.md Show resolved Hide resolved

Hazhzeng previously approved these changes Jun 19, 2020

View reviewed changes

binding-library/python/azure/functions_extensions/kafka/kafka.py Outdated Show resolved Hide resolved

samples/python/KafkaTriggerMany/main.py Outdated Show resolved Hide resolved

samples/python/library/README.md Show resolved Hide resolved

amamounelsayed reviewed Jun 19, 2020

View reviewed changes

samples/container/kafka-function/README.md Show resolved Hide resolved

amamounelsayed reviewed Jun 19, 2020

View reviewed changes

samples/java/README.MD Outdated Show resolved Hide resolved

amamounelsayed reviewed Jun 19, 2020

View reviewed changes

samples/typescript/kafka-trigger/UsersTriggerMany/function.json Show resolved Hide resolved

refactor the implementation and fix the document sample

f88a247

TsuyoshiUshio dismissed Hazhzeng’s stale review via f88a247 June 19, 2020 23:43

fix typo

25325b1

anirudhgarg reviewed Jun 20, 2020

View reviewed changes

samples/README.md Outdated Show resolved Hide resolved

samples/README.md Outdated Show resolved Hide resolved

samples/README.md Outdated Show resolved Hide resolved

samples/README.md Outdated Show resolved Hide resolved

anirudhgarg reviewed Jun 20, 2020

View reviewed changes

samples/README.md Outdated Show resolved Hide resolved

samples/README.md Outdated Show resolved Hide resolved

anirudhgarg previously requested changes Jun 20, 2020

View reviewed changes

ghost added the Needs: author feedback label Jun 20, 2020

mhoeger reviewed Jun 22, 2020

View reviewed changes

ghost removed the Needs: author feedback label Jun 24, 2020

TsuyoshiUshio and others added 4 commits June 24, 2020 09:58

Update samples/README.md

9625d25

Co-authored-by: Anirudh Garg <anirudhgarg@gmail.com>

update readme

d483087

Merge branch 'tsushi/pythoncardinality' of github.com:Azure/azure-fun…

aca6a81

…ctions-kafka-extension into tsushi/pythoncardinality

reflect the change for the javascript/typescript

75bce8a

TsuyoshiUshio mentioned this pull request Jun 24, 2020

Support Alpine Docker image for V3 #141

Open

TsuyoshiUshio added 2 commits June 24, 2020 16:32

fix link issue

c6224f4

update python library

37db1cb

TsuyoshiUshio mentioned this pull request Jun 25, 2020

Kafka extension implementation Azure/azure-functions-python-library#62

Merged

This was referenced Jun 26, 2020

Local debug fails on mac #109

Closed

Cannot find librdkafka when hosting in Azure #123

Open

TsuyoshiUshio requested review from anirudhgarg and removed request for anirudhgarg June 26, 2020 23:19

amamounelsayed approved these changes Jun 26, 2020

View reviewed changes

TsuyoshiUshio merged commit 1a7cb25 into dev Jun 27, 2020

TsuyoshiUshio deleted the tsushi/pythoncardinality branch August 28, 2020 03:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Samples and documentation #140

Update Samples and documentation #140

TsuyoshiUshio commented Jun 19, 2020

Hazhzeng left a comment

amamounelsayed Jun 19, 2020 •

edited

TsuyoshiUshio Jun 20, 2020

amamounelsayed Jun 19, 2020

TsuyoshiUshio Jun 20, 2020

amamounelsayed Jun 19, 2020

amamounelsayed Jun 19, 2020

anirudhgarg left a comment

mhoeger left a comment

TsuyoshiUshio commented Jun 25, 2020

Update Samples and documentation #140

Update Samples and documentation #140

Conversation

TsuyoshiUshio commented Jun 19, 2020

What I did?

Review Direction

Python for @Hazhzeng

Java/TypeScript for @mhoeger

Java for @amamounelsayed

Overview/Structure for @anirudhgarg

TODO

Hazhzeng left a comment

Choose a reason for hiding this comment

amamounelsayed Jun 19, 2020 • edited

Choose a reason for hiding this comment

TsuyoshiUshio Jun 20, 2020

Choose a reason for hiding this comment

amamounelsayed Jun 19, 2020

Choose a reason for hiding this comment

TsuyoshiUshio Jun 20, 2020

Choose a reason for hiding this comment

amamounelsayed Jun 19, 2020

Choose a reason for hiding this comment

amamounelsayed Jun 19, 2020

Choose a reason for hiding this comment

anirudhgarg left a comment

Choose a reason for hiding this comment

mhoeger left a comment

Choose a reason for hiding this comment

TsuyoshiUshio commented Jun 25, 2020

amamounelsayed Jun 19, 2020 •

edited