Cryostat のインストール


Red Hat build of Cryostat 3

Red Hat Customer Content Services

概要

Red Hat build of Cryostat は、OpenShift Container Platform で提供される Red Hat 製品です。『Cryostat のインストール』 では、この製品の概要と、ソフトウェアをインストールして使用を開始する方法を説明します。

はじめに

Red Hat build of Cryostat は、JDK Flight Recorder (JFR) のコンテナーネイティブ実装です。これを使用すると、OpenShift Container Platform クラスターで実行されるワークロードで Java 仮想マシン (JVM) のパフォーマンスを安全にモニターできます。Cryostat 3.0 を使用すると、Web コンソールまたは HTTP API を使用して、コンテナー化されたアプリケーション内の JVM の JFR データを起動、停止、取得、アーカイブ、インポート、およびエクスポートできます。

ユースケースに応じて、Cryostat が提供するビルトインツールを使用して、Red Hat OpenShift クラスターに直接レコーディングを保存して分析したり、外部のモニタリングアプリケーションにレコーディングをエクスポートして、レコーディングしたデータをより詳細に分析したりできます。

重要

Red Hat build of Cryostat は、テクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、用語の置き換えは、今後の複数のリリースにわたって段階的に実施されます。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。

第1章 Cryostat の概要

Cryostat は、JDK Flight Recorder (JFR) をベースとするコンテナーネイティブ Java アプリケーションで、Red Hat OpenShift クラスターで実行されるコンテナー化されたワークロードの Java 仮想マシン (JVM) パフォーマンスを監視できます。

コンテナー化された Java アプリケーションをホストする Red Hat OpenShift プロジェクトのコンテナーに Cryostat をデプロイできます。また、コンテナー化されたワークロードの実行に使用する JVM インスタンスに対応する JVM ターゲットを作成できます。さらに、Cryostat を JVM ターゲットに接続して、各 JVM ターゲットのヒープおよびヒープ以外のメモリー使用量、スレッド数、ガベージコレクション、およびその他のパフォーマンスメトリクスに関するデータを記録および分析できます。

Cryostat に含まれるツールを使用して、JVM のパフォーマンスのリアルタイム監視、JDK Flight Recorder (JFR) のレコーディングおよびスナップショットのキャプチャー、自動分析レポートの生成、Grafana ダッシュボードを使用してレコーディングされたパフォーマンスデータの可視化を行えます。

Cryostat Web コンソールおよび HTTP API は、外部モニタリングアプリケーションを使用せずにコンテナー内の JVM パフォーマンスデータを分析する方法を提供します。ただし、クラスター環境外にあるデータのより深い分析を行う必要がある場合は、Cryostat からのレコーディングを JDK Mission Control (JMC) の外部インスタンスにエクスポートすることもできます。

Cryostat は、OpenShift Container Platform の標準機能としてロールベースのアクセス制御 (RBAC) をサポートします。

Operator Lifecycle Manager (OLM) を使用して、Red Hat OpenShift プロジェクトに Cryostat をインストールできます。

Red Hat Ecosystem Catalog から最新の Cryostat コンポーネントイメージをダウンロードすることもできます。Red Hat Ecosystem Catalog には、Cryostat 3.0 用の次のコンテナーイメージが存在します。

  • Cryostat
  • Red Hat build of Cryostat Operator
  • Red Hat build of Cryostat Operator バンドル
  • Cryostat レポート
  • Cryostat Grafana ダッシュボード
  • Cryostat DB
  • Cryostat ストレージ
  • JFR データソース

第2章 Cryostat のインストール

Operator Lifecycle Manager (OLM) を使用して、Red Hat build of Cryostat Operator を Red Hat OpenShift のプロジェクトにインストールできます。

Red Hat build of Cryostat Operator をインストールすると、Red Hat OpenShift Web コンソールから、Web コンソールを使用してアクセス可能な Cryostat のインスタンスを作成できます。

Red Hat Ecosystem Catalog から最新の Cryostat コンポーネントイメージをダウンロードすることもできます。

2.1. Red Hat build of Cryostat Operator を使用した Red Hat OpenShift への Cryostat のインストール

