Red Hat Decision Manager と他の製品およびコンポーネントの統合
概要
はじめに
開発者またはシステム管理者は、Spring Boot、Red Hat Single Sign-On などの他の製品やコンポーネントと Red Hat Decision Manager を統合できます。
多様性を受け入れるオープンソースの強化
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みにより、これらの変更は今後の複数のリリースに対して段階的に実施されます。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。
パート I. Spring Boot での Red Hat Decision Manager ビジネスアプリケーションの作成
開発者は、Maven archetype コマンドを使用して Red Hat Decision Manager Spring Boot ビジネスアプリケーションを作成し、それらのアプリケーションを設定して、既存のサービスまたはクラウドにデプロイできます。
第1章 Red Hat Decision Manager Spring Boot ビジネスアプリケーション
Spring Framework は、Java アプリケーション開発用に包括的なインフラストラクチャーサポートを提供する Java プラットフォームです。Spring Boot は、Spring Boot スターターをベースにした、軽量フレームワークです。Spring Boot スターターは、pom.xml
ファイルで、このファイルには Spring Boot プロジェクトに追加可能な依存関係の記述子セットが含まれます。
Red Hat Decision Manager Spring Boot ビジネスアプリケーションは、特定のビジネス機能を提供する個別サービスを柔軟に、UI に依存せず、論理的にグループ化します。ビジネスアプリケーションは、Spring Boot スターターをベースにしています。通常、個別にデプロイされ、個別にバージョン管理できます。完全なビジネスアプリケーションを使用すると、ドメインは特定のビジネスゴール (たとえば、注文管理や宿泊管理など) を達成できます。ビジネスアプリケーションを作成して設定した後には、OpenShift で、既存のサービスやクラウドにデプロイできます。
ビジネスアプリケーションには、以下のプロジェクト 1 つ以上と、同じ型のプロジェクトを複数含めることができます。
- ビジネスアセット (KJAR): ビジネスプロセス、ルール、フォームが含まれており、Business Central へのインポートが簡単です。
- データモデル: データモデルのプロジェクトでは、サービスプロジェクトやビジネスアセットプロジェクト間で共有される、共通のデータ構造を提供しています。これにより、適切なカプセル化、再利用の促進、ショートカットの軽減が可能になります。各サービスプロジェクトは、独自の公開データモデルを公開できます。
- 動的アセット: ケース管理で使用できるアセットが含まれています。
- サービス: 実際のサービスにさまざまな機能を提供する、デプロイメント可能なプロジェクト。これには、ビジネスを管理するビジネスロジックが含まれます。多くの場合に、サービスプロジェクトにはビジネスアセットとデータモデルプロジェクトが含まれます。ビジネスアプリケーションは、サービスをより小さなコンポーネントサービスプロジェクトに分割して、管理性を向上できます。
第2章 Apache Maven および Red Hat Decision Manager Spring Boot アプリケーション
Apache Maven は分散型構築自動化ツールで、ソフトウェアプロジェクトの作成、ビルド、および管理を行うために Java アプリケーション開発で使用されます。Maven は Project Object Model (POM) ファイルと呼ばれる標準の設定ファイルを使用して、プロジェクトの定義や構築プロセスの管理を行います。POM ファイルは、モジュールおよびコンポーネントの依存関係、ビルドの順番、結果となるプロジェクトパッケージのターゲットを記述し、XML ファイルを使用して出力します。これにより、プロジェクトが適切かつ統一された状態でビルドされるようになります。
Maven リポジトリーには、Java ライブラリー、プラグイン、およびその他のビルドアーティファクトが格納されます。デフォルトのパブリックリポジトリーは Maven 2 Central Repository ですが、複数の開発チームの間で共通のアーティファクトを共有する目的で、社内のプライベートおよび内部リポジトリーとすることが可能です。また、サードパーティーのリポジトリーも利用できます。
Spring Boot プロジェクトでオンライン Maven リポジトリーを使用するか、Red Hat Decision Manager Maven リポジトリーをダウンロードできます。Spring Boot プロジェクトでオンライン Maven リポジトリーを使用することが推奨されます。リポジトリーマネージャーまたは共有サーバー上のリポジトリーと使用する Maven 設定は、プロジェクトの制御および管理性を向上させます。
第3章 オンラインリポジトリーの Maven の settings.xml ファイルの設定
ユーザーの settings.xml
ファイルを設定して、Maven プロジェクトでオンライン Maven リポジトリーを使用できます。これは、推奨の手法です。リポジトリーマネージャーまたは共有サーバー上のリポジトリーと使用する Maven 設定は、プロジェクトの制御および管理性を向上させます。
Maven の settings.xml
ファイルを変更してリポジトリーを設定する場合、変更はすべての Maven プロジェクトに適用されます。
手順
テキストエディターまたは統合開発環境 (IDE) で Maven の
~/.m2/settings.xml
ファイルを開きます。注記~/.m2/
ディレクトリーにsettings.xml
ファイルがない場合には、$MAVEN_HOME/.m2/conf/
ディレクトリーから~/.m2/
ディレクトリーにsettings.xml
ファイルをコピーします。以下の行を
settings.xml
ファイルの<profiles>
要素に追加します。<!-- Configure the Maven repository --> <profile> <id>red-hat-enterprise-maven-repository</id> <repositories> <repository> <id>red-hat-enterprise-maven-repository</id> <url>https://maven.repository.redhat.com/ga/</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>red-hat-enterprise-maven-repository</id> <url>https://maven.repository.redhat.com/ga/</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </pluginRepository> </pluginRepositories> </profile>
以下の行を
settings.xml
ファイルの<activeProfiles>
要素に追加し、ファイルを保存します。<activeProfile>red-hat-enterprise-maven-repository</activeProfile>
3.1. Maven archetype からの Spring Boot ビジネスアプリケーションの作成
Maven アーキタイプを使用して、Spring Boot フレームワークを使用するビジネスアプリケーションを作成できます。これにより、Red Hat Decision Manager のインストールと設定の必要性がなくなります。ビジネスアセットプロジェクト、データモデルプロジェクト、またはサービスプロジェクトを作成できます。
前提条件
- Apache Maven 3.5 以降
手順
次のコマンドのいずれかを入力して、Spring Boot ビジネスアプリケーションプロジェクトを作成します。これらのコマンドで、business-application
をビジネスアプリケーションの名前に置き換えます。
ビジネスプロセス、ルールおよびフォームを含むビジネスアセットプロジェクトを作成するには:
mvn archetype:generate -B -DarchetypeGroupId=org.kie -DarchetypeArtifactId=kie-kjar-archetype -DarchetypeVersion=7.67.0.Final-redhat-00024 -DgroupId=com.company -DartifactId=business-application-kjar -Dversion=1.0-SNAPSHOT -Dpackage=com.company
このコマンドは、
business-application-kjar-1.0-SNAPSHOT.jar
を生成するプロジェクトを作成します。サービスプロジェクトとビジネス資産プロジェクトの間で共有される共通のデータ構造を提供するデータモデル資産プロジェクトを作成するには、次の手順に従います。
mvn archetype:generate -B -DarchetypeGroupId=org.kie -DarchetypeArtifactId=kie-model-archetype -DarchetypeVersion=7.67.0.Final-redhat-00024 -DgroupId=com.company -DartifactId=business-application-model -Dversion=1.0-SNAPSHOT -Dpackage=com.company.model
このコマンドは、
business-application-model-1.0-SNAPSHOT.jar
を生成するプロジェクトを作成します。ケース管理機能を提供する動的資産プロジェクトを作成するには:
mvn archetype:generate -B -DarchetypeGroupId=org.kie -DarchetypeArtifactId=kie-kjar-archetype -DarchetypeVersion=7.67.0.Final-redhat-00024 -DcaseProject=true -DgroupId=com.company -DartifactId=business-application-kjar -Dversion=1.0-SNAPSHOT -Dpackage=com.company
このコマンドは、
business-application-kjar-1.0-SNAPSHOT.jar
を生成するプロジェクトを作成します。サービスプロジェクト (ビジネスを運用するビジネスロジックを含むさまざまな機能を備えたサービスを提供するデプロイ可能なプロジェクト) を作成するには、次のいずれかのコマンドを入力します。
ビジネス自動化は、プロセス管理、ケース管理、意思決定管理、および最適化の機能をカバーしています。これらはデフォルトで、ビジネスアプリケーションのサービスプロジェクトで設定されますが、設定によってオフにすることができます。プロセス管理、ケース管理、意思決定管理、および最適化の機能を含むビジネスアプリケーションサービスプロジェクト (デフォルトの設定) を作成するには:
mvn archetype:generate -B -DarchetypeGroupId=org.kie -DarchetypeArtifactId=kie-service-spring-boot-archetype -DarchetypeVersion=7.67.0.Final-redhat-00024 -DgroupId=com.company -DartifactId=business-application-service -Dversion=1.0-SNAPSHOT -Dpackage=com.company.service -DappType=bpm
意思決定管理は、主に意思決定とルールに関連する機能をカバーしています。意思決定およびルール関連の機能を含む意思決定管理サービスプロジェクトを作成するには:
mvn archetype:generate -B -DarchetypeGroupId=org.kie -DarchetypeArtifactId=kie-service-spring-boot-archetype -DarchetypeVersion=7.67.0.Final-redhat-00024 -DgroupId=com.company -DartifactId=business-application-service -Dversion=1.0-SNAPSHOT -Dpackage=com.company.service -DappType=brm
ビジネスの最適化では、計画の問題とソリューションに関連する機能がカバーされています。Red Hat build of OptaPlanner サービスプロジェクトを作成して、計画の問題とソリューション関連の機能を解決するには、次の手順を実行します。
mvn archetype:generate -B -DarchetypeGroupId=org.kie -DarchetypeArtifactId=kie-service-spring-boot-archetype -DarchetypeVersion=7.67.0.Final-redhat-00024 -DgroupId=com.company -DartifactId=business-application-service -Dversion=1.0-SNAPSHOT -Dpackage=com.company.service -DappType=planner
これらのコマンドは、
business-application-service-1.0-SNAPSHOT.jar
を生成するプロジェクトを作成します。多くの場合に、サービスプロジェクトにはビジネスアセットとデータモデルプロジェクトが含まれます。ビジネスアプリケーションは、サービスをより小さなコンポーネントサービスプロジェクトに分割して、管理性を向上できます。
3.2. オンライン Maven リポジトリー用の Red Hat Decision Manager Spring Boot プロジェクトの設定
Red Hat Decision Manager Spring Boot プロジェクトを作成したら、アプリケーションデータを保存するためにオンライン Maven リポジトリーで設定します。
前提条件
- Maven の archetype コマンドで作成した Spring Boot のビジネスアプリケーションのサービスファイルがある。詳細は、「Maven archetype からの Spring Boot ビジネスアプリケーションの作成」 を参照してください。
手順
-
Red Hat Decision Manager Spring Boot アプリケーションが含まれるディレクトリーで、テキストエディターまたは IDE で
<BUSINESS-APPLICATION>-service/pom.xml
ファイルを開きます。<BUSINESS-APPLICATION>
は Spring Boot プロジェクトの名前に置き換えてください。 以下のリポジトリーを
repositories
要素に追加します。<repository> <id>jboss-enterprise-repository-group</id> <name>Red Hat JBoss Enterprise Maven Repository</name> <url>https://maven.repository.redhat.com/ga/</url> <layout>default</layout> <releases> <updatePolicy>never</updatePolicy> </releases> <snapshots> <updatePolicy>daily</updatePolicy> </snapshots> </repository>
以下のプラグインを
pluginRepositories
要素に追加します。注記pom.xml
ファイルにpluginRepositories
要素がない場合は、これも追加します。<pluginRepository> <id>jboss-enterprise-repository-group</id> <name>Red Hat JBoss Enterprise Maven Repository</name> <url>https://maven.repository.redhat.com/ga/</url> <layout>default</layout> <releases> <updatePolicy>never</updatePolicy> </releases> <snapshots> <updatePolicy>daily</updatePolicy> </snapshots> </pluginRepository>
これにより、お使いのビジネスアプリケーションに、製品化した Maven リポジトリーが追加されます。
3.3. Red Hat Process Automation Manager Maven リポジトリーのダウンロードおよび設定
オンライン Maven リポジトリーを使用しない場合は、Red Hat Process Automation Manager Maven リポジトリーをダウンロードして設定できます。Red Hat Process Automation Manager Maven リポジトリーには、Java 開発者がアプリケーションの構築に使用する要件の多くが含まれています。この手順では、Maven の settings.xml
ファイルを編集し、Red Hat Process Automation Manager Maven リポジトリーを設定する方法を説明します。
Maven の settings.xml
ファイルを変更してリポジトリーを設定する場合、変更はすべての Maven プロジェクトに適用されます。
前提条件
- Red Hat Process Automation Manager Spring Boot プロジェクトを作成している。
手順
Red Hat カスタマーポータルの Software Downloads ページに移動し (ログインが必要)、ドロップダウンオプションから以下の製品およびバージョンを選択します。
- 製品: Process Automation Manager
- バージョン: 7.13.4
-
Red Hat Process Automation Manager 7.13 Maven リポジトリー (
rhpam-7.13.4-maven-repository.zip
) をダウンロードします。 - ダウンロードしたアーカイブをデプロイメントします。
-
~/.m2/
ディレクトリーに移動し、テキストエディターまたは統合開発環境 (IDE) で Maven のsettings.xml
ファイルを開きます。 以下の行を Maven
settings.xml
ファイルの<profiles>
要素に追加します。ここで、<MAVEN_REPOSITORY>
はダウンロードした Maven リポジトリーのパスです。<MAVEN_REPOSITORY>
の形式は、file://$PATH
(例:file:///home/userX/rhpam-7.13.4.GA-maven-repository/maven-repository
) にする必要があります。<profile> <id>red-hat-enterprise-maven-repository</id> <repositories> <repository> <id>red-hat-enterprise-maven-repository</id> <url><MAVEN_REPOSITORY></url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>red-hat-enterprise-maven-repository</id> <url><MAVEN_REPOSITORY></url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </pluginRepository> </pluginRepositories> </profile>
以下の行を Maven の
settings.xml
ファイルの<activeProfiles>
要素に追加し、ファイルを保存します。<activeProfile>red-hat-enterprise-maven-repository</activeProfile>
Maven リポジトリーに古いアーティファクトが含まれる場合は、プロジェクトをビルドまたはデプロイしたときに以下のいずれかの Maven エラーメッセージが表示されることがあります。ここで、<ARTIFACT_NAME>
は不明なアーティファクトの名前で、<PROJECT_NAME>
は構築を試みているプロジェクトの名前になります。
-
Missing artifact <PROJECT_NAME>
-
[ERROR] Failed to execute goal on project <ARTIFACT_NAME>; Could not resolve dependencies for <PROJECT_NAME>
この問題を解決するには、~/.m2/repository
ディレクトリーにあるローカルリポジトリーのキャッシュバージョンを削除し、最新の Maven アーティファクトを強制的にダウンロードします。
第4章 Red Hat Decision Manager での Spring Security
Spring Security は、Spring Security ライブラリー を設定するサーブレットフィルターのコレクションによって提供されます。これらのフィルターは、ユーザー名とパスワードを使用した認証およびロールを使用した承認を行います。Red Hat Decision Manager Spring Boot アプリケーションで生成されるデフォルトの Spring Security 実装は、認証なしで承認を行います。つまり、アプリケーションに対して有効なユーザー名とパスワードを持つユーザーは、ロールなしでアプリケーションにアクセスできます。
サーブレットフィルターは、CSRF (Cross-Site Request Forgery) や CORS (Cross-Origin Resource Sharing) などの一般的な脆弱性から Spring Boot アプリケーションを保護します。Spring Web は DispatcherServlet
に依存し、受信した HTTP 要求を @Controller
アノテーションが付けられた基盤となる java REST リソースにリダイレクトします。DispatchServlet
は、セキュリティーなどの要素に依存しません。ビジネスアプリケーションロジックの外部でセキュリティーなどの実装の詳細を処理することは、優れた方法であり、より効率的です。そのため、Spring はフィルターを使用して HTTP 要求を傍受してから、それらを DispatchServlet
にルーティングします。
典型的な Spring Security 実装は、複数のサーブレットフィルターを使用する以下の手順で構成されます。
- HTTP 要求からユーザー認証情報を抽出し、デコードまたは復号します。
- データベース、Web サービス、Red Hat Single Sign-On などの企業アイデンティティープロバイダーに対して認証情報を検証することにより、完全な認証を行います。
- 承認されたユーザーが要求を実行する権限を持っているかどうかを決定することにより、完全な承認を行います。
-
ユーザーが認証および承認された場合は、要求を
DispatchServlet
に伝播します。
Spring はこれらの手順を個別のフィルターに分割し、FilterChain で連結させます。この連鎖メソッドは、ほとんどすべてのアイデンティティープロバイダーとセキュリティーフレームワークと連携するために必要な柔軟性を提供します。Spring Security では、プログラムを使用してアプリケーションの FilterChain を定義できます。次のセクションは、Maven archetype コマンドを使用して作成された Spring Boot ビジネスアプリケーションサービスファイルの business-application-service/src/main/java/com/company/service/DefaultWebSecurityConfig.java
ファイルからのものです。詳細は、「Maven archetype からの Spring Boot ビジネスアプリケーションの作成」 を参照してください。
@Configuration("kieServerSecurity") @EnableWebSecurity public class DefaultWebSecurityConfig extends WebSecurityConfigurerAdapter { @Override (1) protected void configure(HttpSecurity http) throws Exception { http .cors().and() .csrf().disable() (2) .authorizeRequests() (3) .antMatchers("/rest/*").authenticated().and() .httpBasic().and() (4) .headers().frameOptions().disable(); (5) }
-
(1) デフォルトの
configure(HttpSecurity http)
メソッドをオーバーライドし、Spring HttpClient fluent API/DSL を使用してカスタムの FilterChain を定義します。 - (2) ローカルテストにおける CORS トークンおよび CSRF トークンの一般的な脆弱性フィルターを無効にします。
- (3) パターン 'rest/*' に送信された要求には認証が必要ですが、ロールは定義されていません。
- (4) 承認ヘッダーによる Basic 認証を許可します (ヘッダー 'Authorization: Basic dGVzdF91c2VyOnBhc3N3b3Jk' など)。
- (5) 要求/レスポンスから 'X-Frame-Options' ヘッダーを削除します。
この設定により、認証されたユーザーは KIE API を実行できます。
デフォルトの実装は外部アイデンティティープロバイダーに統合されないため、ユーザーはメモリー内の同じ DefaultWebSecurityConfg
クラスで定義されます。以下のセクションは、Red Hat Decision Manager Spring Boot ビジネスアプリケーションの作成時に提供されるユーザーを示しています。
@Autowired public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception { auth.inMemoryAuthentication().withUser("user").password("user").roles("kie-server"); auth.inMemoryAuthentication().withUser("wbadmin").password("wbadmin").roles("admin"); auth.inMemoryAuthentication().withUser("kieserver").password("kieserver1!").roles("kie-server"); }
4.1. Spring Security を使用した承認による認証
デフォルトでは、Red Hat Decision Manager Spring Boot アプリケーションに対して有効なユーザー名とパスワードを持つユーザーは、ロールなしでアプリケーションにアクセスできます。Spring Security の認証および承認は、HTTPSecurity
フィルターチェーン設定から取得します。特定のロールマッピングを持たないユーザーから REST API を保護するには、Spring Security .authorizeRequests()
メソッドを使用して、承認する URL を一致させます。
前提条件
- Red Hat Decision Manager Spring Boot アプリケーションがある。
手順
-
Red Hat Decision Manager Spring Boot アプリケーションが含まれるディレクトリーで、テキストエディターまたは IDE で
business-application-service/src/main/java/com/company/service/DefaultWebSecurityConfig.java
ファイルを開きます。 特定のロールがある場合にのみ認証されたユーザーによるアクセス要求を承認するには、以下のいずれかの方法で
.antMatchers("/rest/*").authenticated().and()
行を編集します。1 つのロールを承認するには、以下の例のように
antMatchers
メソッドを編集します。ここで、<role>
はユーザーがアクセスするために必要なロールに置き換えます。@Configuration("kieServerSecurity") @EnableWebSecurity public class DefaultWebSecurityConfig extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { http .cors().and().csrf().disable() .authorizeRequests() .antMatchers("/**").hasRole("<role>") .anyRequest().authenticated() .and().httpBasic() .and().headers().frameOptions().disable(); } ...
さまざまなロールのうちの 1 つを持つユーザーを承認するには、以下の例のように
antMatchers
メソッドを編集します。ここで、<role>
および<role1>
はそれぞれ、ユーザーがアクセスするために持つことができるロールです。@Configuration("kieServerSecurity") @EnableWebSecurity public class DefaultWebSecurityConfig extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { http .cors().and().csrf().disable() .authorizeRequests() .antMatchers("/**").hasAnyRole("<role>", "<role1") .anyRequest().authenticated() .and().httpBasic() .and().headers().frameOptions().disable(); } ...
authorizeRequests
メソッドでは、特定の式に対する要求の承認が必要です。すべての要求が正常に認証されている必要があります。認証は、HTTP Basic 認証を使用して実行されます。認証されたユーザーが、自分では持っていないロールに対して保護されているリソースにアクセスしようとすると、そのユーザーは HTTP 403 (Forbidden)
エラーを受け取ります。
4.2. Red Hat Decision Manager ビジネスアプリケーションでの Spring Security の無効化
Red Hat Decision Manager ビジネスアプリケーションで Spring Security を設定して、認証なしでセキュリティーコンテキストを提供することができます。
前提条件
- Red Hat Decision Manager Spring Boot アプリケーションがある。
手順
-
Red Hat Decision Manager Spring Boot アプリケーションが含まれるディレクトリーで、テキストエディターまたは統合開発環境 (IDE) で
business-application-service/src/main/java/com/company/service/DefaultWebSecurityConfig.java
ファイルを開きます。 以下の例で示すように
.antMatchers
メソッドを編集します。@Override protected void configure(HttpSecurity http) throws Exception { http .cors().and().csrf().disable() .authorizeRequests() .antMatchers("/*") .permitAll() .and().headers().frameOptions().disable(); }
PermitAll
メソッドは、指定された URL パターンに対するすべての要求を許可します。
HttpServletRequest
にセキュリティーコンテキストが渡されないため、Spring は AnonymousAuthenticationToken
を作成し、ROLE_ANONYMOUS
ロール以外の指定されたロールを持たない anonymousUser
ユーザーで SecurityContext
を追加します。ユーザーは、アプリケーションの多くの機能にアクセスできません。たとえば、割り当てられたタスクをグループ化するためにアクションを割り当てることができなくなります。
4.3. 事前認証での Spring セキュリティーの使用
PermitAll
メソッドを使用して Spring Security 認証を無効にすると、すべてのユーザーはアプリケーションにログインできますが、ユーザーのアクセスと機能は限定されます。ただし、ユーザーを事前に認証できるため (指定されたサービスアカウントなど)、ユーザーのグループは同じログインを使用できますが、ユーザーのグループに必要なすべてのパーミッションが付与されます。このため、各ユーザーに認証情報を作成する必要はありません。
事前認証を実装する最も簡単な方法は、カスタムフィルターサーブレットを作成し、DefaultWebSecurityConfig
クラスのセキュリティー FilterChain の前に追加することです。これにより、カスタマイズされたプロファイルベースのセキュリティーコンテキストを挿入し、そのコンテンツを制御して、シンプルに保つことができます。
前提条件
- Red Hat Decision Manager Spring Boot アプリケーションがあり、Spring Security を 「Red Hat Decision Manager ビジネスアプリケーションでの Spring Security の無効化」 に従って無効化している。
手順
AnonymousAuthenticationFilter
クラスを拡張する以下のクラスを作成します。import org.springframework.security.authentication.AnonymousAuthenticationToken; import org.springframework.security.core.Authentication; import org.springframework.security.core.AuthenticationException; import org.springframework.security.core.GrantedAuthority; import org.springframework.security.core.authority.SimpleGrantedAuthority; import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.security.web.authentication.AnonymousAuthenticationFilter; import javax.servlet.FilterChain; import javax.servlet.ServletException; import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.http.HttpServletRequest; import java.io.IOException; import java.util.Arrays; import java.util.Collections; import java.util.List; public class <CLASS_NAME> extends AnonymousAuthenticationFilter { private static final Logger log = LoggerFactory.getLogger(<CLASS_NAME>.class); public AnonymousAuthFilter() { super("PROXY_AUTH_FILTER"); } @Override public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException { SecurityContextHolder.getContext().setAuthentication(createAuthentication((HttpServletRequest) req)); log.info("SecurityContextHolder pre-auth user: {}", SecurityContextHolder.getContext()); if (log.isDebugEnabled()) { log.debug("Populated SecurityContextHolder with authenticated user: {}", SecurityContextHolder.getContext().getAuthentication()); } chain.doFilter(req, res); } @Override protected Authentication createAuthentication(final HttpServletRequest request) throws AuthenticationException { log.info("<ANONYMOUS_USER>"); List<? extends GrantedAuthority> authorities = Collections .unmodifiableList(Arrays.asList(new SimpleGrantedAuthority("<ROLE>") )); return new AnonymousAuthenticationToken("ANONYMOUS", "<ANONYMOUS_USER>", authorities); } }
以下の変数を置き換えてください。
-
<CLASS_NAME>
を、このクラスの名前 (AnonymousAuthFilter
など) に置き換えます。 -
<ANONYMOUS_USER>
をユーザー ID (Service_Group
など) に置き換えます。 -
<ROLE>
を<ANONYMOUS_USER>
に付与する必要がある権限を持つロールに置き換えます。
-
<ANONYMOUS_USER>
に複数のロールを割り当てる必要がある場合は、以下の例に示すようにロールを追加します。.unmodifiableList(Arrays.asList(new SimpleGrantedAuthority("<ROLE>") , new SimpleGrantedAuthority("<ROLE2>")
.anonymous().authenticationFilter(new <CLASS_NAME>()).and()
をbusiness-application-service/src/main/java/com/company/service/DefaultWebSecurityConfig.java
ファイルに追加します。<CLASS_NAME>
は作成したクラス名に置き換えます。@Override protected void configure(HttpSecurity http) throws Exception { http .anonymous().authenticationFilter(new <CLASS_NAME>()).and() // Override anonymousUser .cors().and().csrf().disable() .authorizeRequests() .antMatchers("/*").permitAll() .and().headers().frameOptions().disable(); }
4.4. Red Hat Single Sign-On を使用したビジネスアプリケーションの設定
ほとんどの組織は、シングルサインオン (SSO) トークンを使用して、ユーザーおよびグループの詳細を提供します。Red Hat Single Sign-On (RHSSO) を使用して、サービス間のシングルサインオンを有効にし、一元的にユーザーとロールの設定や管理ができます。
前提条件
- Spring Boot ビジネスアプリケーションがある。
手順
- Red Hat シングルサインオン (SSO) をダウンロードします。手順は、Red Hat Single Sign-On Getting Started Guide を参照してください。
RHSSO を設定します。
デフォルトのマスターレルムを使用するか、新しいレルムを作成します。
レルムは、一連のユーザー、認証情報、ロール、およびグループを管理します。ユーザーはレルムに属し、レルムにログインします。レルムは相互に分離され、制御するユーザーのみを管理および認証できます。
-
springboot-app
クライアントを作成して、パブリックにAccessType
を追加します。 以下の例で示すように、ローカルの設定に合わせて有効なリダイレクト URI と Web オリジンを設定します。
-
有効なリダイレクト URI:
http://localhost:8090/*
-
Web オリジン:
http://localhost:8090
-
有効なリダイレクト URI:
- アプリケーションで使用するレルムロールを作成します。
- アプリケーションで使用するユーザーを作成してロールを割り当てます。
以下の要素およびプロパティーを Spring Boot プロジェクトの
pom.xml
ファイルに追加します。ここで、<KEYCLOAK_VERSION>
は使用している Keycloak のバージョンに置き換えます。<properties> <version.org.keycloak><KEYCLOAK_VERSION></version.org.keycloak> </properties>
以下の依存関係を Spring Boot プロジェクトの
pom.xml
ファイルに追加します。<dependencyManagement> <dependencies> <dependency> <groupId>org.keycloak.bom</groupId> <artifactId>keycloak-adapter-bom</artifactId> <version>${version.org.keycloak}</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> .... <dependency> <groupId>org.keycloak</groupId> <artifactId>keycloak-spring-boot-starter</artifactId> </dependency>
Spring Boot プロジェクトディレクトリーで
business-application-service/src/main/resources/application.properties
ファイルを開き、以下の行を追加します。# keycloak security setup keycloak.auth-server-url=http://localhost:8100/auth keycloak.realm=master keycloak.resource=springboot-app keycloak.public-client=true keycloak.principal-attribute=preferred_username keycloak.enable-basic-auth=true
business-application-service/src/main/java/com/company/service/DefaultWebSecurityConfig.java
ファイルを変更して、Spring Security が RHSSO で正しく機能することを確認します。import org.keycloak.adapters.KeycloakConfigResolver; import org.keycloak.adapters.springboot.KeycloakSpringBootConfigResolver; import org.keycloak.adapters.springsecurity.authentication.KeycloakAuthenticationProvider; import org.keycloak.adapters.springsecurity.config.KeycloakWebSecurityConfigurerAdapter; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; import org.springframework.security.core.authority.mapping.SimpleAuthorityMapper; import org.springframework.security.core.session.SessionRegistryImpl; import org.springframework.security.web.authentication.session.RegisterSessionAuthenticationStrategy; import org.springframework.security.web.authentication.session.SessionAuthenticationStrategy; @Configuration("kieServerSecurity") @EnableWebSecurity public class DefaultWebSecurityConfig extends KeycloakWebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { super.configure(http); http .csrf().disable() .authorizeRequests() .anyRequest().authenticated() .and() .httpBasic(); } @Autowired public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception { KeycloakAuthenticationProvider keycloakAuthenticationProvider = keycloakAuthenticationProvider(); SimpleAuthorityMapper mapper = new SimpleAuthorityMapper(); mapper.setPrefix(""); keycloakAuthenticationProvider.setGrantedAuthoritiesMapper(mapper); auth.authenticationProvider(keycloakAuthenticationProvider); } @Bean public KeycloakConfigResolver KeycloakConfigResolver() { return new KeycloakSpringBootConfigResolver(); } @Override protected SessionAuthenticationStrategy sessionAuthenticationStrategy() { return new RegisterSessionAuthenticationStrategy(new SessionRegistryImpl()); } }
第5章 Red Hat Decision Manager Spring Boot の設定
Spring Boot プロジェクトの作成後、複数のコンポーネントを設定してアプリケーションをカスタマイズできます。
5.1. Spring Boot アプリケーションの REST エンドポイントの設定
Spring Boot プロジェクトを作成したら、Spring Boot アプリケーションの REST エンドポイントのホスト、ポート、およびパスを設定できます。
前提条件
- Maven の archetype コマンドで作成した Spring Boot のビジネスアプリケーションのサービスファイルがある。詳細は、「Maven archetype からの Spring Boot ビジネスアプリケーションの作成」 を参照してください。
手順
-
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-service/src/main/resources
ディレクトリーに移動します。<BUSINESS-APPLICATION>
は Spring Boot プロジェクトの名前に置き換えます。 -
テキストエディターで
application.properties
ファイルを開きます。 REST エンドポイントのホスト、ポート、およびパスを設定します。
<ADDRESS>
はサーバーアドレスに、<PORT>
はサーバーポートに置き換えます。server.address=<ADDRESS> server.port=<PORT> cxf.path=/rest
以下の例では、REST エンドポイントをポート
8090
のlocalhost
アドレスに追加します。server.address=localhost server.port=8090 cxf.path=/rest
5.2. KIE Server アイデンティティーの設定
Spring Boot プロジェクトを作成したら、簡単に特定できるように KIE Server を設定できます。
前提条件
- Maven の archetype コマンドで作成した Spring Boot のビジネスアプリケーションのサービスファイルがある。詳細は、「Maven archetype からの Spring Boot ビジネスアプリケーションの作成」 を参照してください。
手順
-
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-service/src/main/resources
ディレクトリーに移動します。<BUSINESS-APPLICATION>
は Spring Boot プロジェクトの名前に置き換えます。 -
テキストエディターで
application.properties
ファイルを開きます。 以下の例のように KIE Server パラメーターを設定します。
kieserver.serverId=<BUSINESS-APPLICATION>-service kieserver.serverName=<BUSINESS-APPLICATION>-service kieserver.location=http://localhost:8090/rest/server kieserver.controllers=http://localhost:8080/business-central/rest/controller
以下の表で、ビジネスプロジェクトに設定可能な KIE Server のパラメーターを紹介します。
表5.1 kieserver パラメーター パラメーター 値 説明 kieserver.serverId
string
Process Automation Manager コントローラーに接続時にビジネスアプリケーションを識別するために使用する ID。
kieserver.serverName
string
Process Automation Manager コントローラーに接続時にビジネスアプリケーションを識別するために使用する名前。
kieserver.serverId
パラメーターに使用した文字と同じものを使用できます。kieserver.location
URL
REST API を使用する他のコンポーネントがこのサーバーの場所を識別するために使用します。
server.address
およびserver.port
で定義されている場所は使用しないでください。kieserver.controllers
URL
コントローラー URL のコンマ区切りリスト
5.3. ランタイム時に起動する KIE Server コンポーネントの設定
Spring Boot ビジネスアプリケーションの作成時に Business Automation を選択した場合は、ランタイムに起動する必要のある KIE Server のコンポーネントを指定することができます。
前提条件
- Maven の archetype コマンドで作成した Spring Boot のビジネスアプリケーションのサービスファイルがある。詳細は、「Maven archetype からの Spring Boot ビジネスアプリケーションの作成」 を参照してください。
手順
-
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-service/src/main/resources
ディレクトリーに移動します。<BUSINESS-APPLICATION>
は Spring Boot プロジェクトの名前に置き換えます。 -
テキストエディターで
application.properties
ファイルを開きます。 ランタイムにコンポーネントが起動するように設定するには、コンポーネントの値を
true
に設定します。以下の表は、ランタイムに起動するように設定できるコンポーネントのリストです。
表5.2 kieserver ケーパビリティーパラメーター パラメーター 値 説明 kieserver.drools.enabled
true, false
Decision Manager コンポーネントを有効または無効にします。
kieserver.dmn.enabled
true, false
DMN (Decision Model and Notation) コンポーネントを有効または無効にします。
5.4. ビジネスアプリケーションのユーザーグループプロバイダーの設定
Red Hat Decision Manager を使用すると、人間中心のアクティビティーを管理できます。2 つの KIE API エントリーポイントを使用して、ユーザーリポジトリーおよびグループリポジトリーを統合できます。
-
UserGroupCallback
: ユーザーまたはグループが存在するかどうかを確認して、特定のユーザーのグループの情報を集めます。 -
UserInfo
: メールアドレスや設定言語など、ユーザーおよびグループの追加情報を収集します。
すぐに使用できるコードまたはカスタムの開発コードなど、代わりのコードを指定すると、これらの両コンポーネントを設定できます。
UserGroupCallback
コンポーネントについては、デフォルトの実装はアプリケーションのセキュリティーコンテキストをもとにしているため、この実装が保持されます。このように、どのバックエンドストアを認証や承認 (例: RH-SSO) に使用するかは重要ではありません。ユーザーやグループの情報収集用の情報源として、この実装が自動的に使用されます。
UserInfo
コンポーネントは、より詳細にわたる情報を収集するため、別のコンポーネントとなっています。
前提条件
- Spring Boot ビジネスアプリケーションがある。
手順
UserGroupCallback
の別の実装を提供するには、以下のコードを、アプリケーションクラスに追加するか、@Configuration
のアノテーションが付いた別のクラスに追加します。@Bean(name = "userGroupCallback") public UserGroupCallback userGroupCallback(IdentityProvider identityProvider) throws IOException { return new MyCustomUserGroupCallback(identityProvider); }
UserInfo
の別の実装を提供するには、以下のコードを、アプリケーションクラスに追加するか、@Configuration
のアノテーションが付いた別のクラスに追加します。@Bean(name = "userInfo") public UserInfo userInfo() throws IOException { return new MyCustomUserInfo(); }
5.5. Swagger ドキュメントの有効化
Red Hat Decision Manager ビジネスアプリケーションのサービスプロジェクトで利用可能なすべてのエンドポイントに関する Swagger ベースのドキュメントを有効にできます。
前提条件
- Spring Boot ビジネスアプリケーションがある。
手順
-
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-service
ディレクトリーに移動します。<BUSINESS-APPLICATION>
は Spring Boot プロジェクトの名前に置き換えます。 -
テキストエディターでサービスプロジェクト
pom.xml
ファイルを開きます。 サービスプロジェクトの
pom.xml
ファイルに以下の依存関係を追加して、このファイルを保存します。<dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-rs-service-description-swagger</artifactId> <version>3.2.6</version> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-jaxrs</artifactId> <version>1.5.15</version> <exclusions> <exclusion> <groupId>javax.ws.rs</groupId> <artifactId>jsr311-api</artifactId> </exclusion> </exclusions> </dependency>
Swagger UI を有効にするには (任意)、以下の依存関係を
pom.xml
ファイルに追加して、このファイルを保存します。<dependency> <groupId>org.webjars</groupId> <artifactId>swagger-ui</artifactId> <version>2.2.10</version> </dependency>
-
テキストエディターで
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-service/src/main/resources/application.properties
ファイルを開きます。 Swagger サポートを有効にするには、以下の行を
application.properties
ファイルに追加します。kieserver.swagger.enabled=true
ビジネスアプリケーションの起動後に、http://localhost:8090/rest/swagger.json
で Swagger ドキュメントを表示できます。全エンドポイントについては、http://localhost:8090/rest/api-docs?url=http://localhost:8090/rest/swagger.json
で入手できます。
第6章 自己完結型 Red Hat Decision Manager Spring Boot JAR ファイルの作成
KIE Server および 1 つ以上の KJAR ファイルなど、完全なサービスを含む、自己完結型 Red Hat Decision Manager Spring Boot JAR ファイル 1 つを作成できます。Red Hat Decision Manager Spring Boot JAR ファイルは、ランタイム時に読み込まれる KJAR ファイルには依存しません。
必要に応じて、Red Hat Decision Manager Spring Boot JAR ファイルには、モジュールを含む、同じ KJAR ファイルの複数のバージョンを含めることができます。これらの KJAR ファイルは、artifactID
属性値と groupID
属性値が同じですが、version
の値は異なります。
含める KJAR ファイルは、クラスローダーの衝突を避けるために BOOT-INF/lib
ディレクトリーの JAR ファイルから分離されています。各 KJAR クラスパスコンテナーファイルは、他の KJAR クラスパスコンテナーファイルから分離され、Spring Boot クラスローダーに依存しません。
前提条件
- 既存の Red Hat Decision Manager Spring Boot プロジェクトがある。
- プロジェクトの KJAR ファイル 1 つ以上の開発を完了している。
手順
プロジェクトの KJAR ファイルをすべてビルドします。デフォルトのビジネスアプリケーションでは、KJAR ソースは
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-kjar
ディレクトリーに含まれます。BUSINESS-APPLICATION
はビジネスアプリケーションの名前に置き換えます。プロジェクトには、他の KJAR ソースディレクトリーが含まれている可能性があります。すべての KJAR ソースのディレクトリーの KJAR ファイルをビルドするには、以下の手順を実行します。
- KJAR ソースディレクトリーに移動します。
以下のコマンドを入力します。
mvn install
このコマンドは、KJAR ファイルをビルドし、ローカルの Maven リポジトリーに配置します。デフォルトでは、このリポジトリーは
~/.m2/repo
ディレクトリーに配置されます。
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-service/src/main/resources
ディレクトリーで、Spring Boot アプリケーションのapplication.properties
ファイルに以下のプロパティーを追加します。kieserver.classPathContainer=true
このプロパティーを
true
に設定すると、KIE Server はコンテナーが使用するクラスローダーを使用して KJAR ファイルとその依存関係を読み込みます。KIE Server が必要な KJAR モジュールを読み込むには、以下のいずれかのアクションを実行します。
KIE Server を設定して、Spring Boot アプリケーションで利用可能なすべての KJAR モジュールをスキャンし、デプロイするには、以下のプロパティーを
application.properties
ファイルに追加します。kieserver.autoScanDeployments=true
このプロパティーを
true
に設定すると、プログラムを使用して宣言されているか、Maven プラグインを介して宣言されているかに関係なく、KIE Server はアプリケーションで利用可能なすべての KJAR モジュールをデプロイします。このオプションは、すべての KJAR モジュールを含める最も簡単な方法です。ただし、欠点が 2 つあります。
- アプリケーションは、すべての KJAR モジュールのグループ、アーティファクト、バージョン (GAV) に基づいて、すべてのコンテナー ID およびエイリアスを自動的に設定します。KJAR モジュールのカスタムコンテナー ID またはエイリアスを設定できません。
- 起動時に、アプリケーションは JAR ファイルおよび KJAR モジュールのクラスパスをスキャンします。そのため、起動期間は長くなる可能性があります。
このような欠点を回避するには、以下のいずれかのオプションで説明されているように
application.properties
ファイルを使用するか、Java ソースコードを使用して、すべての KJAR モジュールを個別に設定できます。サービスに追加する KJAR モジュールごとに、
application.properties
ファイルを使用して、すべての KJAR モジュールを個別に設定するには、以下のプロパティーをapplication.properties
ファイルに追加します。kieserver.deployments[<n>].containerId=<container> kieserver.deployments[<n>].alias=<alias> kieserver.deployments[<n>].artifactId=<artifact> kieserver.deployments[<n>].groupId=<group> kieserver.deployments[<n>].version=<version>
以下の値を置き換えます。
-
<n>
: 連番: 1 番目の KJAR モジュールは0
、2 番目のモジュールの場合は1
など。 -
<container>
: KJAR モジュールのコンテナー ID -
<alias>
: KJAR モジュールのエイリアス -
<artifact>
: KJAR モジュールのアーティファクト ID -
<group>
: KJAR モジュールのグループ ID -
<version>
: KJAR モジュールのバージョン ID
以下の例では、
Evaluation
用の KJAR モジュールの 2 つのバージョンを設定します。kieserver.deployments[0].alias=evaluation_v1 kieserver.deployments[0].containerId=evaluation_v1 kieserver.deployments[0].artifactId=Evaluation kieserver.deployments[0].groupId=com.myspace kieserver.deployments[0].version=1.0.0-SNAPSHOT kieserver.deployments[1].alias=evaluation_v2 kieserver.deployments[1].containerId=evaluation_v2 kieserver.deployments[1].artifactId=Evaluation kieserver.deployments[1].groupId=com.myspace kieserver.deployments[1].version=2.0.0-SNAPSHOT
-
Java ソースコードを使用してすべての KJAR モジュールを個別に設定するには、以下の例のように、ビジネスアプリケーションサービスにクラスを作成します。
@Configuration public class KieContainerDeployer { @Bean public KieContainerResource evaluation_v1() { KieContainerResource container = new KieContainerResource("evaluation_v1", new ReleaseId("com.myspace", "Evaluation", "1.0.0-SNAPSHOT"), STARTED); container.setConfigItems(Arrays.asList(new KieServerConfigItem(KieServerConstants.PCFG_RUNTIME_STRATEGY, "PER_PROCESS_INSTANCE", "String"))); return container; } @Bean public KieContainerResource evaluation_v2() { KieContainerResource container = new KieContainerResource("evaluation_v2", new ReleaseId("com.myspace", "Evaluation", "2.0.0-SNAPSHOT"), STARTED); container.setConfigItems(Arrays.asList(new KieServerConfigItem(KieServerConstants.PCFG_RUNTIME_STRATEGY, "PER_PROCESS_INSTANCE", "String"))); return container; } }
追加するすべての KJAR モジュールについて、このクラスに
KieContainerResource
Bean を作成します。Bean の名前はコンテナー名であり、KieContainerResource()
の最初のパラメーターはエイリアス名で、ReleaseId()
のパラメーターは、KJAR モジュールのグループ ID、アーティファクト ID、およびバージョン ID です。
必要に応じて、ビジネスアプリケーションを Red Hat OpenShift Container Platform Pod で実行するか、現在のディレクトリーが書き込み可能ではない他の環境で実行する場合は、
spring.jta.log-dir
プロパティーをapplication.properties
ファイルに追加し、書き込み可能な場所に設定します。以下に例を示します。spring.jta.log-dir=/tmp
このパラメーターは、トランザクションログの場所を設定します。
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-service
ディレクトリーの Spring Bootpom.xml
ファイルに以下の Maven プラグインを追加します。<GROUP_ID>
、<ARTIFACT_ID>
および<VERSION>
は、プロジェクトが使用する KJAR アーティファクトのグループ、アーティファクト、バージョン (GAV) に置き換えます。これらの値は、KJAR ソースディレクトリーにあるpom.xml
ファイルにあります。注記アーティファクトのバージョンを複数追加できます。
<build> <plugins> <plugin> <groupId>org.kie</groupId> <artifactId>kie-maven-plugin</artifactId> <version>${version.org.kie}</version> <executions> <execution> <id>copy</id> <phase>prepare-package</phase> <goals> <goal>package-dependencies-kjar</goal> </goals> </execution> </executions> <configuration> <artifactItems> <artifactItem> <groupId><GROUP_ID></groupId> <artifactId><ARTIFACT_ID></artifactId> <version><VERSION></version> </artifactItem> </artifactItems> </configuration> </plugin> <plugins> <build>
KJAR の実行に必要なアーティファクトは、ビルド時に解決されます。
以下の例では、
Evaluation
アーティファクトのバージョンを 2 つ追加します。<build> <plugins> <plugin> <groupId>org.kie</groupId> <artifactId>kie-maven-plugin</artifactId> <version>${version.org.kie}</version> <executions> <execution> <id>copy</id> <phase>prepare-package</phase> <goals> <goal>package-dependencies-kjar</goal> </goals> </execution> </executions> <configuration> <artifactItems> <artifactItem> <groupId>com.myspace</groupId> <artifactId>Evaluation</artifactId> <version>1.0.0-SNAPSHOT</version> </artifactItem> <artifactItem> <groupId>com.myspace</groupId> <artifactId>Evaluation</artifactId> <version>2.0.0-SNAPSHOT</version> </artifactItem> </artifactItems> </configuration> </plugin> </plugins> </build>
自己完結型 Spring Boot イメージをビルドするには、
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-service
ディレクトリーで以下のコマンドを入力します。mvn install
オプション: 自己完結型 Spring Boot イメージを実行するには、
target
サブディレクトリーで JAR ファイルを見つけ、以下のコマンドを入力します。java -jar <FILENAME>.jar
このコマンドで
<FILENAME>
は JAR ファイルの名前に置き換えます。
第7章 ビジネスアプリケーションの実行
デフォルトでは、ビジネスアプリケーションには、実行プロジェクト、つまりサービスプロジェクトが 1 つ含まれています。サービスプロジェクトは、Windows または Linux のスタンドアロン (マネージド外) または開発 (マネージド) モードで実行できます。スタンドアロンモードを使用すると、追加の要件なしでアプリケーションを起動できます。開発モードで開始されたアプリケーションは、Business Central を Process Automation Manager コントローラーとして使用する必要があります。
7.1. スタンドアロンモードでのビジネスアプリケーションの実行
スタンドアロン (マネージド外) モードでは、追加要件なしにビジネスアプリケーションを起動できます。
前提条件
- Spring Boot ビジネスアプリケーションがある。
- ビジネスアプリケーションが設定されている。
手順
-
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-service
ディレクトリーに移動します。 以下のコマンドの 1 つを実行します。
表7.1 スタンドアロンの起動オプション コマンド
説明
./launch.sh clean install
(Linux または UNIX) スタンドアロンモードで起動します。
./launch.bat clean install
(Windows) スタンドアロンモードで起動します。
./launch.sh clean install -Pmysql
(Linux または UNIX ) MySQL データベースでアプリケーションを設定した場合に、スタンドアロンモードで起動します。
./launch.bat clean install -Pmysql
(Windows) MySQL データベースでアプリケーションを設定した場合に、スタンドアロンモードで起動します。
./launch.sh clean install -Ppostgres
(Linux または UNIX ) PostgreSQL データベースでアプリケーションを設定した場合に、スタンドアロンモードで起動します。
./launch.bat clean install -Ppostgres
(Windows) PostgreSQL データベースでアプリケーションを設定した場合に、スタンドアロンモードで起動します。
clean install
の引数で、Maven に、新規インストールをするように指示を出します。プロジェクトは、以下の順番に構築されます。- データモデル
- ビジネスアセット
サービス
スクリプトの初回実行時には、プロジェクトの依存関係がすべてダウンロードされるため、プロジェクトのビルドに時間がかかる場合があります。ビルドの最後に、アプリケーションが起動します。
以下のコマンドを入力して、ビジネスアプリケーションにアクセスします。
http://localhost:8090/
-
認証情報
user
/user
またはkieserver
/kieserver1!
を入力します。
7.2. 開発モードでのビジネスアプリケーションの実行
開発 (マネージド) モードでは、開発者は Red Hat Decision Manager ビジネスアプリケーションアセットのプロジェクトで作業し、再起動の必要なしに動的に変更をデプロイできます。さらに、開発モードでは、プロセスインスタンス、タスク、ジョブなど、ビジネス自動化機能が完全に監視されている環境が提供されます。
前提条件
- Spring Boot ビジネスアプリケーションがある。
- ビジネスアプリケーションを設定している。
- Business Central をインストールし、実行している。
手順
-
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-service
ディレクトリーに移動します。<BUSINESS-APPLICATION>
は Spring Boot プロジェクトの名前に置き換えます。 以下のコマンドの 1 つを実行します。
表7.2 管理起動オプション コマンド
説明
./launch-dev.sh clean install
(Linux または UNIX) 開発モードで起動します。
./launch-dev.bat clean install
(Windows) 開発モードで起動します。
./launch-dev.sh clean install -Pmysql
(Linux または UNIX ) MySQL データベースでアプリケーションを設定した場合に、開発モードで起動します。
./launch-dev.bat clean install -Pmysql
(Windows) MySQL データベースでアプリケーションを設定した場合に、開発モードで起動します。
./launch-dev.sh clean install -Ppostgres
(Linux または UNIX) postgreSQL データベースでアプリケーションを設定した場合に、開発モードで起動します。
./launch-dev.bat clean install -Ppostgres
(Windows) PostgreSQL データベースでアプリケーションを設定した場合に、開発モードで起動します。
clean install
の引数で、Maven に、新規インストールをするように指示を出します。プロジェクトは、以下の順番に構築されます。- データモデル
- ビジネスアセット
サービス
スクリプトの初回実行時には、プロジェクトの依存関係がすべてダウンロードされるため、プロジェクトのビルドに時間がかかる場合があります。ビルドの最後に、アプリケーションが起動します。
以下のコマンドを入力して、ビジネスアプリケーションにアクセスします。
http://localhost:8090/
-
認証情報
user
/user
またはkieserver
/kieserver1!
を入力します。ビジネスアプリケーションを起動した後に、Process Automation Manager コントローラーと接続すると、Business Central の Menu → Deploy → Execution Servers に表示されます。
第8章 Red Hat OpenShift Container Platform での SpringBoot ビジネスアプリケーションの実行
Red Hat OpenShift Container Platform で Red Hat Decision Manager SpringBoot ビジネスアプリケーションを実行するには、イミュータブルイメージを作成し、このイメージを Red Hat OpenShift Container Platform 環境にプッシュします。
前提条件
- Red Hat Decision Manager SpringBoot ビジネスアプリケーションを開発済みである。アプリケーションの作成方法は、「Maven archetype からの Spring Boot ビジネスアプリケーションの作成」 を参照してください。
- 必要に応じて、アプリケーションに Spring セキュリティーを設定している。Spring セキュリティーの設定方法は、4章Red Hat Decision Manager での Spring Security を参照してください。
- ビジネスアプリケーションに必要な追加の Spring 設定を完了している。ビジネスアプリケーションの Spring 設定に関する方法は、5章Red Hat Decision Manager Spring Boot の設定 を参照してください。
- ビジネスアプリケーションに、JAR ファイルを 1 つ作成している。SpringBoot ビジネスアプリケーションに単一の JAR ファイルを作成する方法は、6章自己完結型 Red Hat Decision Manager Spring Boot JAR ファイルの作成 を参照してください。
-
oc
コマンドを使用して Red Hat OpenShift Container Platform 環境にログインしており、必要なプロジェクトがアクティブである。
手順
ビジネスアプリケーションプロジェクトディレクトリー外部で、以下のサブディレクトリーを含めて
ocp-image
ディレクトリーを作成します。ocp-image |--/root |--/opt |-- /spring-service
ビジネスアプリケーションの単一の JAR ファイルを
root/opt/spring-service
サブディレクトリーにコピーします。以下に例を示します。cd ../business-application-service cp target/business-application-service-1.0-SNAPSHOT.jar ../ocp-image/root/opt/spring-service/
ocp-image
ディレクトリーで、以下の内容を含むDockerfile
ファイルを作成します。FROM registry.access.redhat.com/ubi8/openjdk-11:latest COPY root / EXPOSE 8090 WORKDIR /opt/spring-service/ CMD ["sh","-c", "java ${JAVA_OPTIONS} -Dorg.kie.server.mode=PRODUCTION -jar /opt/spring-service/<FILENAME>.jar"]
<FILENAME>.jar
は、ビジネスアプリケーションの単一の JAR ファイルの名前に置き換えます。初期イメージをビルドし、Red Hat OpenShift Container Platform 環境にデプロイするには、以下の手順を実行します。
イメージをビルドするには、
ocp-image
ディレクトリーで以下のコマンドを実行します。oc new-build --binary --strategy=docker --name openshift-kie-springboot oc start-build openshift-kie-springboot --from-dir=. --follow
オプション:
openshift-kie-springboot
は、これらのコマンドと後続の全コマンドのカスタムアプリケーションの名前に置き換えます。Red Hat OpenShift Container Platform 環境でイメージをデプロイするには、以下のコマンドを実行します。
oc new-app openshift-kie-springboot
オプション: イメージのルートを公開するには、以下のコマンドを実行します。
oc expose service/openshift-kie-springboot --port=8090
新しいバージョンの Red Hat Decision Manager または Spring Boot の JAR ファイルをビルドした場合など、すでにイメージをビルドし、更新する必要がある場合には、
ocp-image
ディレクトリーで以下のコマンドを実行します。oc start-build openshift-kie-springboot --from-dir=. --follow
第9章 Business Central へのビジネスアセットプロジェクトのインポートおよびデプロイ
Red Hat Decision Manager ビジネスアプリケーションの一部であるビジネスアセットプロジェクトを Business Central にインポートしてから、そのプロジェクトをビジネスアプリケーションにデプロイできます。
前提条件
- 開発モードで実行されているビジネスアプリケーションプロジェクトがある。
- Red Hat Decision Manager の Business Central がインストールされている。
手順
-
<BUSINESS-APPLICATION>/<BUSINESS-APPLICATION>-kjar
ディレクトリーに移動します。<BUSINESS-APPLICATION>
は Spring Boot プロジェクトの名前に置き換えます。 以下のコマンドを実行して、プロジェクトの Git リポジトリーを初期化します。
$ git init $ git add -A $ git commit -m "Initial project structure"
- Business Central にログインし、Menu → Design → Projects の順に移動します。
Import Project を選択して、以下の URL を入力します。
file:///<business-application-path>/<business-application-name>-kjar
- Import をクリックして、インポートするプロジェクトを確定します。
- ビジネスアセットプロジェクトを Business Central にインポートしてから、Add Assets をクリックして、ルールやデシジョンテーブルなどのアセットを使用しているビジネスアセットプロジェクトに追加します。
プロジェクトページで Deploy をクリックして、実行中のビジネスアプリケーションにプロジェクトをデプロイします。
注記Build & Install オプションを選択してプロジェクトをビルドし、KJAR ファイルを KIE Server にデプロイせずに設定済みの Maven リポジトリーに公開することもできます。開発環境では、Deploy をクリックすると、ビルドされた KJAR ファイルを KIE Server に、実行中のインスタンス (がある場合はそれ) を停止せずにデプロイできます。または Redeploy をクリックして、ビルドされた KJAR ファイルをデプロイしてすべてのインスタンスを置き換えることもできます。次回、ビルドされた KJAR ファイルをデプロイまたは再デプロイすると、以前のデプロイメントユニット (KIE コンテナー) が同じターゲット KIE Server で自動的に更新されます。実稼働環境では Redeploy オプションは無効になっており、Deploy をクリックして、ビルドされた KJAR ファイルを KIE Server 上の新規デプロイメントユニット (KIE コンテナー) にデプロイすることのみが可能です。
KIE Server の環境モードを設定するには、
org.kie.server.mode
システムプロパティーをorg.kie.server.mode=development
またはorg.kie.server.mode=production
に設定します。Business Central の対応するプロジェクトでのデプロイメント動作を設定するには、プロジェクトの Settings → General Settings → Version に移動し、Development Mode オプションを選択します。デフォルトでは、KIE Server および Business Central のすべての新規プロジェクトは開発モードになっています。Development Mode をオンにしたプロジェクトをデプロイしたり、実稼働モードになっている KIE Server に手動でSNAPSHOT
バージョンの接尾辞を追加したプロジェクトをデプロイしたりすることはできません。- プロジェクトのデプロイメントに関する詳細を確認するには、画面の上部にあるデプロイメントバナーの View deployment details か、Deploy のドロップダウンメニューをクリックします。このオプションを使用すると、Menu → Deploy → Execution Servers ページに移動します。
第10章 JMS メッセージブローカーで監査データの複製
KIE Server 監査データを Java Message Service (JMS) メッセージブローカー (ActiveMQ、Artemis など) に複製してから、外部データベーススキーマにデータをダンプし、アプリケーションスキーマから監査データを削除して Spring Boot アプリケーションのパフォーマンスを向上することができます。
メッセージブローカーのデータを複製するようにアプリケーションを設定すると、KIE Server でイベントが発生したときにそのイベントの記録は KIE Server データベーススキーマに保存され、メッセージブローカーに送信されます。その後、外部サービスを設定して、メッセージブローカーデータをアプリケーションのデータベーススキーマの正確なレプリカに使用できます。このデータは、イベントが KIE Server によって生成されるたびに、メッセージブローカーおよび外部データベースに追加されます。
監査データのみがメッセージブローカーに保存されます。他のデータはレプリケートされません。
前提条件
- 既存の Red Hat Decision Manager Spring Boot プロジェクトがある。
手順
-
テキストエディターで Spring Boot アプリケーションの
pom.xml
ファイルを開きます。 KIE Server Spring Boot 監査依存関係を
pom.xml
ファイルに追加します。<dependency> <groupId>org.kie</groupId> <artifactId>kie-server-spring-boot-autoconfiguration-audit-replication</artifactId> <version>${version.org.kie}</version> </dependency>
JMS クライアントの依存関係を追加します。以下の例では、Advanced Message Queuing Protocol (AMQP) 依存関係を追加します。
<dependency> <groupId>org.amqphub.spring</groupId> <artifactId>amqp-10-jms-spring-boot-starter</artifactId> <version>2.2.6</version> </dependency>
JMS プールの依存関係を追加します。
<dependency> <groupId>org.messaginghub</groupId> <artifactId>pooled-jms</artifactId> </dependency>
KIE Server 監査レプリケーションがキューを使用するように設定するには、以下のタスクを完了します。
以下の行を、Spring Boot アプリケーションの
application.properties
ファイルに追加します。kieserver.audit-replication.producer=true kieserver.audit-replication.queue=audit-queue
メッセージブローカークライアントに必要なプロパティーを追加します。以下の例は、AMPQ に KIE Server を設定する方法を示しています。ここで、
<JMS_HOST_PORT>
はブローカーがリッスンするポートで、<USERNAME>
および<PASSWORD
はブローカーのログイン認証情報になります。amqphub.amqp10jms.remote-url=amqp://<JMS_HOST_PORT> amqphub.amqp10jms.username=<USERNAME> amqphub.amqp10jms.password=<PASSWORD> amqphub.amqp10jms.pool.enabled=true
以下の行を、メッセージブローカーデータを使用するサービスの
application.properties
ファイルに追加します。kieserver.audit-replication.consumer=true kieserver.audit-replication.queue=audit-queue
メッセージブローカークライアントに必要なプロパティーを、メッセージブローカーデータを使用するサービスの
application.properties
ファイルに追加します。以下の例は、AMPQ に KIE Server を設定する方法を示しています。ここで、<JMS_HOST_PORT>
はメッセージブローカーがリッスンするポートで、<USERNAME>
および<PASSWORD>
はメッセージブローカーのログイン認証情報になります。amqphub.amqp10jms.remote-url=amqp://<JMS_HOST_PORT> amqphub.amqp10jms.username=<USERNAME> amqphub.amqp10jms.password=<PASSWORD> amqphub.amqp10jms.pool.enabled=true
KIE Server 監査レプリケーションがトピックを使用するように設定するには、以下のタスクを実行します。
以下の行を、Spring Boot アプリケーションの
application.properties
ファイルに追加します。kieserver.audit-replication.producer=true kieserver.audit-replication.topic=audit-topic
メッセージブローカークライアントに必要なプロパティーを、メッセージブローカーデータを使用するサービスの
application.properties
ファイルに追加します。以下の例は、AMPQ に KIE Server を設定する方法を示しています。ここで、<JMS_HOST_PORT>
はメッセージブローカーがリッスンするポートで、<USERNAME>
および<PASSWORD
はメッセージブローカーのログイン認証情報になります。spring.jms.pub-sub-domain=true amqphub.amqp10jms.remote-url=amqp://<JMS_HOST_PORT> amqphub.amqp10jms.username=<USERNAME> amqphub.amqp10jms.password=<PASSWORD> amqphub.amqp10jms.pool.enabled=true
以下の行を、メッセージブローカーデータを使用するサービスの
application.properties
ファイルに追加します。kieserver.audit-replication.consumer=true kieserver.audit-replication.topic=audit-topic::jbpm kieserver.audit-replication.topic.subscriber=jbpm spring.jms.pub-sub-domain=true
メッセージブローカークライアントに必要なプロパティーを、メッセージブローカーデータを使用するサービスの
application.properties
ファイルに追加します。以下の例は、AMPQ に KIE Server を設定する方法を示しています。ここで、<JMS_HOST_PORT>
はメッセージブローカーがリッスンするポートで、<USERNAME>
および<PASSWORD>
はメッセージブローカーのログイン認証情報になります。amqphub.amqp10jms.remote-url=amqp://<JMS_HOST_PORT> amqphub.amqp10jms.username=<USERNAME> amqphub.amqp10jms.password=<PASSWORD> amqphub.amqp10jms.pool.enabled=true amqphub.amqp10jms.clientId=jbpm
オプション: レプリケートされたデータが含まれる KIE Server を読み取り専用に設定するには、
application.properties
ファイルのorg.kie.server.rest.mode.readonly
プロパティーをtrue
に設定します。org.kie.server.rest.mode.readonly=true
10.1. Spring Boot JMS 監査レプリケーションパラメーター
以下の表は、Spring Boot で Red Hat Decision Manager アプリケーションの JMS 監査レプリケーションを設定するために使用するパラメーターを説明しています。
パラメーター | 値 | 説明 |
---|---|---|
|
| ビジネスアプリケーションが、JMS メッセージを複製してキューまたはトピックのいずれかに送信するプロデューサーとして動作するかどうかを指定します。 |
|
| ビジネスアプリケーションが、キューまたはトピックのいずれかから JMS メッセージを受信するコンシューマーとして動作するかどうかを指定します。 |
|
| メッセージを送信または消費する JMS キューの名前。 |
|
| メッセージを送信または消費する JMS トピックの名前。 |
|
| トピックサブスクライバーの名前。 |
|
| ビジネスアプリケーションの読み取り専用モードを指定します。 |
パート II. Red Hat Decision Manager と Red Hat Fuse の統合
システム管理者は、Red Hat JBoss Enterprise Application Platform で、Red Hat Decision Manager と Red Hat Fuse を統合して、統合サービス間の通信を容易化します。
第11章 Red Hat Fuse および Red Hat Decision Manager
Red Hat Fuse は、アジャイル統合ソリューションの一部である、分散型のクラウドネイティブ統合プラットフォームです。チームはこの分散アプローチを使用することで、必要に応じて統合サービスをデプロイできます。Fuse には、統合エキスパート、アプリケーション開発者、ビジネスユーザーなど、さまざまなユーザーに柔軟にサービスを提供でき、各自がデプロイメント、アーキテクチャー、ツールを選択できます。API 中心のコンテナーベースのアーキテクチャーは、各サービスを切り離して、個別に作成、デプロイメント、デプロイできるようにします。その結果、企業全体のコラボレーションをサポートする統合ソリューションが実現できます。
Red Hat Decision Manager は、ビジネスルール管理、複合イベント処理、Decision Model & Notation (DMN) 実行、およびプランニングの問題を解決するための Red Hat build of OptaPlanner を組み合わせた、オープンソースの意思決定管理プラットフォームです。これにより、ビジネス上の意思決定を自動化し、そのロジックをビジネス全体で利用できるようにします。
ルール、デシジョンテーブル、DMN モデルなどのビジネスアセットはプロジェクト内で組織化され、Business Central リポジトリーに保存されます。これにより、ビジネス全体で一貫性や透明性を維持し、監査を行えます。ビジネスユーザーは、IT 担当者からのサポートなしでビジネスロジックを編集できます。
Apache Karaf コンテナープラットフォームに Red Hat Fuse をインストールしてから、このコンテナーに Red Hat Process Automation Manager をインストールし、設定してください。
Red Hat JBoss Enterprise Application Platform の別のインスタンスに Red Hat Fuse をインストールし、Red Hat Process Automation Manager と統合することもできます。kie-camel
モジュールは、Red Hat Fuse と Red Hat Process Automation Manager との間の統合を提供します。
Red Hat Decision Manager 7.13 がサポートする Red Hat Fuse のバージョンについては、Red Hat Decision Manager 7 でサポートされる設定 を参照してください。
Red Hat Fuse on Spring Boot をインストールできます。Red Hat Decision Manager では、このシナリオ向けの特別な統合はありません。
Red Hat Fuse on Spring Boot で実行しているアプリケーションの kie-server-client
ライブラリーを使用して、KIE Server で実行している Red Hat Decision Manager サービスと通信できるようにします。
kie-server-client
ライブラリーの使用に関する詳細は、KIE API を使った Red Hat Decision Manager の操作 を参照してください。
第12章 Apache Karaf 上に Fuse を統合した Red Hat Decision Manager のデシジョンエンジン
Apache Karaf は、スタンドアロンで、オープンソースのランタイム環境です。OSGi Alliance の OSGi 標準に基づいています。Karaf は、高度なクラスローディングサポートを備えた OSGi バンドルを通じてモジュール化のサポートを提供します。Karaf コンテナーでは、依存関係の複数のバージョンを並行してデプロイできます。ホットコードスワップを使用すると、コンテナーをシャットダウンせずにモジュールをアップグレードまたは置き換えることができます。
Red Hat Decision Manager は、Karaf 機能を使用して、Karaf で FUSE と統合されます。これらの機能を使用して、Karaf 上の FUSE 向けに Red Hat Decision Manager の個別のコンポーネントをインストールできます。
機能ファイルは XML ファイルで、このファイルを使用して特定の機能向けにどの OSGI バンドルをインストールするかを指定します。以下の機能 XML ファイルにより、Red Hat Decision Manager と Fuse on Karaf の統合を容易にします。
rhba-features-<FUSE-VERSION>-features.xml
このファイルは、Karaf にインストールした Fuse に含まれており、
<FUSE-VERSION>
は Fuse のバージョンに置き換えます。このファイルは、system/org/jboss/fuse/features/rhba-features
ディレクトリーの Karaf システムリポジトリーに保存されます。このファイルには、Red Hat Decision Manager 機能をインストールするための前提条件が含まれています。kie-karaf-features-7.67.0.Final-redhat-00024-features-fuse.xml
このファイルは Red Hat Decision Manager に含まれており、Red Hat Decision Manager 機能を提供します。この機能により、Red Hat Fuse にデプロイできる OSGi 機能が決まります。OSGi ユーザーは、このファイルから機能をインストールして、Red Hat Decision Manager を Fuse にインストールし、それぞれのアプリケーションで使用できます。この機能ファイルは、Red Hat Decision Manager で配布されるオンラインおよびオフラインの Maven リポジトリーに配置されています。このファイルのグループ ID、アーティファクト ID、およびバージョン (GAV) 識別子は、
org.kie:kie-karaf-features:7.67.0.Final-redhat-00024
です。
12.1. Karaf 上の古くなった Red Hat Decision Manager 機能 XML ファイルの削除
お使いの環境に、以前の Red Hat Decision Manager 機能 XML ファイル (例: kie-karaf-features-<VERSION>-features.xml
) が含まれている場合には、このファイルと関連するファイルすべてを削除してから、最新の機能 XML ファイルをインストールする必要があります。
前提条件
- 以前の機能 XML ファイルが Apache Karaf の環境に存在する。
手順
以下のコマンドを実行して、使用環境に以前の Red Hat Decision Manager 機能 XML ファイルが含まれているかどうかを確認します。
$ JBossFuse:karaf@root> feature:repo-list $ JBossFuse:karaf@root> feature:list
以下のコマンドを入力します。
<FUSE_HOME>
は Fuse のインストールディレクトリーに置き換えて、Red Hat Fuse コンソールを起動します。$ ./<FUSE_HOME>/bin/fuse
以下のコマンドを入力します。
<FEATURE_NAME>
は、アンインストールする機能の名前に置き換えて、以前の機能 XML ファイルを使用するアプリケーションまたは機能をアンインストールします。JBossFuse:karaf@root> features:uninstall <FEATURE_NAME>
以下の例では、機能の削除方法を紹介します。
JBossFuse:karaf@root> features:uninstall drools-module JBossFuse:karaf@root> features:uninstall jbpm JBossFuse:karaf@root> features:uninstall kie-ci
Karaf の home で、
drools
、kie
、またはjbpm
を使用するバンドルへの参照を検索します。以下の例では、grep
を使用してこれらのコンポーネントを検索する方法を示しています。karaf@root> list -t 0 -s | grep drools karaf@root> list -t 0 -s | grep kie karaf@root> list -t 0 -s | grep jbpm
この例は、上記のコマンドからの出力です。
250 │ Active │ 80 │ 7.19.0.201902201522 │ org.drools.canonical-model 251 │ Active │ 80 │ 7.19.0.201902201522 │ org.drools.cdi 252 │ Active │ 80 │ 7.19.0.201902201522 │ org.drools.compiler
以下のコマンドを入力します。
BUNDLE_ID
は、検索で返されたバンドル ID に置き換えて、以前の手順で検出されたバンドルを削除します。karaf@root> osgi:uninstall BUNDLE_ID
次のコマンドを入力して、古くなった
drools-karaf-features
の URL を削除します。karaf@root> features:removeurl mvn:org.kie/kie-karaf-features/VERSION.Final-redhat-VERSION/xml/features
- Fuse を再起動します。
12.2. XML ファイルを使用した Karaf への Red Hat Decision Manager 機能のインストール
Karaf に Red Hat Decision Manager 機能をインストールして、Red Hat Decision Manager プロセス向けに動的ランタイム環境を作成できます。
前提条件
- Apache Karaf コンテナーで Red Hat Fuse が利用できるようになっている。Apache Karaf への Fuse のインストール手順は、Apache Karaf コンテナーへの Red Hat Fuse のインストール を参照してください。
- 「Karaf 上の古くなった Red Hat Decision Manager 機能 XML ファイルの削除」 に記載されているように、以前の Red Hat Decision Manager 機能 XML ファイルが削除されている。
手順
Red Hat Decision Manager の機能をインストールするには、次のコマンドを入力します。
$ JBossFuse:karaf@root> feature:install <FEATURE_NAME>
org.drools.osgi.spring.OsgiKModuleBeanFactoryPostProcessor
の代わりに org.kie.spring.KModuleBeanFactoryPostProcessor
を使用して、OSGi 環境の KIE 要素を後処理します。
kie-spring
機能をインストールする前に drools-module
機能をインストールしないようにしてください。先にインストールしてしまうと、drools-compiler
バンドルにより、kie-spring
がエクスポートしたパッケージが検出されなくなります。
これらの機能を間違った順番でインストールした場合は、osgi:refresh drools-compiler_bundle_ID
を実行して、drools-compiler
が強制的に Import-Package
メタデータをリビルドするようにします。
このコマンドでは、<FEATURE_NAME>
は、「Red Hat Decision Manager の Karaf 機能」 に記載の機能の 1 つに置き換えます。
12.3. Maven を使用した Karaf への Red Hat Decision Manager 機能のインストール
必要に応じて、Apache Karaf 上にある Fuse で Red Hat Decision Manager をインストールして、統合サービスをデプロイします。
前提条件
- Apache Karaf インストールに Red Hat Fuse 7.12 が存在する。インストール手順は、Apache Karaf コンテナーへの Red Hat Fuse のインストールを参照してください。
- 「Karaf 上の古くなった Red Hat Decision Manager 機能 XML ファイルの削除」 の説明のように、以前の機能 XML ファイルが削除されている。
手順
-
Maven リポジトリーを設定するには、テキストエディターで
FUSE_HOME/etc/org.ops4j.pax.url.mvn.cfg
ファイルを開きます。 https://maven.repository.redhat.com/ga/
リポジトリーがorg.ops4j.pax.url.mvn.repositories
変数に存在することを確認します。必要に応じて、追加してください。注記org.ops4j.pax.url.mvn.repositories
変数内のエントリーをコンマ、スペース、およびバックスラッシュ (, \
) で区切ります。バックスラッシュを追加すると、強制的に改行されます。Fuse を起動するには以下のコマンドを入力します。
<FUSE_HOME>
は Fuse のインストールディレクトリーに置き換えます。$ ./FUSE_HOME/bin/fuse
インストールの前提条件が含まれる機能ファイルに参照を追加するには、以下のコマンドを入力します。
<FUSE_VERSION
は、インストールする Fuse のバージョンに置き換えます。$ feature:repo-add mvn:org.jboss.fuse.features/rhba-features/<FUSE-VERSION>/xml/features
以下のコマンドを入力して、Red Hat Decision Manager 機能の XML ファイルへの参照を追加します。
$ JBossFuse:karaf@root> features:addurl mvn:org.kie/kie-karaf-features/VERSION/xml/features-fuse
現在の
drools-karaf-features
バージョンを確認するには、Red Hat Decision Manager 7 Supported Configurations ページを参照してください。以下のコマンドを入力して、Red Hat Decision Manager 機能の XML ファイルで提供される機能をインストールします。このコマンドでは、
<FEATURE_NAME>
は、「Red Hat Decision Manager の Karaf 機能」 に記載の機能の 1 つに置き換えます。JBossFuse:karaf@root> features:install <FEATURE_NAME>
次のコマンドを入力して、インストールを確認します。
$ JBossFuse:karaf@root>feature:list
機能が正常にインストールされると、ステータスは
started
になります。
12.4. Red Hat Decision Manager の Karaf 機能
以下の表では、Red Hat Decision Manager の Karaf 機能を紹介します。
機能 | 説明 |
---|---|
| Drools のコアとコンパイラーが含まれており、プレーン DRL から KIE ベースと KIE セッションを作成するのに使用します。また、実行可能モデルの実装も含まれています。永続性、プロセス、またはデシジョンテーブルを必要とせずに Drools を使用してルール評価ができます。 |
| Drools テンプレートが含まれています。 |
|
プロセスまたはデシジョンテーブルを必要とせずに、Drools を使用して永続性 (Persistence) とトランザクション (Transaction) でルール評価を行います。 |
| デシジョンテーブルと合わせて、Drools を使用します。 |
コアエンジン JAR および |
Red Hat Decision Manager と KIE スキャナー ( |
|
Fuse と Red Hat Decision Manager を統合する Apache Camel エンドポイントである |
|
|
第13章 Red Hat JBoss Enterprise Application Platform への Fuse のインストール
Red Hat JBoss EAP 7.4 に Red Hat Fuse 7.12 をインストールして、Red Hat Decision Manager と統合します。
前提条件
- Red Hat JBoss Enterprise Application Platform 7.4 に Red Hat Decision Manager がインストールされている。インストールの説明は、Red Hat JBoss EAP 7.4 への Red Hat Decision Manager のインストールおよび設定 を参照してください。
- Red Hat JBoss Enterprise Application Platform 7.4 の別のインスタンスを利用できる。
手順
- Red Hat JBoss Enterprise Application Platform 7.4 に Red Hat Fuse 7.12 をインストールします。インストールの説明は、Red Hat Fuse ドキュメントの JBoss EAP のインストール セクション参照してください。
-
テキストエディターで、Fuse のホームディレクトリーにある
pom.xml
を開きます。 以下の例のように
pom.xml
ファイルを編集して、kie-camel
コンポーネントの依存関係を含めて、統合プロジェクトを作成します。<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-core</artifactId> <scope>provided</scope> </dependency> <dependency> <groupId>org.kie</groupId> <artifactId>kie-api</artifactId> </dependency> <dependency> <groupId>org.kie</groupId> <artifactId>kie-ci</artifactId> <exclusions> <exclusion> <groupId>aopalliance</groupId> <artifactId>aopalliance</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.kie.server</groupId> <artifactId>kie-server-api</artifactId> <exclusions> <exclusion> <groupId>org.jboss.spec.javax.xml.bind</groupId> <artifactId>jboss-jaxb-api_2.3_spec</artifactId> </exclusion> <exclusion> <groupId>javax.activation</groupId> <artifactId>activation</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.jbpm</groupId> <artifactId>jbpm-bpmn2</artifactId> </dependency> <dependency> <groupId>org.kie</groupId> <artifactId>kie-camel</artifactId> <exclusions> <exclusion> <groupId>org.apache.cxf</groupId> <artifactId>cxf-core</artifactId> </exclusion> <exclusion> <groupId>org.apache.camel</groupId> <artifactId>camel-cxf</artifactId> </exclusion> <exclusion> <groupId>org.apache.camel</groupId> <artifactId>camel-cxf-transport</artifactId> </exclusion> <exclusion> <groupId>com.thoughtworks.xstream</groupId> <artifactId>xstream</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.kie.server</groupId> <artifactId>kie-server-client</artifactId> <exclusions> <exclusion> <groupId>org.jboss.spec.javax.ws.rs</groupId> <artifactId>jboss-jaxrs-api_2.0_spec</artifactId> </exclusion> </exclusions> </dependency>
第14章 kie-camel
コンポーネント
kie-camel
コンポーネントは、Fuse と Red Hat Decision Manager が統合された Red Hat Fuse が提供する Apache Camel エンドポイントです。このコンポーネントを使用して、ルートにするプルして実行できる Maven グループ ID、アーティファクト ID、バージョン (GAV) の識別子を使用して、Red Hat Decision Manager モジュールを指定できます。また、ファクトとしてメッセージボディーの一部を指定することもできます。埋め込みエンジンまたは KIE Server で、kie-camel
コンポーネントを使用できます。
埋め込みエンジン
このシナリオでは、KIE エンジンが Fuse 統合プロジェクトと同じコンテナーで実行されます。エンジン間の通信には、KIE コマンドを使用できます。Camel プロデューサーを作成するには、以下の URI を使用します。
kie-local:kie-session-name?action=execute
たとえば、次のコマンドを入力して、Spring の Camel ルートを初期化します。
<from uri="direct:runCommand" /> <to uri="kie-local:kie-session1?action=execute"/>
KIE Server
このシナリオでは、kie-camel
コンポーネントは KIE Server REST API を使用して KIE Server に接続します。こうすることでユーザーは、KIE Server API を使用して KIE Server と通信できます。プロデューサーを作成するには、以下の URI を使用します。
kie:http://username:password@kie-server-url`
たとえば、次のコマンドを入力して、Spring の Camel ルートを初期化します。
<from uri="direct:runCommand" /> <to uri="kie:http://user:psswd@localhost:8080/kie-server-services/services/rest/server"/>
メッセージには以下のヘッダーが含まれます。
ヘッダー | 説明 |
---|---|
| KIE Server クライアント (必須) |
| KIE Server クライアント (必須) |
| クライアントメソッドパラメーターの値 (任意) |
| メッセージボディーを保存するメソッドパラメーター (任意) |
パート III. Red Hat Decision Manager と Red Hat Single Sign-On の統合
システム管理者は、Red Hat シングルサインオンを Red Hat Decision Manager に統合し、単一の認証メソッドを使用することで Red Hat Decision Manager ブラウザーアプリケーションを保護できます。
前提条件
- Red Hat JBoss EAP 7.4 に Red Hat Decision Manager がインストールされている。詳細は、Red Hat JBoss EAP 7.4 への Red Hat Decision Manager のインストールおよび設定 を参照してください。
第15章 統合オプション
Red Hat シングルサインオン (RH-SSO) は、ブラウザーアプリケーションと REST Web サービス、および Git へのアクセスのセキュリティーを確保するために使用できるシングルサインオンソリューションです。
Red Hat Decision Manager と RH-SSO を統合する際に、Red Hat Decision Manager 向けに SSO と IDM (アイデンティティ管理) を作成します。RH-SSO のセッション管理機能により、一度認証するだけで、Web 上でさまざまな Red Hat Decision Manager 環境を使用できます。
以下の章では、Red Hat Decision Manager と RH-SSO を統合する方法を説明します。
18章RH-SSO を使用した Business Central の認証
RH-SSO サーバーを使用して Red Hat Decision Manager を認証するには、Red Hat Decision Manager Web クライアント (Business Central) とリモートサービスの両方を RH-SSO で保護する必要があります。この統合により、Business Central またはリモートサービスコンシューマーのいずれかから RH-SSO を介して Red Hat Decision Manager に接続できます。
19章RH-SSO を使用した KIE Server の認証
RH-SSO サーバーを使用して KIE Server を認証するには、KIE Server が提供するリモートサービスのセキュリティーを確保する必要があります。これを行うことで、リモートの Red Hat Decision Manager サービスコンシューマー (ユーザーまたはサービス) を有効にし、RH-SSO を経由して認証します。KIE Server には Web インターフェイスがありません。
20章RH-SSO を使用したサードパーティークライアントの認証
Business Central または KIE Server が RH-SSO を使用している場合、サードパーティークライアントは RH-SSO を使用して自己認証する必要があります。認証後は、Business Central および KIE Server が提供するリモートサービスのエンドポイント (REST API、リモートファイルシステムサービスなど) を使用できます。
Red Hat Decision Manager との LDAP 統合を容易にするには、LDAP での RH-SSO を使用することを検討してください。詳細は、Red Hat Single Sign-On Server 管理ガイド の「LDAP および Active Directory」セクションを参照してください。
第16章 RH-SSO のインストールおよび設定
レルムは、Web またはアプリケーションサーバーに定義するセキュリティーポリシードメインです。セキュリティーレルムは、異なるアプリケーションリソースのアクセスを制限するのに使用します。RH-SSO インスタンスが非公開か他の製品と共有されているかにかかわらず、新規レルムを作成する必要があります。マスターレルムを、スーパー管理者がシステムのレルムを作成して管理する場所として維持できます。他の製品システムと共有している RH-SSO インスタンスと統合して、これらのアプリケーションでシングルサインオンを行うためには、これらのアプリケーションですべて同じレルムが使用される必要があります。RH-SSO レルムを作成するには、RH-SSO 7.5 をダウンロード、インストール、および設定します。
Business Central および KIE Server が異なるサーバーにインストールされている場合は、両サーバーでこの手順を行ってください。
手順
Red Hat カスタマーポータルの Software Downloads ページに移動し (ログインが必要)、ドロップダウンオプションから製品およびバージョンを選択します。
- 製品: Red Hat Single Sign-On
- バージョン: 7.5
-
Red Hat Single Sign-On 7.5.0 Server (
rh-sso-7.5.0.zip
) と最新のサーバーパッチをダウンロードします。 基本的な RH-SSO スタンドアロンサーバーをインストールして設定するには、Red Hat Single Sign On Getting Started Guide の手順に従います。実稼働環境の高度な設定は、Red Hat Single Sign On Server Administration Guide を参照してください。
注記同じシステムで RH-SSO と Red Hat Decision Manager サーバーの両方を実行する場合には、以下のアクションのいずれかによりポートの競合を避けてください。
RHSSO_HOME/standalone/configuration/standalone-full.xml
ファイルを更新して、ポートのオフセットを 100 に設定してください。以下に例を示します。<socket-binding-group name="standard-sockets" default-interface="public" port-offset="${jboss.socket.binding.port-offset:100}">
環境変数を使用して、サーバーの実行時にポートオフセットを設定します。
bin/standalone.sh -Djboss.socket.binding.port-offset=100
第17章 Red Hat Decision Manager ロールおよびユーザー
Business Central または KIE Server にアクセスするには、サーバーを起動する前にユーザーを作成して適切なロールを割り当てます。Business Central または KIE Server のインストール時に、ユーザーとロールを作成できます。
Business Central と KIE Server の両方が単一のインスタンスで動作している場合、Business Central で認証されたユーザーは KIE Server にもアクセスできます。
ただし、Business Central と KIE Server が別のインスタンスで動作している場合、Business Central で認証されたユーザーが KIE Server にアクセスするには、別途認証が必要です。たとえば、Business Central で認証されているものの、KIE Server で認証されていないユーザーが Business Central でプロセス定義を表示または管理しようとすると、401 エラーがログファイルに記録され、Invalid credentials to load data from remote server.Contact your system administrator.
メッセージが Business Central に表示されます。
このセクションでは、Red Hat Decision Manager のユーザーロールを説明します。
admin
、analyst
、および rest-all
のロールは Business Central 用に予約されています。kie-server
ロールは KIE Server 用に予約されています。このため、Business Central または KIE Server のいずれか、それら両方がインストールされているかどうかによって、利用可能なロールは異なります。
-
admin
:admin
ロールを持つユーザーは Business Central 管理者です。管理者は、ユーザーの管理や、リポジトリーの作成、クローン作成、および管理ができます。アプリケーションで必要な変更をすべて利用できます。admin
ロールを持つユーザーは、Red Hat Decision Manager の全領域にアクセスできます。 -
analyst
:analyst
ロールを持つユーザーには、すべてのハイレベル機能へのアクセスがあります。プロジェクトのモデル化が可能です。ただし、このユーザーは、Design → Projects ビューでスペースに貢献者を追加したり、スペースを削除したりできません。analyst
ロールを持つユーザーは、管理者向けの Deploy → Execution Servers ビューにアクセスできません。ただし、これらのユーザーは、ライブラリーパースペクティブにアクセスするときに Deploy ボタンを使用できます。 -
rest-all
:rest-all
ロールを持つユーザーは、Business Central REST 機能にアクセスできます。 -
kie-server
:kie-server
ロールを持つユーザーは、KIE Server REST 機能にアクセスできます。
17.1. Red Hat Decision Manager ユーザーの追加
Business Central または KIE Server の認証に RH-SSO を使用する前に、作成したレルムにユーザーを追加する必要があります。新しいユーザーを追加して、Red Hat Decision Manager にアクセスするためのロールを追加するには、以下の手順を行います。
- RH-SSO 管理コンソールにログインして、ユーザーを追加するレルムを開きます。
Manage セクションで Users メニューアイテムをクリックします。
Users ページに空のユーザーリストが表示されます。
空のユーザーリストで Add User ボタンをクリックして、新規ユーザーの作成を開始します。
Add User ページが開きます。
- Add User ページで、ユーザー情報を入力して Save をクリックします。
- Credentials タブをクリックして、パスワードを作成します。
Red Hat Decision Manager へのアクセスを許可するロールの新規ユーザーを割り当てます。たとえば、Business Central にアクセスするには
admin
ロールを割り当てるか、KIE Server にアクセスするにはkie-server
ロールを割り当てます。注記Business Central から OpenShift にデプロイするプロジェクトの場合は、ロールを割り当てずに
mavenuser
という RH-SSO ユーザーを作成し、OpenShift テンプレートのBUSINESS_CENTRAL_MAVEN_USERNAME
およびBUSINESS_CENTRAL_MAVEN_PASSWORD
にこのユーザーを追加します。Roles セクションの Realm Roles タブで、このロールをレルムロールとして定義します。
Business Central で使用するロールの場合は、ロールを
kie
クライアントのクライアントロールとして定義できます。kie
クライアントの設定手順は、「RH-SSO への Business Central クライアントの作成」 を参照してください。クライアントロールを使用するには、「Business Central への RH-SSO クライアントアダプターのインストール」 の説明に従って、Business Central の追加設定も設定する必要があります。レルムロールとして KIE Server で使用するロールを定義する必要があります。
- Users ページの Role Mappings タブをクリックして、ロールを割り当てます。
第18章 RH-SSO を使用した Business Central の認証
この章では、RH-SSO を介して Business Central を認証する方法を説明します。この章には以下のセクションが含まれます。
前提条件
- Red Hat JBoss EAP 7.4 への Red Hat Decision Manager のインストールおよび設定 の記載通りに、Business Central が Red Hat JBoss EAP 7.4 サーバーにインストールされている。
- 16章RH-SSO のインストールおよび設定 の記載通りに、RH-SSO がインストールされている。
- 「Red Hat Decision Manager ユーザーの追加」 の記載通りに、Business Central ユーザーが RH-SSO に追加されている。
- オプション: Business Central から RH-SSO ユーザーを管理する場合には RH-SSO の全 realm-management クライアントロールが Business Central の管理者ユーザーに追加されている。
このセクションは、「RH-SSO への Business Central クライアントの作成」 を除き、スタンドアロンのインストールが対象です。Red Hat OpenShift Container Platform で RH-SSO と Red Hat Decision Manager を統合する場合には、「RH-SSO への Business Central クライアントの作成」 の手順のみを実行して、Red Hat OpenShift Container Platform に Red Hat Decision Manager 環境をデプロイしてください。Red Hat OpenShift Container Platform に Red Hat Decision Manager をデプロイする手順は、Red Hat OpenShift Container Platform への Red Hat Decision Manager のデプロイメント を参照してください。
18.1. RH-SSO への Business Central クライアントの作成
RH-SSO サーバーの起動後、RH-SSO 管理コンソールを使用して RH-SSO 向けに Business Central クライアントを作成します。
手順
Web ブラウザーに
http://localhost:8180/auth/admin
と入力して、RH-SSO 管理コンソールを開き、RH-SSO のインストール時に作成した管理者の認証情報を使用してログインします。注記Red Hat OpenShift Container Platform で RH-SSO を設定している場合は、RH-SSO ルートに公開されている URL を入力します。OpenShift 管理者は、必要に応じてこの URL を提供してください。
初回のログイン時に、新規ユーザー登録フォームで初期ユーザーを設定できます。
- RH-SSO 管理コンソールで、Realm Settings メニューアイテムをクリックします。
Realm Settings ページで Add Realm をクリックします。
Add realm ページが表示されます。
- Add realm ページで、レルムの名前を指定して Create をクリックします。
Clients メニューアイテムをクリックし、Create をクリックします。
Add Client ページが表示されます。
Add Client ページで、レルムにクライアントを新規作成するのに必要な情報を指定します。以下に例を示します。
- Client ID: kie
- Client protocol: openid-connect
Root URL:
http://localhost:8080/business-central
注記Red Hat OpenShift Container Platform で RH-SSO を設定している場合は、KIE Server ルートに公開されている URL を入力します。OpenShift 管理者は、必要に応じてこの URL を提供してください。
Save をクリックして変更を保存します。
作成した新規クライアントの Access Type は、デフォルトでは
public
に設定されています。この設定をconfidential
に変更します。これで、Business Central アプリケーションのクライアントが含まれるレルムに RH-SSO サーバーが設定され、
localhost:8180
で HTTP 接続をリッスンした状態で実行しています。このレルムは、Business Central アプリケーションに異なるユーザー、ロール、セッションを提供します。注記RH-SSO サーバークライアントは単一の business-central デプロイメントに対して URL を 1 つ使用します。配置設定が 2 つ以上ある場合、以下のようなエラーメッセージが表示されることがあります。
ご迷惑をおかけしております…
無効なパラメーター: redirect_uri
このエラーを解決するには、クライアント設定の Valid Redirect URIs フィールドに
/*
を追加します。Configure ページで、Clients > kie > Settings と進み、Valid Redirect URIs フィールドに、たとえば、
/*
を追加してください。http://localhost:8080/business-central/*
18.2. Business Central への RH-SSO クライアントアダプターのインストール
RH-SSO をインストールしたら、Red Hat JBoss EAP に RH-SSO クライアントアダプターをインストールして、Business Central に対して設定する必要があります。
前提条件
- Red Hat JBoss EAP 7.4 への Red Hat Decision Manager のインストールおよび設定 の記載通りに、Business Central が Red Hat JBoss EAP 7.4 インスタンスにインストールされている。
- 16章RH-SSO のインストールおよび設定 の記載通りに、RH-SSO がインストールされている。
-
「Red Hat Decision Manager ユーザーの追加」 の記載通りに、
admin
ロールが割り当てられたユーザーが RH-SSO に追加されている。
手順
Red Hat カスタマーポータルの Software Downloads ページに移動し (ログインが必要)、ドロップダウンオプションから製品およびバージョンを選択します。
- 製品: Red Hat Single Sign-On
- バージョン: 7.5
- Patches タブを選択します。
-
Red Hat Single Sign-On 7.5 Client Adapter for EAP 7 (
rh-sso-7.5.0-eap7-adapter.zip
または最新のバージョン) をダウンロードします。 adapter zip をデプロイメントしてインストールします。インストール手順は、Red Hat Single Sign On アプリケーションおよびサービスの保護ガイド の「JBoss EAP アダプター」セクションを参照してください。
注記-Dserver.config=standalone-full.xml
プロパティーでアダプターをインストールします。-
Red Hat JBoss EAP インストールの
EAP_HOME/standalone/configuration
ディレクトリーに移動し、テキストエディターでstandalone-full.xml
ファイルを開きます。 以下の例に表示されているシステムプロパティーを
<system-properties>
に追加します。<system-properties> <property name="org.jbpm.workbench.kie_server.keycloak" value="true"/> <property name="org.uberfire.ext.security.management.api.userManagementServices" value="KCAdapterUserManagementService"/> <property name="org.uberfire.ext.security.management.keycloak.authServer" value="http://localhost:8180/auth"/> </system-properties>
オプション: クライアントロールを使用する場合は、以下のシステムプロパティーを追加します。
<property name="org.uberfire.ext.security.management.keycloak.use-resource-role-mappings" value="true"/>
デフォルトでは、クライアントのリソース名は
kie
です。クライアントリソース名は、RH-SSO でクライアントの設定に使用したクライアント名と同じである必要があります。カスタムのクライアントリソースを使用する場合は、以下のシステムプロパティーも追加します。<property name="org.uberfire.ext.security.management.keycloak.resource" value="customClient"/>
customClient
はクライアントリソース名に置き換えます。RH-SSO サブシステム設定を追加します。以下に例を示します。
<subsystem xmlns="urn:jboss:domain:keycloak:1.1"> <secure-deployment name="business-central.war"> <realm>demo</realm> <realm-public-key>MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCrVrCuTtArbgaZzL1hvh0xtL5mc7o0NqPVnYXkLvgcwiC3BjLGw1tGEGoJaXDuSaRllobm53JBhjx33UNv+5z/UMG4kytBWxheNVKnL6GgqlNabMaFfPLPCF8kAgKnsi79NMo+n6KnSY8YeUmec/p2vjO2NjsSAVcWEQMVhJ31LwIDAQAB</realm-public-key> <auth-server-url>http://localhost:8180/auth</auth-server-url> <ssl-required>external</ssl-required> <enable-basic-auth>true</enable-basic-auth> <resource>kie</resource> <credential name="secret">759514d0-dbb1-46ba-b7e7-ff76e63c6891</credential> <principal-attribute>preferred_username</principal-attribute> </secure-deployment> </subsystem>
この例で、
-
secure-deployment name
は、アプリケーションの WAR ファイルの名前です。 -
realm
は、使用するアプリケーション用に作成したレルムの名前です。 -
realm-public-key
は、作成したレルムの公開鍵です。この鍵は、RH-SSO 管理コンソールで作成したレルムの Realm settings ページの Keys タブで確認できます。realm-public-key
の値を指定しない場合は、サーバーが自動的に取得します。 -
auth-server-url
は、RH-SSO 認証サーバーの URL です。 -
enable-basic-auth
は、クライアントがトークンベースと Basic 認証の両方のアプローチを使用して要求を実行できるように、Basic 認証メカニズムを有効にする設定です。 -
resource
は、作成したクライアントの名前です。クライアントロールを使用するには、RH-SSO でクライアントの設定時に使用したクライアントリソース名を設定します。 -
credential name
は、作成したクライアントの秘密鍵です。この鍵は、RH-SSO 管理コンソールの Clients ページの Credentials タブで確認できます。 principal-attribute
は、アプリケーションでユーザー名を表示するための属性です。この値を指定しないと、アプリケーションに、ユーザー名ではなくユーザー ID が表示されます。注記RH-SSO サーバーは、ユーザー名を小文字に変換します。したがって、RH-SSO と統合すると、Red Hat Decision Manager ではユーザー名が小文字で表示されます。ユーザー名が、ビジネスプロセスに大文字でハードコードされている場合は、アプリケーションが大文字のユーザー名を識別できない場合があります。
クライアントロールを使用する場合は、
<secure-deployment>
の下に以下の設定も追加します。<use-resource-role-mappings>true</use-resource-role-mappings>
-
Elytron サブシステムには、JACC 仕様に基づいた組み込み型ポリシープロバイダーがあります。
standalone.xml
、または Elytron がインストールされているファイルで手動で JACC を有効にするには、以下のタスクのいずれかを実行します。ポリシープロバイダーを作成するには、Red Hat JBoss EAP の管理コマンドラインインターフェイス (CLI) で以下のコマンドを入力します。
/subsystem=undertow/application-security-domain=other:remove() /subsystem=undertow/application-security-domain=other:add(http-authentication-factory="keycloak-http-authentication") /subsystem=ejb3/application-security-domain=other:write-attribute(name=security-domain, value=KeycloakDomain)
Red Hat JBoss EAP 管理 CLI に関する詳細は、Red Hat JBoss EAP の Management CLI Guide を参照してください。
Red Hat JBoss EAP インストールの
EAP_HOME/standalone/configuration
ディレクトリーに移動します。standalone.xml
ファイルおよびstandalone-full.xml
ファイルで Elytron と undertow サブシステム設定の場所を特定して JACC を有効にします。以下に例を示します。<subsystem xmlns="urn:jboss:domain:undertow:12.0" ... > ... <application-security-domains> <application-security-domain name="other" http-authentication-factory="keycloak-http-authentication"/> </application-security-domains>
<subsystem xmlns="urn:jboss:domain:ejb3:9.0"> ... <application-security-domains> <application-security-domain name="other" security-domain="KeycloakDomain"/> </application-security-domains>
EAP_HOME/bin/
に移動し、以下のコマンドを実行して Red Hat JBoss EAP サーバーを起動します。./standalone.sh -c standalone-full.xml
RH-SSO セキュリティーサブシステムを使用するようにアプリケーションの WAR ファイルを更新して、Business Central の RH-SSO アダプターを設定することもできます。ただし Red Hat では、RH-SSO サブシステムからアダプターを設定することを推奨します。つまり、設定を各 WAR ファイルに適用するのではなく、Red Hat JBoss EAP の設定を更新します。
18.3. RH-SSO による Business Central の外部ファイルシステムおよび Git リポジトリーサービスへのアクセスを可能にする
Business Central が RH-SSO 認証を使用してファイルシステムや Git リポジトリーなどの他のリモートサービスを消費できるようにするには、設定ファイルを作成する必要があります。
手順
JSON 設定ファイルを生成します。
- RH-SSO 管理コンソール (http://localhost:8180/auth/admin) に移動します。
- Clients をクリックします。
以下の設定で新規クライアントを作成します。
-
Client ID は
kie-git
に設定します。 -
Access Type は
confidential
に設定します。 - Standard Flow Enabled オプションを無効にします。
- Direct Access Grants Enabled オプションを有効にします。
-
Client ID は
- Save をクリックします。
- クライアント設定画面の上部にある Installation タブをクリックして、Format Option に Keycloak OIDC JSON を選択します。
- Download をクリックします。
-
ダウンロードした JSON ファイルを、サーバーのファイルシステム内でアクセス可能なディレクトリーに移動するか、アプリケーションクラスパスに追加します。このファイルのデフォルトの名前と場所は
$EAP_HOME/kie-git.json
です。 オプション:
EAP_HOME/standalone/configuration/standalone-full.xml
ファイルの<system-properties>
タグの下に、以下のシステムプロパティーを追加してください。<property name="org.uberfire.ext.security.keycloak.keycloak-config-file" value="$EAP_HOME/kie-git.json"/>
プロパティーの
$EAP_HOME/kie-git.json
値を、新しい JSON 設定ファイルへの絶対パスまたはクラスパス (classpath:/EXAMPLE_PATH/kie-git.json
) に置き換えてください。注記org.uberfire.ext.security.keycloak.keycloak-config-file
プロパティーを設定しない場合、Red Hat Decision Manager は$EAP_HOME/kie-git.json
ファイルを読み取ります。
結果
RH-SSO サーバーで認証されたすべてのユーザーは、内部の GIT リポジトリーをクローンすることができます。以下のコマンドで、USER_NAME
を RH-SSO ユーザー (admin
など) に置き換えます。
git clone ssh://USER_NAME@localhost:8001/system
+
RH-SSO サーバークライアントは、単一のリモートサービスデプロイメントに対して URL を 1 つ使用します。配置設定が 2 つ以上ある場合、以下のようなエラーメッセージが表示されることがあります。
ご迷惑をおかけしております… 無効なパラメーター: redirect_uri
このエラーを解決するには、クライアント設定の Valid Redirect URIs フィールドに /*
を追加します。
Configure ページで、Clients > kie-git > Settings と進み、Valid Redirect URIs フィールドに、たとえば、/*
を追加してください。
http://localhost:8080/remote-system/*
第19章 RH-SSO を使用した KIE Server の認証
KIE Server は、サードパーティークライアントの REST API を提供します。KIE Server と RH-SSO を統合した場合は、サードパーティークライアントのアイデンティティー管理を RH-SSO サーバーに委譲できます。
Red Hat Decision Manager のレルムクライアントを作成して、Red Hat JBoss EAP に RH-SSO クライアントアダプターを設定したら、KIE Server に RH-SSO 認証を設定できます。
前提条件
- 16章RH-SSO のインストールおよび設定 の記載通りに、RH-SSO がインストールされている。
-
「Red Hat Decision Manager ユーザーの追加」 の記載通りに、
kie-server
ロールが割り当てられたユーザーが 1 つ以上 RH-SSO に追加されている。 - Red Hat JBoss EAP 7.4 への Red Hat Decision Manager のインストールおよび設定 の記載通りに、KIE Server が Red Hat JBoss EAP 7.4 インスタンスにインストールされている。
この章は以下のセクションで設定されます。
このセクションは、「RH-SSO で KIE Server クライアントの作成」 を除き、スタンドアロンのインストールが対象です。Red Hat OpenShift Container Platform で RH-SSO と Red Hat Decision Manager を統合する場合には、「RH-SSO で KIE Server クライアントの作成」 の手順を実行して、Red Hat OpenShift Container Platform に Red Hat Decision Manager 環境をデプロイしてください。Red Hat OpenShift Container Platform に Red Hat Decision Manager をデプロイする手順は、Red Hat OpenShift Container Platform への Red Hat Decision Manager のデプロイメント を参照してください。
19.1. RH-SSO で KIE Server クライアントの作成
RH-SSO 管理コンソールを使用して、既存のレルムに KIE Server クライアントを作成します。
前提条件
- Red Hat JBoss EAP 7.4 への Red Hat Decision Manager のインストールおよび設定 の記載通りに、KIE Server が Red Hat JBoss EAP 7.4 サーバーにインストールされている。
- 16章RH-SSO のインストールおよび設定 の記載通りに、RH-SSO がインストールされている。
-
「Red Hat Decision Manager ユーザーの追加」 の記載通りに、
kie-server
ロールが割り当てられたユーザーが 1 つ以上 RH-SSO に追加されている。
手順
- RH-SSO 管理コンソールで、16章RH-SSO のインストールおよび設定で作成したセキュリティーレルムを開きます。
Clients をクリックし、Create をクリックします。
Add Client ページが表示されます。
Add Client ページで、レルムに KIE Server クライアントを作成するのに必要な情報を入力し、Save をクリックします。以下に例を示します。
-
クライアント ID:
kie-execution-server
-
Root URL:
http://localhost:8080/kie-server
クライアントのプロトコル:
openid-connect
注記Red Hat OpenShift Container Platform で RH-SSO を設定している場合は、KIE Server ルートに公開されている URL を入力します。OpenShift 管理者は、必要に応じてこの URL を提供してください。
-
クライアント ID:
-
新規クライアントの Access Type は、デフォルトでは
public
に設定されています。この設定をconfidential
に変更して、もう一度 Save をクリックします。 Credentials タブに移動して秘密鍵をコピーします。秘密鍵は、
kie-execution-server
クライアントを設定するのに必要になります。注記RH-SSO サーバークライアントは単一の KIE Server デプロイメントに対して URL を 1 つ使用します。配置設定が 2 つ以上ある場合、以下のようなエラーメッセージが表示されることがあります。
ご迷惑をおかけしております…
無効なパラメーター: redirect_uri
このエラーを解決するには、クライアント設定の Valid Redirect URIs フィールドに
/*
を追加します。Configure ページで、Clients > kie-execution-server > Settings と進み、Valid Redirect URIs フィールドに、たとえば、
/*
を追加してください。http://localhost:8080/kie-server/*
19.2. クライアントアダプターを使用する KIE Server のインストールおよび設定
RH-SSO をインストールしたら、Red Hat JBoss EAP に RH-SSO クライアントアダプターをインストールして、KIE Server に対して設定する必要があります。
前提条件
- Red Hat JBoss EAP 7.4 への Red Hat Decision Manager のインストールおよび設定 の記載通りに、KIE Server が Red Hat JBoss EAP 7.4 サーバーにインストールされている。
- 16章RH-SSO のインストールおよび設定 の記載通りに、RH-SSO がインストールされている。
-
「Red Hat Decision Manager ユーザーの追加」 の記載通りに、
kie-server
ロールが割り当てられたユーザーが 1 つ以上 RH-SSO に追加されている。
KIE Server を Business Central 以外のアプリケーションにデプロイする場合には、2 番目のサーバーに RH-SSO をインストールして設定します。
手順
Red Hat カスタマーポータルの Software Downloads ページに移動し (ログインが必要)、ドロップダウンオプションから製品およびバージョンを選択します。
- 製品: Red Hat Single Sign-On
- バージョン: 7.5
-
Red Hat Single Sign-On 7.5 Client Adapter for JBoss EAP 7 (
rh-sso-7.5.0-eap7-adapter.zip
または最新のバージョン) をダウンロードします。 - adapter zip をデプロイメントしてインストールします。インストール手順は、Red Hat Single Sign On アプリケーションおよびサービスの保護ガイド の「JBoss EAP アダプター」セクションを参照してください。
-
EAP_HOME/standalone/configuration
に移動して、standalone-full.xml
ファイルを開きます。 -
両方のファイルから、
<single-sign-on/>
要素を削除します。 -
Red Hat JBoss EAP システムの
EAP_HOME/standalone/configuration
ディレクトリーに移動し、standalone-full.xml
ファイルを編集して RH-SSO サブシステム設定を追加します。以下に例を示します。 Red Hat JBoss EAP システムの
EAP_HOME/standalone/configuration
に移動し、standalone-full.xml
ファイルを編集して RH-SSO サブシステム設定を追加します。以下に例を示します。<subsystem xmlns="urn:jboss:domain:keycloak:1.1"> <secure-deployment name="kie-server.war"> <realm>demo</realm> <realm-public-key>MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCrVrCuTtArbgaZzL1hvh0xtL5mc7o0NqPVnYXkLvgcwiC3BjLGw1tGEGoJaXDuSaRllobm53JBhjx33UNv+5z/UMG4kytBWxheNVKnL6GgqlNabMaFfPLPCF8kAgKnsi79NMo+n6KnSY8YeUmec/p2vjO2NjsSAVcWEQMVhJ31LwIDAQAB</realm-public-key> <auth-server-url>http://localhost:8180/auth</auth-server-url> <ssl-required>external</ssl-required> <resource>kie-execution-server</resource> <enable-basic-auth>true</enable-basic-auth> <credential name="secret">03c2b267-7f64-4647-8566-572be673f5fa</credential> <principal-attribute>preferred_username</principal-attribute> </secure-deployment> </subsystem> <system-properties> <property name="org.kie.server.sync.deploy" value="false"/> </system-properties>
この例で、
-
secure-deployment name
は、アプリケーションの WAR ファイルの名前です。 -
realm
は、使用するアプリケーション用に作成したレルムの名前です。 -
realm-public-key
は、作成したレルムの公開鍵です。この鍵は、RH-SSO 管理コンソールで作成したレルムの Realm settings ページの Keys タブで確認できます。この公開鍵の値を指定しない場合は、サーバーが自動的に取得します。 -
auth-server-url
は、RH-SSO 認証サーバーの URL です。 -
resource
は、作成したサーバークライアントの名前です。 -
enable-basic-auth
は、クライアントがトークンベースと Basic 認証の両方のアプローチを使用して要求を実行できるように、Basic 認証メカニズムを有効にする設定です。 -
credential name
は、作成したサーバークライアントの秘密鍵です。この鍵は、RH-SSO 管理コンソールの Clients ページの Credentials タブで確認できます。 -
principal-attribute
は、アプリケーションでユーザー名を表示するための属性です。この値を指定しないと、アプリケーションに、ユーザー名ではなくユーザー ID が表示されます。
-
- 設定変更を保存します。
以下のコマンドを使用し、Red Hat JBoss EAP サーバーを再起動して KIE Server を実行します。
EXEC_SERVER_HOME/bin/standalone.sh -c standalone-full.xml -Dorg.kie.server.id=<ID> -Dorg.kie.server.user=<USER> -Dorg.kie.server.pwd=<PWD> -Dorg.kie.server.location=<LOCATION_URL> -Dorg.kie.server.controller=<CONTROLLER_URL> -Dorg.kie.server.controller.user=<CONTROLLER_USER> -Dorg.kie.server.controller.pwd=<CONTOLLER_PASSWORD>
以下に例を示します。
EXEC_SERVER_HOME/bin/standalone.sh -c standalone-full.xml -Dorg.kie.server.id=kieserver1 -Dorg.kie.server.user=kieserver -Dorg.kie.server.pwd=password -Dorg.kie.server.location=http://localhost:8080/kie-server/services/rest/server -Dorg.kie.server.controller=http://localhost:8080/business-central/rest/controller -Dorg.kie.server.controller.user=kiecontroller -Dorg.kie.server.controller.pwd=password
KIE Server の実行中に、以下のコマンドを実行してサーバーの状態を確認します。
<KIE_SERVER_USER>
はkie-server
ロールが割り当てられているユーザーで、そのパスワードは<PASSWORD>
です。curl http://<KIE_SERVER_USER>:<PASSWORD>@localhost:8080/kie-server/services/rest/server/
19.3. KIE Server のトークンベースの認証
Red Hat Decision Manager と KIE Server 間の通信に、トークンベースの認証を使用することもできます。アプリケーションにおいて、ユーザー名とパスワードの代わりに、完全なトークンをアプリケーションサーバーのシステムプロパティーとして使用できます。ただし、トークンは自動的に更新されないため、アプリケーションの通信が行われている間にトークンが失効しないようにする必要があります。トークンを取得する方法は 「トークンベースの認証」 を参照してください。
手順
トークンを使用して KIE Server を管理するように Business Central を設定するには、以下を実行します。
-
org.kie.server.token
プロパティーを設定します。 org.kie.server.user
プロパティーとorg.kie.server.pwd
プロパティーは設定しないでください。これで、Red Hat Decision Manager は
Authorization: Bearer $TOKEN
認証メソッドを使用します。
-
トークンベースの認証を使用して REST API を使用する場合は、以下を行います。
-
org.kie.server.controller.token
プロパティーを設定します。 -
org.kie.server.controller.user
プロパティーおよびorg.kie.server.controller.pwd
プロパティーは設定しないでください。
-
KIE Server はトークンを更新できないため、有効期限の長いトークンを使用してください。トークンの有効期限は、2038 年 1 月 19 日以前に設定してください。セキュリティーのベストプラクティスで、お使いの環境に適したソリューションかどうかを確認してください。
第20章 RH-SSO を使用したサードパーティークライアントの認証
Business Central または KIE Server が提供するさまざまなリモートサービスを使用するには、curl、wget、Web ブラウザー、カスタムの REST クライアントなどのクライアントが、RH-SSO サーバー経由で認証を受け、要求を実行するために有効なトークンを取得する必要があります。リモートのサービスを使用するには、認証済みのユーザーに以下のロールを割り当てる必要があります。
-
rest-all
: Business Central リモートサービスを使用する場合 -
kie-server
: KIE Server のリモートサービスを使用する場合
RH-SSO 管理コンソールを使用してこれらのロールを作成し、リモートサービスを使用するユーザーに割り当てます。
クライアントは、以下のオプションのいずれかを使用して RH-SSO 経由で認証できます。
- クライアントでサポートされている場合は Basic 認証
- トークンベースの認証
20.1. Basic 認証
Business Central と KIE Server の両方に対して RH-SSO クライアントアダプターの設定で Basic 認証を有効にした場合は、以下の例のようにトークンの付与/更新の呼び出しをせずにサービスを呼び出すことができます。
Web ベースのリモートリポジトリーエンドポイントの場合:
curl http://admin:password@localhost:8080/business-central/rest/repositories
KIE Server の場合:
curl http://admin:password@localhost:8080/kie-server/services/rest/server/
20.2. トークンベースの認証
よりセキュアな認証オプションを希望される場合は、RH-SSO から付与されたトークンを使用すると、Business Central および KIE Server の両方からリモートサービスを使用できます。
手順
RH-SSO 管理コンソールで Clients メニューアイテムをクリックし、Create をクリックして新規クライアントを作成します。
Add Client ページが表示されます。
Add Client ページで、レルムにクライアントを新規作成するのに必要な情報を指定します。以下に例を示します。
-
Client ID:
kie-remote
-
クライアントのプロトコル:
openid-connect
-
Client ID:
- Save をクリックして変更を保存します。
Realm Settings でトークンの設定を変更します。
- RH-SSO 管理コンソールで、Realm Settings メニューアイテムをクリックします。
- Tokens タブをクリックします。
Access Token Lifespan の値を
15
分に変更します。これにより、有効期限が切れる前にトークンを取得してサービスを呼び出すための十分な時間が得られます。
- Save をクリックして変更を保存します。
リモートクライアントの公開クライアントを作成したら、以下のコマンドを使用して、RH-SSO サーバーのトークンエンドポイントに HTTP 要求を行ってトークンを取得できます。
RESULT=`curl --data "grant_type=password&client_id=kie-remote&username=admin&password=password" http://localhost:8180/auth/realms/demo/protocol/openid-connect/token`
このコマンドのユーザーは Business Central RH-SSO ユーザーです。詳細は、「Red Hat Decision Manager ユーザーの追加」 を参照してください。
RH-SSO サーバーから取得したトークンを表示するには、以下のコマンドを使用します。
TOKEN=`echo $RESULT | sed 's/.*access_token":"//g' | sed 's/".*//g'`
このトークンを使用してリモートの呼び出しを認証できるようになります。たとえば、Red Hat Decision Manager の内部リポジトリーを確認するには、以下のようにトークンを使用します。
curl -H "Authorization: bearer $TOKEN" http://localhost:8080/business-central/rest/repositories
付録A バージョン情報
このドキュメントの最終更新日: 2023 年 9 月 5 日 (火)
付録B お問い合わせ先
Red Hat Decision Manager ドキュメントチーム: brms-docs@redhat.com