HawtIO 診断コンソールガイド

1. HawtIO: 4.2.0.redhat-00034
2. Camel Spring Boot: 4.10.3.redhat-00019
3. Jolokia: 2.2.9.redhat-00001

1. 以下の例のように、settings.xml ファイルに Red Hat リポジトリーの repository 要素を追加します。

   <?xml version="1.0"?>
   <settings>
   
     <profiles>
       <profile>
         <id>extra-repos</id>
         <activation>
           <activeByDefault>true</activeByDefault>
         </activation>
         <repositories>
          <repository>
            <id>redhat-ga-repository</id>
            <url>https://maven.repository.redhat.com/ga</url>
            <releases>
              <enabled>true</enabled>
            </releases>
            <snapshots>
              <enabled>false</enabled>
            </snapshots>
           </repository>
           <repository>
             <id>redhat-ea-repository</id>
             <url>https://maven.repository.redhat.com/earlyaccess/all</url>
             <releases>
               <enabled>true</enabled>
             </releases>
             <snapshots>
               <enabled>false</enabled>
             </snapshots>
           </repository>
         </repositories>
         <pluginRepositories>
           <pluginRepository>
             <id>redhat-ga-repository</id>
             <url>https://maven.repository.redhat.com/ga</url>
             <releases>
               <enabled>true</enabled>
             </releases>
             <snapshots>
               <enabled>false</enabled>
             </snapshots>
           </pluginRepository>
           <pluginRepository>
             <id>redhat-ea-repository</id>
             <url>https://maven.repository.redhat.com/earlyaccess/all</url>
             <releases>
               <enabled>true</enabled>
             </releases>
             <snapshots>
               <enabled>false</enabled>
             </snapshots>
           </pluginRepository>
         </pluginRepositories>
       </profile>
     </profiles>
   
     <activeProfiles>
       <activeProfile>extra-repos</activeProfile>
     </activeProfiles>
   
   </settings>

手順:

1. jbang コマンドを使用して、マシンに HawtIO の最新バージョンをインストールします。

   $ jbang app install -Dhawtio.jbang.version=4.2.0.redhat-00034 hawtio@hawtio/hawtio

   注記

   このインストール方法は、jbang>=0.115.0 でのみ利用できます。

2. HawtIO コマンドがインストールされます。次のコマンドで HawtIO インスタンスを起動します。

   $ hawtio

3. このコマンドは、http://localhost:8080/hawtio/ でコンソールを自動的に開きます。ポート番号を変更するには、次のコマンドを実行します。

   $ hawtio --port 8090

4. CLI の設定オプションの詳細を確認するには、次のコードを実行してください。

   $ hawtio --help
   Usage: hawtio [-hjoV] [-c=<contextPath>] [-d=<plugins>] [-e=<extraClassPath>]
                 [-H=<host>] [-k=<keyStore>] [-l=<warLocation>] [-p=<port>]
                 [-s=<keyStorePass>] [-w=<war>]
   Run HawtIO
     -c, --context-path=<contextPath>
                         Context path.
     -d, --plugins-dir=<plugins>
                         Directory to search for .war files to install as 3rd
                           party plugins.
     -e, --extra-class-path=<extraClassPath>
                         Extra class path.
     -h, --help          Print usage help and exit.
     -H, --host=<host>   Hostname to listen to.
     -j, --join          Join server thread.
     -k, --key-store=<keyStore>
                         JKS keyStore with the keys for https.
     -l, --war-location=<warLocation>
                         Directory to search for .war files.
     -o, --open-url      Open the web console automatic in the web browser.
     -p, --port=<port>   Port number.
     -s, --key-store-pass=<keyStorePass>
                         Password for the JKS keyStore with the keys for https.
     -V, --version       Print HawtIO version
     -w, --war=<war>     War file or directory of the hawtio web application.

1. io.hawt:hawtio-quarkus およびサポートする Camel Quarkus エクステンションを pom.xml の依存関係に追加します。

   <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>io.hawt</groupId>
         <artifactId>hawtio-bom</artifactId>
         <version>4.2.0.redhat-00034</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
     </dependencies>
     <!-- ... other BOMs or dependencies ... -->
   </dependencyManagement>
   
   <dependencies>
     <dependency>
       <groupId>io.hawt</groupId>
       <artifactId>hawtio-quarkus</artifactId>
     </dependency>
   
      <!-- Mandatory for enabling Camel management via JMX / HawtIO -->
     <dependency>
       <groupId>org.apache.camel.quarkus</groupId>
       <artifactId>camel-quarkus-management</artifactId>
     </dependency>
   
     <!-- (Optional) Required for HawtIO Camel route diagram tab -->
     <dependency>
       <groupId>org.apache.camel.quarkus</groupId>
       <artifactId>camel-quarkus-jaxb</artifactId>
     </dependency>
   
     <!-- ... other dependencies ... -->
   </dependencies>