Operator Lifecycle Manager (OLM) を使用して、Red Hat build of Cryostat Operator を Red Hat OpenShift クラスターのプロジェクトにインストールできます。Red Hat build of Cryostat Operator を使用すると、シングル namespace またはマルチ namespace の Cryostat インスタンスを作成できます。これらのインスタンスは、Red Hat OpenShift Web コンソールからアクセスできる GUI を使用して制御できます。

重要

Red Hat build of Cryostat Operator のサブスクリプションを Cryostat 2.0 から Cryostat 3.0 に更新する場合は、更新チャネルを stable-2.0 から stable に変更する必要があります。

前提条件

  • OpenShift Container Platform 4.12 以降のクラスターを作成している。
  • Red Hat build of Cryostat Operator をプロジェクトにインストールする権限を持つ Red Hat OpenShift ユーザーアカウントを作成している。
  • クラスターに Operator Lifecycle Manager (OLM) がインストールされている。
  • Red Hat OpenShift の cert-manager Operator を使用して cert-manager をインストールしている。

  • Red Hat OpenShift Web コンソールを使用して Red Hat OpenShift にログインしている。

手順

  1. ブラウザーで、Web コンソールを使用して Home > Projects に移動します。
  2. Red Hat build of Cryostat をインストールするプロジェクトの名前を選択します。
  3. Red Hat build of Cryostat Operator をインストールします。

    1. Web コンソールのナビゲーションメニューで、Operators > OperatorHub に移動します。
    2. リストから Red Hat build of Cryostat Operator を選択します。画面上部の検索ボックスを使用すると、Red Hat build of Cryostat Operator を検索できます。
    3. Install をクリックし、プロジェクトに Red Hat build of Cryostat Operator をインストールします。

      Red Hat OpenShift Web コンソールで、Cryostat カスタムリソース (CR) を作成するように求められます。

      注記

      Cryostat 3.0 以降では、Installation mode エリアで、All namespaces on the cluster (default) ラジオボタンのみが使用可能なオプションになります。

      CR は手動または自動で作成できます。CR を手動で作成する場合は、ステップ 4 を参照してください。CR を自動的に作成する場合は、ステップ 5 を参照してください。

  4. CR を手動で作成する場合は、以下の手順を実行します。

    1. Web コンソールを使用して Operators > Installed Operators に移動し、インストール済み Operator のリストから Red Hat build of Cryostat Operator を選択します。

      図2.1 インストール済み Operator のリストでの Red Hat build of Cryostat Operator の表示

    2. Details タブをクリックします。
    3. Cryostat インスタンスを作成するには、Provided APIs セクションに移動します。次に、CryostatCreate instance をクリックします。

      注記

      Cryostat 3.0 以降では、Cryostat API を使用して、シングルおよびマルチ namespace の両方の Cryostat インスタンスを作成できるようになりました。

      図2.2 Red Hat build of Cryostat Operator によって提供される Cryostat API の選択

    4. Form view または YAML view のラジオボタンをクリックします。YAML 設定ファイルに情報を入力する場合は、YAML view をクリックします。
    5. 作成する Cryostat のインスタンスの一意名を指定します。
    6. オプション: ラベルフィールドで、デプロイするオペランドワークロードのラベルまたはアノテーションを指定します。
    7. Target Namespaces フィールドで、Cryostat のこのインスタンスにアクセスして操作することを許可するワークロードの namespace を選択します。必要に応じて、Cryostat をインストールしたのと同じ namespace を選択することも、別の namespace を選択することもできます。さらに namespace を追加するには、+Add Target Namespace をクリックします。

      重要

      Cryostat インスタンスにアクセスできるユーザーは、その Cryostat インスタンスに認識される namespace 内のすべてのターゲットアプリケーションにアクセスできます。したがって、マルチ namespace の Cryostat インスタンスをデプロイする場合は、監視対象にどの namespace を選択するか、Cryostat をどの namespace にインストールするか、およびどのユーザーにアクセスを許可するかを考慮する必要があります。

      デプロイメントに追加するその他の設定オプションも指定できます。

      図2.3 Web コンソールでのフォームを使用した Cryostat インスタンスの作成

      あるいは、フォームを使用する代わりに、YAML テンプレートを使用してインスタンスを作成し、追加の設定オプションを指定することもできます。

      図2.4 Web コンソールでの YAML テンプレートを使用した Cryostat インスタンスの作成

  5. 自動プロンプトオプションを使用して CR を作成する場合は、プロンプトの指示に従い、次の手順を実行します。

    1. Form view または YAML view のラジオボタンをクリックします。YAML 設定ファイルに情報を入力する場合は、YAML view をクリックします。
    2. 作成する Cryostat のインスタンスの一意名を指定します。
    3. オプション: ラベルフィールドで、デプロイするオペランドワークロードのラベルまたはアノテーションを指定します。
    4. Target Namespaces フィールドで、Cryostat のこのインスタンスにアクセスして操作することを許可するワークロードの namespace を選択します。必要に応じて、Cryostat をインストールしたのと同じ namespace を選択することも、別の namespace を選択することもできます。さらに namespace を追加するには、+Add Target Namespace をクリックします。

      重要

      Cryostat インスタンスにアクセスできるユーザーは、その Cryostat インスタンスに認識される namespace 内のすべてのターゲットアプリケーションにアクセスできます。したがって、マルチ namespace の Cryostat インスタンスをデプロイする場合は、監視対象にどの namespace を選択するか、Cryostat をどの namespace にインストールするか、およびどのユーザーにアクセスを許可するかを考慮する必要があります。

      デプロイメントに追加するその他の設定オプションも指定できます。

      図2.5 Web コンソールでのフォームを使用した Cryostat インスタンスの作成

      あるいは、フォームを使用する代わりに、YAML テンプレートを使用してインスタンスを作成し、追加の設定オプションを指定することもできます。

      図2.6 Web コンソールでの YAML テンプレートを使用した Cryostat インスタンスの作成

  6. Create をクリックして、Cryostat インスタンスの作成プロセスを開始します。

    Cryostat インスタンスのすべてのリソースの準備が完了しなければアクセスできません。

