Camel K を使用したインテグレーションの開発および管理

手順

1. プロパティーを使用する Camel インテグレーションを開発します。以下の簡単な例には、{{my.message}} プロパティープレースホルダーが含まれています。

   ...
   - from:
      uri: "timer:tick"
      steps:
        - set-body:
            constant: "{{my.message}}"
        - to: "log:info"
   ...

2. 以下の構文を使用してインテグレーションを実行し、実行時にプロパティー値を設定します。

   kamel run --property <property>=<value> <integration>

   または、(--property の代わりに) --p 短縮表記を使用することもできます。

   kamel run --property <property>=<value> <integration>

   以下に例を示します。

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

   または

   kamel run --p 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]
   ...

手順

1. インテグレーションのプロパティーファイルを作成します。以下の例は、my.properties という名前のファイルからのものです。

   my.key.1=hello
   my.key.2=world

2. プロパティーファイルに定義されたプロパティーを使用する Camel インテグレーションを開発します。以下の Routing.java 統合例では {{my.key.1}} および {{my.key.2=world}} プロパティープレースホルダーを使用します。

   import org.apache.camel.builder.RouteBuilder;
   
   public class Routing extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
       from("timer:property-file")
          .routeId("property-file")
          .log("property file content is: {{my.key.1}} {{my.key.2}}");
   
     }
   }

3. 以下の構文を使用してインテグレーションを実行し、プロパティーファイルを参照します。

   kamel run --property file:<my-file.properties> <integration>

   または、(--property の代わりに) --p 短縮表記を使用することもできます。

   kamel run --p file:<my-file.properties> <integration>

   以下に例を示します。

   kamel run Routing.java --property:file=my.properties --dev

手順

1. 設定値が含まれるテキストファイルを参照する Camel K インテグレーションを作成します。

   たとえば、以下のインテグレーション (ConfigFileRoute.java) は、実行時にクラスパスで resources-data.txt ファイルが利用可能でなければなりません。

   import org.apache.camel.builder.RouteBuilder;
   
   public class ConfigFileRoute extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
       from("timer:config-file")
           .setBody()
               .simple("resource:classpath:resources-data.txt")
           .log("resource file content is: ${body}");
   
     }
   }

2. インテグレーションを実行し、実行中のインテグレーションで使用できるように、--config オプションを使用してテキストファイルを指定します。以下に例を示します。

   kamel run --config file:resources-data.txt ConfigFileRoute.java --dev

   必要に応じて、--config オプションを繰り返し追加して、複数のファイルを指定できます。以下に例を示します。

   kamel run --config file:resources-data1.txt --config file:resources-data2.txt ConfigFileRoute.java --dev

手順

1. ConfigMap を参照する Camel K インテグレーションを作成します。

   たとえば、以下のインテグレーション (名前: ConfigConfigmapRoute.java) は、my-cm という名前の ConfigMap の my-configmap-key という名前の設定値を参照します。

   import org.apache.camel.builder.RouteBuilder;
   
   public class ConfigConfigmapRoute extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
       from("timer:configmap")
           .setBody()
                .simple("resource:classpath:my-configmap-key")
           .log("configmap content is: ${body}");
   
     }
   }

2. インテグレーションを実行し、--config オプションを使用して ConfigMap ファイルをマテリアル化し、実行中のインテグレーションで使用できるようにします。以下に例を示します。

   kamel run --config configmap:my-cm ConfigConfigmapRoute.java --dev

   インテグレーションが起動すると、Camel K Operator は ConfigMap の内容で OpenShift ボリュームをマウントします。

手順

1. ConfigMap を参照する Camel K インテグレーションを作成します。

   たとえば、以下のインテグレーション (名前: ConfigSecretRoute.java) は、my-sec という名前のシークレットの my-secret プロパティーを参照します。

   import org.apache.camel.builder.RouteBuilder;
   
   public class ConfigSecretRoute extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
       from("timer:secret")
           .setBody()
               .simple("resource:classpath:my-secret")
           .log("secret content is: ${body}");
   
     }
   }