2. application.properties に次の設定を追加して認証を無効にします。

   quarkus.hawtio.authenticationEnabled = false

   1. 認証を設定することもできます。「Quarkus 認証メカニズム」を参照してください。

3. 以下のように、開発モードで Quarkus アプリケーションを使用して HawtIO を実行します。

   mvn compile quarkus:dev

4. http://localhost:8080/hawtio/ を開き、HawtIO コンソールを表示します。

手順:

1. io.hawt:hawtio-springboot およびサポートする Camel Spring Boot スターターを pom.xml の依存関係に追加します。

   <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>io.hawt</groupId>
         <artifactId>hawtio-bom</artifactId>
         <version>4.2.0.redhat-00034</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
       <!-- ... other BOMs or dependencies ... -->
     </dependencies>
   </dependencyManagement>
   
   <dependencies>
     <dependency>
       <groupId>io.hawt</groupId>
       <artifactId>hawtio-springboot</artifactId>
     </dependency>
   
      <!-- Mandatory for enabling Camel management via JMX / HawtIO -->
     <dependency>
       <groupId>org.apache.camel.springboot</groupId>
       <artifactId>camel-management-starter</artifactId>
     </dependency>
   
     <!-- (Optional) Required for HawtIO Camel route diagram tab -->
     <dependency>
       <groupId>org.apache.camel.springboot</groupId>
       <artifactId>camel-spring-boot-xml-starter</artifactId>
     </dependency>
   
     <!-- ... other dependencies ... -->
   </dependencies>

2. 次の行を application.properties に追加して、HawtIO および Jolokia エンドポイントを有効にします。

   spring.jmx.enabled = true
   management.endpoints.web.exposure.include = hawtio,jolokia

3. 次のように、Spring Boot アプリケーションを開発モードで使用して HawtIO を実行します。

   mvn spring-boot:run

4. http://localhost:8080/actuator/hawtio を開き、HawtIO コンソールを表示します。

1. Keycloak サーバーを準備する
2. HawtIO を任意のランタイム (Quarkus、Spring Boot、WildFly、Karaf、Jetty、Tomcat など) にデプロイし、認証に Keycloak を使用するように設定する

1. Web ブラウザーで、cluster admin 権限を持つユーザーとして OpenShift コンソールにログインします。
2. Operators をクリックした後、OperatorHub をクリックします。
3. 検索フィールドウィンドウで HawtIO と入力し、Operator の一覧をフィルタリングします。HawtIO Operator をクリックします。

4. HawtIO Operator インストールウィンドウで、Install をクリックします。Create Operator Subscription フォームが表示されます。

   1. Update Channel の場合は、stable-v1 を選択します。

   2. Installation Mode では、デフォルト (クラスターの特定の namespace) を受け入れます。

      注記

      このモードは、Operator が HawtIO CR を監視する namespace を決定します。これは、完全にデプロイされるときに HawtIO が監視する namespace とは異なります。HawtIO が監視する namespace は、HawtIO CR を介して設定できます。

   3. Installed Namespace では、HawtIO Operator をインストールする namespace を選択します。

   4. Update Approval では、Automatic または Manual を選択し、OpenShift が HawtIO Operator への更新を処理する方法を設定します。

      1. Automatic 更新オプションが選択され、新しいバージョンの HawtIO Operator が利用可能な場合、OpenShift Operator Lifecycle Manager (OLM) は人的介入なしに、HawtIO の実行中のインスタンスを自動的にアップグレードします。
      2. Manual 更新オプションが選択され、Operator の新しいバージョンが利用可能な場合、OLM は更新要求のみを作成します。クラスター管理者は、HawtIO Operator を新しいバージョンに更新するために、更新要求を手動で承認する必要があります。
5. Install をクリックすると、OpenShift は現在の namespace に HawtIO Operator をインストールします。
6. インストールを確認するには、Operators をクリックした後、Installed Operators をクリックします。HawtIO は Operator のリストに表示されるはずです。

7. OpenShift Web コンソールを使用して HawtIO をデプロイするには、以下を実行します。

   1. Installed Operators のリストの Name 列の下にある HawtIO Operator をクリックします。
   2. Provided APIs の Operator Details ページで、Create HawtIO をクリックします。

   3. 設定のデフォルト値を使用するか、任意でデフォルト値を編集します。

      1. Replicas の場合、HawtIO のパフォーマンスを向上させるには (たとえば、高可用性環境の場合)、HawtIO に割り当てられる Pod の数を増やすことができます。
      2. RBAC (ロールベースアクセス制御) では、デフォルトの RBAC 動作をカスタマイズする場合や、HawtIO Operator をインストールした namespace に ConfigMap ファイルがすでに存在する場合にのみ、Config Map フィールドに値を指定します。
      3. Nginx は、HawtIO Operator インストールのパフォーマンスチューニング を参照してください。

      4. Type には、以下のいずれかを指定します。

         1. クラスター: HawtIO が、HawtIO 対応アプリケーションの OpenShift クラスター上にあるすべての namespace を監視する場合。
         2. namespace: HawtIO が、同じ namespace にデプロイされた HawtIO 対応アプリケーションのみを監視する場合。
   4. Create をクリックします。HawtIO Operator Details ページが開き、デプロイメントのステータスが表示されます。