検証

  1. Web コンソールのナビゲーションメニューで、Operators をクリックし、Installed Operators をクリックします。
  2. インストール済み Operator のテーブルから、Red Hat build of Cryostat Operator を選択します。
  3. Cryostat タブを選択します。

    Cryostat インスタンスが、インスタンスのテーブルで開き、次の条件が一覧表示されます。

    • TLSSetupCompletetrue に設定されている。
    • MainDeploymentAvailabletrue に設定されている。
    • オプション: レポートジェネレーターサービスを有効にした場合、ReportsDeploymentAvailable が表示され、true に設定されている。

      図2.7 OpenShift の Cryostat インスタンスの Status 列で True に設定された条件の例

  4. オプション: Cryostat テーブルから Cryostat インスタンスを選択します。Cryostat Conditions テーブルに移動すると、各条件の詳細情報を確認できます。

    図2.8 各条件とその基準をリストした Cryostat Conditions 表の例

2.1.1. Web コンソールを使用して Cryostat にアクセスする

Red Hat OpenShift Web コンソールからアクセス可能な Web コンソールを使用して、Cryostat にアクセスして制御できます。

Cryostat は、Red Hat OpenShift に組み込まれている OAuth サーバーと統合します。Red Hat OpenShift で Cryostat にアクセスしようとすると、OAuth サーバーによって Red Hat OpenShift のログインページが表示され、そこで Red Hat OpenShift の認証情報を入力できます。認証情報を入力すると、OAuth サーバーによって Cryostat Web コンソールが表示されます。

注記

OpenShift Container Platform で Cryostat のすべての機能にアクセスする場合は、Red Hat OpenShift ユーザーアカウントに対して Cryostat 固有のロールベースアクセスコントロール (RBAC) 権限をリクエストする必要があります。

RBAC 権限 を参照してください。

前提条件

  • プロジェクトに Cryostat インスタンスを作成している。
  • Red Hat OpenShift Web コンソールにログインしている。

