Getting Started with Camel K

Procedure

1. In the OpenShift Container Platform web console, log in by using an account with cluster administrator privileges.

2. Create a new OpenShift project:

   1. In the left navigation menu, click Home > Project > Create Project.
   2. Enter a project name, for example, my-camel-k-project, and then click Create.
3. In the left navigation menu, click Operators > OperatorHub.
4. In the Filter by keyword text box, type Camel K and then click the Red Hat Integration - Camel K Operator card.
5. Read the information about the operator and then click Install. The Operator installation page opens.

6. Select the following subscription settings:

   • Update Channel > latest

   • Choose among the following 2 options:

     • Installation Mode > A specific namespace on the cluster > my-camel-k-project
     • Installation Mode > All namespaces on the cluster (default) > Openshift operator
   Note

   If you do not choose among the above two options, the system by default chooses a global namespace on the cluster then leading to openshift operator.

   • Approval Strategy > Automatic

     Note

     The Installation mode > All namespaces on the cluster and Approval Strategy > Manual settings are also available if required by your environment.

7. Click Install, and wait a few moments until the Camel K Operator is ready for use.

8. Download and install the Camel K CLI tool:

   1. From the Help menu (?) at the top of the OpenShift web console, select Command line tools.
   2. Scroll down to the kamel - Red Hat Integration - Camel K - Command Line Interface section.
   3. Click the link to download the binary for your local operating system (Linux, Mac, Windows).
   4. Unzip and install the CLI in your system path.

   5. To verify that you can access the Kamel K CLI, open a command window and then type the following:

      kamel --help

      This command shows information about Camel K CLI commands.

Procedure

1. In the OpenShift Container Platform web console, log in by using an account with cluster administrator privileges.
2. In the left navigation menu, click Operators > OperatorHub.
3. In the Filter by keyword text box, enter Serverless to find the OpenShift Serverless Operator.
4. Read the information about the Operator and then click Install to display the Operator subscription page.

5. Select the default subscription settings:

   • Update Channel > Select the channel that matches your OpenShift version, for example, 4.16
   • Installation Mode > All namespaces on the cluster

   • Approval Strategy > Automatic

     Note

     The Approval Strategy > Manual setting is also available if required by your environment.

6. Click Install, and wait a few moments until the Operator is ready for use.

7. Install the required Knative components using the steps in the OpenShift documentation:

   • Installing Knative Serving
   • Installing Knative Eventing

8. (Optional) Download and install the OpenShift Serverless CLI tool:

   1. From the Help menu (?) at the top of the OpenShift web console, select Command line tools.
   2. Scroll down to the kn - OpenShift Serverless - Command Line Interface section.
   3. Click the link to download the binary for your local operating system (Linux, Mac, Windows)
   4. Unzip and install the CLI in your system path.

   5. To verify that you can access the kn CLI, open a command window and then type the following:

      kn --help

      This command shows information about OpenShift Serverless CLI commands.

      For more details, see the OpenShift Serverless CLI documentation.

Procedure

1. To create a ConfigMap from a file, run the following command.

   oc create configmap maven-settings --from-file=settings.xml

   Created ConfigMap can be then referenced in the IntegrationPlatform resource, from the spec.build.maven.settings field.

   Example

   apiVersion: camel.apache.org/v1
   kind: IntegrationPlatform
   metadata:
     name: camel-k
   spec:
     build:
        maven:
           settings:
              configMapKeyRef:
                   key: settings.xml
                   name: maven-settings

   Or you can edit the IntegrationPlatform resource directly to reference the ConfigMap that contains the Maven settings using following command:

   oc edit itp camel-k

Procedure

1. Create a Secret from file using following command:

   oc create secret generic maven-ca-certs --from-file=ca.crt

2. Reference the created Secret in the IntegrationPlatform resource, from the spec.build.maven.caSecret field as shown below.

   apiVersion: camel.apache.org/v1
   kind: IntegrationPlatform
   metadata:
     name: camel-k
   spec:
     build:
         maven:
             caSecret:
                key: tls.crt
                name: tls-secret