8. HawtIO を開くには、以下を実行します。

   1. namespace デプロイメントの場合: OpenShift Web コンソールで、HawtIO Operator がインストールされているプロジェクトを開き、Overview を選択します。Project Overview ページで、Launcher セクションまで下にスクロールし、HawtIO リンクをクリックします。
   2. cluster デプロイメントでは、OpenShift Web コンソールのタイトルバーで、グリッドアイコンをクリックします。ポップアップメニューの Red Hat Applications で、HawtIO URL リンクをクリックします。
   3. HawtIO にログインします。ブラウザーに Authorize Access ページが表示され、必要なパーミッションが表示されます。
   4. Allow selected permissions をクリックします。HawtIO がブラウザーで開き、アクセスが許可される HawtIO 対応アプリケーション Pod が表示されます。
9. Connect をクリックして、監視対象のアプリケーションを表示します。新しいブラウザーウィンドウが開き、HawtIO のアプリケーションが表示されます。

1. admin: ユーザーが OpenShift で Pod を更新できる場合、ユーザーには HawtIO の admin ロールが付与されます。ユーザーは、HawtIO で Pod の書き込み MBean 操作を実行できます。
2. viewer: ユーザーが OpenShift で Pod を取得できる場合、ユーザーには HawtIO の viewer ロールが付与されます。ユーザーは、HawtIO で Pod の読み取り専用 MBean 操作を実行できます。

1. auth: 認証設定 | type: object

   1. internalSSL: 内部通信に SSL を使用します。OpenShift インストールの場合、これは常に true に設定する必要があります。
   2. clientCertCheckSchedule: 証明書の有効期限をチェックする頻度を定義する CronJob スケジュール。スケジュールが設定されていない場合、クライアントのローテーションは有効になりません | type: string
   3. clientCertCommonName : 生成されたクライアント証明書 CN| type: string
   4. clientCertExpirationDate: 生成されたクライアント証明書の有効期限 | type: string | format: date-time
   5. clientCertExpirationPeriod: 証明書をローテーションできる有効期限までの期間 (時間単位)。デフォルトは 24 時間に設定されています | type: integer

2. config : HawtIO コンソールの設定 | type: object

   1. about: About ページに表示される情報 | type: object

      1. additionalInfo: description セクションのテキスト | タイプ: 文字列
      2. copyright: copyright セクションのテキスト | type: string
      3. imgSrc: ページに表示されるイメージ。これは、HawtIO ステータス URL からの相対パス、または絶対 URL を指定可能です | type: string

      4. productInfo: 製品情報のリスト | type: array

         1. items: About ページに表示される製品情報 | type: object | 必須: [ "name", "value" ]

            1. name: 製品情報の名前 | type: string
            2. value: 製品情報の値 | type: string
      5. title: ページのタイトル | type: string

   2. branding: UI ブランディング | type: object

      1. appLogoUrl: ナビゲーションバーに表示されるロゴの URL。これは、HawtIO ステータス URL からの相対パス、または絶対 URL になります。| type: string
      2. appName: 通常は Web ブラウザータブに表示されるアプリケーションのタイトル。| type: string
      3. css: アプリケーションのスタイル設定に使用できる外部 CSS スタイルシートの URL。これは、HawtIO ステータス URL からの相対パス、または絶対 URL になります。| type: string
      4. favicon: 通常、Web ブラウザーのタブに表示される favicon の URL。これは、HawtIO ステータス URL からの相対パス、または絶対 URL になります。| type: string

   3. disabledRoutes: ルートが一致する UI コンポーネントを無効にします | type: array |

      1. items:type: string

   4. online: OpenShift 関連の設定 | type: object

      1. consoleLink: OpenShift Web コンソールリンクの設定。HawtIO デプロイメントが 'cluster' と同等の場合、アプリケーションメニューにリンクが追加されます。それ以外の場合は、HawtIO プロジェクトダッシュボードにリンクが追加されます。| type: object

         1. imageRelativePath: アプリケーションメニューのリンクの前に使用されるアイコンの、HawtIO ステータス URL からの相対パス。これは、HawtIO デプロイメントタイプが cluster と等しい場合にのみ該当します。イメージは正方形で、24x24 ピクセルで表示されます。| type: string
         2. section: リンクが表示されるアプリケーションメニューのセクション。これは、HawtIO デプロイメントタイプが 'cluster' と同等の場合にのみ該当します。| type: string
         3. text : リンクのテキスト表示 | type: string
      2. projectSelector: プロジェクトを監視するために使用されるセレクター。これは、HawtIO デプロイメントタイプが 'cluster' と同等の場合にのみ該当します。デフォルトでは、ログインしているユーザーがアクセスできるプロジェクトがすべて監視されます。kubectl get コマンドの --selector または -l オプションで要求されているように、セレクターの文字列表現を指定する必要があります。Kubernetes Labels and Selectors を参照してください。| type: string