手順

  1. Red Hat OpenShift Web コンソールで、Installed Operators に移動し、リストから Red Hat build of Cryostat Operator を選択します。
  2. アクセスする Cryostat インスタンスを選択するには、Cryostat タブをクリックし、テーブルからこの Cryostat インスタンスを選択します。

    図2.9 Cryostat タブで Cryostat インスタンスを選択する例

  3. Cryostat ログイン画面にアクセスするには、Application URL セクションのリンクをクリックします。OAuth サーバーは、ユーザーを OpenShift Container Platform ログインページにリダイレクトし、Cryostat API に対する認証用の OAuth アクセストークンを取得できるようにします。

    図2.10 アプリケーション URL セクションでリンクを選択する例

  4. 認証情報の詳細を入力し、ログイン をクリックします。初めて OAuth サーバー経由でログインすると、Web ブラウザーで Authorize Access ページが開きます。

    図2.11 Web ブラウザーで開く Authorize Access ページの例

  5. Requested permissions オプションを確認し、必要なチェックボックスを選択します。最適な Cryostat のパフォーマンスを得るには、両方のチェックボックスを選択してください。
  6. 以下のいずれかのオプションを選択します。

    • 選択した要求済みの権限を受け入れる場合は、Allow selected permissions ボタンをクリックします。
    • 要求済みの権限のオプションをすべて拒否する場合は、Deny ボタンをクリックします。

      Web ブラウザーによって Cryostat Web コンソールにリダイレクトされます。このコンソールでは、Java 仮想マシン (JVM) で実行されている Java アプリケーションを監視できます。

2.1.2. RBAC 権限

Cryostat 3.0 以降では、Cryostat インスタンスをインストールするときに、Cryostat CRD の .spec.authorizationOptions.openShiftSSO.accessReview フィールドを使用して、Cryostat へのアクセスに必要なロールベースのアクセス制御 (RBAC) 権限を指定できます。Cryostat アプリケーションのインストール namespace のデフォルトのロールは create pods/exec です。

指定された RBAC ロールが割り当てられているすべての Red Hat OpenShift ユーザーアカウントには、Cryostat コンソールとすべての Cryostat 機能への完全なアクセス権が付与されます。Red Hat OpenShift アカウントに必要な RBAC 権限がない場合、このユーザーは Cryostat にアクセスできなくなります。

図2.12 OpenShift SSO アクセスレビューの認可オプションの指定

次のフィールドを使用して、Cryostat へのアクセスに必要なカスタムの RBAC 設定を指定できます。

Expand
フィールド詳細

group

リソースの API グループ

* 値を指定すると、すべてのグループが対象となります。

name

get コマンドで要求されるリソースの名前、または delete コマンドで削除されるリソースの名前

空の値を指定すると、すべての名前が対象となります。

namespace

要求されているアクションの namespace

現在、namespace なしとすべての namespace の間に区別はありません。次のガイドラインを考慮してください。

  • LocalSubjectAccessReviews の空の値がデフォルトで使用されます。
  • 空の値は、対象とするクラスタースコープのリソースをなしにします。
  • 空の値は、SubjectAccessReview または SelfSubjectAccessReview からのすべての namespace スコープのリソースが対象となります。

resource

既存のリソースタイプ

* 値を指定すると、すべてのリソースのタイプが対象となります。

subresource

既存のリソースタイプ

空の値を指定すると、対象とするリソースタイプをなしにします。

verb

Kubernetes リソース API 動詞 (例: getlistwatchcreateupdatedeleteproxy)

* 値を指定すると、すべての動詞が対象となります。

version

リソースの API バージョン

* 値を指定すると、すべてのバージョンが対象となります。

2.2. Helm チャート

Red Hat OpenShift 上の Red Hat build of Cryostat Operator を使用して Red Hat Cryostat をインストールする代わりに、Helm チャートを使用できます。Red Hat build of Cryostat Operator は Cryostat のインストールに適した方法ですが、より少ないクラスター権限で柔軟なインストール方法が必要な場合は、Helm チャートで Cryostat をインストールすることができます。

Helm は Red Hat OpenShift 上のパッケージマネージャーであり、以下のようなメリットがあります。

  • カスタムフックを使用して、アプリケーションの定期的な更新を適用します。
  • 複雑なアプリケーションのインストールを管理します。
  • パブリックサーバーまたはプライベートサーバーでホストできるチャートを提供します。パブリックサーバーでチャートを共有する場合は、セキュリティー上のリスクを認識していることを確認してください。
  • アプリケーションの以前のバージョンへのロールバックをサポートします。

デフォルトで、Red Hat OpenShift 4.12 には Helm チャートパッケージマネージャーが含まれています。

Cryostat Helm チャートで Cryostat をインストールする前に、Cryostat Helm チャートおよび Red Hat build of Cryostat Operator でサポートされている以下の機能を検討してください。

Expand
機能Cryostat Helm チャートRed Hat build of Cryostat Operator

