This example demonstrates how to create a Camel based Knative source for Salesforce and a Camel route which consumes it.
You can find more information about Apache Camel and Apache Camel K on the official Camel website.
Read the general instructions in the root README.md file for setting up your environment and the Kubernetes cluster before looking at this example.
Make sure you've read the installation instructions for your specific cluster before starting the example.
You should open this file with Didact if available on your IDE.
Validate all Requirements at Once!
Kubectl CLI
The Kubernetes kubectl CLI tool will be used to interact with the Kubernetes cluster.
Check if the Kubectl CLI is installed{.didact}
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}
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}
Knative installed on the cluster
The cluster also needs to have Knative installed and working. Refer to the official Knative documentation for information on how to install it in your cluster.
Check if the Knative Serving is installed{.didact}
Check if the Knative Eventing is installed{.didact}
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
Check if the Knative Camel Source is installed{.didact}
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}
Let's open a terminal and go to the example directory:
cd 10-knative-source-salesforce
(^ execute{.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})
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})
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})
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 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})
You should find an IntegrationPlatform in status Ready.
You can now proceed to the next section.
This examples uses OAuth 2.0 Refresh Token Flow, which requires 3 credentials collected from Salesforce - Client ID, Client Secret and Refresh Token.
you might want to sign up with your own Developer account at developer.salesforce.com. After you have done that, you’ll need to create a Connected Application for your integration.
Here is an example workflow of creating a Connected Application and get required credentials.For more details, please check Salesforce online manual https://help.salesforce.com/articleView?id=extend_code_overview.htm&type=5
Note: This was written with Salesforce Lightening user interface. Classic user interface might have slightly different menu and/or workflow.
PLATFORM TOOLS > Apps > App Manager in a navigation tree at the left of Salesforce Setup screenNew Connected App button at the upper rightcamelk_knative_source_salesforce for Connected App Namehttps://login.salesforce.com/services/oauth2/success for Callback URLAccess and manage your data (api) and Perform requests on your behalf at any time (refresh_token, offline_access), then click Add buttonManage Connected Apps page. Consumer Key and Consumer Secret are available in API section. Use Consumer Key as a Client ID and Consumer Secret as a Client Secret.PLATFORM TOOLS > Apps > Connected Apps > Manage Connected AppsEdit next to the camelk_knative_source_salesforceRelax IP restrictions for IP RelaxationRefresh token is valid until revokedSaveIn your browser go to the URL change the __YOUR_CLIENT_ID_HERE__ with your connected application Consumer Key:
https://login.salesforce.com/services/oauth2/authorize?response_type=token&client_id=YOUR_CLIENT_ID_HERE&redirect_uri=https://login.salesforce.com/services/oauth2/success&display=touch
Allow access to the application, and you’ll end up on a page with refresh_token, something like:
https://login.salesforce.com/services/oauth2/success#access_token=..&refresh_token=<refresh_token>&instance_url=...&issued_at=...&signature=...&scope=...&token_type=Bearer
This repository contains a simple salesforce.properties{.didact} that can be used to generate a Kubernetes Secret with the Salesforce credential by replacing <Your Client ID>, <Your Client Secret> and <Your Refresh Token> with the actual values.
kubectl create secret generic salesforce --from-file=salesforce.properties
(^ execute{.didact})
As the example levareges Knative Eventing channels, we need to create the one that the example will use:
kubectl apply -f salesforce-channel.yaml
(^ execute{.didact})
This repository contains a Camel Source based on the Salesforce component that forward Salesforce event notifications to a Knative channel named salesforce
Use the following command to deploy the Camel Source:
kubectl apply -f salesforce-source.yaml
(^ execute{.didact})
kamel run SalesforceConsumer.java --dev
(^ execute{.didact})
If everything is ok, after the build phase finishes, you should see the Camel integration running and printing the message when you create a Contact in Salesforce.
To cleanup everything, execute the following command:
kubectl delete namespace camel-source
(^ execute{.didact})