3. externalRoutes: 外部ルート名のリスト。ルートを使用してコンソールにアクセスするために Operator によってアノテーションが付けられます | type: array |

   1. items:type: string

4. metadataPropagation : デプロイメント、Pod、サービス、ルートなどの生成されたリソースに伝播する HawtIO カスタムリソースのメタデータの設定 | type: object

   1. annotations: 伝播するアノテーション | type: array |

      1. items:type: string

   2. labels: 伝播するラベル | type: array |

      1. items:type: string

5. nginx: Nginx ランタイム設定 type: object

   1. clientBodyBufferSize: クライアント要求本文を読み取るためのバッファーサイズ。デフォルトは 256k です。| type: string
   2. proxyBuffers: プロキシーサーバーからの応答を読み取るために 1 つの接続で使用されるバッファーの数とサイズ。デフォルトは 16 128k です。| type: string
   3. subrequestOutputBufferSize: サブ要求の応答本文を保存するために使用されるバッファーのサイズ。デフォルトは 10m です。| type: string

6. rbac : RBAC 設定 | type: object

   1. configMap: ACL 定義を含む ConfigMap の名前。| type: string
   2. disableRBACRegistry: RBACRegistry によるパフォーマンスの向上を無効にし、従来の動作に戻します。デフォルトは false です。| type: boolean
7. replicas: 必要な Pod の数。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 1 です。| type: integer | format: int32

8. resources: HawtIO コンソールのコンピュートリソース | type: object

   1. claims: Claims は、このコンテナーによって使用される、spec.resourceClaims で定義されたリソースの名前をリストします。これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。このフィールドは変更不可能です。コンテナーに対してのみ設定できます。| type: array |

      1. items: ResourceClaim は PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。| type: object | 必須: [ "name" ]
      2. name: name は、このフィールドが使用されている Pod の pod.spec.resourceClaims 内の 1 つのエントリーの名前と一致する必要があります。そのリソースをコンテナー内で利用できるようにします。| type: string
   2. limits: limits は、許可されるコンピュートリソースの最大量を示します。Kubernetes Resource Management for Pods and Containers を参照してください | type: object
   3. requests: requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。Kubernetes Resource Management for Pods and Containers を参照してください | type: object

9. route: ルートのカスタム証明書設定 (ほとんどの OpenShift インストールでは必要ありません)。| type: object

   1. caCert: Ca 証明書の秘密鍵セレクター | type: object | 必須: [ "key" ]

      1. key: 選択するシークレットのキー。有効な秘密鍵でなければなりません。| type: string
      2. name: 参照先の名前。Kubernetes Names を参照してください | type: string
      3. オプション: シークレットまたはそのキーを定義する必要があるかどうかを指定します | type: boolean

   2. certSecret: ルート TLS 終了に使用されるカスタム証明書の TLS シークレットの名前 | type: object

      1. name: 参照先の名前。Kubernetes Names を参照してください | type: string
10. routeHostname: HawtIO サービスを外部に公開するルートのエッジホスト名。指定されていない場合は自動的に生成され、[-] の形式になります。これは、クラスターに設定されているデフォルトのルーティングサブドメインです。フィールドが空の場合、Operator はルートを再作成し、ホストが再生成されることに注意してください。| type: string

11. type: デプロイメントの種類デフォルトは cluster です。| type: string

    1. cluster: HawtIO は、認証されたユーザーがアクセスできるすべての名前空間でアプリケーションを検出し、管理できます。
    2. namespace: HawtIO は、デプロイメント名前空間内のアプリケーションを検出および管理できます。
12. version: HawtIO コンソールコンテナーイメージのバージョン。非推奨: インストールにまだ必要な以前の Operator (<1.0.0) は下方互換性を確保するために残されています | type: string

1. 必要に応じて、これらの値をカスタマイズします。

   archetypeVersion

   4.10.3.redhat-00019

   groupId

   io.hawtio.online.examples

   artifactId

   hawtio-online-example-camel-springboot-os

   version

   1.0.0

2. Maven archetype を実行します。

   mvn archetype:generate  \
     -DarchetypeGroupId=org.apache.camel.archetypes  \
     -DarchetypeArtifactId=camel-archetype-spring-boot  \
     -DarchetypeVersion=4.10.3.redhat-00019  \
     -DgroupId=io.hawt.online.examples  \
     -DartifactId=hawtio-online-example  \
     -Dversion=1.0.0  \
     -DinteractiveMode=false \
     -Dpackage=io.hawtio