2. インテグレーションを実行し、--config オプションを使用してシークレットをマテリアル化し、実行中のインテグレーションで使用できるようにします。以下に例を示します。

   kamel run --config secret:my-sec ConfigSecretRoute.java --dev

   インテグレーションが起動すると、Camel K Operator はシークレットの内容で OpenShift ボリュームをマウントします。

手順

1. プロパティーが含まれるテキストファイルを作成します。

   たとえば、以下のプロパティーを含む my.properties という名前のファイルを作成します。

   my.key.1=hello
   my.key.2=world

2. プロパティーファイルに基づいて ConfigMap またはシークレットを作成します。

   たとえば、以下のコマンドを使用して my.properties ファイルからシークレットを作成します。

   oc create secret generic my-sec --from-file my.properties

3. インテグレーションで、シークレットに定義されたプロパティーを参照します。

   たとえば、以下のインテグレーション (名前: ConfigSecretRoute.java) は、my.key.1 と my.key.2 プロパティーを参照します。

   import org.apache.camel.builder.RouteBuilder;
   
   public class ConfigSecretPropertyRoute extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
       from("timer:secret")
           .routeId("secret")
           .log("{{my.key.1}} {{my.key.2}}");
   
     }
   }

4. インテグレーションを実行し、--config オプションを使用して、my.key.1 および my.key.2 プロパティーが含まれるシークレットを指定します。

   以下に例を示します。

   kamel run --config secret:my-sec ConfigSecretPropertyRoute.java --dev

手順

1. ConfigMap またはシークレットのいずれかのソースだけからの設定値を使用するインテグレーションを作成します。

   たとえば、以下のインテグレーション (ConfigSecretKeyRoute.java) は、my-sec-multi シークレット内のいずれかのソースだけからのプロパティーを使用します。

   import org.apache.camel.builder.RouteBuilder;
   
   public class ConfigSecretKeyRoute extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
       from("timer:secret")
         .setBody()
             .simple("resource:classpath:my-secret-key-2")
         .log("secret content is: ${body}");
     }
   }

2. --config secret オプションと /key 表記を使用して、インテグレーションを実行します。

   以下に例を示します。

   kamel run --config secret:my-sec-multi/my-secret-key-2 ConfigSecretKeyRoute.java --dev

3. インテグレーション Pod を確認し、指定されたソース (例: my-secret-key-2) のみがマウントされていることを確認します。

   たとえば、以下のコマンドを実行して Pod のすべてのボリュームを一覧表示します。

   oc set volume pod/<pod-name> --all

手順

1. 指定するファイルの内容を読み取る Camel K インテグレーションを作成します。

   たとえば、以下の統合 (ResourceFileBinaryRoute.java) を展開して resources-data.zip ファイルを読み込みます。

   import org.apache.camel.builder.RouteBuilder;
   
   public class ResourceFileBinaryRoute extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
       from("file:/etc/camel/resources/?fileName=resources-data.zip&noop=true&idempotent=false")
           .unmarshal().zipFile()
           .log("resource file unzipped content is: ${body}");
   
     }
   }

2. インテグレーションを実行し、--resource オプションを使用してファイルをデフォルトの宛先ディレクトリー (/etc/camel/resources/) にコピーします。以下に例を示します。

   kamel run --resource file:resources-data.zip ResourceFileBinaryRoute.java -d camel-zipfile --dev

   注記: バイナリーファイルを指定すると、ファイルの内容のバイナリー表現が作成され、インテグレーションで透過的にデコードされます。

   必要に応じて、--resource オプションを繰り返し追加して、複数のリソースを指定できます。以下に例を示します。

   kamel run --resource file:resources-data1.txt --resource file:resources-data2.txt ResourceFileBinaryRoute.java -d camel-zipfile --dev

手順

1. OpenShift クラスターに保存されている ConfigMap を参照する Camel K インテグレーションを作成します。

   たとえば、以下のインテグレーション (Resource ConfigmapRoute.java) は my- configmap-key が含まれる my-cm という名前の ConfigMap を参照します。

   import org.apache.camel.builder.RouteBuilder;
   
   public class ResourceConfigmapRoute extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
       from("file:/etc/camel/resources/my-cm/?fileName=my-configmap-key&noop=true&idempotent=false")
           .log("resource file content is: ${body}");
   
     }
   }

2. インテグレーションを実行し、--resource オプションを使用してデフォルトの /etc/camel/resources/ ディレクトリーの ConfigMap ファイルをマテリアル化し、実行中のインテグレーションで使用できるようにします。

   以下に例を示します。

   kamel run --resource configmap:my-cm ResourceConfigmapRoute.java --dev

   インテグレーションが起動すると、Camel K Operator は ConfigMap の内容でボリュームをマウントします (例: my-configmap-key)。

手順

1. OpenShift クラスターに保存されているシークレットを参照する Camel K インテグレーションを作成します。

   たとえば、以下のインテグレーション (名前: ResourceSecretRoute.java) は my-sec シークレットを参照します。

   import org.apache.camel.builder.RouteBuilder;
   
   public class ResourceSecretRoute extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
         from("file:/etc/camel/resources/my-sec/?fileName=my-secret-key&noop=true&idempotent=false")
             .log("resource file content is: ${body}");
   
     }
   }

2. インテグレーションを実行し、--resource オプションを使用してデフォルトの /etc/camel/resources/ ディレクトリーの Secret ファイルをマテリアル化し、実行中のインテグレーションで使用できるようにします。

   以下に例を示します。

   kamel run --resource secret:my-sec ResourceSecretRoute.java --dev

   インテグレーションが起動すると、Camel K Operator はシークレットの内容でボリュームをマウントします (例: my-sec)。

手順

1. 設定プロパティーが含まれるファイル、ConfigMap、またはシークレットを参照する Camel K インテグレーションを作成します。たとえば、以下のインテグレーション (名前: ResourceFileLocationRoute.java) は myprops ファイルを参照します。

   import org.apache.camel.builder.RouteBuilder;
   
   public class ResourceFileLocationRoute extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
         from("file:/tmp/?fileName=input.txt&noop=true&idempotent=false")
            .log("resource file content is: ${body}");
   
     }
   }

2. インテグレーションを実行し、@path 構文で --resource オプションを使用して、リソースの内容 (ファイル、ConfigMap、または Secret のいずれか) をマウントする場所を指定します。

   たとえば、以下のコマンドは、/tmp ディレクトリーを使用して input.txt ファイルをマウントするように指定します。

   kamel run --resource file:resources-data.txt@/tmp/input.txt ResourceFileLocationRoute.java --dev

3. インテグレーションの Pod で、ファイル (例: input.txt) が正しい場所 (例: tmp ディレクトリー内) にマウントされていることを確認します。たとえば、以下のコマンドを実行します。

   oc exec <pod-name> -- cat /tmp/input.txt

手順

1. ConfigMap またはシークレットのいずれかのリソースだけからの設定値を使用するインテグレーションを作成します。たとえば、以下のインテグレーション ( ResourceConfigmapKeyLocationRoute.java という名称) は my-cm-multi ConfigMap を参照します。

   import org.apache.camel.builder.RouteBuilder;
   
   public class ResourceConfigmapKeyLocationRoute extends RouteBuilder {
     @Override
     public void configure() throws Exception {
   
       from("file:/tmp/app/data/?fileName=my-configmap-key-2&noop=true&idempotent=false")
          .log("resource file content is: ${body} consumed from
           ${header.CamelFileName}");
   
     }
   }

2. インテグレーションを実行し、@path 構文で --resource オプションを使用して、ソースの内容 (ファイル、ConfigMap、または Secret のいずれか) をマウントする場所を指定します。

   たとえば、以下のコマンドは ConfigMap 内に含まれるソースのいずれか (my-configmap-key-2@) のみを使用し、/tmp/app/data ディレクトリーを使用してマウントすることを指定します。

   kamel run --resource configmap:my-cm-multi/my-configmap-key-2@/tmp/app/data ResourceConfigmapKeyLocationRoute.java --dev

3. インテグレーションの Pod で、1 つのファイル (例: my-configmap-key-2) だけが正しい場所 (例: /tmp/app/data) にマウントされていることを確認します。たとえば、以下のコマンドを実行します。

   oc exec <pod-name> -- cat /tmp/app/data/my-configmap-key-2

1. OpenShift クラスターの Web コンソールにログインします。
2. インテグレーションを作成する予定のプロジェクト (例: my-camel-k-kafka) を作成または開きます。
3. Camel K のインストール の説明に従って、Camel K Operator および Camel K CLI をインストールします。

4. AMQ Streams Operator をインストールします。

   1. 任意のプロジェクトから Operators > OperatorHub を選択します。
   2. Filter by Keyword フィールドに AMQ Streams を入力します。

   3. Red Hat Integration - AMQ Streams カードをクリックしてから Install をクリックします。

      Install Operator ページが開きます。

   4. デフォルトを受け入れ、Install をクリックします。
5. Operators > Installed Operators を選択し、Camel K および AMQ Streams Operator がインストールされていることを確認します。

1. OpenShift クラスターの Web コンソールにログインします。
2. Projects を選択してから、Red Hat Integration - AMQ Streams Operator をインストールしたプロジェクトをクリックします。たとえば、my-camel-k-kafka プロジェクトをクリックします。
3. Operators > Installed Operators の順に選択し、Red Hat Integration - AMQ Streams をクリックします。

4. Kafka クラスターを作成します。

   1. Kafka で、Create instance をクリックします。
   2. kafka-test などクラスターの名前を入力します。

   3. その他のデフォルトを受け入れ、Create をクリックします。

      Kafka インスタンスを作成するプロセスの完了に数分かかる場合があります。

      ステータスが ready になったら、次のステップに進みます。

5. Kafka トピックを作成します。

   1. Operators > Installed Operators の順に選択し、Red Hat Integration - AMQ Streams をクリックします。
   2. Kafka Topic で Create Kafka Topic をクリックします。
   3. トピックの名前を入力します (例: test-topic)。
   4. その他のデフォルトを受け入れ、Create をクリックします。

手順

1. クラスター管理者アカウントで OpenShift Web コンソールにログインします。

2. Camel K または Kamelets アプリケーションの OpenShift プロジェクトを作成します。

   1. Home > Projects を選択します。
   2. Create Project をクリックします。
   3. プロジェクトの名前 (例: my-camel-k-kafka) を入力し、続いて Create をクリックします。
3. Getting started with the rhoas CLI の説明に従って、RHOAS CLI をダウンロードおよびインストールします。
4. Camel K のインストール の説明に従って、Camel K Operator および Camel K CLI をインストールします。
5. Red Hat Integration - Camel K Operator がインストールされていることを確認するには、Operators > Installed Operators の順にクリックします。

1. コマンドラインから OpenShift クラスターにログインします。

2. プロジェクトを開きます。以下に例を示します。

   oc project my-camel-k-kafka

3. Camel K Operator がプロジェクトにインストールされていることを確認します。

   oc get csv

   結果には、Red Hat Camel K Operator が表示され、それが Succeeded フェーズにあることを示します。

4. Kafka インスタンスを準備し、RHOAS に接続します。

   1. 以下のコマンドを使用して RHOAS CLI にログインします。

      rhoas login

   2. kafka-test などの kafka インスタンスを作成します。

      rhoas kafka create kafka-test

      Kafka インスタンスを作成するプロセスの完了に数分かかる場合があります。

5. Kafka インスタンスのステータスを確認するには、以下を実行します。

   rhoas status

   Web コンソールでステータスを表示することもできます。

   https://cloud.redhat.com/application-services/streams/kafkas/

   ステータスが ready になったら、次のステップに進みます。

6. 新しい Kafka トピックを作成します。

   rhoas kafka topic create --name test-topic

7. Kafka インスタンス (クラスター) を Openshift Application Services インスタンスに接続します。

   rhoas cluster connect

8. クレデンシャルトークンを取得するスクリプトの手順に従います。

   以下のような出力が表示されるはずです。

   Token Secret "rh-cloud-services-accesstoken-cli" created successfully
   Service Account Secret "rh-cloud-services-service-account" created successfully
   KafkaConnection resource "kafka-test" has been created
   KafkaConnection successfully installed on your cluster.

手順

1. Kafka ブローカーの URL (ブートストラップ URL) を取得します。

   rhoas status

   コマンドは、以下のような出力を返します。

     Kafka
     ---------------------------------------------------------------
     ID:                     1ptdfZRHmLKwqW6A3YKM2MawgDh
     Name:                   my-kafka
     Status:                 ready
     Bootstrap URL:        my-kafka--ptdfzrhmlkwqw-a-ykm-mawgdh.kafka.devshift.org:443

2. ユーザー名とパスワードを取得するには、以下の構文を使用してサービスアカウントを作成します。

   rhoas service-account create --name "<account-name>" --file-format json

   注記

   サービスアカウントの作成時に、ファイル形式および場所を選択してクレデンシャルを保存できます。詳細は、rhoas service-account create --help コマンドを参照してください。

   以下に例を示します。

   rhoas service-account create --name "my-service-acct" --file-format json

   サービスアカウントが作成され、JSON ファイルに保存されます。

3. サービスアカウントの認証情報を確認するには、credentials.json ファイルを表示します。

   cat credentials.json

   コマンドは、以下のような出力を返します。

   {"clientID":"srvc-acct-eb575691-b94a-41f1-ab97-50ade0cd1094", "password":"facf3df1-3c8d-4253-aa87-8c95ca5e1225"}

4. Kakfa トピックとの間でメッセージを送受信する権限を付与します。以下のコマンドを使用します。ここで、clientID は (ステップ 3 からの)credentials.json ファイルで指定される値に置き換えます。

   rhoas kafka acl grant-access --producer --consumer --service-account $CLIENT_ID --topic test-topic --group all

   以下に例を示します。

   rhoas kafka acl grant-access --producer --consumer --service-account srvc-acct-eb575691-b94a-41f1-ab97-50ade0cd1094 --topic test-topic --group all

手順

1. application.properties ファイルを編集し、Kafka 認証情報を追加します。

   application.properties ファイル

   camel.component.kafka.brokers = <YOUR-KAFKA-BOOTSTRAP-URL-HERE>
   camel.component.kafka.security-protocol = SASL_SSL
   camel.component.kafka.sasl-mechanism = PLAIN
   camel.component.kafka.sasl-jaas-config=org.apache.kafka.common.security.plain.PlainLoginModule required username='<YOUR-SERVICE-ACCOUNT-ID-HERE>' password='<YOUR-SERVICE-ACCOUNT-SECRET-HERE>';
   consumer.topic=<TOPIC-NAME>
   producer.topic=<TOPIC-NAME>

2. 以下のコマンドを実行して、application.properties ファイルに機密プロパティーが含まれるシークレットを作成します。

   oc create secret generic kafka-props --from-file application.properties

   Camel K インテグレーションの実行時に、このシークレットを使用します。

手順

1. application-oauth.properties ファイルを編集し、Kafka 認証情報を追加します。

   application-oauth.properties ファイル

   camel.component.kafka.brokers = <YOUR-KAFKA-BOOTSTRAP-URL-HERE>
   camel.component.kafka.security-protocol = SASL_SSL
   camel.component.kafka.sasl-mechanism = OAUTHBEARER
   camel.component.kafka.sasl-jaas-config = org.apache.kafka.common.security.oauthbearer.OAuthBearerLoginModule required \
   oauth.client.id='<YOUR-SERVICE-ACCOUNT-ID-HERE>' \
   oauth.client.secret='<YOUR-SERVICE-ACCOUNT-SECRET-HERE>' \
   oauth.token.endpoint.uri="https://identity.api.openshift.com/auth/realms/rhoas/protocol/openid-connect/token" ;
   camel.component.kafka.additional-properties[sasl.login.callback.handler.class]=io.strimzi.kafka.oauth.client.JaasClientOauthLoginCallbackHandler
   
   consumer.topic=<TOPIC-NAME>
   producer.topic=<TOPIC-NAME>

2. 以下のコマンドを実行して、application.properties ファイルに機密プロパティーが含まれるシークレットを作成します。

   oc create secret generic kafka-props --from-file application-oauth.properties

   Camel K インテグレーションの実行時に、このシークレットを使用します。