This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-k-examples.git
commit d7cae88b42349e1a482d894f17eb68920d433d54
Author: lburgazzoli <lburgazz...@gmail.com>
AuthorDate: Tue Jun 23 19:48:57 2020 +0200
Add an Knative Camel Source example
---
03-knative-source-basic/readme.didact.md | 174 +++++++++++++++++++++++
03-knative-source-basic/readme.md | 1 +
03-knative-source-basic/telegram-channel.yaml | 7 +
03-knative-source-basic/telegram-consumer.groovy | 9 ++
03-knative-source-basic/telegram-source.yaml | 31 ++++
03-knative-source-basic/telegram.properties | 4 +
README.md | 1 +
7 files changed, 227 insertions(+)
diff --git a/03-knative-source-basic/readme.didact.md
b/03-knative-source-basic/readme.didact.md
new file mode 100644
index 0000000..021483b
--- /dev/null
+++ b/03-knative-source-basic/readme.didact.md
@@ -0,0 +1,174 @@
+# Camel Knative Source Basic Example
+
+This example demonstrates how to get started with Camel based Knative sources
by showing you some of the most important
+features that you should know before trying to develop more complex examples.
+
+You can find more information about Apache Camel and Apache Camel K on the
[official Camel website](https://camel.apache.org).
+
+## Before you begin
+
+Read the general instructions in the [root README.md file](../README.md) for
setting up your environment and the Kubernetes cluster before looking at this
example.
+
+Make sure you've read the [installation
instructions](https://camel.apache.org/camel-k/latest/installation/installation.html)
for your specific
+cluster before starting the example.
+
+You should open this file with
[Didact](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-didact)
if available on your IDE.
+
+## Requirements
+
+<a href='didact://?commandId=vscode.didact.validateAllRequirements'
title='Validate all requirements!'><button>Validate all Requirements at
Once!</button></a>
+
+**Kubectl CLI**
+
+The Kubernetes `kubectl` CLI tool will be used to interact with the Kubernetes
cluster.
+
+[Check if the Kubectl CLI is
installed](didact://?commandId=vscode.didact.cliCommandSuccessful&text=kubectl-requirements-status$$kubectl%20help&completion=Checked%20kubectl%20tool%20availability
"Tests to see if `kubectl help` returns a 0 return code"){.didact}
+
+*Status: unknown*{#kubectl-requirements-status}
+
+**Connection to a Kubernetes cluster**
+
+You need to connect to a Kubernetes cluster in order to run the example.
+
+[Check if you're connected to a Kubernetes
cluster](didact://?commandId=vscode.didact.cliCommandSuccessful&text=cluster-requirements-status$$kubectl%20get%20pod&completion=Checked%20Kubernetes%20connection
"Tests to see if `kubectl get pod` returns a 0 return code"){.didact}
+
+*Status: unknown*{#cluster-requirements-status}
+
+**Apache Camel K CLI ("kamel")**
+
+You need the Apache Camel K CLI ("kamel") in order to access all Camel K
features.
+
+[Check if the Apache Camel K CLI ("kamel") is
installed](didact://?commandId=vscode.didact.requirementCheck&text=kamel-requirements-status$$kamel%20version$$Camel%20K%20Client&completion=Checked%20if%20Camel%20K%20CLI%20is%20available%20on%20this%20system.
"Tests to see if `kamel version` returns a result"){.didact}
+
+*Status: unknown*{#kamel-requirements-status}
+
+**Knative installed on the cluster**
+
+The cluster also needs to have Knative installed and working. Refer to the
[official Knative documentation](https://knative.dev/docs/install/) for
information on how to install it in your cluster.
+
+[Check if the Knative Serving is
installed](didact://?commandId=vscode.didact.requirementCheck&text=kserving-project-check$$kubectl%20api-resources%20--api-group=serving.knative.dev$$kservice%2Cksvc&completion=Verified%20Knative%20services%20installation.
"Verifies if Knative Serving is installed"){.didact}
+
+*Status: unknown*{#kserving-project-check}
+
+[Check if the Knative Eventing is
installed](didact://?commandId=vscode.didact.requirementCheck&text=keventing-project-check$$kubectl%20api-resources%20--api-group=messaging.knative.dev$$inmemorychannels&completion=Verified%20Knative%20eventing%20services%20installation.
"Verifies if Knative Eventing is installed"){.didact}
+
+*Status: unknown*{#keventing-project-check}
+
+**Knative Camel Source installed on the cluster**
+
+The cluster also needs to have installed the Knative Camel Source from the
camel.yaml in the [Eventing Sources release
page](https://github.com/knative/eventing-contrib/releases)
+
+[Check if the Knative Camel Source is
installed](didact://?commandId=vscode.didact.requirementCheck&text=kservice-project-check$$kubectl%20api-resources%20--api-group=sources.knative.dev$$camelsources&completion=Verified%20Knative%20Camel%20Source%20installation.
"Verifies if Knative Camel Source is installed"){.didact}
+
+*Status: unknown*{#kservice-project-check}
+
+### Optional Requirements
+
+The following requirements are optional. They don't prevent the execution of
the demo, but may make it easier to follow.
+
+**VS Code Extension Pack for Apache Camel**
+
+The VS Code Extension Pack for Apache Camel provides a collection of useful
tools for Apache Camel K developers,
+such as code completion and integrated lifecycle management. They are
**recommended** for the tutorial, but they are **not**
+required.
+
+You can install it from the VS Code Extensions marketplace.
+
+[Check if the VS Code Extension Pack for Apache Camel by Red Hat is
installed](didact://?commandId=vscode.didact.extensionRequirementCheck&text=extension-requirement-status$$redhat.apache-camel-extension-pack&completion=Camel%20extension%20pack%20is%20available%20on%20this%20system.
"Checks the VS Code workspace to make sure the extension pack is
installed"){.didact}
+
+*Status: unknown*{#extension-requirement-status}
+
+## 1. Preparing the namespace
+
+Let's open a terminal and go to the example directory:
+
+```
+cd 03-knative-source-basic
+```
+([^
execute](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=camelTerm$$cd%2003-knative-source-basic&completion=Executed%20command.
"Opens a new terminal and sends the command above"){.didact})
+
+
+We're going to create a namespace named `camel-source` for running the
example. To create it, execute the following command:
+
+```
+kubectl create namespace camel-source
+```
+([^
execute](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=camelTerm$$kubectl%20create%20namespace%20camel-source&completion=New%20project%20creation.
"Opens a new terminal and sends the command above"){.didact})
+
+
+Now we can set the `camel-source` namespace as default namespace for the
following commands:
+
+```
+kubectl config set-context --current --namespace=camel-source
+```
+([^
execute](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=camelTerm$$kubectl%20config%20set-context%20--current%20--namespace%3Dcamel-basic&completion=New%20project%20creation.
"Opens a new terminal and sends the command above"){.didact})
+
+You need to install Camel K in the `camel-source` namespace (or globally in
the whole cluster).
+In many settings (e.g. OpenShift, CRC), it's sufficient to execute the
following command to install Camel K:
+
+```
+kamel install
+```
+([^
execute](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=camelTerm$$kamel%20install&completion=Installing%20Camel%20K.
"Opens a new terminal and sends the command above"){.didact})
+
+NOTE: The `kamel install` command requires some prerequisites to be successful
in some situations, e.g. you need to enable the registry addon on Minikube.
Refer to the [Camel K install
guide](https://camel.apache.org/camel-k/latest/installation/installation.html)
for cluster-specific instructions.
+
+To check that Camel K is installed we'll retrieve the IntegrationPlatform
object from the namespace:
+
+```
+kubectl get integrationplatform
+```
+([^
execute](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=camelTerm$$kubectl%20get%20integrationplatform&completion=Executed%20Command.
"Opens a new terminal and sends the command above"){.didact})
+
+You should find an IntegrationPlatform in status `Ready`.
+
+You can now proceed to the next section.
+
+## 2. Preparing the environment
+
+This repository contains a simple
[telegram.properties](didact://?commandId=vscode.openFolder&projectFilePath=01-basic/telegram.properties&completion=Opened%20the%telegram.properties%20file
"Opens the telegram.properties file"){.didact} that can be used to generate a
Kubernetes Secret with the Telergam Bot Token obtained with the
(@BotFather)[hhtps://telegram.me/botfather] by replacing `
+<token-from-botfather>` with the actual token.
+
+```
+kubectl create secret generic telegram --from-file=telegram.properties
+```
+([^
execute](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=camelTerm$$kubectl%20create%20secret%20generic%20telegram%20--from-file%3Dtelegram.properties&completion=secret%20%22telegram%22%20created.
"Create a secret with Telegram credentials"){.didact})
+
+As the example levareges (Knative Eventing
channels)[https://knative.dev/docs/eventing/channels/], we need to create the
one that the example will use:
+
+```
+kubectl apply -f telegram-channel.yaml
+```
+([^
execute](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=camelTerm$$kubectl%20apply%20-f%20telegram-channel.yaml&completion=inmemorychannel.messaging.knative.dev/telegram$20created.
"Create a Knative InMemoryChannel named Telegam"){.didact})
+
+## 2. Running a Camel Source
+
+This repository contains a simple Camel Source based on the (Telegram
component)[https://camel.apache.org/components/latest/telegram-component.html]
that forward messages received by the bot to a Knative channel named `telegram`
+
+Use the following command to deploy the Camel Source:
+
+```
+kubectl apply -f telegram-source.yaml
+```
+([^
execute](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=camelTerm$$kubectl%20apply%20-f%20telegram-source.yaml&completion=camelsource.sources.knative.dev/camel-telegram-source%20created.
"Opens a new terminal and sends the command above"){.didact})
+
+
+## 2. Running a basic integration to echo messages from Telegam in the console
+
+
+```
+kamel run telegram-consumer.groovy --dev
+```
+([^
execute](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=camelTerm$$kamel%20run%20telegram-consumer.groovy%20--dev&completion=Camel%20K%20telegram-consumer%20integration%20run%20in%20dev%20mode.
"Opens a new terminal and sends the command above"){.didact})
+
+
+If everything is ok, after the build phase finishes, you should see the Camel
integration running and printing the mesage you ahve sent to tour Telegram Bot.
+
+## 4. Uninstall
+
+To cleanup everything, execute the following command:
+
+```kubectl delete namespace camel-source```
+
+([^
execute](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=camelTerm$$kubectl%20delete%20namespace%20camel-basic&completion=Removed%20the%20namespace%20from%20the%20cluster.
"Cleans up the cluster after running the example"){.didact})
+
diff --git a/03-knative-source-basic/readme.md
b/03-knative-source-basic/readme.md
new file mode 120000
index 0000000..c0bf82f
--- /dev/null
+++ b/03-knative-source-basic/readme.md
@@ -0,0 +1 @@
+readme.didact.md
\ No newline at end of file
diff --git a/03-knative-source-basic/telegram-channel.yaml
b/03-knative-source-basic/telegram-channel.yaml
new file mode 100644
index 0000000..3e66f6d
--- /dev/null
+++ b/03-knative-source-basic/telegram-channel.yaml
@@ -0,0 +1,7 @@
+#
+# Knative Channel
+#
+apiVersion: messaging.knative.dev/v1alpha1
+kind: InMemoryChannel
+metadata:
+ name: telegram
\ No newline at end of file
diff --git a/03-knative-source-basic/telegram-consumer.groovy
b/03-knative-source-basic/telegram-consumer.groovy
new file mode 100644
index 0000000..644fb61
--- /dev/null
+++ b/03-knative-source-basic/telegram-consumer.groovy
@@ -0,0 +1,9 @@
+// camel-k: dependency=camel-jackson
+//
+// Apache Camel Telegram Consumer
+//
+from('knative:channel/telegram')
+ .unmarshal()
+ .json()
+ .setBody { it.in.body.text }
+ .log('Recieved: ${body}')
diff --git a/03-knative-source-basic/telegram-source.yaml
b/03-knative-source-basic/telegram-source.yaml
new file mode 100644
index 0000000..d888fed
--- /dev/null
+++ b/03-knative-source-basic/telegram-source.yaml
@@ -0,0 +1,31 @@
+#
+# Apache Camel Telegram Source
+#
+apiVersion: sources.knative.dev/v1alpha1
+kind: CamelSource
+metadata:
+ name: camel-telegram-source
+spec:
+ source:
+ integration:
+ configuration:
+ - type: secret
+ value: telegram
+ dependencies:
+ - camel:jackson
+ flow:
+ from:
+ uri: telegram:bots
+ parameters:
+ # Telegram token obtained by BotFather and defined
+ # in the telegram.properties
+ authorizationToken: "{{telegram.token}}"
+ steps:
+ - to: "log:received?showAll=true&multiline=true"
+ - marshal:
+ json: {}
+ sink:
+ ref:
+ apiVersion: messaging.knative.dev/v1beta1
+ kind: InMemoryChannel
+ name: telegram
diff --git a/03-knative-source-basic/telegram.properties
b/03-knative-source-basic/telegram.properties
new file mode 100644
index 0000000..4931752
--- /dev/null
+++ b/03-knative-source-basic/telegram.properties
@@ -0,0 +1,4 @@
+#
+# Telegram Secret
+#
+telegram.token = <token-from-botfather>
\ No newline at end of file
diff --git a/README.md b/README.md
index f1fbdf6..0206521 100644
--- a/README.md
+++ b/README.md
@@ -48,3 +48,4 @@ This is the current list of examples:
- [01 Basic](./01-basic): Getting started with Camel K by learning the most
important features that you should know before trying to develop more complex
examples.
- [02 Serverless API](./02-serverless-api): Learn how to design an API that
manages files in a remote storage location and leverages *Knative* Serving to
scale automatically (even to zero instances) based on the current load.
+- [03 Knative Source Basic](./03-knative-source-basic): Getting started with
Knative Camel Source by learning the most important concepts you should know
before trying to develop more complex examples.