3. artifactId という名前の新しいプロジェクトに移動します (上記の例では、hawtio-online-example)。

   hello world アプリケーションのサンプルが作成され、コンパイルが可能です。

   この時点で、アプリケーションはローカルで実行できるはずです。

4. アプリケーションをテストするには、mvn spring-boot:run Maven ゴールを使用します。

   $ mvn spring-boot:run

1. 必要な依存関係を <dependencies> セクションに追加します。

   <dependencies>
     ...
   
     <!-- Camel -->
     ...
   
     <!-- Dependency is mandatory for exposing Jolokia endpoint -->
     <dependency>
         <groupId>org.apache.camel.springboot</groupId>
         <artifactId>camel-jolokia-starter</artifactId>
     </dependency>
   
     <!-- Optional: enables debugging support for Camel -->
     <dependency>
       <groupId>org.apache.camel</groupId>
       <artifactId>camel-debug</artifactId>
       <version>4.10.3.redhat-00019</version>
    </dependency>
   
   ...
   </dependencies>

   設定の詳細は、Jolokia コンポーネントのドキュメント を参照してください。

2. インフライト監視を有効にするには、Spring Boot のドキュメント に従って、application.properties ファイルに次のプロパティーも追加します。

   camel.springboot.inflight-repository-browse-enabled=true

1. 前提条件

   • 適切なプロジェクトが選択されている (ドキュメント を参照)。
   • すべてのファイルが設定されている。

2. 次の maven コマンドを実行します。

   mvn clean install -DskipTests -P openshift

   アプリケーションは S2I でコンパイルされ、OpenShift に デプロイされます。

3. Spring Boot アプリケーションが正しく実行されていることを確認します。

   Red Hat build of Quarkus ドキュメントの Red Hat build of Quarkus Java アプリケーションの OpenShift Container Platform へのデプロイ セクションに記載されている検証手順に従ってください。

4. 新しい Spring Boot アプリケーションが正しく実行されると、HawtIO インスタンスによって検出されます (モードによって異なります。'Namespace' モードでは、インスタンスが同じプロジェクト内にある必要があります)。

   新しいコンテナーは、次のスクリーンショットのように表示されます。

   

5. Connect をクリックして、Spring Boot アプリケーションが HawtIO で使用できるかどうかを確認します。

   

1. 新しい Quarkus アプリケーションの場合は、Maven quarkus クイックスタート が利用できます。例:

   mvn com.redhat.quarkus.platform:quarkus-maven-plugin:<quarkus.platform.version>:create\
   -DprojectGroupId=org.hawtio \
   -DprojectArtifactId=quarkus-helloworld \
   -Dextensions='openshift,camel-quarkus-quartz'

   注記

   Camel Quarkus の公式ドキュメントの最新の quarkus.platform.version を使用してください。

   1. quarkus-maven-plugin を使用してプロジェクトのスキャフォールディングを生成します。
   2. プロジェクトの maven groupId を org.hawtio に設定し、必要に応じてカスタマイズします。
   3. maven artifactId プロジェクトを quarkus-helloworld に設定し、必要に応じてカスタマイズします。

   4. 以下の Quarkus エクステンションを使用します。

      1. openshift: Maven がローカル OpenShift クラスターにデプロイできるようにします。
      2. camel-quarkus-quartz : サンプル Quarkus アプリケーションで使用するために Camel エクステンション quartz を有効にします。
   5. クイックスタートを実行すると、Quarkus プロジェクトのスキャフォールディングが作成され、個々のアプリケーションをさらにカスタマイズできるようになります。

2. アプリケーションをビルドして OpenShift にデプロイするには、src/main/resources/application.properties ファイルで次のプロパティーを指定する必要があります (関連の ドキュメント を参照)。

     # Set the Docker build strategy
     quarkus.openshift.build-strategy=docker
   
     # Expose the service to create an OpenShift Container Platform route
     quarkus.openshift.route.expose=true

1. この例では、簡単な Camel ‘hello-world’ Quarkus アプリケーションを実装します。src/main/java/org/hawtio/SampleCamelRoute.java ファイルを以下の内容のプロジェクトに追加します。

   package org.hawtio;
   
   import jakarta.enterprise.context.ApplicationScoped;
   import org.apache.camel.builder.endpoint.EndpointRouteBuilder;
   
   @ApplicationScoped
   public class SampleCamelRoute extends EndpointRouteBuilder
   {
   
   	@Override
   	public void configure()
   	{
   		from(quartz("cron").cron("{{quartz.cron}}")).routeId("cron")
   			.setBody().constant("Hello Camel! - cron")
   			.to(stream("out"))
   			.to(mock("result"));
   
        	from("quartz:simple?trigger.repeatInterval={{quartz.repeatInterval}}").routeId("simple")
   			.setBody().constant("Hello Camel! - simple")
   			.to(stream("out"))
   			.to(mock("result"));
   	}
   }

   1. この例では、Camel ルートを介してコンテナーログの "Hello Camel …​" エントリーをログに記録します。

