Chapter 7. Configuring Camel K integrations

This chapter explains available options for configuring Red Hat Integration - Camel K integrations using properties:

7.1. Configuring Camel K integrations using properties

You can configure properties for Camel K integrations on the command line at runtime. When you define a property in an integration using a property placeholder, for example, {{my.message}}, you can specify the property value on the command line, for example --property my.message=Hello. You can specify multiple properties in a single command.

Prerequisites

Section 3.1, “Setting up your Camel K development environment”

Procedure

Develop a Camel integration that uses a property. The following simple route includes a {{my.message}} property placeholder:

...
   from("timer:java?period=1s")
     .routeId("java")
     .setBody()
        .simple("{{my.message}} from ${routeId}")
     .to("log:info");
...

...
   from("timer:java?period=1s")
     .routeId("java")
     .setBody()
        .simple("{{my.message}} from ${routeId}")
     .to("log:info");
...

Copy to Clipboard

Enter the kamel run command using the --property option to set the property value at runtime. For example:

kamel run --property my.message="Hola Mundo" HelloCamelK.java --dev

$ kamel run --property my.message="Hola Mundo" HelloCamelK.java --dev
...
[1] 2020-04-13 15:39:59.213 INFO  [main] ApplicationRuntime - Listener org.apache.camel.k.listener.RoutesDumper@6e0dec4a executed in phase Started
[1] 2020-04-13 15:40:00.237 INFO  [Camel (camel-k) thread #1 - timer://java] info - Exchange[ExchangePattern: InOnly, BodyType: String, Body: Hola Mundo from java]
...

Copy to Clipboard

Additional resources

7.2. Configuring Camel K integrations using property files

You can configure multiple properties for Camel K integrations by specifying a property file on the command line at runtime. When you define properties in an integration using property placeholders, for example, {{my.items}}, you can specify the property values on the command line using a properties file, for example --property-file my-integration.properties.

Prerequisites

Section 3.1, “Setting up your Camel K development environment”

Procedure

Define your integration properties file. The following shows a simple example from a routing.properties file:

List of items for random generation
Marker to identify priority items

# List of items for random generation
items=*radiator *engine *door window

# Marker to identify priority items
priority-marker=*

Copy to Clipboard

Develop a Camel integration that uses properties defined in the properties file. The following example from the Routing.java integration uses the {{items}} and {{priority-marker}} property placeholders:

...
from("timer:java?period=6000")
    .id("generator")
    .bean(this, "generateRandomItem({{items}})")
    .choice()
      .when().simple("${body.startsWith('{{priority-marker}}')}")
        .transform().body(String.class, item -> item.substring(priorityMarker.length()))
        .to("direct:priorityQueue")
      .otherwise()
        .to("direct:standardQueue");
...

...
from("timer:java?period=6000")
    .id("generator")
    .bean(this, "generateRandomItem({{items}})")
    .choice()
      .when().simple("${body.startsWith('{{priority-marker}}')}")
        .transform().body(String.class, item -> item.substring(priorityMarker.length()))
        .to("direct:priorityQueue")
      .otherwise()
        .to("direct:standardQueue");
...

Copy to Clipboard

Enter the kamel run command with the --property-file option. For example:

kamel run Routing.java --property-file routing.properties --dev

$ kamel run Routing.java --property-file routing.properties --dev
...
[1] 2020-04-13 15:20:30.424 INFO  [main] ApplicationRuntime - Listener org.apache.camel.k.listener.RoutesDumper@6e0dec4a executed in phase Started
[1] 2020-04-13 15:20:31.461 INFO  [Camel (camel-k) thread #1 - timer://java] priority - !!Priority item: engine
[1] 2020-04-13 15:20:37.426 INFO  [Camel (camel-k) thread #1 - timer://java] standard - Standard item: window
[1] 2020-04-13 15:20:43.429 INFO  [Camel (camel-k) thread #1 - timer://java] priority - !!Priority item: door
...

Copy to Clipboard

Additional resources

7.3. Configuring Camel K properties using an OpenShift ConfigMap

You can configure multiple properties for Camel K integrations using an OpenShift ConfigMap. When you define properties in an integration using property placeholders, for example, {{my.message}}, you can specify the property values at runtime using a ConfigMap. You can also specify additional properties such as logging levels in the application.properties section of the ConfigMap.

Prerequisites

Section 3.1, “Setting up your Camel K development environment”

Procedure

Develop a Camel integration that uses properties. The following simple route includes the {{my.message}} property placeholder:

...
   from("timer:java?period=1s")
     .routeId("java")
     .setBody()
        .simple("{{my.message}} from ${routeId}")
     .to("log:info");
...

...
   from("timer:java?period=1s")
     .routeId("java")
     .setBody()
        .simple("{{my.message}} from ${routeId}")
     .to("log:info");
...

Copy to Clipboard

Define a ConfigMap that contains your configuration properties. For example:

apiVersion: v1
kind: ConfigMap
metadata:
  name: my-configmap
data:
  application.properties: |
    my.message=Bonjour le monde
    logging.level.org.apache.camel=DEBUG

apiVersion: v1
kind: ConfigMap
metadata:
  name: my-configmap
data:
  application.properties: |
    my.message=Bonjour le monde
    logging.level.org.apache.camel=DEBUG

Copy to Clipboard

This example sets the value of the my.message property and sets the logging level for the org.apache.camel package in the application.properties.

Create the ConfigMap in the same OpenShift namespace as your integration:
```
oc apply -f my-configmap.yaml
```
```
$ oc apply -f my-configmap.yaml
configmap/my-configmap created
```
Copy to Clipboard

Run the integration with the --configmap option to specify the configuration properties in the ConfigMap:

kamel run --configmap=my-configmap HelloCamelK.java --dev

$ kamel run --configmap=my-configmap HelloCamelK.java --dev
...
[1] 2020-04-14 14:18:20.654 DEBUG [Camel (camel-k) thread #1 - timer://java] DefaultReactiveExecutor - Queuing reactive work: CamelInternalProcessor - UnitOfWork - afterProcess - DefaultErrorHandler[sendTo(log://info)] - ID-hello-camel-k-5df4bcd7dc-zq4vw-1586873876659-0-25
[1] 2020-04-14 14:18:20.654 DEBUG [Camel (camel-k) thread #1 - timer://java] SendProcessor - >>>> log://info Exchange[ID-hello-camel-k-5df4bcd7dc-zq4vw-1586873876659-0-25]
[1] 2020-04-14 14:18:20.655 INFO  [Camel (camel-k) thread #1 - timer://java] info - Exchange[ExchangePattern: InOnly, BodyType: String, Body: Bonjour le monde from java]
...

Copy to Clipboard

Additional resources

Section 7.4, “Configuring Camel K properties using an OpenShift Secret”

7.4. Configuring Camel K properties using an OpenShift Secret

You can configure multiple properties for Camel K integrations using an OpenShift Secret. When you define properties in an integration using property placeholders, for example, {{my.message}}, you can specify the property values at runtime using a Secret. You can also specify additional properties such as logging levels in the application.properties section of the Secret.

Note

Configuring integration properties using a Secret is similar to configuring using a ConfigMap. The main difference is that you may need to base64-encode the content of the application.properties in the Secret.

Prerequisites

Section 3.1, “Setting up your Camel K development environment”

Procedure

Develop a Camel integration that uses properties. The following simple route includes the {{my.message}} property placeholder:

...
   from("timer:java?period=1s")
     .routeId("java")
     .setBody()
        .simple("{{my.message}} from ${routeId}")
     .to("log:info");
...

...
   from("timer:java?period=1s")
     .routeId("java")
     .setBody()
        .simple("{{my.message}} from ${routeId}")
     .to("log:info");
...

Copy to Clipboard

Define a Secret that contains your configuration properties. For example:

apiVersion: v1
kind: Secret
metadata:
  name: my-secret
data:
  application.properties: |
    bXkubWVzc2FnZT1IZWxsbyBXb3JsZAogICAgbG9nZ2luZy5sZXZlbC5vcmcuYXBhY2hlLmNhbWVs
    PURFQlVHCg==

apiVersion: v1
kind: Secret
metadata:
  name: my-secret
data:
  application.properties: |
    bXkubWVzc2FnZT1IZWxsbyBXb3JsZAogICAgbG9nZ2luZy5sZXZlbC5vcmcuYXBhY2hlLmNhbWVs
    PURFQlVHCg==

Copy to Clipboard

This example sets the value of the my.message property to Hello World and sets the logging level for the org.apache.camel package to DEBUG. These settings are specified in base64-encoded format in the application.properties.

Create the Secret in the same OpenShift namespace as your integration:
```
oc apply -f my-secret.yaml
```
```
$ oc apply -f my-secret.yaml
secret/my-secret created
```
Copy to Clipboard

Run the integration with the --secret option to specify the configuration properties in the Secret:

kamel run --secret=my-secret HelloCamelK.java --dev

$ kamel run --secret=my-secret HelloCamelK.java --dev
[1] 2020-04-14 14:30:29.788 DEBUG [Camel (camel-k) thread #1 - timer://java] DefaultReactiveExecutor - Queuing reactive work: CamelInternalProcessor - UnitOfWork - afterProcess - DefaultErrorHandler[sendTo(log://info)] - ID-hello-camel-k-68f85d99b9-srd92-1586874486770-0-144
[1] 2020-04-14 14:30:29.789 DEBUG [Camel (camel-k) thread #1 - timer://java] SendProcessor - >>>> log://info Exchange[ID-hello-camel-k-68f85d99b9-srd92-1586874486770-0-144]
[1] 2020-04-14 14:30:29.789 INFO  [Camel (camel-k) thread #1 - timer://java] info - Exchange[ExchangePattern: InOnly, BodyType: String, Body: Hello World from java]

Copy to Clipboard

Additional resources

Section 7.3, “Configuring Camel K properties using an OpenShift ConfigMap”

7.5. Configuring Camel integration components

You can configure Camel components programmatically in your integration code or by using configuration properties on the command line at runtime. You can configure Camel components using the following syntax:

camel.component.${scheme}.${property}=${value}

camel.component.${scheme}.${property}=${value}

Copy to Clipboard

For example, to change the queue size of the Camel seda component for staged event-driven architecture, you can configure the following property on the command line:

camel.component.seda.queueSize=10

camel.component.seda.queueSize=10

Copy to Clipboard

Prerequisites

Section 3.1, “Setting up your Camel K development environment”

Procedure

Enter the kamel run command and specify the Camel component configuration using the --property option. For example:

kamel run --property camel.component.seda.queueSize=10 examples/Integration.java

$ kamel run --property camel.component.seda.queueSize=10 examples/Integration.java

Copy to Clipboard

Additional resources

7.6. Configuring Camel K integration dependencies

Camel K automatically resolves a wide range of dependencies that are required to run your integration code. However, you can explicitly add dependencies on the command line at runtime using the kamel run --dependency option.

The following example integration uses Camel K automatic dependency resolution:

...
  from("imap://admin@myserver.com")
    .to("seda:output")
...

...
  from("imap://admin@myserver.com")
    .to("seda:output")
...

Copy to Clipboard

Because this integration has an endpoint starting with the imap: prefix, Camel K can automatically add the camel-mail component to the list of required dependencies. The seda: endpoint belongs to camel-core, which is automatically added to all integrations, so Camel K does not add additional dependencies for this component.

Camel K automatic dependency resolution is transparent to the user at runtime. This is very useful in development mode because you can quickly add all the components that you need without exiting the development loop.

You can explicitly add a dependency using the kamel run --dependency or -d option. You might need to use this to specify dependencies that are not included in the Camel catalog. You can specify multiple dependencies on the command line.

Prerequisites

Section 3.1, “Setting up your Camel K development environment”

Procedure

Enter the kamel run command and specify dependencies using the -d option. For example:

kamel run -d mvn:com.google.guava:guava:26.0-jre -d camel-mina2 Integration.java

$ kamel run -d mvn:com.google.guava:guava:26.0-jre -d camel-mina2 Integration.java

Copy to Clipboard

Note

You can disable automatic dependency resolution by disabling the dependencies trait: -trait dependencies.enabled=false. However, this is not recommended in most cases.

Additional resources

Chapter 7. Configuring Camel K integrations

7.1. Configuring Camel K integrations using properties

7.2. Configuring Camel K integrations using property files

7.3. Configuring Camel K properties using an OpenShift ConfigMap

7.4. Configuring Camel K properties using an OpenShift Secret

7.5. Configuring Camel integration components

7.6. Configuring Camel K integration dependencies

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links