Procedure

1. Install VS Code on your development platform. For example, on Red Hat Enterprise Linux:

   1. Install the required key and repository:

      $ sudo rpm --import https://packages.microsoft.com/keys/microsoft.asc
      $ sudo sh -c 'echo -e "[code]\nname=Visual Studio Code\nbaseurl=https://packages.microsoft.com/yumrepos/vscode\nenabled=1\ngpgcheck=1\ngpgkey=https://packages.microsoft.com/keys/microsoft.asc" > /etc/yum.repos.d/vscode.repo'

   2. Update the cache and install the VS Code package:

      $ yum check-update
      $ sudo yum install code

      For details on installing on other platforms, see the VS Code installation documentation.

2. Enter the code command to launch the VS Code editor. For more details, see the VS Code command line documentation.

3. Install the VS Code Camel Extension Pack, which includes the extensions required for Camel K. For example, in VS Code:

   1. In the left navigation bar, click Extensions.
   2. In the search box, enter Apache Camel.

   3. Select the Extension Pack for Apache Camel by Red Hat, and click Install.

      

      For more details, see the instructions for the Extension Pack for Apache Camel by Red Hat.

Procedure

1. Enter the camel init command to generate a simple Java integration file. For example:

   $ camel init HelloCamelK.java

2. Open the generated integration file in your IDE and edit as appropriate. For example, the HelloCamelK.java integration automatically includes the Camel timer and log components to help you get started:

   // camel-k: language=java
   
   import org.apache.camel.builder.RouteBuilder;
   
   public class HelloCamelK extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
         // Write your routes here, for example:
         from("timer:java?period=1s")
           .routeId("java")
           .setBody()
             .simple("Hello Camel K from ${routeId}")
           .to("log:info");
   
     }
   }

Procedure

1. Enter the camel init command to generate a simple YAML integration file. For example:

   $ camel init hello.camelk.yaml

2. Open the generated integration file in your IDE and edit as appropriate. For example, the hello.camelk.yaml integration automatically includes the Camel timer and log components to help you get started:

   # Write your routes here, for example:
   - from:
       uri: "timer:yaml"
       parameters:
         period: "1s"
       steps:
         - set-body:
             constant: "Hello Camel K from yaml"
         - to: "log:info"

Procedure

1. Log into your OpenShift cluster using the oc client tool, for example:

   $ oc login --token=my-token --server=https://my-cluster.example.com:6443

2. Ensure that the Camel K Operator is running, for example:

   $ oc get pod
   NAME                               READY   STATUS    RESTARTS   AGE
   camel-k-operator-86b8d94b4-pk7d6   1/1     Running   0          6m28s

3. Enter the kamel run command to run your integration in the cloud on OpenShift. For example:

   Java example

   $ kamel run HelloCamelK.java
   integration "hello-camel-k" created

   YAML example

   $ kamel run hello.camelk.yaml
   integration "hello" created

4. Enter the kamel get command to check the status of the integration:

   $ kamel get
   NAME       PHASE           KIT
   hello      Building Kit    myproject/kit-bq666mjej725sk8sn12g

   When the integration runs for the first time, Camel K builds the integration kit for the container image, which downloads all the required Camel modules and adds them to the image classpath.

5. Enter kamel get again to verify that the integration is running:

   $ kamel get
   NAME       PHASE   KIT
   hello      Running myproject/kit-bq666mjej725sk8sn12g

6. Enter the kamel log command to print the log to stdout:

   $ kamel log hello
   [1] 2021-08-11 17:58:40,573 INFO  [org.apa.cam.k.Runtime] (main) Apache Camel K Runtime 1.7.1.fuse-800025-redhat-00001
   [1] 2021-08-11 17:58:40,653 INFO  [org.apa.cam.qua.cor.CamelBootstrapRecorder] (main) bootstrap runtime: org.apache.camel.quarkus.main.CamelMainRuntime
   [1] 2021-08-11 17:58:40,844 INFO  [org.apa.cam.k.lis.SourcesConfigurer] (main) Loading routes from: SourceDefinition{name='camel-k-embedded-flow', language='yaml', location='file:/etc/camel/sources/camel-k-embedded-flow.yaml', }
   [1] 2021-08-11 17:58:41,216 INFO  [org.apa.cam.imp.eng.AbstractCamelContext] (main) Routes startup summary (total:1 started:1)
   [1] 2021-08-11 17:58:41,217 INFO  [org.apa.cam.imp.eng.AbstractCamelContext] (main)     Started route1 (timer://yaml)
   [1] 2021-08-11 17:58:41,217 INFO  [org.apa.cam.imp.eng.AbstractCamelContext] (main) Apache Camel 3.10.0.fuse-800010-redhat-00001 (camel-1) started in 136ms (build:0ms init:100ms start:36ms)
   [1] 2021-08-11 17:58:41,268 INFO  [io.quarkus] (main) camel-k-integration 1.6.6 on JVM (powered by Quarkus 1.11.7.Final-redhat-00009) started in 2.064s.
   [1] 2021-08-11 17:58:41,269 INFO  [io.quarkus] (main) Profile prod activated.
   [1] 2021-08-11 17:58:41,269 INFO  [io.quarkus] (main) Installed features: [camel-bean, camel-core, camel-k-core, camel-k-runtime, camel-log, camel-support-common, camel-timer, camel-yaml-dsl, cdi]
   [1] 2021-08-11 17:58:42,423 INFO  [info] (Camel (camel-1) thread #0 - timer://yaml) Exchange[ExchangePattern: InOnly, BodyType: String, Body: Hello Camel K from yaml]
   ...

7. Press Ctrl-C to terminate logging in the terminal.

Procedure

1. Log into your OpenShift cluster using the oc client tool, for example:

   $ oc login --token=my-token --server=https://my-cluster.example.com:6443

2. Ensure that the Camel K Operator is running, for example:

   $ oc get pod
   NAME                               READY   STATUS    RESTARTS   AGE
   camel-k-operator-86b8d94b4-pk7d6   1/1     Running   0          6m28s

3. Enter the kamel run command with --dev to run your integration in development mode on OpenShift in the cloud. The following shows a simple Java example:

   $ kamel run HelloCamelK.java --dev
   Condition "IntegrationPlatformAvailable" is "True" for Integration hello-camel-k: test/camel-k
   Integration hello-camel-k in phase "Initialization"
   Integration hello-camel-k in phase "Building Kit"
   Condition "IntegrationKitAvailable" is "True" for Integration hello-camel-k: kit-c49sqn4apkb4qgn55ak0
   Integration hello-camel-k in phase "Deploying"
   Progress: integration "hello-camel-k" in phase Initialization
   Progress: integration "hello-camel-k" in phase Building Kit
   Progress: integration "hello-camel-k" in phase Deploying
   Integration hello-camel-k in phase "Running"
   Condition "DeploymentAvailable" is "True" for Integration hello-camel-k: deployment name is hello-camel-k
   Progress: integration "hello-camel-k" in phase Running
   Condition "CronJobAvailable" is "False" for Integration hello-camel-k: different controller strategy used (deployment)
   Condition "KnativeServiceAvailable" is "False" for Integration hello-camel-k: different controller strategy used (deployment)
   Condition "Ready" is "False" for Integration hello-camel-k
   Condition "Ready" is "True" for Integration hello-camel-k
   [1] Monitoring pod hello-camel-k-7f85df47b8-js7cb
   ...
   ...
   [1] 2021-08-11 18:34:44,069 INFO  [org.apa.cam.k.Runtime] (main) Apache Camel K Runtime 1.7.1.fuse-800025-redhat-00001
   [1] 2021-08-11 18:34:44,167 INFO  [org.apa.cam.qua.cor.CamelBootstrapRecorder] (main) bootstrap runtime: org.apache.camel.quarkus.main.CamelMainRuntime
   [1] 2021-08-11 18:34:44,362 INFO  [org.apa.cam.k.lis.SourcesConfigurer] (main) Loading routes from: SourceDefinition{name='HelloCamelK', language='java', location='file:/etc/camel/sources/HelloCamelK.java', }
   [1] 2021-08-11 18:34:46,180 INFO  [org.apa.cam.imp.eng.AbstractCamelContext] (main) Routes startup summary (total:1 started:1)
   [1] 2021-08-11 18:34:46,180 INFO  [org.apa.cam.imp.eng.AbstractCamelContext] (main)     Started java (timer://java)
   [1] 2021-08-11 18:34:46,180 INFO  [org.apa.cam.imp.eng.AbstractCamelContext] (main) Apache Camel 3.10.0.fuse-800010-redhat-00001 (camel-1) started in 243ms (build:0ms init:213ms start:30ms)
   [1] 2021-08-11 18:34:46,190 INFO  [io.quarkus] (main) camel-k-integration 1.6.6 on JVM (powered by Quarkus 1.11.7.Final-redhat-00009) started in 3.457s.
   [1] 2021-08-11 18:34:46,190 INFO  [io.quarkus] (main) Profile prod activated.
   [1] 2021-08-11 18:34:46,191 INFO  [io.quarkus] (main) Installed features: [camel-bean, camel-core, camel-java-joor-dsl, camel-k-core, camel-k-runtime, camel-log, camel-support-common, camel-timer, cdi]
   [1] 2021-08-11 18:34:47,200 INFO  [info] (Camel (camel-1) thread #0 - timer://java) Exchange[ExchangePattern: InOnly, BodyType: String, Body: Hello Camel K from java]
   [1] 2021-08-11 18:34:48,180 INFO  [info] (Camel (camel-1) thread #0 - timer://java) Exchange[ExchangePattern: InOnly, BodyType: String, Body: Hello Camel K from java]
   [1] 2021-08-11 18:34:49,180 INFO  [info] (Camel (camel-1) thread #0 - timer://java) Exchange[ExchangePattern: InOnly, BodyType: String, Body: Hello Camel K from java]
   ...

4. Edit the content of your integration DSL file, save your changes, and see the changes displayed instantly in the terminal. For example:

   ...
   integration "hello-camel-k" updated
   ...
   [2] 2021-08-11 18:40:54,173 INFO  [org.apa.cam.k.Runtime] (main) Apache Camel K Runtime 1.7.1.fuse-800025-redhat-00001
   [2] 2021-08-11 18:40:54,209 INFO  [org.apa.cam.qua.cor.CamelBootstrapRecorder] (main) bootstrap runtime: org.apache.camel.quarkus.main.CamelMainRuntime
   [2] 2021-08-11 18:40:54,301 INFO  [org.apa.cam.k.lis.SourcesConfigurer] (main) Loading routes from: SourceDefinition{name='HelloCamelK', language='java', location='file:/etc/camel/sources/HelloCamelK.java', }
   [2] 2021-08-11 18:40:55,796 INFO  [org.apa.cam.imp.eng.AbstractCamelContext] (main) Routes startup summary (total:1 started:1)
   [2] 2021-08-11 18:40:55,796 INFO  [org.apa.cam.imp.eng.AbstractCamelContext] (main)     Started java (timer://java)
   [2] 2021-08-11 18:40:55,797 INFO  [org.apa.cam.imp.eng.AbstractCamelContext] (main) Apache Camel 3.10.0.fuse-800010-redhat-00001 (camel-1) started in 174ms (build:0ms init:147ms start:27ms)
   [2] 2021-08-11 18:40:55,803 INFO  [io.quarkus] (main) camel-k-integration 1.6.6 on JVM (powered by Quarkus 1.11.7.Final-redhat-00009) started in 3.025s.
   [2] 2021-08-11 18:40:55,808 INFO  [io.quarkus] (main) Profile prod activated.
   [2] 2021-08-11 18:40:55,809 INFO  [io.quarkus] (main) Installed features: [camel-bean, camel-core, camel-java-joor-dsl, camel-k-core, camel-k-runtime, camel-log, camel-support-common, camel-timer, cdi]
   [2] 2021-08-11 18:40:56,810 INFO  [info] (Camel (camel-1) thread #0 - timer://java) Exchange[ExchangePattern: InOnly, BodyType: String, Body: Hello Camel K from java]
   [2] 2021-08-11 18:40:57,793 INFO  [info] (Camel (camel-1) thread #0 - timer://java) Exchange[ExchangePattern: InOnly, BodyType: String, Body: Hello Camel K from java]
   ...

5. Press Ctrl-C to terminate logging in the terminal.

Procedure

1. Add a Camel K modeline entry to your integration file. For example:

   ThreeScaleRest.java

   // camel-k: trait=3scale.enabled=true trait=container.limit-memory=256Mi 1
   import org.apache.camel.builder.RouteBuilder;
   
   public class ThreeScaleRest extends RouteBuilder {
   
     @Override
     public void configure() throws Exception {
         rest().get("/")
           .to("direct:x");
   
         from("direct:x")
           .setBody().constant("Hello");
     }
   }

   Enables both the container and 3scale traits, to expose the route through 3scale and to limit the container memory.

2. Run the integration, for example:

   kamel run ThreeScaleRest.java

   The kamel run command outputs any modeline options specified in the integration, for example:

   Modeline options have been loaded from source files
   Full command: kamel run ThreeScaleRest.java --trait=3scale.enabled=true --trait=container.limit-memory=256Mi

Code example

1. Following is a simple integration that uses a Configmap to expose some message on an HTTP endpoint. You can start creating such an integration and testing in a namespace called development.

   kubectl create configmap my-cm --from-literal=greeting="hello, I am development!" -n development

   PromoteServer.java

   import org.apache.camel.builder.RouteBuilder;
   
   public class PromoteServer extends RouteBuilder {
     @Override
     public void configure() throws Exception {
       from("platform-http:/hello?httpMethodRestrict=GET").setBody(simple("resource:classpath:greeting"));
     }
   }

2. Now run it.

   kamel run --dev -n development PromoteServer.java --config configmap:my-cm [-t service.node-port=true]

3. You must tweak the service trait, depending on the Kubernetes platform and the level of exposure you want to provide. After that you can test it.

   curl http://192.168.49.2:32116/hello
   hello, I am development!

4. After testing of your integration, you can move it to a production environment. You must have the destination environment (a Openshift namespace) ready with an operator (sharing the same operator source container registry) and any configuration, such as the configmap you have used here. For that scope, create one on the destination namespace.

   kubectl create configmap my-cm --from-literal=greeting="hello, I am production!" -n production

   Note

   For security reasons, there is a check to ensure that the expected resources such as Configmaps, Secrets and Kamelets are present on the destination. If any of these resources are missing, the integration does not move.

5. You can now promote your integration.

   kamel promote promote-server -n development --to production
   kamel logs promote-server -n production

6. Test the promoted integration.

   curl http://192.168.49.2:30764/hello
   hello, I am production!

   Since the Integration is reusing the same container image, the new application is executed immediately. Also, the immutability of the Integration is assured as the container used is exactly the same as the one tested in development (changes are just the configurations).

   Note

   The integration running in the test is not altered in any way and keeps running until you stop it.

Procedure

1. In the Administrator perspective of the OpenShift Container Platform web console, navigate to Operators → Installed Operators.
2. Click the Camel K Operator.
3. Click the Subscription tab.
4. Click the name of the update channel under Channel.
5. Click the newer update channel that you want to change to. For example, latest. Click Save. This will start the upgrade to the latest Camel K version.

Procedure

1. Clone the tutorial Git repository.

   $ git clone git@github.com:openshift-integration/camel-k-example-basic.git

2. In VS Code, select File → Open Folder → camel-k-example-basic.
3. In the VS Code navigation tree, click the readme.md file. This opens a new tab in VS Code to display the tutorial instructions.

4. Follow the tutorial instructions.

   Alternatively, if you do not have VS Code installed, you can manually enter the commands from deploying basic Camel K Java integration.

Procedure

1. Clone the tutorial Git repository:

   $ git clone git@github.com:openshift-integration/camel-k-example-knative.git

2. In VS Code, select File → Open Folder → camel-k-example-knative.
3. In the VS Code navigation tree, click the readme.md file. This opens a new tab in VS Code to display the tutorial instructions.

4. Follow the tutorial instructions.

   If you do not have VS Code installed, you can manually enter the commands from deploying Camel K Knative integration.

Procedure

1. Clone the tutorial Git repository:

   $ git clone git@github.com:openshift-integration/camel-k-example-transformations.git

2. In VS Code, select File → Open Folder → camel-k-example-transformations.
3. In the VS Code navigation tree, click the readme.md file. This opens a new tab in VS Code to display the tutorial instructions.

4. Follow the tutorial instructions.

   If you do not have VS Code installed, you can manually enter the commands from deploying Camel K transformations integration.

Procedure

1. Clone the tutorial Git repository.

   $ git clone git@github.com:openshift-integration/camel-k-example-event-streaming.git

2. In VS Code, select File → Open Folder → camel-k-example-event-streaming.
3. In the VS Code navigation tree, click the readme.md file. This opens a new tab in VS Code to display the tutorial instructions.

4. Follow the tutorial instructions.

   Alternatively, if you do not have VS Code installed, you can manually enter the commands from deploying Camel K event stream integration.

Procedure

1. Clone the tutorial Git repository.

   $ git clone git@github.com:openshift-integration/camel-k-example-api.git

2. In VS Code, select File → Open Folder → camel-k-example-api.
3. In the VS Code navigation tree, click the readme.md file. This opens a new tab in VS Code to display the tutorial instructions.

4. Follow the tutorial instructions.

   Alternatively, if you do not have VS Code installed, you can manually enter the commands from deploying Camel K API integration.

Procedure

1. Clone the tutorial Git repository:

   $ git clone git@github.com:openshift-integration/camel-k-example-saas.git

2. In VS Code, select File → Open Folder → camel-k-example-saas.
3. In the VS Code navigation tree, click the readme.md file. This opens a new tab in VS Code to display the tutorial instructions.

4. Follow the tutorial instructions .

   If you do not have VS Code installed, you can manually enter the commands from deploying Camel K SaaS integration.

Procedure

1. Clone the tutorial Git repository.

   $ git clone git@github.com:openshift-integration/camel-k-example-jdbc.git

2. In VS Code, select File → Open Folder → camel-k-example-jdbc.
3. In the VS Code navigation tree, click the readme.md file. This opens a new tab in VS Code to display the tutorial instructions.

4. Follow the tutorial instructions.

   Alternatively, if you do not have VS Code installed, you can manually enter the commands from deploying Camel K JDBC integration.

Procedure

1. Clone the tutorial Git repository:

   $ git clone git@github.com:openshift-integration/camel-k-example-jms.git

2. In VS Code, select File → Open Folder → camel-k-example-jms.
3. In the VS Code navigation tree, click the readme.md file. This opens a new tab in VS Code to display the tutorial instructions.

4. Follow the tutorial instructions.

   If you do not have VS Code installed, you can manually enter the commands from deploying Camel K JMS integration.

Procedure

1. Clone the tutorial Git repository:

   $ git clone git@github.com:openshift-integration/camel-k-example-kafka.git

2. In VS Code, select File → Open Folder → camel-k-example-kafka.
3. In the VS Code navigation tree, click the readme.md file. This opens a new tab in VS Code to display the tutorial instructions.

4. Follow the tutorial instructions.

   If you do not have VS Code installed, you can manually enter the commands from deploying Camel K Kafka integration.