サービスを利用した Cryostat へのアクセス

ルートを利用した Cryostat へのアクセス

Basic 認証

 

OpenShift OAuth 認証

 

エンドツーエンドの暗号化

 

Grafana インテグレーション

永続ストレージ

Sidecar レポートジェネレーター

 

前出の表から、Cryostat Helm チャートが Red Hat build of Cryostat Operator と同じレベルの機能をサポートしていないことがわかります。

2.2.1. Helm チャートを使用した Cryostat のインストール

デフォルトで、Red Hat OpenShift 4.12 には Helm チャートパッケージマネージャーが含まれています。このパッケージマネージャーを使って、Red Hat OpenShift に Cryostat Helm チャートをインストールすることができます。次に、この Helm チャートを使って、Red Hat OpenShift に Cryostat インスタンスをインストールすることができます。

Cryostat Helm チャートをインストールすると、Helm チャートは以下のオブジェクトを作成します。

  • Cryostat、Grafana、および Grafana 用のデータソースが含まれる Deployment
  • Cryostat と Grafana のサービスを Red Hat OpenShift クラスターの外部に公開する Routes。このオブジェクトは、Red Hat OpenShift ではデフォルトで有効になっています。
  • Cryostat と Grafana の Services
  • Cryostat の Service AccountRole、および Role Binding により、Cryostat Helm チャートはこれらのオブジェクトを使用してアプリケーションを検出することができます。

前提条件

  • Red Hat OpenShift Web コンソールを使用して OpenShift Container Platform にログインしている。
  • OpenShift Container Platform でアプリケーションおよび他のワークロードを作成するために、プロジェクトで適切なロールと権限を設定している。

手順

  1. Red Hat OpenShift Web コンソールで、Developer モードに切り替えます。
  2. +Add メニューをクリックします。
  3. Developer Catalog パネルから、Helm Chart をクリックします。
  4. Cryostat タイルをクリックします。Red Hat OpenShift の Web コンソールにウィンドウが表示されます。

    ヒント

    Cryostat タイルをすばやく見つけるには、検索フィールドに Cryostat と入力してください。

  5. Create をクリックします。
  6. Create Helm Release ウィンドウで、次のアクションを実行します。

    1. Release name フィールドに、Cryostat Helm チャートの名前を入力します。
    2. Chart version ドロップダウンリストから、Cryostat のバージョンが選択されていることを確認します。
    3. オプション: Form viewChart Values をクリックしてから、Cryostat Helm チャートのオプションを設定します。
    4. オプション: その他の設定オプションにアクセスするには、YAML View に切り替えて、必要に応じてパラメーターを編集します。

      図2.13 OpenShift Create Helm Release ウィンドウ

  7. Create をクリックします。

    Cryostat Helm チャートの情報を表示できるタブ付きのウィンドウが Web コンソールで開く場合があります。Release notes タブで、インストール後に実行する必要のある手順を確認できます。これらの手順を実行するには、Red Hat OpenShift クラスターの oc CLI を使用する必要があります。Cryostat Helm チャートは、デフォルトでネットワークに Routes を使用します。Routes を無効にしている場合、選択したネットワークの種類によって手順が異なる場合があります。

    重要

    Cryostat Helm チャートの core.route.enabled または grafana.route.enabledfalse に設定すると、Routes リソースが無効になり、Web コンソールにポート転送 oc の指示が表示されます。

  8. オプション: トポロジーウィンドウで Pod アイコンをクリックし、Details タブまたは Resources タブに移動して、Pod の詳細情報を表示します。

    ヒント

    Pod をすばやく見つける必要がある場合は、オプションの表示、リソースによるフィルタリング、Pod の名前の入力ができるフィルターツールバーの使用を検討してください。

    Release notes タブに記載されているインストール後の手順を完了すると、アプリケーションで Cryostat を使用できるようになります。

    図2.14 OpenShift の Pod トポロジーウィンドウ

検証

  1. インストール後の手順を完了したターミナルで、"Visit the Cryostat application at …​" ステップに進み、Cryostat アプリケーションにアクセスできる URL を表示します。
注記

Cryostat アプリケーション URL にアクセスするための URL は、選択した設定パラメーターによって異なります。

改訂日時: 2024-07-02

法律上の通知

Copyright © 2024 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat