スタートガイド

マシンまたはコンテナープラットフォームが、Red Hat build of Keycloak で必要な使用方法に十分なメモリーと CPU を提供できることを確認してください。実稼働環境のサイジングを開始する方法の詳細は、{links_high-availability_concepts-memory-and-cpu-sizing_name} を参照してください。

OpenJDK 21 がインストールされていることを確認してください。

Red Hat build of Keycloak を Red Hat の Web サイト からダウンロードして展開します。

このファイルを展開すると、rhbk-26.4.0 という名前のディレクトリーが作成されます。

start-dev オプションを使用すると、開発モードで Red Hat build of Keycloak が起動します。このモードでは、Red Hat build of Keycloak を初めて試して、すぐに起動して実行することができます。このモードは、Red Hat build of Keycloak の開発など、開発者にとって便利なデフォルト設定を提供します。

Red Hat build of Keycloak にはデフォルトの管理者ユーザーがありません。Keycloak を起動する前に、管理者ユーザーを作成する必要があります。

Red Hat build of Keycloak のレルムはテナントに相当します。各レルムにより、管理者はアプリケーションとユーザーの分離グループを作成できます。Red Hat build of Keycloak には、最初は master と呼ばれる単一のレルムが含まれています。このレルムは、Red Hat build of Keycloak の管理にのみ使用し、アプリケーションの管理には使用しません。

次の手順を使用して、最初のレルムを作成します。

図1.1 レルムの追加

View larger image

最初、レルムにはユーザーがいません。ユーザーを作成するには、以下を実行します。

図1.2 ユーザーの作成

View larger image

このユーザーがログインするにはパスワードが必要です。初期パスワードを設定するには、以下を実行します。

図1.3 パスワードの設定

View larger image

これで、アカウントコンソールにログインし、このユーザーが正しく設定されていることを確認できます。

アカウントコンソールのユーザーとして、プロファイルの変更、2 要素認証の追加、ID プロバイダーアカウントの追加などを実行してアカウントを管理できます。

View larger image

最初のアプリケーションに対してセキュリティー保護を行うには、まずアプリケーションを Red Hat build of Keycloak インスタンスに登録します。

図1.5 クライアントの更新

View larger image

クライアントが正常に作成されたことを確認するために、Keycloak Web サイト の SPA テストアプリケーションを使用できます。

実稼働環境で Red Hat build of Keycloak を実行する前に、以下の操作を行うことを検討してください。

詳細は、サーバー設定ガイド を参照してください。

Red Hat build of Keycloak ワークロードを監視するときは、CPU またはメモリーの使用率が低すぎたり高すぎたりしていないかを確認します。Java 仮想マシン (JVM) で使用可能なリソースをより適切に調整するには、CPU およびメモリーリソースのサイジングの概念 を参照してください。

JVM で使用可能なメモリーの量を増やす前に、特にメモリー不足エラーが発生した場合は、ヒープダンプを使用してフットプリントの増加原因を特定することが最善策となります。応答時間が長すぎる場合は、HTTP 作業キューが大きすぎることを示している可能性があり、単にメモリーを増やすよりもロード制限を調整した方が効果的です。以下のセクションを参照してください。

単一の Red Hat build of Keycloak インスタンスは可用性の問題の影響を受けやすくなります。インスタンスがダウンすると、別のインスタンスが起動するまで完全な停止が発生します。異なるマシン上で 2 つ以上のクラスターメンバーを実行すると、Red Hat build of Keycloak の可用性が大幅に向上します。

単一の JVM では、同時に処理できるリクエストの数に制限があります。追加のサーバーインスタンスは、データベースや分散キャッシュなどの関連リソースによってスケーリングが制限されるまで、スループットをほぼリニアスケーリングできます。

一般的には、水平スケーリングの問題を処理するために、Red Hat build of Keycloak Operator を許可することを検討してください。Operator を使用する場合は、水平方向にスケーリングするために、必要に応じて Keycloak カスタムリソースの spec.instances を設定します。詳細は、Operator を使用した複数のアベイラビリティーゾーンにまたがる Red Hat build of Keycloak のデプロイ 参照してください。

Operator を使用していない場合は、以下を確認してください。

クラスター全体が利用できなくなった場合にサービスの可用性が失われないようにするには、「高可用性ガイド」を参照して、マルチクラスターデプロイメントの詳細を確認してください。高可用性の概要 を参照してください。

apiVersion: autoscaling/v2
kind: HorizontalPodAutoscaler
metadata:
  name: keycloak-hpa
  namespace: keycloak-cluster
spec:
  scaleTargetRef:
    apiVersion: k8s.keycloak.org/v2alpha1
    kind: Keycloak
    name: keycloak
  minReplicas: 2
  maxReplicas: 10
  metrics:
    - type: Resource
      resource:
        name: cpu
        target:
          type: Utilization
          averageUtilization: 80

apiVersion: autoscaling/v2
kind: HorizontalPodAutoscaler
metadata:
  name: keycloak-hpa
  namespace: keycloak-cluster
spec:
  scaleTargetRef:
    apiVersion: k8s.keycloak.org/v2alpha1
    kind: Keycloak
    name: keycloak
  minReplicas: 2
  maxReplicas: 10
  metrics:
    - type: Resource
      resource:
        name: cpu
        target:
          type: Utilization
          averageUtilization: 80