2. 次のプロパティーを使用して src/main/resources/application.properties ファイルを変更します。

     # Camel
     camel.context.name = SampleCamel
   
     # Uncomment the following to enable the Camel plugin Trace tab
     #camel.main.tracing = true
     #camel.main.backlogTracing = true
     #camel.main.useBreadcrumb = true
   
     # Uncomment to enable debugging of the application and in turn
     # enables the Camel plugin Debug tab even in non-development
     # environment
     #quarkus.camel.debug.enabled = true
   
     # Define properties for the Camel quartz component used in the
     # example
     quartz.cron = 0/10 * * * * ?
     quartz.repeatInterval = 10000

3. pom.xml ファイルの <dependencies> セクションに次の依存関係を追加します。これらは src/main/java/org/hawtio/SampleCamelRoute.java で定義されているルートのために必要です。アプリケーションに追加された Camel ルートが変更された場合は、これらを変更する必要があります。

   <dependency>
     <groupId>org.apache.camel.quarkus</groupId>
     <artifactId>camel-quarkus-stream</artifactId>
   </dependency>
   <dependency>
     <groupId>org.apache.camel.quarkus</groupId>
     <artifactId>camel-quarkus-mock</artifactId>
   </dependency>

1. Maven プロパティーが src/main/resources/application.properties ファイルに渡されるようにするには、ファイル pom.xml の <build> セクションに以下を追加する必要があります。

   <resources>
     <resource>
       <directory>src/main/resources</directory>
       <filtering>true</filtering>
     </resource>
   </resources>

2. pom.xml ファイルの <properties> セクションに次の Jolokia プロパティーを追加します。これらは、Quarkus コンテナーで実行中の jolokia java-agent を設定するために使用されます (プロパティーの説明は、Jolokia JVM エージェント のドキュメントを参照してください)。

     <properties>
     	...
   
     	<!-- The current HawtIO Jolokia Version -->
     	<jolokia-version>2.2.9.redhat-00001</jolokia-version>
   
     	<!--
   
       ===============================================================
       === Jolokia agent configuration for the connection with HawtIO
       ===============================================================
   
   	It should use HTTPS and SSL client authentication at minimum.
   	The client principal should match those the HawtIO instance provides (the default is `hawtio-online.hawtio.svc`).
     	-->
     	<jolokia.protocol>https</jolokia.protocol>
     	<jolokia.host>*</jolokia.host>
     	<jolokia.port>8778</jolokia.port>
   	<jolokia.useSslClientAuthentication>true</jolokia.useSslClientAuthentication>
   	<jolokia.caCert>/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt</jolokia.caCert>
     	<jolokia.clientPrincipal.1>cn=hawtio-online.hawtio.svc</jolokia.clientPrincipal.1>
     	<jolokia.extendedClientCheck>true</jolokia.extendedClientCheck>
     	<jolokia.discoveryEnabled>false</jolokia.discoveryEnabled>
   
   	...
     </properties>

3. pom.xml ファイルの <dependencies> セクションに次の依存関係を追加します。

   <!--
   	This dependency is required for enabling Camel management via JMX / HawtIO.
   -->
   <dependency>
   	<groupId>org.apache.camel.quarkus</groupId>
   	<artifactId>camel-quarkus-management</artifactId>
   </dependency>
   
   <!--
   	This dependency is optional for monitoring with HawtIO but is required for HawtIO view the Camel routes source XML.
   -->
   <dependency>
   	<groupId>org.apache.camel.quarkus</groupId>
   	<artifactId>camel-quarkus-jaxb</artifactId>
   </dependency>
   
   <!--
   	Add this optional dependency, to enable Camel plugin debugging feature.
   -->
   <dependency>
   	<groupId>org.apache.camel.quarkus</groupId>
   	<artifactId>camel-quarkus-debug</artifactId>
   </dependency>
   
   <!--
   	This dependency is required to include the Jolokia agent jvm for
   	access to JMX beans.
   -->
   <dependency>
   	<groupId>org.jolokia</groupId>
   	<artifactId>jolokia-agent-jvm</artifactId>
   	<version>${jolokia-version}</version>
   	<classifier>javaagent</classifier>
   </dependency>

4. Maven プロパティーフィルタリングが実装されている場合、アプリケーションのビルド中に ${jolokia…} 環境変数を pom.xml から渡す必要があります。このプロパティーの目的は、jolokia java-agent を実行するコンテナーの実行プロセスに JVM オプションを追加することです。次のプロパティーを使用して src/main/resources/application.properties ファイルを変更します。

   # Enable the jolokia java-agent on the quarkus application
   quarkus.openshift.env.vars.JAVA_OPTS_APPEND=-javaagent:lib/main/org.jolokia.jolokia-agent-jvm-${jolokia-version}-javaagent.jar=protocol=${jolokia.protocol}\,host=${jolokia.host}\,port=${jolokia.port}\,useSslClientAuthentication=${jolokia.useSslClientAuthentication}\,caCert=${jolokia.caCert}\,clientPrincipal.1=${jolokia.clientPrincipal.1}\,extendedClientCheck=${jolokia.extendedClientCheck}\,discoveryEnabled=${jolokia.discoveryEnabled}

1. HawtIO がデプロイされたアプリケーションを検出するには、実行中のコンテナーに jolokia という名前のポートが存在している必要があります。したがって、src/main/resources/application.properties ファイルに次のプロパティーを追加する必要があります。

   # Define the Jolokia port on the container for HawtIO access
   quarkus.openshift.ports.jolokia.container-port=${jolokia.port}
   quarkus.openshift.ports.jolokia.protocol=TCP

1. コマンドライン (CLI) はすでに OpenShift クラスターにログインしており、プロジェクト が選択されている。

2. すべてのファイルが設定されている場合は、次の maven コマンドを実行できる。

   ./mvnw clean package -Dquarkus.kubernetes.deploy=true

3. ここ で説明する検証手順を使用して、Quarkus アプリケーションが正しく実行されていることを確認する。

4. アプリケーションが正しく実行されていると仮定すると、新しい Quarkus アプリケーションは HawtIO インスタンスによって検出されるはずです (モードによって異なります。'Namespace' モードでは、同じプロジェクト内にある必要があります)。新しいコンテナーは、次のスクリーンショットのように表示されます。

   

5. 接続をクリックすると、Quarkus アプリケーションを HawtIO で確認できます。

   

1. Quarkus アプリケーションの OpenShift へのデプロイ
2. A Quarkus application: Getting started
3. Quarkus Openshift エクステンションの使用

1. AMQ Broker をデプロイするために作成された CR を開きます

2. 次に示すように、deploymentPlan セクションで、jolokiaAgentEnabled および managementRBACEnabled プロパティーを追加し、値を指定します。

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
   spec:
     deploymentPlan:
       size: 4
       image: registry.redhat.io/amq7/amq-broker-rhel8:7.13
       ...
       jolokiaAgentEnabled: true
       managementRBACEnabled: false

   jolokiaAgentEnabled: HawtIO Online がデプロイメント内のブローカーのランタイムデータを検出して表示できるかどうかを指定します。HawtIO Online を使用するには、値を true に設定します。

   managementRBACEnabled デプロイメント内のブローカーに対してロールベースのアクセス制御 (RBAC) を有効にするかどうかを指定します。HawtIO Online は独自のロールベースのアクセス制御を使用するため、HawtIO Online を使用するには値を false に設定する 必要 があります。

   重要

   managementRBACEnabled の値を false に設定して HawtIO Online の使用を有効にすると、ブローカーの管理 MBean に認可が不要になります。managementRBACEnabled が false に設定されている間は、ブローカー上のすべての管理操作が不正に使用される可能性があるため、AMQ 管理コンソールを使用 しない でください。

3. CR インスタンスを保存します。

4. ブローカーデプロイメントを先に作成したプロジェクトに切り替えます。

   oc project <project_name>

5. 次のコマンドを実行して、変更を CR インスタンスに適用します。

   oc apply -f <path/to/custom_resource_instance>.yaml

6. ブラウザーで Hawtio Online を開きます。設定した AMQ ブローカーは、アクセスが許可されている HawtIO 対応アプリケーション Pod のリストに表示されるはずです。
7. Connect をクリックして AMQ Broker を表示します。
8. 新しいブラウザーウィンドウが開き、HawtIO のアプリケーションが表示されます。Artemis プラグインはメインナビゲーションメニューからアクセスできます。

1. Camel タブのツリービューで、Camel Contexts をクリックします。
2. リストのコンテキストの横にあるボックスにチェックマークを入れます。
3. Start または Suspend をクリックします。

4. コンテキストを削除するには以下を行います。

   1. コンテキストを停止します。
   2. 楕円のアイコンをクリックし、ドロップダウンメニューで Delete を選択します。

1. Camel タブのツリービューで、Camel アプリケーションをクリックします。
2. アプリケーションの属性と値のリストを表示するには、Attributes をクリックします。
3. アプリケーション属性をグラフィカルに表示するには、Chart をクリックした後、Edit をクリックし、チャートに表示する属性を選択します。
4. inflight exchange および blocked exchange を表示するには、Exchanges をクリックします。
5. アプリケーションエンドポイントを表示するには、Endpoints をクリックします。リストは URL、Route ID、および direction で絞り込むことができます。
6. メッセージ本文とメッセージヘッダーを別のタイプに変換するために使用される Camel 組み込みタイプ変換メカニズムに関連する統計を表示、有効化、および無効化するには、Type Converters をクリックします。
7. JMX 操作 (XML からのルートの追加または更新、クラスパスで利用できる Camel コンポーネントの検索など) を表示および実行するには、Operations をクリックします。

1. ルートのリストを表示するには、以下を行います。

   1. Camel タブをクリックします。

   2. ツリービューでアプリケーションの routes フォルダーをクリックします。

      

2. 1 つまたは複数のルートを起動、停止、または削除するには、以下を行います。

   1. リストのルートの横にあるボックスにチェックマークを入れます。
   2. Start または Stop をクリックします。

   3. 最初にルートを停止してから削除する必要があります。停止したら楕円のアイコンをクリックし、ドロップダウンメニューで Delete を選択します。

      
      注記
      • ルートを削除する場合、デプロイされたアプリケーションから削除します。
      • ツリービューで特定のルートを選択し、右上のメニューをクリックして起動、停止、または削除することもできます。
3. ルートのグラフィカルな図を表示するには、Route Diagram をクリックします。
4. inflight exchange および blocked exchange を表示するには、Exchanges をクリックします。
5. エンドポイントを表示するには、Endpoints をクリックします。URL、Route ID、および方向でリストを絞り込むことができます。
6. Type Converters をクリックし、Camel の組み込みタイプ変換メカニズムに関連する統計を表示、有効化、および無効化します。このメカニズムはメッセージ本文とメッセージヘッダーを別のタイプに変換するために使用されます。

7. 特定のルートと対話するには、以下を行います。。

   1. Camel タブのツリービューで、ルートを選択します。ルート属性と値のリストを表示するには、Attributes をクリックします。
   2. ルート属性をグラフィカルに表示するには、Chart をクリックします。Edit をクリックすると、チャートに表示する属性を選択できます。
   3. inflight exchange および blocked exchange を表示するには、Exchanges をクリックします。
   4. Operations をクリックして JMX 操作 (ルートを XML としてダンプ、ルートの Camel ID 値の取得など) を表示および実行できます。

8. ルートを介してメッセージをトレースするには、以下を実行します。

   1. Camel タブのツリービューで、ルートを選択します。
   2. Trace を選択してから、Start tracing をクリックします。

9. メッセージをルートに送信するには、以下を行います。

   1. Camel タブのツリービューでコンテキストのエンドポイントフォルダーを開き、エンドポイントを選択します。
   2. Send サブタブをクリックします。
   3. JSON または XML 形式のメッセージを設定します。
   4. Send をクリックします。
   5. ルートの Trace タブに戻り、ルートを介したメッセージのフローを確認します。

1. Camel タブのツリービューで、ルートを選択します。
2. Debug を選択し、Start debugging をクリックします。

3. ブレークポイントを追加するには、図のノードを選択し、Add breakpoint をクリックします。ノードに赤い点が表示されます。

   

4. ノードがブレークポイントのリストに追加されます。

   

5. 下矢印をクリックして次のノードに移動するか、Resume ボタンをクリックしてルートの実行を再開します。

   
6. Pause ボタンをクリックして、ルートのすべてのスレッドを一時停止します。
7. 終了したら Stop debugging をクリックします。すべてのブレークポイントが消去されます。

1. リソースサーバー:

   保護されたリソースをホストするサーバーコンポーネント。アクセスはアクセストークンに基づき制限または許可されます。通常、このサーバーは REST API を介してアクセスされ、サーバーがユーザーインターフェイスを提供することはありません。

2. クライアント:

   ユーザー (リソース所有者として扱われる) に代わってリソースサーバーにアクセスするアプリケーション (通常はユーザーインターフェイスを持っています)。リソースサーバーにアクセスするには、まずクライアントがアクセストークンを取得する必要があります。

   OpenID Connect 仕様では、クライアントはリライングパーティー (RP) と呼ばれます。

3. 認可サーバー:

   クライアントとリソースサーバー間の通信を調整するサーバー。クライアントは認可サーバーにユーザー (リソース所有者) を認証するように要求し、認証が成功すると、リソースサーバーにアクセスするためのアクセストークンがクライアントに発行されます。

   OpenID Connect 仕様では、認可サーバーは OpenID プロバイダー (OP) と呼ばれます。

1. admin または manager、admin、viewer、user のロールを持つ admin
2. viewer または viewer および user のロールを持つ viewer
3. jdoe または user ロールのみを持つ jdoe

1. Web プラットフォーム:

   この種類のクライアントは、サーバー側のアプリケーションや API に適しています。

2. SPA プラットフォーム:

   SPA アプリケーションはブラウザー内で実行されるため、"認可コードフロー" と、いわゆるパブリッククライアントを使用するのが自然です。なぜなら、ブラウザーアプリケーションに認証情報と秘密を保存する適切な方法がないからです。