Language:
Format:

Spring Boot 2.1.x ランタイムガイド

Red Hat support for Spring Boot 2.1

Spring Boot 2.1 を使用して、OpenShift およびスタンドアロン RHEL で実行するアプリケーションを開発

概要

本ガイドでは、Spring Boot の使用方法について説明します。

前書き

本ガイドでは、概念と、開発者が Spring Boot ランタイムの使用に必要な実用的な詳細情報を説明します。OpenShift 上の Linux コンテナーとしてデプロイされた Spring Boot アプリケーションの設計を管理する情報を提供します。

第1章 Spring Boot でのアプリケーション開発の概要

本セクションでは、Red Hat ランタイムでのアプリケーション開発の基本概念を説明します。Spring Boot ランタイムの概要も説明します。

1.1. Red Hat Runtimes でのアプリケーション開発の概要

Red Hat OpenShift は、クラウドネイティブランタイムのコレクションを提供するコンテナーアプリケーションプラットフォームです。ランタイムを使用して、OpenShift で Java または JavaScript アプリケーションを開発、ビルド、およびデプロイできます。

Red Hat Runtimes for OpenShift を使用したアプリケーション開発には、以下が含まれます。

OpenShift 上で実行されるように設計された Eclipse Vert.x、Thorntail、Spring Boot などのランタイムのコレクション。
OpenShift でのクラウドネイティブ開発への規定的なアプローチ。

OpenShift は、アプリケーションのデプロイメントおよび監視の管理、保護、自動化に役立ちます。ビジネス上の問題を小規模なマイクロサービスに分割し、OpenShift を使用してマイクロサービスをデプロイし、監視し、維持することができます。サーキットブレーカー、ヘルスチェック、サービス検出などのパターンをアプリケーションに実装できます。

クラウドネイティブな開発は、クラウドコンピューティングを最大限に活用します。

以下でアプリケーションをビルドし、デプロイし、管理できます。

OpenShift Container Platform: Red Hat のプライベートオンプレミスクラウド。
Red Hat Container Development Kit (Minishift): ローカルマシンにインストールおよび実行できるローカルクラウド。この機能は、Red Hat Container Development Kit (CDK) または Minishift で提供されます。
Red Hat CodeReady Studio: アプリケーションの開発、テスト、デプロイを行う統合開発環境 (IDE)。

アプリケーション開発を開始できるようにするため、サンプルアプリケーションですべてのランタイムが利用可能になります。これらのサンプルアプリケーションは Developer Launcher からアクセスできます。サンプルをテンプレートとして使用してアプリケーションを作成することができます。アプリケーションの例の詳細は、「 Introduction to example applications 」を参照してください。

本ガイドでは、Spring Boot ランタイムに関する詳細情報を提供します。その他のランタイムの詳細は、関連するランタイムドキュメントを参照してください。

1.2. Developer Launcher を使用した Red Hat OpenShift でのアプリケーション開発

Developer Launcher (developers.redhat.com/launch) を使用して、OpenShift でのクラウドネイティブアプリケーションの開発を開始することができます。これは、Red Hat が提供するサービスです。

Developer Launcher はスタンドアロンのプロジェクトジェネレーターです。これを使用して、OpenShift Container Platform、Minshift、CDK などの OpenShift インスタンスでアプリケーションをビルドし、デプロイできます。

Developer Launcher でアプリケーションをダウンロードおよびデプロイする方法は、「Developer Launcher を使用したアプリケーションのダウンロードおよびインストール」セクションを参照してください。

1.3. Spring Boot の概要

Spring Boot では、スタンドアロン Spring ベースのアプリケーションを作成できます。Spring Boot に関するドキュメントの一覧は、「関連情報」を参照してください。https://access.redhat.com/documentation/ja-jp/red_hat_support_for_spring_boot/2.1/html-single/spring_boot_2.1.x_runtime_guide/#additional-springboot-resources_spring-boot

OpenShift 上の Spring Boot は、以下のように、Spring Boot の合理化されたアプリケーション開発機能と OpenShift のインフラストラクチャーおよびコンテナーオーケストレーション機能を組み合わせたものです。

ローリング更新
サービス検出
カナリアデプロイメント
一般的なマイクロサービスパターンを実装する方法: 外部化設定、ヘルスチェック、サーキットブレーカー、およびフェイルオーバー

1.3.1. Spring Boot の機能およびフレームワークの概要

本ガイドでは、Spring Boot を使用した最新のアプリケーションの設計について説明します。これらの概念は、HTTP コネクターまたはノンブロッキング HTTP コネクターを使用した Web または Websocket アプリケーションの開発をサポートします。アプリケーションは、OpenShift でクラウドネイティブ機能を使用するよう変更したり、更新したりせずにパッケージ化し、デプロイできます。

以下の表の機能は、OpenShift で実行されるサンプルアプリケーションのコレクションとして利用できます。一部の機能は、ネイティブで Kubernetes となっており、Spring Cloud Kubernetes から入手できます。Actuator などの機能は Spring Boot で直接利用できます。

表1.1 機能およびフレームワークの概要

機能	対応する問題	クラウドネイティブ	フレームワーク
サーキットブレーカー	サービス障害の発生時に中断することなく、サービス間の切り替えを行い、受信要求の処理を継続します。	◯	Spring Cloud Netflix - Hystrix
ヘルスチェック	サービスの readiness および liveness を確認します。プローブに失敗すると、サービスが自動的に再起動します。	◯	Spring Boot アクチュエーター
Service Discovery// include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]	OpenShift にデプロイされた Service/Endpoint を検出し、DNS エントリーに一致するサービス名を使用してサービスまたはルートの背後で公開されます。	はい - Kubernetes API を使用	Spring Cloud Kubernetes - DiscoveryClient
サーバー側の負荷分散	複数のサービスインスタンスをデプロイし、負荷を透過的に分散することにより、負荷の増加を処理します。	はい - 内部 Kubernetes ロードバランサーの使用	-
外部化パラメーター	アプリケーションを実行中の環境とは独立させます。	はい： Kubernetes ConfigMap またはシークレット	Spring Cloud Kubernetes - ConfigMap

1.3.2. サンプルアプリケーションの概要

クラウドネイティブのアプリケーションおよびサービスをビルドする方法を実証する作業アプリケーションがあります。これらは、アプリケーションの開発時に使用する必要のある規範的なアーキテクチャー、設計パターン、ツール、およびベストプラクティスを示しています。サンプルアプリケーションは、クラウドネイティブのマイクロサービスを作成するためのテンプレートとして使用できます。本ガイドで説明しているデプロイメントプロセスを使用して、例を更新および再デプロイできます。

この例では、以下のようなマイクロサービスパターンを実装します。

REST API の作成
データベースの相互運用
ヘルスチェックパターンの実装
アプリケーションの設定を外部化してセキュア化し、容易なスケーリング

サンプルアプリケーションは以下のように使用できます。

テクノロジーのデモの実行
プロジェクトのアプリケーションの開発方法を理解するツールまたはサンドボックスの学習
独自のユースケースを更新または拡張するためのヒント

各サンプルアプリケーションは 1 つ以上のランタイムに実装されます。たとえば、REST API Level 0 のサンプルは以下のランタイムで利用できます。

以降のセクションでは、Spring Boot ランタイムに実装されたサンプルアプリケーションを説明します。

第2章 Spring Boot を使用するようにアプリケーションを設定

アプリケーションのルートディレクトリーにある pom.xml ファイルの Spring Boot BOM (Bill of Materials) アーティファクトを参照します。

前提条件

Maven ベースのアプリケーション

手順

pom.xml ファイルを開き、me.snowdrop:spring-boot-bom アーティファクトを < dependencyManagement > セクションに追加し、<type> pom</type > および <scope> import</scope > を指定します。

<project>
  ...
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>me.snowdrop</groupId>
        <artifactId>spring-boot-bom</artifactId>
        <version>2.1.15.Final-redhat-00001</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
  ...
</project>

以下のプロパティーを追加して、使用している Spring Boot と Spring Boot Maven プラグインのバージョンを追跡します。

<project>
  ...
  <properties>
    <spring-boot.version>2.1.15.RELEASE</spring-boot.version>
    <spring-boot-maven-plugin.version>2.1.15.RELEASE</spring-boot-maven-plugin.version>
  </properties>
  ...
</project>

Spring Boot Starters と Spring Boot Maven プラグインが含まれるリポジトリーを指定します。

  <!-- Specify the repositories containing Spring Boot artifacts. -->
  <repositories>
    <repository>
      <id>redhat-ga</id>
      <name>Red Hat GA Repository</name>
      <url>https://maven.repository.redhat.com/ga/</url>
    </repository>
  </repositories>

  <!-- Specify the repositories containing the plugins used to execute the build of your application. -->
  <pluginRepositories>
    <pluginRepository>
      <id>redhat-ga</id>
      <name>Red Hat GA Repository</name>
      <url>https://maven.repository.redhat.com/ga/</url>
    </pluginRepository>
  </pluginRepositories>

アプリケーションをパッケージ化するために使用されるプラグインとして spring-boot-maven-plugin を参照します。

<project>
  ...
  <build>
    <plugins>
        ...
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <version>${spring-boot-maven-plugin.version}</version>
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
              </executions>
            <configuration>
                <redeploy>true</redeploy>
            </configuration>
        </plugin>
        ...
    </plugins>
  </build>
  ...
</project>

その他のリソース

Spring Boot アプリケーションのパッケージ化に関する詳細は、Spring Boot Maven Plugin のドキュメントを参照してください。

第3章 Developer Launcher を使用したアプリケーションのダウンロードおよびデプロイ

このセクションでは、ランタイムで提供されるサンプルアプリケーションをダウンロードおよびデプロイする方法を説明します。アプリケーションのサンプルは Developer Launcher で利用できます。

3.1. Developer Launcher の使用

Developer Launcher (developers.redhat.com/launch) は OpenShift 上で実行します。アプリケーションのサンプルをデプロイする場合、Developer Launcher は以下のプロセスを説明します。

ランタイムの選択
アプリケーションのビルドおよび実行

選択に基づいて、Developer Launcher はカスタムプロジェクトを生成します。プロジェクトの ZIP バージョンをダウンロードするか、または OpenShift Online インスタンスでアプリケーションを直接起動できます。

Developer Launcher を使用してアプリケーションを OpenShift にデプロイする場合は、Source-to-Image (S2I) ビルドプロセスが使用されます。このビルドプロセスは、OpenShift でアプリケーションを実行するために必要なすべての設定、ビルド、およびデプロイメントのステップを処理します。

3.2. Developer Launcher を使用したサンプルアプリケーションのダウンロード

Red Hat は、Spring Boot ランタイムを使い始めるのに役立つサンプルアプリケーションを提供します。これらの例は、Developer Launcher (developers.redhat.com/launch) で利用できます。

サンプルアプリケーションをダウンロードして、ビルドし、デプロイできます。本セクションでは、サンプルアプリケーションをダウンロードする方法を説明します。

サンプルアプリケーションをテンプレートとして使用し、独自のクラウドネイティブアプリケーションを作成できます。

手順

Developer Launcher (developers.redhat.com/launch) に移動します。
Start をクリックします。
Deploy an Example Application をクリックします。
Select an Example をクリックし、ランタイムで使用できるサンプルアプリケーションの一覧を表示します。
ランタイムを選択します。
サンプルアプリケーションを選択します。
注記
複数のランタイムで利用できるアプリケーションの例もあります。前の手順でランタイムを選択していない場合は、サンプルアプリケーションで利用できるランタイムの一覧からランタイムを選択できます。
ランタイムのリリースバージョンを選択します。ランタイムに一覧表示されているコミュニティーまたは製品リリースから選択できます。
Save をクリックします。
Download をクリックして、サンプルアプリケーションをダウンロードします。
ソースおよびドキュメントファイルを含む ZIP ファイルがダウンロードされます。

3.3. OpenShift Container Platform または CDK (Minishift) へのサンプルアプリケーションのデプロイメント

サンプルアプリケーションを OpenShift Container Platform または CDK (Minishift) のいずれかにデプロイできます。アプリケーションをデプロイする場所に応じて、認証に該当する Web コンソールを使用します。

前提条件

Developer Launcher を使用して、サンプルアプリケーションプロジェクトを作成している。
アプリケーションを OpenShift Container Platform にデプロイする場合は、OpenShift Container Platform Web コンソールにアクセスできるようにしている。
CDK (Minishift) にアプリケーションをデプロイする場合は、CDK (Minishift) Web コンソールにアクセスできるようにしている。
OC コマンドラインクライアントがインストールされている。

手順

サンプルアプリケーションをダウンロードします。
oc コマンドラインクライアントを使用して、サンプルアプリケーションを OpenShift Container Platform または CDK (Minishift) にデプロイできます。
Web コンソールによって提供されるトークンを使用してクライアントを認証する必要があります。アプリケーションをデプロイする場所に応じて、OpenShift Container Platform Web コンソールまたは CDK (Minishift) Web コンソールを使用します。以下の手順を実行してクライアントの認証を取得します。
1. Web コンソールにログインします。
2. Web コンソールの右上隅にあるクエスチョンマークアイコンをクリックします。
3. 一覧から Command Line Tools を選択します。
4. oc login コマンドをコピーします。
5. ターミナルにコマンドを貼り付け、CLI クライアント oc をアカウントで認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```
ZIP ファイルの内容を展開します。
```
$ unzip MY_APPLICATION_NAME.zip
```
OpenShift で新規プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
MY_APPLICATION_NAME の root ディレクトリーに移動します。
Maven を使用してサンプルアプリケーションをデプロイします。
```
$ mvn clean fabric8:deploy -Popenshift
```
注記: アプリケーションの例によっては、追加の設定が必要になる場合があります。サンプルアプリケーションをビルドおよびデプロイするには、README ファイルに記載されている手順に従います。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa               1/1       Running     0          58s
MY_APP_NAME-s2i-1-build           0/1       Completed   0          2m
```
MY_APP_NAME-1-aaaaa Pod は完全にデプロイされ起動すると Running ステータスになります。アプリケーションの Pod 名は異なる場合があります。Pod 名の数値は、新しいビルドごとに増加します。末尾の文字は、Pod の作成時に生成されます。
アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。
ルート情報の例
```
$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME         MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME      MY_APP_NAME      8080
```
Pod のルート情報は、アクセスできるベース URL を提供します。この例では、http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスできます。

第4章 Spring Boot ランタイムアプリケーションの開発およびデプロイ

サンプルを使用する他に、ゼロから新しい Spring Boot アプリケーションを作成して、OpenShift にデプロイできます。

Spring Boot アプリケーションでサポート対象でテスト済みの Maven アーティファクトを指定する方法や使用の推奨される方法は、OpenShift Application Runtimes Spring Boot BOM の使用が推奨されます。

4.1. Spring Boot アプリケーションの開発

基本的な Spring Boot アプリケーションには、以下を作成する必要があります。

Spring Boot メソッドが含まれる Java クラス。
アプリケーションをビルドするために Maven が必要とする情報が含まれる pom.xml ファイル。

以下の手順では、応答として "{"content":"Greetings!"}" を返す単純な Greeting アプリケーションを作成します。

注記

アプリケーションを OpenShift にビルドおよびデプロイする場合は、Spring Boot 2.1.x は OpenJDK 8 および OpenJDK 11 をベースとしたビルダーイメージのみをサポートします。Oracle JDK および OpenJDK 9 のビルダーイメージはサポートされていません。

前提条件

Maven がインストールされている。
OpenJDK 8 または OpenJDK 11 がインストールされている。

手順

myApp ディレクトリーを新規作成し、そのディレクトリーに移動します。
```
$ mkdir myApp
$ cd myApp
```
これは、アプリケーションのルートディレクトリーです。
ルートディレクトリーにディレクトリー構造 src/main/java/com/example/ を作成し、これに移動します。
```
$ mkdir -p src/main/java/com/example/
$ cd src/main/java/com/example/
```

アプリケーションコードを含む Java クラスファイル MyApp.java を作成します。

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class MyApp {

    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }

    @RequestMapping("/")
    @ResponseBody
    public Message displayMessage() {
        return new Message();
    }

    static class Message {
        private String content = "Greetings!";

        public String getContent() {
            return content;
        }

        public void setContent(String content) {
            this.content = content;
        }
    }
}

以下の内容を含むアプリケーションルートディレクトリー myApp に pom.xml ファイルを作成します。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example</groupId>
  <artifactId>my-app</artifactId>
  <version>1.0.0-SNAPSHOT</version>

  <name>MyApp</name>
  <description>My Application</description>

  <!-- Specify the JDK builder image used to build your application. -->
  <!-- Use OpenJDK 8 and OpenJDK 11-based images. OracleJDK-based images are not supported. -->
  <properties>
    <fabric8.generator.from>registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift:latest</fabric8.generator.from>
  </properties>

  <!-- Import dependencies from the Spring Boot BOM. -->
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>me.snowdrop</groupId>
        <artifactId>spring-boot-bom</artifactId>
        <version>2.1.15.Final-redhat-00001</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <dependencies>
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-tomcat</artifactId>
      </dependency>
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
      </dependency>
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <version>2.1.15.RELEASE</version>
      </plugin>
    </plugins>
  </build>

  <!-- Specify the repositories containing Spring Boot artifacts -->
  <repositories>
    <repository>
      <id>redhat-ga</id>
      <name>Red Hat GA Repository</name>
      <url>https://maven.repository.redhat.com/ga/</url>
    </repository>
  </repositories>

  <pluginRepositories>
    <pluginRepository>
      <id>redhat-ga</id>
      <name>Red Hat GA Repository</name>
      <url>https://maven.repository.redhat.com/ga/</url>
    </pluginRepository>
  </pluginRepositories>

</project>

アプリケーションのルートディレクトリーから Maven を使用してアプリケーションをビルドします。
```
$ mvn spring-boot:run
```
アプリケーションが実行していることを確認します。
curl またはブラウザーを使用して、アプリケーションが http://localhost:8080 で稼働していることを確認します。
```
$ curl http://localhost:8080
{"content":"Greetings!"}
```

追加情報

推奨されるプラクティスとして、Liveness プローブおよび Readiness プローブを設定し、OpenShift で実行する際にアプリケーションのヘルスモニターリングを有効にできます。OpenShift でのアプリケーションのヘルスモニターリングの仕組みを確認するには、ヘルスチェックの例を試してください。

4.2. Spring Boot アプリケーションの OpenShift へのデプロイ

Spring Boot アプリケーションを OpenShift にデプロイするには、アプリケーションで pom.xml ファイルを設定し、Fabric8 Maven プラグインを使用します。pom.xml ファイルの fabric8.generator.from URL を置き換えて、OpenJDK イメージを指定できます。

4.2.1. Red Hat Enterprise Linux 用の OpenJDK イメージ

アプリケーションをビルドし、OpenShift にデプロイするために使用する OpenJDK イメージを選択できます。OpenJDK イメージは、OpenJDK 8 または OpenJDK 11 を使用して、RHEL 7 および RHEL 8 で利用できます。

RHEL 8 イメージにアクセスするには、Red Hat Ecosystem Catalog での Docker または Podman 認証が必要です。認証手順は、以下の表の Red Hat Ecosystem Catalog リンクにあります。

OS	JDK	Red Hat Ecosystem Catalog
RHEL 7	OpenJDK 8	OpenJDK 8 を使用した RHEL 7
RHEL 7	OpenJDK 11	OpenJDK 11 を使用した RHEL 7
RHEL 8	OpenJDK 8	OpenJDK 8 を使用した RHEL 8
RHEL 8	OpenJDK 11	OpenJDK 11 を使用した RHEL 8

注記

RHEL 7 ホストでの RHEL 8 ベースのコンテナーの使用 (OpenShift 3 や OpenShift 4 など) は、サポートが限定されています。詳細は、Red Hat Enterprise Linux Container Compatibility Matrix を参照してください。

4.2.2. OpenShift デプロイメント向け Spring Boot アプリケーションの準備

Spring Boot アプリケーションを OpenShift にデプロイするには、以下を含める必要があります。

アプリケーションの pom.xml ファイルにあるランチャープロファイル情報。

以下の手順では、Fabric8 Maven プラグインを使用したプロファイルは、アプリケーションを OpenShift にビルドおよびデプロイするために使用されます。

前提条件

Maven がインストールされている。
Red Hat Ecosystem Catalog での Docker または Podman 認証による RHEL 8 イメージへのアクセスができる。

手順

以下の内容を、アプリケーションのルートディレクトリーの pom.xml ファイルに追加します。

...

<profiles>
    <profile>
      <id>openshift</id>
      <build>
        <plugins>
          <plugin>
            <groupId>io.fabric8</groupId>
            <artifactId>fabric8-maven-plugin</artifactId>
            <version>4.4.1</version>
            <executions>
              <execution>
                <goals>
                  <goal>resource</goal>
                  <goal>build</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
    </profile>
</profiles>

pom.xml ファイル の fabric8.generator.from プロパティーを置き換えると、OpenJDK イメージを指定します。

OpenJDK 8 を使用した RHEL 7

<fabric8.generator.from>registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift:latest</fabric8.generator.from>

OpenJDK 11 を使用した RHEL 7

<fabric8.generator.from>registry.access.redhat.com/openjdk/openjdk-11-rhel7:latest</fabric8.generator.from>

OpenJDK 8 を使用した RHEL 8

<fabric8.generator.from>registry.redhat.io/openjdk/openjdk-8-rhel8:latest</fabric8.generator.from>

OpenJDK 11 を使用した RHEL 8

<fabric8.generator.from>registry.redhat.io/openjdk/openjdk-11-rhel8:latest</fabric8.generator.from>

4.2.3. Fabric8 Maven プラグインを使用した Spring Boot アプリケーションの OpenShift へのデプロイ

Spring Boot アプリケーションを OpenShift にデプロイするには、以下を実行する必要があります。

OpenShift インスタンスにログインします。
OpenShift インスタンスにアプリケーションをデプロイします。

前提条件

CLI クライアント oc がインストールされている。
Maven がインストールされている。

手順

oc クライアントを使用して OpenShift インスタンスにログインします。
```
$ oc login ...
```
OpenShift インスタンスで新規プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションのルートディレクトリーから Maven を使用してアプリケーションを OpenShift にデプロイします。アプリケーションのルートディレクトリーには pom.xml ファイルが含まれます。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
デプロイメントを確認します。
1. アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa               1/1       Running     0          58s
MY_APP_NAME-s2i-1-build           0/1       Completed   0          2m
```
  MY_APP_NAME-1-aaaaa Pod は、完全にデプロイされて起動すると、ステータスが Running になるはずです。
  特定の Pod 名が異なります。
2. Pod のルートを確認します。
  ルート情報の例
```
$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME         MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME      MY_APP_NAME      8080
```
  Pod のルート情報には、アクセスに使用するベース URL が提供されます。
  この例では、http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスできます。
3. アプリケーションが OpenShift で実行していることを確認します。
```
$ curl http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME
{"content":"Greetings!"}
```

4.3. スタンドアロン Red Hat Enterprise Linux への Spring Boot アプリケーションのデプロイ

Spring Boot アプリケーションをスタンドアロンの Red Hat Enterprise Linux にデプロイするには、アプリケーションで pom.xml ファイルを設定し、Maven を使用してパッケージ化し、java-jar コマンドを使用してデプロイします。

前提条件

RHEL 7 または RHEL 8 がインストールされている。

4.3.1. スタンドアロン Red Hat Enterprise Linux デプロイメント用の Spring Boot アプリケーションの準備

Spring Boot アプリケーションをスタンドアロンの Red Hat Enterprise Linux にデプロイするには、最初に Maven を使用してアプリケーションをパッケージ化する必要があります。

前提条件

Maven がインストールされている。

手順

以下の内容をアプリケーションの root ディレクトリーの pom.xml ファイルに追加します。

  ...
  <!-- Specify target artifact type for the repackage goal. -->
  <packaging>jar</packaging>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <version>${spring-boot.version}</version>
        <executions>
          <execution>
              <goals>
               <goal>repackage</goal>
             </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  ...

Maven を使用してアプリケーションをパッケージ化します。
```
$ mvn clean package
```
作成される JAR ファイルは target ディレクトリーに置かれます。

4.3.2. jar を使用したスタンドアロン Red Hat Enterprise Linux への Spring Boot アプリケーションのデプロイ

Spring Boot アプリケーションをスタンドアロンの Red Hat Enterprise Linux にデプロイするには、java -jar コマンドを使用します。

前提条件

RHEL 7 または RHEL 8 がインストールされている。
OpenJDK 8 または OpenJDK 11 がインストールされている。
アプリケーションが含まれる JAR ファイル。

手順

そのアプリケーションで JAR ファイルをデプロイします。
```
$ java -jar my-project-1.0.0.jar
```
デプロイメントを確認します。
curl またはブラウザーを使用して、アプリケーションが http://localhost:8080 で稼働していることを確認します。
```
$ curl http://localhost:8080
```

第5章 Eclipse Vert.x で Spring Boot を使用したリアクティブアプリケーションの開発

注記

Spring Boot の Eclipse Vert.x リアクティブコンポーネントは、テクノロジープレビューとして提供されます。

本セクションでは、Spring Boot および Eclipse Vert.x をベースとした Spring Boot スターターを使用して、リアクティブでアプリケーションを開発する方法を説明します。以下の例は、スターターを使用してリアクティブアプリケーションを作成する方法を表しています。

5.1. Eclipse Vert.x での Spring Boot の概要

Spring リアクティブスタックは Project Reactor 上に構築され、バックプレーシャーを実装し、Reactive Streams 仕様に準拠しています。非同期イベントストリーム処理を有効にする Flux および Mono 機能 API タイプを提供します。

Spring は、Project Reactor の上部に WebFlux (非同期イベント駆動型の Web アプリケーションフレームワーク) を提供します。WebFlux は、主に Reactor Netty と連携するように設計されていますが、Eclipse Vert.x などの他のリアクティブ HTTP サーバーでも操作できます。

Spring WebFlux および Reactor を使用すると、以下のアプリケーションを作成できます。

ブロックなし: アプリケーションは、現在の要求の完了に必要なリモートコンポーネントまたはサービスからの応答を待機しているときに、追加の要求を引き続き処理します。
非同期: アプリケーションは応答イベントを生成し、それらをアプリケーション内の他のクライアントが取得できるイベントストリームに再び公開することで、イベントストリームからイベントに応答します。
イベント駆動型: アプリケーションは、マウスクリック、HTTP 要求、ストレージに追加される新しいファイルなど、ユーザーまたは別のサービスが生成するイベントに応答します。
スケーラブル: アプリケーションの必要なイベント処理容量のみに一致する Publisher または Subscriber の数が増えると、アプリケーションの個別クライアント間のルーティング要求の複雑性が向上します。リアクティブアプリケーションは、他のアプリケーションプログラミングモデルと比較して、コンピューティングおよびネットワークリソースを使用して多数のイベントを処理できます。
耐久性: アプリケーションは、サービス全体に影響を与えることなく、依存するサービス障害を処理できます。

Spring WebFlux を使用する追加の利点には以下が含まれます。

SpringMVC での類似性: SpringMVC API タイプと WebFlux API タイプは類似しており、開発者は SpringMVC の知識を WebFlux を使用したプログラミングアプリケーションに簡単に適用できます。

Red Hat による Spring Reactive 製品は、Reactor と WebFlux から OpenShift とスタンドアロンの RHEL の利点を提供し、WebFLux フレームワークの Eclipse Vert.x 拡張のセットを導入します。これにより、Spring Boot の抽象化および高速なプロトタイプ機能を保持でき、アプリケーション内のサービス間のネットワーク通信を完全にリアクティブで処理する非同期 IO API を利用できます。

アノテーション付きコントローラーのサポート: WebFlux は、SpringMVC により導入されるエンドポイントコントローラーアノテーションを保持します (SpringMVC および WebFlux はリアクティブな RxJava2 および Reactor の戻り値タイプ)。
機能的なプログラミングサポート: Reactor の Java 8 Functional API とだけでなく、CompletablebFuture API、および Stream API とも相互作用します。アノテーションベースのエンドポイントに加えて、WebFlux は機能的なエンドポイントもサポートします。

その他のリソース

Spring Reactive スタックの一部であるテクノロジーの実装に関する詳細は、以下のリソースを参照してください。

5.2. リアクティブ Spring Web

spring-web モジュールは、Spring WebFlux のリアクティブ機能の基盤要素を提供します。以下が含まれます。

HttpHandler API によって提供される HTTP 抽象化
サポートされるサーバーのリアクティブストリームアダプター (Eclipse Vert.x、Undertow など)
イベントストリームデータをエンコードおよびデコードするためのコードデックです。これには、以下が含まれます。
- DataBuffer、さまざまなタイプのバイトバッファー表現 Netty ByteBuf、java.nio.ByteBuffer など) の抽象化
- HTTP とは関係なくコンテンツをエンコードおよびデコードする低レベルの契約
- HTTP メッセージコンテンツのエンコードおよびデコードを行う HttpMessageReader および HTTPMessageWriter コントラクト
WebHandler API (非ブロッキング契約を使用する Servlet 3.1 I/O API に対応)

Web アプリケーションを設計する場合は、Spring WebFlux が以下を提供する 2 つのプログラミングモデルのいずれかを選択できます。

アノテーション付きコントローラー: Spring WebFlux のアノテーションが付けられたコントローラーは Spring MVC と一致しており、spring-web モジュールと同じアノテーションに基づいています。SpringMVC の spring-web モジュールに加えて、WebFlux の対応する @RequestBody 引数もサポートしています。
機能エンドポイント: Java 8 Lambda 式および機能 API の Spring WebFlux が提供する機能エンドポイント。このプログラミングモデルは、要求をルーティングおよび処理する専用のライブラリー (この場合は Reactor など) に依存します。インテントの宣言とコールバックの使用に依存してアクティビティーを完了するアノテーションベースのエンドポイントコントローラーとは対照的に、機能エンドポイントに基づくリアクティブモデルでは、要求の処理をアプリケーションで完全に制御できます。

5.3. WebFlux でのリアクティブ Spring Boot HTTP サービスの作成

Spring Boot および WebFlux を使用して、基本的なリアクティブ Hello World HTTP Web サービスを作成します。

前提条件

JDK 8 または JDK 11 がインストールされている。
Maven がインストールされている。
Spring Boot を使用するよう設定されたMaven ベースのアプリケーションプロジェクト

手順

vertx-spring-boot-starter-http をプロジェクトの pom.xml ファイルに依存関係として追加します。

pom.xml

<project>
...
  <dependencies>
  ...
    <dependency>
      <groupId>dev.snowdrop</groupId>
      <artifactId>vertx-spring-boot-starter-http</artifactId>
    </dependency>
  ...
  <dependencies>
...
</project>

アプリケーションのメインクラスを作成し、ルーターおよびハンドラーメソッドを定義します。

HttpSampleApplication.java

package dev.snowdrop.vertx.sample.http;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;
import reactor.core.publisher.Mono;

import static org.springframework.web.reactive.function.BodyInserters.fromObject;
import static org.springframework.web.reactive.function.server.RouterFunctions.route;
import static org.springframework.web.reactive.function.server.ServerResponse.ok;

@SpringBootApplication
public class HttpSampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(HttpSampleApplication.class, args);
    }

    @Bean
    public RouterFunction<ServerResponse> helloRouter() {
        return route()
            .GET("/hello", this::helloHandler)
            .build();
    }

    private Mono<ServerResponse> helloHandler(ServerRequest request) {
        String name = request
            .queryParam("name")
            .orElse("World");
        String message = String.format("Hello, %s!", name);

        return ok()
            .body(fromObject(message));
    }
}

オプション: アプリケーションをローカルで実行し、テストします。
1. Maven プロジェクトのルートディレクトリーへ移動します。
```
$ cd myApp
```
2. アプリケーションをパッケージ化します。
```
$ mvn clean package
```
3. コマンドラインからアプリケーションを起動します。
```
$ java -jar target/vertx-spring-boot-sample-http.jar
```
4. 新しいターミナルウィンドウで、/hello エンドポイントで HTTP 要求を発行します。
```
$ curl localhost:8080/hello
Hello, World!
```
5. カスタム名と、パーソナルな応答を取得するために要求を指定します。
```
$ curl http://localhost:8080/hello?name=John
Hello, John!
```

その他のリソース

Fabric8 Maven プラグインを使用して、アプリケーションを OpenShift クラスターにデプロイできます。
また、スタンドアロンの Red Hat Enterprise Linux でのデプロイメント用にアプリケーションを設定することもできます。
Spring Boot でリアクティブ Web サービスの作成に関する詳細は、Spring コミュニティードキュメントのリアクティブ REST サービスの開発ガイドを参照してください。

5.4. リアクティブ Spring Boot WebFlux アプリケーションで Basic 認証の使用

Spring Security および WebFlux スターターを使用して、リアクティブ Hello World HTTP Web サービスを作成し、基本的なフォームベースの認証を作成します。

前提条件

JDK 8 または JDK 11 がインストールされている。
Maven がインストールされている。
Spring Boot を使用するよう設定されたMaven ベースのアプリケーションプロジェクト

手順

vertx-spring-boot-starter-http および spring-boot-starter-security をプロジェクトの pom.xml ファイルに依存関係として追加します。

pom.xml

<project>
...
  <dependencies>
  ...
    <dependency>
      <groupId>dev.snowdrop</groupId>
      <artifactId>vertx-spring-boot-starter-http</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
  ...
  <dependencies>
...
</project>

アプリケーションのエンドポイントコントローラークラスを作成します。

HelloController.java

package dev.snowdrop.vertx.sample.http.security;

import java.security.Principal;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Mono;

@RestController
public class HelloController {

    @GetMapping("/")
    public Mono<String> hello(Mono<Principal> principal) {
        return principal
            .map(Principal::getName)
            .map(this::helloMessage);
    }

    private String helloMessage(String username) {
        return "Hello, " + username + "!";
    }
}

アプリケーションのメインクラスを作成します。

HttpSecuritySampleApplication.java

package dev.snowdrop.vertx.sample.http.security;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class HttpSecuritySampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(HttpSecuritySampleApplication.class, args);
    }
}

/hello エンドポイントにアクセスするためのユーザー認証情報を格納する SecurityConfiguration クラスを作成します。

SecurityConfiguration.java

package dev.snowdrop.vertx.sample.http.security;

import org.springframework.context.annotation.Bean;
import org.springframework.security.config.annotation.web.reactive.EnableWebFluxSecurity;
import org.springframework.security.core.userdetails.MapReactiveUserDetailsService;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;

@EnableWebFluxSecurity
public class SecurityConfiguration {

    @Bean
    public MapReactiveUserDetailsService userDetailsService() {
        UserDetails user = User.withDefaultPasswordEncoder()
            .username("user")
            .password("user")
            .roles("USER")
            .build();

        return new MapReactiveUserDetailsService(user);
    }
}

オプション: アプリケーションをローカルで実行し、テストします。
1. Maven プロジェクトのルートディレクトリーへ移動します。
```
$ cd myApp
```
2. アプリケーションをパッケージ化します。
```
$ mvn clean package
```
3. コマンドラインからアプリケーションを起動します。
```
$ java -jar target/vertx-spring-boot-sample-http-security.jar
```
4. ブラウザーを使用して http://localhost:8080 に移動し、ログイン画面にアクセスします。
5. 以下の認証情報を使用してログインします。
  - username: user
  - password: user
  以下のログイン時に、カスタマイズされた挨拶文を受け取ります。
```
Hello, user!
```
6. Web ブラウザーを使用して http://localhost:8080/logout に移動し、Log out ボタンを使用してアプリケーションからログアウトします。
7. または、ターミナルを使用して localhost:8080 で認証されていない HTTP 要求を実行します。アプリケーションから HTTP 401 Unauthorized 応答を受信します。
```
$ curl -I http://localhost:8080
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
X-XSS-Protection: 1 ; mode=block
Referrer-Policy: no-referrer
```
8. サンプルユーザー認証情報を使用して認証された要求を発行します。パーソナルな応答を受け取ります。
```
$ curl -u user:user http://localhost:8080
Hello, user!
```

その他のリソース

Fabric8 Maven プラグインを使用して、アプリケーションを OpenShift クラスターにデプロイできます。
また、スタンドアロンの Red Hat Enterprise Linux でのデプロイメント用にアプリケーションを設定することもできます。
Basic HTTP 認証スキームの詳細は RFC-7617 のドキュメントを参照してください。
フォームベースの認証など、対話式クライアントの HTTP 認証拡張の完全仕様は、RFC-8053 を参照してください。

5.5. リアクティブ Spring Boot アプリケーションで OAuth2 認証の使用。

リアクティブ Spring Boot アプリケーションの OAuth2 認証を設定し、クライアント ID およびクライアントシークレットを使用して認証します。

前提条件

JDK 8 または JDK 11 がインストールされている。
GitHub アカウント
Maven がインストールされている。
Spring Boot を使用するよう設定されたMaven ベースのアプリケーションプロジェクト

手順

Github アカウントに新規 OAuth 2 アプリケーションを登録します。登録フォームに以下の値を指定するようにしてください。
- ホームページ URL: http://localhost:8080
- 承認コールバック URL: http://localhost:8080/login/oauth2/code/github
  登録が完了したら、クライアント ID とクライアントシークレットを保存します。

プロジェクトの pom.xml ファイルに以下の依存関係を追加します。

vertx-spring-boot-starter-http
spring-boot-starter-security
spring-boot-starter-oauth2-client

reactor-netty

spring-boot-starter-oauth2-client が適切に動作するには、reactor-netty クライアントが必要です。

pom.xml

<project>
...
  <dependencies>
  ...
    <dependency>
      <groupId>dev.snowdrop</groupId>
      <artifactId>vertx-spring-boot-starter-http</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-oauth2-client</artifactId>
    </dependency>
    <!-- Spring OAuth2 client only works with Reactor Netty client -->
    <dependency>
      <groupId>io.projectreactor.netty</groupId>
      <artifactId>reactor-netty</artifactId>
    </dependency>
  ...
  <dependencies>
...
</project>

アプリケーションのエンドポイントコントローラークラスを作成します。

HelloController.java

package dev.snowdrop.vertx.sample.http.oauth;

import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.security.oauth2.core.user.OAuth2User;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Mono;

@RestController
public class HelloController {

    @GetMapping
    public Mono<String> hello(@AuthenticationPrincipal OAuth2User oauth2User) {
        return Mono.just("Hello, " + oauth2User.getAttributes().get("name") + "!");
    }
}

アプリケーションのメインクラスを作成します。

OAuthSampleApplication.java

package dev.snowdrop.vertx.sample.http.oauth;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class OAuthSampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(OAuthSampleApplication.class, args);
    }
}

YAML 設定ファイルを作成して、アプリケーション登録時に GitHub から受け取った OAuth2 クライアント ID およびクライアントシークレットを保存します。
src/main/resources/application.yml
```
spring:
  security:
    oauth2:
      client:
        registration:
          github:
            client-id: YOUR_GITHUB_CLIENT_ID
            client-secret: YOUR_GITHUB_CLIENT_SECRET
```
オプション: アプリケーションをローカルで実行し、テストします。
1. Maven プロジェクトのルートディレクトリーへ移動します。
```
$ cd myApp
```
2. アプリケーションをパッケージ化します。
```
$ mvn clean package
```
3. コマンドラインからアプリケーションを起動します。
```
$ java -jar target/vertx-spring-boot-sample-http-oauth.jar
```
4. Web ブラウザーを使用して http://localhost:8080 に移動します。GitHub の OAuth2 アプリケーション認可画面にリダイレクトされます。プロンプトが表示されたら、GitHub アカウントの認証情報を使用してログインします。
5. Authorize をクリックして確定します。パーソナライズされたグリーティングメッセージを示す画面にリダイレクトされます。

その他のリソース

Fabric8 Maven プラグインを使用して、アプリケーションを OpenShift クラスターにデプロイできます。
また、スタンドアロンの Red Hat Enterprise Linux でのデプロイメント用にアプリケーションを設定することもできます。
詳細は、Spring コミュニティードキュメントの OAuth2 チュートリアルを参照してください。または、Spring Security の OAuth2 を使用するためのチュートリアルを参照してください。
OAuth2 認証フレームワークの完全な仕様については、RFC-6749 を参照してください。

5.6. リアクティブ Spring Boot SMTP メールアプリケーションの作成

Eclipse Vert.x を使用して Spring Boot でリアクティブ SMTP メールサービスを作成します。

前提条件

JDK 8 または JDK 11 がインストールされている。
Maven がインストールされている。
Spring Boot を使用するよう設定されたMaven ベースのアプリケーションプロジェクト
マシンに設定された SMTP メールサーバー

手順

vertx-spring-boot-starter-http および vertx-spring-boot-starter-mail をプロジェクトの pom.xml ファイルに依存関係として追加します。

pom.xml

<project>
...
  <dependencies>
  ...
    <dependency>
      <groupId>dev.snowdrop</groupId>
      <artifactId>vertx-spring-boot-starter-http</artifactId>
    </dependency>
    <dependency>
      <groupId>dev.snowdrop</groupId>
      <artifactId>vertx-spring-boot-starter-mail</artifactId>
    </dependency>
  ...
  <dependencies>
...
</project>

アプリケーションのメールハンドラークラスを作成します。

MailHandler.java

package dev.snowdrop.vertx.sample.mail;

import dev.snowdrop.vertx.mail.MailClient;
import dev.snowdrop.vertx.mail.MailMessage;
import dev.snowdrop.vertx.mail.SimpleMailMessage;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;
import reactor.core.publisher.Mono;

import static org.springframework.web.reactive.function.server.ServerResponse.noContent;

@Component
public class MailHandler {

    private final MailClient mailClient;

    public MailHandler(MailClient mailClient) {
        this.mailClient = mailClient;
    }

    public Mono<ServerResponse> send(ServerRequest request) {
        return request.formData()
            .log()
            .map(this::formToMessage)
            .flatMap(mailClient::send)
            .flatMap(result -> noContent().build());
    }

    private MailMessage formToMessage(MultiValueMap<String, String> form) {
        return new SimpleMailMessage()
            .setFrom(form.getFirst("from"))
            .setTo(form.get("to"))
            .setSubject(form.getFirst("subject"))
            .setText(form.getFirst("text"));
    }

}

アプリケーションのメインクラスを作成します。

MailSampleApplication.java

package dev.snowdrop.vertx.sample.mail;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.core.io.ClassPathResource;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.ServerResponse;

import static org.springframework.http.MediaType.APPLICATION_FORM_URLENCODED;
import static org.springframework.web.reactive.function.server.RequestPredicates.accept;
import static org.springframework.web.reactive.function.server.RouterFunctions.resources;
import static org.springframework.web.reactive.function.server.RouterFunctions.route;

@SpringBootApplication
public class MailSampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(MailSampleApplication.class, args);
    }

    @Bean
    public RouterFunction<ServerResponse> mailRouter(MailHandler mailHandler) {
        return route()
                .POST("/mail", accept(APPLICATION_FORM_URLENCODED), mailHandler::send)
                .build();
    }

    @Bean
    public RouterFunction<ServerResponse> staticResourceRouter() {
        return resources("/**", new ClassPathResource("static/"));
    }

}

application.properties ファイルを作成して、SMTP サーバー認証情報を保存します。

application.properties

vertx.mail.host=YOUR_SMTP_SERVER_HOSTNAME
vertx.mail.username=YOUR_SMTP_SERVER_USERNAME
vertx.mail.password=YOUR_SMTP_SERVER_PASSWORD

アプリケーションのフロントエンドとして機能する src/main/resources/static/index.html ファイルを作成します。または、この手順で使用できる HTML メールフォームの例を使用してください。
オプション: アプリケーションをローカルで実行し、テストします。
1. Maven プロジェクトのルートディレクトリーへ移動します。
```
$ cd myApp
```
2. アプリケーションをパッケージ化します。
```
$ mvn clean package
```
3. コマンドラインからアプリケーションを起動します。
```
$ java -jar target/vertx-spring-boot-sample-mail.jar
```
4. Web ブラウザーを使用して http://localhost:8080/index.html に移動し、メールフォームにアクセスします。

その他のリソース

RHEL 7 で SMTP メールサーバーを設定する方法は、RHEL 7 ドキュメントの Mail Transport Agent Configuration セクションを参照してください。
Fabric8 Maven プラグインを使用して、アプリケーションを OpenShift クラスターにデプロイできます。
また、スタンドアロンの Red Hat Enterprise Linux でのデプロイメント用にアプリケーションを設定することもできます。

5.7. サーバー向けイベント

サーバー送信イベント (SSE) は、HTTP サーバーがクライアントに単方向の更新を送信できるようにするプッシュテクノロジーです。SSE は、イベントソースとクライアント間の接続を確立することで機能します。イベントソースはこの接続を使用してイベントをクライアント側にプッシュします。サーバーがイベントをプッシュした後、接続は開いたままになり、後続のイベントをプッシュするのに使用できます。クライアントがサーバー上のリクエストを終了すると、接続は閉じられます。SSE は、クライアントが更新のためにイベントソースをポーリングするたびに新しい接続を確立する必要があるポーリングの代替手段を表します。WebSocket とは対照的に、SSE は 1 つの方向でイベントをプッシュします (つまり、ソースからクライアントへ)。イベントソースとクライアント間の双方向通信を処理しません。

SSE の指定は HTML5 に組み込まれており、レガシーバージョンを含む Web ブラウザーで広くサポートされます。SSE はコマンドラインから使用でき、他のプロトコルと比較してセットアップが比較的簡単です。

SSE は、サーバーからクライアントに頻繁に更新を必要とするユースケースに適していますが、クライアント側からサーバーへの更新の頻度は低くなることが予想されます。クライアント側からサーバーへの更新は、REST などの別のプロトコルで処理できます。このようなユースケースの例には、新規ファイルがファイルサーバーにアップロードされる時に、ソーシャルメディアフィードの更新やクライアントに送信される通知が含まれます。

5.8. リアクティブ Spring Boot アプリケーションでのサーバー送信イベントの使用

HTTP リクエストを受け入れ、サーバー送信イベント (SSE) のストリームを返す単純なサービスを作成します。クライアントがサーバーへの接続を確立し、ストリーミングを開始すると、接続は開いたままになります。サーバーは接続を再利用して、新しいイベントをクライアントに継続的にプッシュします。リクエストをキャンセルすると、接続が閉じられてストリームが停止し、クライアントがサーバーの更新フォームの受信を停止させます。

前提条件

JDK 8 または JDK 11 がインストールされている。
Maven がインストールされている。
Spring Boot を使用するよう設定されたMaven ベースのアプリケーションプロジェクト

手順

vertx-spring-boot-starter-http をプロジェクトの pom.xml ファイルに依存関係として追加します。

pom.xml

<project>
...
  <dependencies>
  ...
    <dependency>
      <groupId>dev.snowdrop</groupId>
      <artifactId>vertx-spring-boot-starter-http</artifactId>
    </dependency>
  ...
  <dependencies>
...
</project>

アプリケーションのメインクラスを作成します。

SseExampleApplication.java

package dev.snowdrop.vertx.sample.sse;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SseSampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(SseSampleApplication.class, args);
    }
}

アプリケーションのサーバー送信イベントコントローラークラスを作成します。この例では、クラスはランダムな整数のストリームを生成し、それらをターミナルアプリケーションに出力します。

SseController.java

package dev.snowdrop.vertx.sample.sse;

import java.time.Duration;
import java.util.Random;

import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Flux;

@RestController
public class SseController {

    @GetMapping(produces = MediaType.TEXT_EVENT_STREAM_VALUE)
    public Flux<Integer> getRandomNumberStream() {
        Random random = new Random();

        return Flux.interval(Duration.ofSeconds(1))
            .map(i -> random.nextInt())
            .log();
    }
}

オプション: アプリケーションをローカルで実行し、テストします。
1. Maven プロジェクトのルートディレクトリーへ移動します。
```
$ cd myApp
```
2. アプリケーションをパッケージ化します。
```
$ mvn clean package
```
3. コマンドラインからアプリケーションを起動します。
```
$ java -jar target/vertx-spring-boot-sample-sse.jar
```
4. 新しいターミナルウィンドウで、HTTP 要求を localhost に発行します。サーバーから送信されたイベントコントローラーからランダムな整数の連続ストリームの受信を開始します。
```
$ curl localhost:8080
data:-2126721954

data:-573499422

data:1404187823

data:1338766210

data:-666543077
...
```
  Ctrl+C を押して HTTP 要求をキャンセルし、応答のストリームを終了します。

その他のリソース

Fabric8 Maven プラグインを使用して、アプリケーションを OpenShift クラスターにデプロイできます。
また、スタンドアロンの Red Hat Enterprise Linux でのデプロイメント用にアプリケーションを設定することもできます。

サンプルを使用する他に、Eclipse Vert.x スターターで Spring Boot を使用して、新しい Spring Boot アプリケーションをゼロから作成し、それらを OpenShift にデプロイすることもできます。

第6章 Spring Boot ベースのアプリケーションのデバッグ

本セクションでは、ローカルデプロイメントとリモートデプロイメントの両方で Spring Boot ベースのアプリケーションのデバッグについて説明します。

6.1. リモートのデバッグ

アプリケーションをリモートでデバッグするには、まずデバッグモードで開始するように設定してから、デバッガーを割り当てる必要があります。

6.1.1. デバッグモードでの Spring Boot アプリケーションのローカルでの開始

Maven ベースのプロジェクトのデバッグ方法の 1 つは、デバッグポートを指定している間にアプリケーションを手動で起動し、その後にリモートデバッガーをそのポートに接続することです。この方法は、mvn spring-boot:run ゴールを使用してアプリケーションを手動で起動する際に適用できます。

前提条件

Maven ベースのアプリケーション

手順

コンソールで、アプリケーションでディレクトリーに移動します。
アプリケーションを起動し、以下の構文を使用して必要な JVM 引数とデバッグポートを指定します。
```
$ mvn spring-boot:run -Drun.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=$PORT_NUMBER"
```
$PORT_NUMBER は未使用のポート番号です。リモートデバッガー設定のこの番号を覚えておいてください。
JVM を一時停止してリモートデバッガー接続を待つ場合は、アプリケーションを起動する前に suspend を y に変更します。

6.1.2. デバッグモードでの uberjar の起動

アプリケーションを Spring Boot uberjar としてパッケージ化する場合は、以下のパラメーターで実行してデバッグします。

前提条件

アプリケーションによる uberjar

手順

コンソールで、uberjar のディレクトリーに移動します。
以下のパラメーターで uberjar を実行します。行上の uberjar の名前の前に、すべてのパラメーターが指定されていることを確認してください。
```
$ java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=$PORT_NUMBER -jar $UBERJAR_FILENAME
```
$PORT_NUMBER は未使用のポート番号です。リモートデバッガー設定のこの番号を覚えておいてください。
JVM を一時停止してリモートデバッガー接続を待つ場合は、アプリケーションを起動する前に suspend を y に変更します。

6.1.3. デバッグモードでの OpenShift でのアプリケーションの起動

OpenShift で Spring Boot ベースのアプリケーションをリモートでデバッグするには、コンテナー内で JAVA_DEBUG 環境変数を true に設定し、リモートデバッガーからアプリケーションに接続できるようにポート転送を設定する必要があります。

前提条件

アプリケーションが OpenShift で実行している。
マシンにインストールされている oc バイナリー。
ターゲット OpenShift 環境で oc port-forward コマンドを実行する機能。

手順

oc コマンドを使用して、利用可能なデプロイメント設定を一覧表示します。
```
$ oc get dc
```
アプリケーションのデプロイメント設定で JAVA_DEBUG 環境変数を true に設定します。これにより、JVM がデバッグ用にポート番号 5005 を開くように設定されます。以下は例になります。
```
$ oc set env dc/MY_APP_NAME JAVA_DEBUG=true
```
設定変更時に自動的に再デプロイするように設定されていない場合は、アプリケーションを再デプロイします。以下は例になります。
```
$ oc rollout latest dc/MY_APP_NAME
```
ローカルマシンからアプリケーション Pod へのポート転送を設定します。
1. 現在実行中の Pod を一覧表示し、アプリケーションが含まれる Pod を検索します。
```
$ oc get pod
NAME                            READY     STATUS      RESTARTS   AGE
MY_APP_NAME-3-1xrsp          0/1       Running     0          6s
...
```
2. ポート転送を設定します。
```
$ oc port-forward MY_APP_NAME-3-1xrsp $LOCAL_PORT_NUMBER:5005
```
  ここでは、$LOCAL_PORT_NUMBER はローカルマシンで選択した未使用のポート番号になります。リモートデバッガー設定のこの番号をメモします。
デバッグが完了したら、アプリケーション Pod の JAVA_DEBUG 環境変数の設定を解除します。以下は例になります。
```
$ oc set env dc/MY_APP_NAME JAVA_DEBUG-
```

追加リソース

デバッグポートをデフォルト (5005) から変更する場合は、JAVA_DEBUG_PORT 環境変数を設定することもできます。

6.1.4. アプリケーションへのリモートデバッガーの割り当て

デバッグ用にアプリケーションが設定されている場合は、選択したリモートデバッガーを割り当てます。本ガイドでは、Red Hat CodeReady Studio について説明していますが、他のプログラムを使用する場合も手順は同じようになります。

前提条件

ローカルまたは OpenShift 上で実行し、デバッグ用に設定されたアプリケーション。
アプリケーションがデバッグをリッスンしているポート番号。
Red Hat CodeReady Studio がマシンにインストールされている。Red Hat CodeReady Studio ダウンロードページからダウンロードできます。

手順

Red Hat CodeReady Studio を開始します。
アプリケーションの新規デバッグ設定を作成します。
1. Run→Debug Configurations をクリックします。
2. 設定のリストで、Remote Java アプリケーション をダブルクリックします。これにより、新しいリモートデバッグ設定が作成されます。
3. Name フィールドに設定に適した名前を入力します。
4. アプリケーションが含まれるディレクトリーへのパスを Project フィールドに入力します。便宜上、Browse… ボタンを使用できます。
5. Connection Type フィールドを Standard (Socket Attach) に設定していない場合は、これを設定します。
6. Port フィールドを、アプリケーションがデバッグをリッスンしているポート番号に設定します。
7. Apply をクリックします。
Debug Configurations ウィンドウの Debug ボタンをクリックして、デバッグを開始します。
初めてデバッグ設定を迅速に起動するには Run→Debug History をクリックし、一覧から設定を選択します。

追加リソース

Red Hat ナレッジベースの Debug an OpenShift Java Application with JBoss Developer Studio
Red Hat CodeReady Studio はこれまで JBoss Developer Studio と呼ばれていました。
OpenShift ブログの記事 Debugging Java Applications On OpenShift and Kubernetes

6.2. デバッグロギング

6.2.1. Spring Boot デバッグロギングの追加

デバッグロギングをアプリケーションに追加します。

前提条件

デバッグするアプリケーション。たとえば、REST API Level 0 のサンプルです。

手順

ロギングを追加するクラスの org.apache.commons.logging.LogFactory を使用して org.apache.commons.logging.Log オブジェクトを宣言します。
```
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
...
private static Log logger = LogFactory.getLog(TheClass.class);
```
たとえば、REST API Level 0 サンプルの GreetingEndpoint クラスにロギングを追加する場合は、GreetingEndpoint.class を使用します。

logger.debug("my logging message") を使用してデバッグステートメントを追加します。

ロギングステートメントの例

@GET
@Path("/greeting")
@Produces("application/json")
public Greeting greeting(@QueryParam("name") @DefaultValue("World") String name) {
    String message = String.format(properties.getMessage(), name);

    logger.debug("Message: " + message);

    return new Greeting(message);
}

src/main/resources/application.properties に logging.level.fully.qualified.name.of.TheClass=DEBUG を追加します。
たとえば、ロギングステートメントを io.openshift.booster.service.GreetingEndpoint に追加した場合は、以下を使用します。
```
logging.level.io.openshift.booster.service.GreetingEndpoint=DEBUG
```
これにより、DEBUG レベル以上のログメッセージをクラスのログに表示できるようになります。

6.2.2. localhost での Spring Boot デバッグログへのアクセス

アプリケーションを起動し、これと対話してデバッグステートメントを確認します。

前提条件

デバッグロギングが有効になっているアプリケーション。

手順

アプリケーションを起動します。
```
$ mvn spring-boot:run
```
アプリケーションをテストしてデバッグロギングを呼び出します。
たとえば、REST API Level 0 サンプルをテストするには、/api/greeting メソッドを呼び出すことができます。
```
$ curl http://localhost:8080/api/greeting?name=Sarah
```
アプリケーションログを表示して、デバッグメッセージを表示します。
```
i.o.booster.service.GreetingEndpoint     : Message: Hello, Sarah!
```

デバッグロギングを無効にするには、src/main/resources/application.properties から logging.level.fully.qualified.name.of.TheClass=DEBUG を削除し、アプリケーションを再起動します。

6.2.3. OpenShift でのデバッグログへのアクセス

アプリケーションを起動し、これと対話して、OpenShift のデバッグステートメントを確認します。

前提条件

デバッグロギングが有効になっている Maven ベースのアプリケーション。
CLI クライアント oc がインストールされ、認証されている。

手順

アプリケーションを OpenShift にデプロイします。
```
$ mvn clean fabric8:deploy -Popenshift
```
ログを表示します。
1. アプリケーションと共に Pod の名前を取得します。
```
$ oc get pods
```
2. ログ出力の監視を開始します。
```
$ oc logs -f pod/MY_APP_NAME-2-aaaaa
```
  ログ出力を確認できるように、端末ウィンドウにログ出力が表示されます。
アプリケーションと対話します。
たとえば、REST API Level 0 の例にデバッグロギングがあり、/api/greeting メソッドで message 変数をログに記録します。
1. アプリケーションのルートを取得します。
```
$ oc get routes
```
2. アプリケーションの /api/greeting エンドポイントで HTTP 要求を作成します。
```
$ curl $APPLICATION_ROUTE/api/greeting?name=Sarah
```
Pod ログのあるウィンドウに戻り、ログでデバッグロギングメッセージを検査します。
```
i.o.booster.service.GreetingEndpoint     : Message: Hello, Sarah!
```
デバッグロギングを無効にするには、src/main/resources/application.properties から logging.level.fully.qualified.name.of.TheClass=DEBUG を削除し、アプリケーションを再デプロイします。

第7章アプリケーションのモニターリング

このセクションでは、OpenShift で実行する Spring Boot ベースのアプリケーションのモニターリングについて説明します。

7.1. OpenShift でのアプリケーションの JVM メトリクスへのアクセス

7.1.1. OpenShift で Jolokia を使用した JVM メトリクスへのアクセス

Jolokia は、OpenShift 上の HTTP (Java Management Extension) メトリクスにアクセスするための組み込みの軽量ソリューションです。Jolokia を使用すると、HTTP ブリッジ上で JMX によって収集される CPU、ストレージ、およびメモリー使用状況データにアクセスできます。Jolokia は REST インターフェイスおよび JSON 形式のメッセージペイロードを使用します。これは、非常に高速で、リソース要件が低いため、クラウドアプリケーションのモニターリングに適しています。

Java ベースのアプリケーションの場合、OpenShift Web コンソールは、アプリケーションを実行している JVM によって関連するすべてのメトリクス出力を収集し、表示する統合 hawt.io コンソールを提供します。

前提条件

oc クライアントが認証されている。
OpenShift のプロジェクトで実行している Java ベースのアプリケーションコンテナー
最新の JDK 1.8.0 イメージ

手順

プロジェクト内の Pod のデプロイメント設定をリストし、アプリケーションに対応するものを選択します。
```
oc get dc
```
```
NAME         REVISION   DESIRED   CURRENT   TRIGGERED BY
MY_APP_NAME   2          1         1         config,image(my-app:6)
...
```
アプリケーションを実行している Pod の YAML デプロイメントテンプレートを開いて編集します。
```
oc edit dc/MY_APP_NAME
```
以下のエントリーをテンプレートの ports セクションに追加し、変更を保存します。
```
...
spec:
  ...
  ports:
  - containerPort: 8778
    name: jolokia
    protocol: TCP
  ...
...
```
アプリケーションを実行する Pod を再デプロイします。
```
oc rollout latest dc/MY_APP_NAME
```
Pod は更新されたデプロイメント設定で再デプロイされ、ポート 8778 を公開します。
OpenShift Web コンソールにログインします。
サイドバーで、Applications > Pods に移動し、アプリケーションを実行する Pod の名前をクリックします。
Pod の詳細画面で Open Java Console をクリックし、hawt.io コンソールにアクセスします。

追加リソース

hawt.io ドキュメント

第8章利用可能なサンプル Spring Boot

Spring Boot ランタイムは、サンプルアプリケーションを提供します。OpenShift でアプリケーションの開発を開始すると、サンプルアプリケーションをテンプレートとして使用できます。

これらのサンプルアプリケーションは Developer Launcher でアクセスできます。

8.1. Spring Boot の REST API Level 0 サンプル

重要

以下の例は、実稼働環境での実行を目的としていません。

上達度レベルの例: Foundational

REST API Level 0 サンプルでできること

REST API Level 0 サンプルでは、REST フレームワークを使用して、HTTP 経由でビジネスオペレーションをリモートプロシージャコールエンドポイントにマッピングする方法が示されています。これは、Richardson Maturity Model の Level 0 に対応します。REST およびその基本的な原則を使用して HTTP エンドポイントを作成すると、API を柔軟にプロトタイプおよび設計することができます。

この例では、HTTP プロトコルを使用してリモートサービスと対話するためのメカニズムが導入されました。これにより、以下が可能になります。

api/greeting エンドポイントで HTTP GET 要求を実行します。
Hello, World! で設定されるペイロードを使用して JSON 形式でレスポンスを受け取ります。文字列。
String 引数を渡し、api/greeting エンドポイントで HTTP GET 要求を実行します。これにより、クエリー文字列に name 要求パラメーターが使用されます。
Hello, $name! のペイロードを含む JSON 形式の応答を受信します。$name は、要求に渡された name パラメーターの値に置き換えられます。

8.1.1. REST API Level 0 設計トレードオフ

表8.1 設計トレードオフ

利点	悪い点
アプリケーション例では、高速なプロトタイプを有効にします。 API Design は柔軟性があります。 HTTP エンドポイントにより、クライアントは言語に依存しません。	アプリケーションまたはサービスが成熟するにつれて、REST API Level 0 のアプローチは適切にスケーリングされない可能性があります。クリーンな API 設計や、データベースの対話に関するユースケースをサポートしない場合があります。共有された変更可能な状態を含むすべての操作は、適切なバッキングデータストアと統合する必要があります。この API 設計で処理されるすべての要求は、要求に対応するコンテナーにのみスコープ指定されます。これ以降の要求は、同じコンテナーで処理されない可能性があります。

利点

悪い点

アプリケーション例では、高速なプロトタイプを有効にします。
API Design は柔軟性があります。
HTTP エンドポイントにより、クライアントは言語に依存しません。

アプリケーションまたはサービスが成熟するにつれて、REST API Level 0 のアプローチは適切にスケーリングされない可能性があります。クリーンな API 設計や、データベースの対話に関するユースケースをサポートしない場合があります。
- 共有された変更可能な状態を含むすべての操作は、適切なバッキングデータストアと統合する必要があります。
- この API 設計で処理されるすべての要求は、要求に対応するコンテナーにのみスコープ指定されます。これ以降の要求は、同じコンテナーで処理されない可能性があります。

8.1.2. REST API Level 0 サンプルアプリケーションの OpenShift Online へのデプロイメント

以下のオプションのいずれかを使用して、OpenShift Online で REST API Level 0 サンプルアプリケーションを実行します。

developers.redhat.com/launch の使用
CLI クライアント oc の使用

各メソッドは、同じ oc コマンドを使用してアプリケーションをデプロイしますが、developers.redhat.com/launch を使用すると、oc コマンドを実行する自動デプロイメントワークフローが提供されます。

8.1.2.1. developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで developers.redhat.com/launch URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.1.2.2. CLI クライアント `oc` の認証

oc コマンドラインクライアントを使用して OpenShift Online でアプリケーションのサンプルを使用するには、OpenShift Online の Web インターフェイスによって提供されるトークンを使用してクライアントを認証する必要があります。

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで OpenShift Online URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して CLI クライアント oc を OpenShift Online アカウントで認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.1.2.3. CLI クライアント `oc` を使用した REST API Level 0 サンプルアプリケーションのデプロイメント

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。詳細は「developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント」を参照してください。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
OpenShift で新規プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
Maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa               1/1       Running     0          58s
MY_APP_NAME-s2i-1-build           0/1       Completed   0          2m
```
MY_APP_NAME-1-aaaaa Pod は、完全にデプロイされて起動すると、ステータスが Running になるはずです。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。
アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。
ルート情報の例
```
$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME         MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME      MY_APP_NAME      8080
```
Pod のルート情報には、アクセスに使用するベース URL が提供されます。上記の例では、http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスします。

8.1.3. REST API Level 0 サンプルアプリケーションの Minishift または CDK へのデプロイメント

以下のオプションのいずれかを使用して、REST API Level 0 サンプルアプリケーションを Minishift または CDK でローカルに実行します。

Fabric8 Launcher の使用
CLI クライアント oc の使用

各メソッドは、同じ oc コマンドを使用してアプリケーションをデプロイしますが、Fabric8 Launcher を使用すると、oc コマンドを実行する自動デプロイメントワークフローが提供されます。

8.1.3.1. Fabric8 Launcher ツールの URL および認証情報の取得

Minishift または CDK にサンプルアプリケーションを作成してデプロイするには、Fabric8 Launcher ツール URL とユーザー認証情報が必要です。この情報は、Minishift または CDK の起動時に提供されます。

前提条件

Fabric8 Launcher ツールがインストールされ、設定され、実行している。

手順

Minishift または CDK を起動したコンソールに移動します。

実行中の Fabric8 Launcher にアクセスするのに使用できる URL およびユーザー認証情報のコンソール出力を確認します。

Minishift または CDK 起動時のコンソール出力の例

...
-- Removing temporary directory ... OK
-- Server Information ...
   OpenShift server started.
   The server is accessible via web console at:
       https://192.168.42.152:8443

   You are logged in as:
       User:     developer
       Password: developer

   To login as administrator:
       oc login -u system:admin

8.1.3.2. Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Fabric8 Launcher URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.1.3.3. CLI クライアント `oc` の認証

oc コマンドラインクライアントを使用して Minishift または CDK でサンプルアプリケーションを使用するには、Minishift または CDK Web インターフェイスが提供するトークンを使用してクライアントを認証する必要があります。

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Minishift または CDK URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して、Minishift または CDK アカウントで CLI クライアント oc を認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.1.3.4. CLI クライアント `oc` を使用した REST API Level 0 サンプルアプリケーションのデプロイメント

前提条件

Minishift または CDK の Fabric8 Launcher ツールを使用して作成されたサンプルアプリケーション。詳細は「Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント」を参照してください。
Fabric8 Launcher ツールの URL。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
OpenShift で新規プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
Maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa               1/1       Running     0          58s
MY_APP_NAME-s2i-1-build           0/1       Completed   0          2m
```
MY_APP_NAME-1-aaaaa Pod は、完全にデプロイされて起動すると、ステータスが Running になるはずです。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。
アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。
ルート情報の例
```
$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME         MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME      MY_APP_NAME      8080
```
Pod のルート情報には、アクセスに使用するベース URL が提供されます。上記の例では、http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスします。

8.1.4. REST API Level 0 サンプルアプリケーションの OpenShift Container Platform へのデプロイメント

サンプルアプリケーションを OpenShift Container Platform に作成し、デプロイするプロセスは OpenShift Online に似ています。

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。

手順

「REST API Level 0 サンプルアプリケーションの OpenShift Online へのデプロイメント」の説明に従い、OpenShift Container Platform Web コンソールの URL およびユーザー認証情報のみを使用します。

8.1.5. Spring Boot の未変更の REST API Level 0 サンプルアプリケーションとの対話

この例では、GET 要求を受け入れるデフォルトの HTTP エンドポイントを提供します。

前提条件

アプリケーションの実行
curl バイナリーまたは Web ブラウザー

手順

curl を使用して、サンプルに GET 要求を実行します。これを行うには、ブラウザーを使用することもできます。
```
$ curl http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/greeting
{"content":"Hello, World!"}
```
curl を使用して、例に対して URL パラメーター name を付けて GET 要求を実行します。これを行うには、ブラウザーを使用することもできます。
```
$ curl http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/greeting?name=Sarah
{"content":"Hello, Sarah!"}
```

注記

ブラウザーから、例で提供されているフォームを使用して、これらの同じ対話を実行することもできます。フォームは、プロジェクト http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME の root にあります。

8.1.6. REST API Level 0 のサンプルアプリケーション統合テストの実行

このサンプルアプリケーションには、自己完結型の統合テストセットが含まれます。OpenShift プロジェクト内で実行する場合、テストは以下を行います。

アプリケーションのテストインスタンスをプロジェクトにデプロイします。
そのインスタンスで個別のテストを実行します。
テストが完了したら、プロジェクトからアプリケーションのすべてのインスタンスを削除します。

警告

統合テストを実行すると、サンプルアプリケーションの既存インスタンスがすべて、ターゲット OpenShift プロジェクトから削除されます。サンプルアプリケーションが正しく削除されないようにするには、テストを実行するために別の OpenShift プロジェクトを作成して選択してください。

前提条件

認証された oc クライアント。
空の OpenShift プロジェクト。

手順

次のコマンドを実行して統合テストを実行します。

$ mvn clean verify -Popenshift,openshift-it

8.1.7. REST リソース

REST の背景および関連情報は、以下を参照してください。

8.2. Spring Boot の外部化設定の例

重要

以下の例は、実稼働環境での実行を目的としていません。

上達度レベルの例: Foundational

外部化された設定は、ConfigMap を使用して設定を外部化する基本的な例を提供します。ConfigMap は、コンテナーを OpenShift に依存しないようにする一方で、単純なキーと値のペアとして設定データを 1 つ以上の Linux コンテナーに挿入するために OpenShift で使用されるオブジェクトです。

この例では、以下の方法を示しています。

ConfigMap をセットアップし、設定します。
アプリケーション内で ConfigMap によって提供される設定を使用します。
実行中のアプリケーションの ConfigMap 設定に変更をデプロイします。

8.2.1. 外部化された設定の設計パターン

可能な限り、アプリケーション設定を外部化し、アプリケーションコードから分離させます。これにより、異なる環境を通過する際にアプリケーション設定を変更できますが、コードは変更されません。設定を外部化すると、機密情報や内部情報がコードベースやバージョン管理から除外されます。多くの言語およびアプリケーションサーバーは、アプリケーション設定の外部化をサポートする環境変数を提供します。

マイクロサービスアーキテクチャーおよび多言語 (polyglot) 環境は、アプリケーションの設定を管理する複雑な層を追加します。アプリケーションは独立した分散サービスで設定され、それぞれ独自の設定を持つことができます。すべての設定データを同期し、アクセス可能な状態に維持すると、メンテナーンスの課題が発生します。

ConfigMap により、アプリケーション設定を外部化でき、OpenShift 上の個々の Linux コンテナーおよび Pod で使用できます。YAML ファイルの使用を含むさまざまな方法で ConfigMap オブジェクトを作成し、これを Linux コンテナーに挿入できます。ConfigMap を使用すると、設定データのグループ化およびスケーリングが可能です。これにより、基本的な開発、ステージ、および 実稼働 以外の多くの環境を設定できます。ConfigMap の詳細は、 OpenShift ドキュメントを参照してください。

8.2.2. 外部化設定設計のトレードオフ

表8.2 設計のトレードオフ

利点	悪い点
設定がデプロイメントとは分離される個別に更新可能サービス間で共有できる	環境への設定の追加には追加のステップが必要別々に維持する必要があるサービスのスコープを超える調整が必要

8.2.3. 外部化設定のサンプルアプリケーションの OpenShift Online へのデプロイメント

以下のいずれかのオプションを使用して、OpenShift Online で外部化設定アプリケーションを実行します。

developers.redhat.com/launch の使用
CLI クライアント oc の使用

8.2.3.1. developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで developers.redhat.com/launch URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.2.3.2. CLI クライアント `oc` の認証

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで OpenShift Online URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して CLI クライアント oc を OpenShift Online アカウントで認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.2.3.3. CLI クライアント `oc` を使用した Externalized Configuration アプリケーションのデプロイメント

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。詳細は「developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント」を参照してください。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新しい OpenShift プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
サンプルアプリケーションをデプロイする前に、サービスアカウントへの view アクセス権を割り当て、ConfigMap の内容を読み取るためにアプリケーションが OpenShift API にアクセスできるようにします。
```
$ oc policy add-role-to-user view -n $(oc project -q) -z default
```
アプリケーションの root ディレクトリーに移動します。
application.yml を使用して ConfigMap 設定を OpenShift にデプロイします。
```
$ oc create configmap app-config --from-file=application.yml
```

ConfigMap 設定がデプロイされていることを確認します。

$ oc get configmap app-config -o yaml

apiVersion: v1
data:
  application.yml: |
     # This properties file should be used to initialise a ConfigMap
     greeting:
       message: "Hello %s from a ConfigMap!"
...

Maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                                       READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa               1/1       Running     0          58s
MY_APP_NAME-s2i-1-build           0/1       Completed   0          2m
```
MY_APP_NAME-1-aaaaa Pod は、完全にデプロイされて起動すると、ステータスが Running である必要があります。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。
アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。
ルート情報の例
```
$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME         MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME      MY_APP_NAME      8080
```
Pod のルート情報には、アクセスに使用するベース URL が提供されます。上記の例では、http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスします。

8.2.4. 外部化設定アプリケーションの Minishift または CDK へのデプロイメント

以下のオプションのいずれかを使用して、Minishift または CDK で外部設定サンプルアプリケーションをローカルで実行します。

Fabric8 Launcher の使用
CLI クライアント oc の使用

8.2.4.1. Fabric8 Launcher ツールの URL および認証情報の取得

前提条件

Fabric8 Launcher ツールがインストールされ、設定され、実行している。

手順

Minishift または CDK を起動したコンソールに移動します。

実行中の Fabric8 Launcher にアクセスするのに使用できる URL およびユーザー認証情報のコンソール出力を確認します。

Minishift または CDK 起動時のコンソール出力の例

...
-- Removing temporary directory ... OK
-- Server Information ...
   OpenShift server started.
   The server is accessible via web console at:
       https://192.168.42.152:8443

   You are logged in as:
       User:     developer
       Password: developer

   To login as administrator:
       oc login -u system:admin

8.2.4.2. Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Fabric8 Launcher URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.2.4.3. CLI クライアント `oc` の認証

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Minishift または CDK URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して、Minishift または CDK アカウントで CLI クライアント oc を認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.2.4.4. CLI クライアント `oc` を使用した Externalized Configuration アプリケーションのデプロイメント

前提条件

Minishift または CDK の Fabric8 Launcher ツールを使用して作成されたサンプルアプリケーション。詳細は「Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント」を参照してください。
Fabric8 Launcher ツールの URL。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新しい OpenShift プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
サンプルアプリケーションをデプロイする前に、サービスアカウントへの view アクセス権を割り当て、ConfigMap の内容を読み取るためにアプリケーションが OpenShift API にアクセスできるようにします。
```
$ oc policy add-role-to-user view -n $(oc project -q) -z default
```
アプリケーションの root ディレクトリーに移動します。
application.yml を使用して ConfigMap 設定を OpenShift にデプロイします。
```
$ oc create configmap app-config --from-file=application.yml
```

ConfigMap 設定がデプロイされていることを確認します。

$ oc get configmap app-config -o yaml

apiVersion: v1
data:
  application.yml: |
     # This properties file should be used to initialise a ConfigMap
     greeting:
       message: "Hello %s from a ConfigMap!"
...

Maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                                       READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa               1/1       Running     0          58s
MY_APP_NAME-s2i-1-build           0/1       Completed   0          2m
```
MY_APP_NAME-1-aaaaa Pod は、完全にデプロイされて起動すると、ステータスが Running である必要があります。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。
アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。
ルート情報の例
```
$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME         MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME      MY_APP_NAME      8080
```
Pod のルート情報には、アクセスに使用するベース URL が提供されます。上記の例では、http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスします。

8.2.5. 外部設定サンプルアプリケーションの OpenShift Container Platform へのデプロイメント

サンプルアプリケーションを OpenShift Container Platform に作成し、デプロイするプロセスは OpenShift Online に似ています。

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。

手順

「外部化設定のサンプルアプリケーションの OpenShift Online へのデプロイメント」の説明に従い、OpenShift Container Platform Web コンソールの URL およびユーザー認証情報のみを使用します。

8.2.6. Spring Boot の未変更の外部化設定サンプルアプリケーションとの対話

この例では、GET 要求を受け入れるデフォルトの HTTP エンドポイントを提供します。

前提条件

アプリケーションの実行
curl バイナリーまたは Web ブラウザー

手順

curl を使用して、サンプルに GET 要求を実行します。これを行うには、ブラウザーを使用することもできます。
```
$ curl http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/greeting
{"content":"Hello World from a ConfigMap!"}
```
デプロイされた ConfigMap 設定を更新します。
```
$ oc edit configmap app-config
```
greeting.message キーの値を Bonjour! に変更し、ファイルを保存します。これを保存すると、変更は OpenShift インスタンスに伝播されます。
アプリケーションの新規バージョンをデプロイし、ConfigMap 設定の変更が反映されます。
```
$ oc rollout latest dc/MY_APP_NAME
```
例のステータスを確認し、新規 Pod が実行されていることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa       1/1       Running     0          58s
MY_APP_NAME-s2i-1-build   0/1       Completed   0          2m
```
MY_APP_NAME-1-aaaaa Pod は、完全にデプロイされて起動すると、ステータスが Running になるはずです。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。
更新された ConfigMap 設定の例に対して curl を使用して GET リクエストを実行し、更新されたグリーティングを確認します。また、アプリケーションが提供する Web フォームを使用して、ブラウザーから実行することもできます。
```
$ curl http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/greeting
{"content":"Bonjour!"}
```

8.2.7. 外部化設定のサンプルアプリケーションの統合テストの実行

アプリケーションのテストインスタンスをプロジェクトにデプロイします。
そのインスタンスで個別のテストを実行します。
テストが完了したら、プロジェクトからアプリケーションのすべてのインスタンスを削除します。

警告

前提条件

認証された oc クライアント。
空の OpenShift プロジェクト。
サンプルアプリケーションのサービスアカウントに割り当てられたアクセスパーミッションを表示します。これにより、アプリケーションは ConfigMap から設定を読み取ることができます。
```
$ oc policy add-role-to-user view -n $(oc project -q) -z default
```

手順

次のコマンドを実行して統合テストを実行します。

$ mvn clean verify -Popenshift,openshift-it

8.2.8. 外部化設定リソース

外部化設定および ConfigMap の背景および関連情報は、以下を参照してください。

8.3. Spring Boot のリレーショナルデータベースバックエンドのサンプル

重要

以下の例は、実稼働環境での実行を目的としていません。

制限: このサンプルアプリケーションは、Minishift または CDK で実行してください。また、手動のワークフローを使用して、この例を OpenShift Online Pro および OpenShift Container Platform にデプロイすることもできます。この例は、現在 OpenShift Online Starter では使用できません。

上達度レベルの例: Foundational

リレーショナルデータベースバックエンドのサンプル

リレーショナルデータベースバックエンドのサンプルは、REST API Level 0 アプリケーションを拡張して、単純な HTTP API を使用して PostgreSQL データベースで作成、読み取り、更新、削除 (CRUD) 操作を実行する基本的な例を提供します。CRUD 操作は永続ストレージの 4 つの基本的な機能であり、データベースを処理する HTTP API の開発時に広く使用されます。

また、この例では、HTTP アプリケーションが OpenShift のデータベースを特定し、接続する機能も示しています。各ランタイムは、指定のケースで最も適した接続ソリューションを実装する方法を示しています。ランタイムは、API の JDBC、JPA などを使用、または ORM に直接アクセスするなどのオプションを選択できます。

アプリケーションのサンプルは HTTP API を公開し、HTTP で CRUD 操作を実行してデータを操作できるようにするエンドポイントを提供します。CRUD 操作は HTTP Verbs にマップされます。API は JSON フォーマットを使用して要求を受け取りし、ユーザーに応答を返します。また、ユーザーは、サンプルが提供するユーザーインターフェイスを使用して、アプリケーションを使用することもできます。具体的には、この例では以下を可能にするアプリケーションを提供します。

ブラウザーでアプリケーション Web インターフェイスに移動します。これにより、my_data データベースのデータで CRUD 操作を実行する簡単な Web サイトが公開されます。
api/fruits エンドポイントで HTTP GET 要求を実行します。
データベース内のすべての fruits のリストが含まれる JSON 配列としてフォーマットされたレスポンスを受け取ります。
有効なアイテム ID を引数として渡しながら、api/fruits/* エンドポイントで HTTP GET 要求を実行します。
指定した ID を持つ fruit の名前が含まれる JSON 形式で応答を受け取ります。指定された ID に項目がない場合は、呼び出しにより HTTP エラー 404 が発生します。
api/fruits エンドポイントで HTTP POST 要求を実行し、有効な name 値を渡してデータベースの新規エントリーを作成します。
有効な ID と名前を引数として渡して、api/fruits/* エンドポイントで HTTP PUT 要求を実行します。これにより、要求に指定された名前に一致するように、指定の ID を持つ項目の名前が更新されます。
api/fruits/* エンドポイントで HTTP DELETE 要求を実行し、有効な ID を引数として渡します。これにより、指定された ID の項目がデータベースから削除され、応答として HTTP コード 204 (No Content) を返します。無効な ID を渡すと、呼び出しにより HTTP エラー 404 が発生します。

この例には、アプリケーションがデータベースと完全に統合されていることを検証するために使用できる自動化された統合テストのセットも含まれています。

この例では、完全に成熟した RESTful モデル (レベル 3) を紹介していませんが、推奨される HTTP API プラクティスに従って、互換性のある HTTP 動詞とステータスを使用しています。

8.3.1. リレーショナルデータベースバックエンドの設計トレードオフ

表8.3 設計のトレードオフ

利点	悪い点
各ランタイムは、データベースの対話の実装方法を決定します。1 つは JDBC などの低レベルの接続 API を使用し、他の接続では JPA を使用できますが、別の接続は ORM API に直接アクセスできます。各ランタイムは、最適な方法を決定します。各ランタイムはスキーマの作成方法を決定します。	このサンプルアプリケーションで提供される PostgreSQL データベースは永続ストレージではバックアップされていません。データベース Pod を停止または再デプロイすると、データベースへの変更は失われます。変更を保持するために、サンプルアプリケーションの Pod で外部データベースを使用するには、OpenShift ドキュメントの Creating an application with a database を参照してください。また、OpenShift 上のデータベースコンテナーで永続ストレージを設定することもできます。OpenShift およびコンテナーで永続ストレージを使用する方法は、OpenShift ドキュメントの Persistent Storage、Managing Volumes および Persistent Volumes の章を参照してください。

利点

悪い点

各ランタイムは、データベースの対話の実装方法を決定します。1 つは JDBC などの低レベルの接続 API を使用し、他の接続では JPA を使用できますが、別の接続は ORM API に直接アクセスできます。各ランタイムは、最適な方法を決定します。
各ランタイムはスキーマの作成方法を決定します。

このサンプルアプリケーションで提供される PostgreSQL データベースは永続ストレージではバックアップされていません。データベース Pod を停止または再デプロイすると、データベースへの変更は失われます。変更を保持するために、サンプルアプリケーションの Pod で外部データベースを使用するには、OpenShift ドキュメントの Creating an application with a database を参照してください。また、OpenShift 上のデータベースコンテナーで永続ストレージを設定することもできます。OpenShift およびコンテナーで永続ストレージを使用する方法は、OpenShift ドキュメントの Persistent Storage、Managing Volumes および Persistent Volumes の章を参照してください。

8.3.2. リレーショナルデータベースバックエンドのサンプルアプリケーションの OpenShift Online へのデプロイメント

以下のオプションのいずれかを使用して、OpenShift Online でリレーショナルデータベースバックエンドアプリケーションのサンプルアプリケーションを実行します。

developers.redhat.com/launch の使用
CLI クライアント oc の使用

8.3.2.1. developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで developers.redhat.com/launch URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.3.2.2. CLI クライアント `oc` の認証

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで OpenShift Online URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して CLI クライアント oc を OpenShift Online アカウントで認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.3.2.3. CLI クライアント `oc` を使用したリレーショナルデータベースバックエンドのサンプルアプリケーションのデプロイメント

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。詳細は「developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント」を参照してください。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新しい OpenShift プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
PostgreSQL データベースを OpenShift にデプロイします。データベースアプリケーションの作成時に、ユーザー名、パスワード、およびデータベース名に以下の値を使用するようにしてください。これらの値を使用するサンプルアプリケーションが事前設定されています。異なる値を使用すると、アプリケーションがデータベースと統合できなくなります。
```
$ oc new-app -e POSTGRESQL_USER=luke -ePOSTGRESQL_PASSWORD=secret -ePOSTGRESQL_DATABASE=my_data centos/postgresql-10-centos7 --name=my-database
```
データベースのステータスを確認し、Pod が実行中であることを確認します。
```
$ oc get pods -w
my-database-1-aaaaa   1/1       Running   0         45s
my-database-1-deploy   0/1       Completed   0         53s
```
my-database-1-aaaaa Pod のステータスは Running で、完全にデプロイされて起動すると ready と示される必要があります。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。
maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa       1/1       Running     0          58s
MY_APP_NAME-s2i-1-build   0/1       Completed   0          2m
```
MY_APP_NAME-1-aaaaa Pod のステータスは Running で、完全にデプロイされて起動すると ready と示される必要があります。
アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。
ルート情報の例
```
$ oc get routes
NAME                 HOST/PORT                                     PATH      SERVICES             PORT      TERMINATION
MY_APP_NAME   MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME      MY_APP_NAME   8080
```
Pod のルート情報には、アクセスに使用するベース URL が提供されます。上記の例では、http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスします。

8.3.3. リレーショナルデータベースバックエンドのサンプルアプリケーションの Minishift または CDK へのデプロイメント

以下のオプションのいずれかを使用して、Minishift または CDK でローカルで Relational Database Backend サンプルアプリケーションを実行します。

Fabric8 Launcher の使用
CLI クライアント oc の使用

8.3.3.1. Fabric8 Launcher ツールの URL および認証情報の取得

前提条件

Fabric8 Launcher ツールがインストールされ、設定され、実行している。

手順

Minishift または CDK を起動したコンソールに移動します。

実行中の Fabric8 Launcher にアクセスするのに使用できる URL およびユーザー認証情報のコンソール出力を確認します。

Minishift または CDK 起動時のコンソール出力の例

...
-- Removing temporary directory ... OK
-- Server Information ...
   OpenShift server started.
   The server is accessible via web console at:
       https://192.168.42.152:8443

   You are logged in as:
       User:     developer
       Password: developer

   To login as administrator:
       oc login -u system:admin

8.3.3.2. Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Fabric8 Launcher URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.3.3.3. CLI クライアント `oc` の認証

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Minishift または CDK URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して、Minishift または CDK アカウントで CLI クライアント oc を認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.3.3.4. CLI クライアント `oc` を使用したリレーショナルデータベースバックエンドのサンプルアプリケーションのデプロイメント

前提条件

Minishift または CDK の Fabric8 Launcher ツールを使用して作成されたサンプルアプリケーション。詳細は「Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント」を参照してください。
Fabric8 Launcher ツールの URL。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新しい OpenShift プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
PostgreSQL データベースを OpenShift にデプロイします。データベースアプリケーションの作成時に、ユーザー名、パスワード、およびデータベース名に以下の値を使用するようにしてください。これらの値を使用するサンプルアプリケーションが事前設定されています。異なる値を使用すると、アプリケーションがデータベースと統合できなくなります。
```
$ oc new-app -e POSTGRESQL_USER=luke -ePOSTGRESQL_PASSWORD=secret -ePOSTGRESQL_DATABASE=my_data centos/postgresql-10-centos7 --name=my-database
```
データベースのステータスを確認し、Pod が実行中であることを確認します。
```
$ oc get pods -w
my-database-1-aaaaa   1/1       Running   0         45s
my-database-1-deploy   0/1       Completed   0         53s
```
my-database-1-aaaaa Pod のステータスは Running で、完全にデプロイされて起動すると ready と示される必要があります。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。
maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa       1/1       Running     0          58s
MY_APP_NAME-s2i-1-build   0/1       Completed   0          2m
```
MY_APP_NAME-1-aaaaa Pod のステータスは Running で、完全にデプロイされて起動すると ready と示される必要があります。
アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。
ルート情報の例
```
$ oc get routes
NAME                 HOST/PORT                                     PATH      SERVICES             PORT      TERMINATION
MY_APP_NAME   MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME      MY_APP_NAME   8080
```
Pod のルート情報には、アクセスに使用するベース URL が提供されます。上記の例では、http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスします。

8.3.4. リレーショナルデータベースバックエンドのサンプルアプリケーションの OpenShift Container Platform へのデプロイメント

サンプルアプリケーションを OpenShift Container Platform に作成し、デプロイするプロセスは OpenShift Online に似ています。

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。

手順

「リレーショナルデータベースバックエンドのサンプルアプリケーションの OpenShift Online へのデプロイメント」の説明に従い、OpenShift Container Platform Web コンソールの URL およびユーザー認証情報のみを使用します。

8.3.5. Relational Database Backend API との対話

サンプルアプリケーションの作成が完了したら、以下のように対話できます。

前提条件

アプリケーションの実行
curl バイナリーまたは Web ブラウザー

手順

以下のコマンドを実行して、アプリケーションの URL を取得します。

$ oc get route MY_APP_NAME

NAME                 HOST/PORT                                         PATH      SERVICES             PORT      TERMINATION
MY_APP_NAME           MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME              MY_APP_NAME           8080

データベースアプリケーションの Web インターフェイスにアクセスするには、ブラウザーで アプリケーション URL に移動します。

http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME

また、curl を使用して api/fruits/* エンドポイントで要求を直接作成できます。

データベースのエントリーの一覧表示

$ curl http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/fruits

[ {
  "id" : 1,
  "name" : "Apple",
  "stock" : 10
}, {
  "id" : 2,
  "name" : "Orange",
  "stock" : 10
}, {
  "id" : 3,
  "name" : "Pear",
  "stock" : 10
} ]

特定の ID のあるエントリーの取得

$ curl http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/fruits/3

{
  "id" : 3,
  "name" : "Pear",
  "stock" : 10
}

エントリーの新規作成

$ curl -H "Content-Type: application/json" -X POST -d '{"name":"Peach","stock":1}'  http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/fruits

{
  "id" : 4,
  "name" : "Peach",
  "stock" : 1
}

エントリーの更新

$ curl -H "Content-Type: application/json" -X PUT -d '{"name":"Apple","stock":"100"}'  http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/fruits/1

{
  "id" : 1,
  "name" : "Apple",
  "stock" : 100
}

エントリーの削除

$ curl -X DELETE http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/fruits/1

トラブルシューティング

これらのコマンドを実行後に HTTP エラーコード 503 を応答として受け取った場合は、アプリケーションが準備状態にないことを意味します。

8.3.6. リレーショナルデータベースバックエンドのサンプルアプリケーション統合テストの実行

アプリケーションのテストインスタンスをプロジェクトにデプロイします。
そのインスタンスで個別のテストを実行します。
テストが完了したら、プロジェクトからアプリケーションのすべてのインスタンスを削除します。

警告

前提条件

認証された oc クライアント。
空の OpenShift プロジェクト。

手順

次のコマンドを実行して統合テストを実行します。

$ mvn clean verify -Popenshift,openshift-it

8.3.7. リレーショナルデータベースリソース

OpenShift、CRUD、HTTP API、および REST でのリレーショナルデータベースの実行に関する背景および関連情報は、以下を参照してください。

8.4. Spring Boot のヘルスチェックの例

重要

以下の例は、実稼働環境での実行を目的としていません。

上達度レベルの例: Foundational

アプリケーションをデプロイする場合は、アプリケーションが利用可能かどうかを確認し、受信した要求の処理を開始することが重要です。ヘルスチェック パターンを実装すると、アプリケーションが利用できるかどうかや要求に対応できるかどうかなど、アプリケーションの健全性を監視できます。

注記

ヘルスチェックの用語に慣れていない場合は、最初に「ヘルスチェックの概念」セクションを参照してください。

このユースケースの目的は、プローブを使用してヘルスチェックパターンを実証することです。プロービングは、アプリケーションの Liveness および Readiness を報告するために使用されます。このユースケースでは、HTTP health エンドポイントを公開して HTTP 要求を発行するアプリケーションを設定します。コンテナーが動作している場合は、HTTP エンドポイント health の Liveness プローブによると、管理プラットフォームは 200 を戻りコードとして受け取り、それ以上のアクションは必要ありません。HTTP エンドポイント health が応答を返さない場合、たとえばスレッドがブロックされている場合は、Liveness プローブにより、アプリケーションが稼働しているとは見なされません。この場合、プラットフォームはそのアプリケーションに対応する Pod を強制終了し、アプリケーションを再起動するために新規 Pod を再作成します。

このユースケースでは、Readiness プローブを実証し、使用することもできます。アプリケーションが実行していても要求を処理できない場合 (再起動中にアプリケーションが HTTP 応答コード 503 を返す場合など)、このアプリケーションは Readiness プローブにより準備ができていないと見なされます。Readiness プローブによってアプリケーションが準備状態にあるとみなされないと、要求は Readiness プローブにより準備が整っているとみなされるまで、要求はそのアプリケーションにルーティングされません。

8.4.1. ヘルスチェックの概念

ヘルスチェックパターンを理解するには、まず以下の概念を理解する必要があります。

Liveness: Liveness は、アプリケーションが実行しているかどうかを定義します。実行中のアプリケーションが応答しない状態または停止状態に移行する可能性があるため、再起動する必要があります。Liveness の確認は、アプリケーションを再起動する必要があるかどうかを判断するのに役立ちます。
Readines: Readiness は、実行中のアプリケーションが要求を処理できるかどうかを定義します。実行中のアプリケーションがエラーまたは破損状態に切り替わり、要求にサービスを提供することができません。Readiness を確認すると、要求が引き続きそのアプリケーションにルーティングされるべきかどうかが判断されます。
フェイルオーバー: フェイルオーバーにより、サービス要求の失敗が適切に処理されるようになります。アプリケーションが要求のサービスに失敗した場合、その要求と今後の要求は フェイルオーバー または他のアプリケーションにルーティングできます (通常、同じアプリケーションの冗長コピーです)。
耐障害性および安定性: 耐障害性および安定性により、要求処理の失敗を適切に処理できます。接続の損失によりアプリケーションが要求を処理できない場合、耐久性のあるシステムでは、接続が再確立された後にその要求を再試行できます。
プローブ: プローブは実行中のコンテナーで定期的に実行する Kubernetes の動作です。

8.4.2. Health Check サンプルアプリケーションの OpenShift Online へのデプロイメント

以下のオプションのいずれかを使用して、OpenShift Online で Health Check のサンプルアプリケーションを実行します。

developers.redhat.com/launch の使用
CLI クライアント oc の使用

8.4.2.1. developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで developers.redhat.com/launch URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.4.2.2. CLI クライアント `oc` の認証

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで OpenShift Online URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して CLI クライアント oc を OpenShift Online アカウントで認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.4.2.3. CLI クライアント `oc` を使用した Health Check サンプルアプリケーションのデプロイメント

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。詳細は「developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント」を参照してください。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新しい OpenShift プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
Maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa               1/1       Running     0          58s
MY_APP_NAME-s2i-1-build           0/1       Completed   0          2m
```
MY_APP_NAME-1-aaaaa Pod は、完全にデプロイされて起動すると、ステータスが Running になるはずです。また、続行する前に Pod が準備状態になるまで待機する必要があります。これは READY 列に表示されます。たとえば、MY_APP_NAME-1-aaaaa は、READY 列が 1/1 の場合に準備状態になります。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。
アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。
ルート情報の例
```
$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME         MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME      MY_APP_NAME      8080
```
Pod のルート情報には、アクセスに使用するベース URL が提供されます。上記の例では、http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスします。

8.4.3. Health Check のサンプルアプリケーションの Minishift または CDK へのデプロイメント

以下のオプションのいずれかを使用して、Minishift または CDK で Health Check サンプルアプリケーションをローカルで実行します。

Fabric8 Launcher の使用
CLI クライアント oc の使用

8.4.3.1. Fabric8 Launcher ツールの URL および認証情報の取得

前提条件

Fabric8 Launcher ツールがインストールされ、設定され、実行している。

手順

Minishift または CDK を起動したコンソールに移動します。

実行中の Fabric8 Launcher にアクセスするのに使用できる URL およびユーザー認証情報のコンソール出力を確認します。

Minishift または CDK 起動時のコンソール出力の例

...
-- Removing temporary directory ... OK
-- Server Information ...
   OpenShift server started.
   The server is accessible via web console at:
       https://192.168.42.152:8443

   You are logged in as:
       User:     developer
       Password: developer

   To login as administrator:
       oc login -u system:admin

8.4.3.2. Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Fabric8 Launcher URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.4.3.3. CLI クライアント `oc` の認証

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Minishift または CDK URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して、Minishift または CDK アカウントで CLI クライアント oc を認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.4.3.4. CLI クライアント `oc` を使用した Health Check サンプルアプリケーションのデプロイメント

前提条件

Minishift または CDK の Fabric8 Launcher ツールを使用して作成されたサンプルアプリケーション。詳細は「Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント」を参照してください。
Fabric8 Launcher ツールの URL。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新しい OpenShift プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
Maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-1-aaaaa               1/1       Running     0          58s
MY_APP_NAME-s2i-1-build           0/1       Completed   0          2m
```
MY_APP_NAME-1-aaaaa Pod は、完全にデプロイされて起動すると、ステータスが Running になるはずです。また、続行する前に Pod が準備状態になるまで待機する必要があります。これは READY 列に表示されます。たとえば、MY_APP_NAME-1-aaaaa は、READY 列が 1/1 の場合に準備状態になります。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。
アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。
ルート情報の例
```
$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME         MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME      MY_APP_NAME      8080
```
Pod のルート情報には、アクセスに使用するベース URL が提供されます。上記の例では、http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスします。

8.4.4. Health Check サンプルアプリケーションの OpenShift Container Platform へのデプロイメント

サンプルアプリケーションを OpenShift Container Platform に作成し、デプロイするプロセスは OpenShift Online に似ています。

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。

手順

「Health Check サンプルアプリケーションの OpenShift Online へのデプロイメント」の説明に従い、OpenShift Container Platform Web コンソールの URL およびユーザー認証情報のみを使用します。

8.4.5. 未変更の Health Check サンプルアプリケーションとの対話

サンプルアプリケーションをデプロイすると、MY_APP_NAME サービスが実行します。MY_APP_NAME サービスは、以下の REST エンドポイントを公開します。

/api/greeting: 名前を String として返します。
/api/stop: 障害をシミュレーションする手段として、サービスが強制的に応答しなくなります。

以下の手順は、サービスの可用性を確認し、障害をシミュレートする方法を示しています。この利用可能なサービスの障害により、そのサービスで OpenShift の自己修復機能が実行します。

Web インターフェイスを使用して、これらの手順を実施することができます。

curl を使用して、MY_APP_NAME サービスに対して GET 要求を実行します。これを行うには、ブラウザーを使用することもできます。
```
$ curl http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/greeting
```
```
{"content":"Hello, World!"}
```
/api/stop エンドポイントを呼び出して、その直後に /api/greeting エンドポイントの可用性を確認します。
/api/stop エンドポイントを呼び出すと、内部サービスの障害をシミュレートし、OpenShift の自己修復機能をトリガーします。障害のシミュレーション後に /api/greeting を呼び出すと、サービスは Application is not available ページに戻るはずです。
```
$ curl http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/stop
```
(続く)
```
$ curl http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME/api/greeting
```
```
<html>
  <head>
  ...
  </head>
  <body>
    <div>
      <h1>Application is not available</h1>
      ...
    </div>
  </body>
</html>
```
注記
/api/stop エンドポイントを呼び出すと、OpenShift が Pod を削除するタイミングによっては、最初に 404 エラーコードが表示される可能性があります。引き続き /api/greeting エンドポイントを呼び出すと、OpenShift が Pod を削除した後に Application is not available ページが表示されます。
oc get pods -w を使用して、動作中の自己修復機能を継続的に監視します。
サービス障害の呼び出し中に、OpenShift コンソールまたは oc クライアントツールで機能する自己修復機能を確認できます。READY 状態の Pod 数がゼロ (0/1) になり、その後短時間 (1 分未満) で 1 (1/1) に戻ることが確認できるはずです。さらに、サービスの失敗を呼び出すたびに RESTARTS カウントが増加します。
```
$ oc get pods -w
NAME                           READY     STATUS    RESTARTS   AGE
MY_APP_NAME-1-26iy7   0/1       Running   5          18m
MY_APP_NAME-1-26iy7   1/1       Running   5         19m
```
必要に応じて、Web インターフェイスを使用してサービスを呼び出します。
端末ウィンドウを使用した対話では、サービスが提供する Web インターフェイスを使用して、異なるメソッドを起動し、サービスがライフサイクルフェーズを進めるのを監視できます。
```
http://MY_APP_NAME-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME
```

必要に応じて、Web コンソールを使用して、自己修復プロセスの各段階でアプリケーションによって生成されたログ出力を表示します。

プロジェクトに移動します。
サイドバーで Monitoring をクリックします。
画面右上にある Events をクリックし、ログメッセージを表示します。
必要に応じて、View Details をクリックし、Event ログの詳細なビューを表示します。

ヘルスチェックアプリケーションは以下のメッセージを生成します。

メッセージ	Status
Unhealthy	readiness プローブが失敗しました。このメッセージは予想され、`/api/greeting` エンドポイントのシミュレートされた失敗が検出され、自己修復プロセスが開始することを示します。
Killing	サービスを実行している利用不可の Docker コンテナーは、再作成前に強制終了されています。
Pulling	最新バージョンの Docker イメージをダウンロードして、コンテナーを再作成します。
Pulled	Docker イメージが正常にダウンロードされました。
Created	Docker コンテナーが正常に作成されました。
Started	Docker コンテナーが要求を処理する準備が整っている。

8.4.6. Health Check のサンプルアプリケーション統合テストの実行

アプリケーションのテストインスタンスをプロジェクトにデプロイします。
そのインスタンスで個別のテストを実行します。
テストが完了したら、プロジェクトからアプリケーションのすべてのインスタンスを削除します。

警告

前提条件

認証された oc クライアント。
空の OpenShift プロジェクト。

手順

次のコマンドを実行して統合テストを実行します。

$ mvn clean verify -Popenshift,openshift-it

8.4.7. ヘルスチェックリソース

ヘルスチェックの背景および関連情報は、以下を参照してください。

8.5. Spring Boot の Circuit Breaker の例

重要

以下の例は、実稼働環境での実行を目的としていません。

上達度レベルの例: Foundational

Circuit Breaker 例は、サービスの障害を報告し、要求の処理に使用できるまで、失敗したサービスへのアクセスを制限する一般的なパターンを示しています。これにより、障害が発生したサービスの機能に依存する他のサービスでのカスケード障害を防ぐことができます。

この例では、サービスに Circuit Breaker および Fallback パターンを実装する方法を表しています。

8.5.1. サーキットブレーカー設計パターン

Circuit Breaker は、次のことも目的としたパターンです。

ネットワーク障害の影響を低減し、サービスが他のサービスを同期的に呼び出すサービスアーキテクチャーにおける高いレイテンシーを削減します。
いずれかのサービスが以下の状態では:
- ネットワーク障害により利用できない
- 圧倒的なトラフィックが原因で、レイテンシーが異常に高くなる
エンドポイントを呼び出そうとする他のサービスは、エンドポイントに到達しようとして重要なリソースを使い果たし、使用できなくなる可能性があります。
マイクロサービスアーキテクチャー全体が使用できなくなる可能性があるカスケード障害とも呼ばれる状態を防止します。
障害を監視する保護機能とリモート機能の間のプロキシーとして機能します。
障害が特定のしきい値に達すると作動し、サーキットブレーカーへのそれ以降のすべての呼び出しは、保護された呼び出しがまったく行われずに、エラーまたは事前定義されたフォールバック応答を返します。

Circuit Breaker には通常、Circuit Breaker が作動した時に通知するエラー報告メカニズムも含まれます。

Circuit Breaker の実装

Circuit Breaker パターンが実装されると、サービスクライアントは一定間隔でプロキシー経由でリモートサービスエンドポイントを呼び出します。
リモートサービスエンドポイントへの呼び出しが繰り返し一貫して失敗すると、Circuit Breaker が作動し、そのサービスへのすべての呼び出しが、設定されたタイムアウト期間中に即座に失敗し、事前定義されたフォールバック応答を返します。
タイムアウト期間が終了すると、限られた数のテストコールがリモートサービスを通過し、リモートサービスが回復したか、使用できないままであるかを判断できます。
- テストの呼び出しに失敗した場合、Circuit Breaker はサービスを利用できない状態を保ち、受信呼び出しへのフォールバック応答を返し続けます。
- テストに成功すると、Circuit Breaker が閉じ、トラフィックが再度リモートサービスに到達できるようにします。

8.5.2. Circuit Breaker 設計のトレードオフ

表8.4 設計のトレードオフ

利点	悪い点
サービスが、自身が呼び出す他のサービスの障害を処理できるようになる。	タイムアウト値の最適化が困難な場合がある。タイムアウト値を必要以上に大きくすると、レイテンシーが過度に生成される可能性があります。タイムアウトを必要な値より小さくすると、誤検知が発生する可能性があります。

8.5.3. Circuit Breaker サンプルアプリケーションの OpenShift Online へのデプロイメント

以下のオプションのいずれかを使用して、OpenShift Online で Circuit Breaker サンプルアプリケーションを実行します。

developers.redhat.com/launch の使用
CLI クライアント oc の使用

8.5.3.1. developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで developers.redhat.com/launch URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.5.3.2. CLI クライアント `oc` の認証

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで OpenShift Online URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して CLI クライアント oc を OpenShift Online アカウントで認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.5.3.3. CLI クライアント `oc` を使用した Circuit Breaker サンプルアプリケーションのデプロイメント

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。詳細は「developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント」を参照してください。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新しい OpenShift プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
Maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-greeting-1-aaaaa     1/1       Running   0           17s
MY_APP_NAME-greeting-1-deploy    0/1       Completed 0           22s
MY_APP_NAME-name-1-aaaaa         1/1       Running   0           14s
MY_APP_NAME-name-1-deploy        0/1       Completed 0           28s
```
MY_APP_NAME-greeting-1-aaaaa Pod および MY_APP_NAME-name-1-aaaaa Pod の両方には、完全にデプロイおよび起動すると Running のステータスが必要になります。また、続行する前に Pod が準備状態になるまで待機する必要があります。これは READY 列に表示されます。たとえば、MY_APP_NAME-greeting-1-aaaaa は、READY 列が 1/1 の場合に準備状態になります。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。

アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。

ルート情報の例

$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME-greeting   MY_APP_NAME-greeting-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME            MY_APP_NAME-greeting   8080                    None
MY_APP_NAME-name       MY_APP_NAME-name-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME            MY_APP_NAME-name       8080                    None

Pod のルート情報には、アクセスに使用するベース URL が提供されます。上記の例では、http://MY_APP_NAME-greeting-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用し、アプリケーションにアクセスします。

8.5.4. Circuit Breaker サンプルアプリケーションの Minishift または CDK へのデプロイメント

以下のいずれかのオプションを使用して、Minishift または CDK で Circuit Breaker サンプルアプリケーションをローカルで実行します。

Fabric8 Launcher の使用
CLI クライアント oc の使用

8.5.4.1. Fabric8 Launcher ツールの URL および認証情報の取得

前提条件

Fabric8 Launcher ツールがインストールされ、設定され、実行している。

手順

Minishift または CDK を起動したコンソールに移動します。

実行中の Fabric8 Launcher にアクセスするのに使用できる URL およびユーザー認証情報のコンソール出力を確認します。

Minishift または CDK 起動時のコンソール出力の例

...
-- Removing temporary directory ... OK
-- Server Information ...
   OpenShift server started.
   The server is accessible via web console at:
       https://192.168.42.152:8443

   You are logged in as:
       User:     developer
       Password: developer

   To login as administrator:
       oc login -u system:admin

8.5.4.2. Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Fabric8 Launcher URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.5.4.3. CLI クライアント `oc` の認証

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Minishift または CDK URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して、Minishift または CDK アカウントで CLI クライアント oc を認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.5.4.4. CLI クライアント `oc` を使用した Circuit Breaker サンプルアプリケーションのデプロイメント

前提条件

Minishift または CDK の Fabric8 Launcher ツールを使用して作成されたサンプルアプリケーション。詳細は「Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント」を参照してください。
Fabric8 Launcher ツールの URL。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新しい OpenShift プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
Maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift で S2I プロセスを起動し、Pod を起動します。
アプリケーションのステータスを確認し、Pod が実行していることを確認します。
```
$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
MY_APP_NAME-greeting-1-aaaaa     1/1       Running   0           17s
MY_APP_NAME-greeting-1-deploy    0/1       Completed 0           22s
MY_APP_NAME-name-1-aaaaa         1/1       Running   0           14s
MY_APP_NAME-name-1-deploy        0/1       Completed 0           28s
```
MY_APP_NAME-greeting-1-aaaaa Pod および MY_APP_NAME-name-1-aaaaa Pod の両方には、完全にデプロイおよび起動すると Running のステータスが必要になります。また、続行する前に Pod が準備状態になるまで待機する必要があります。これは READY 列に表示されます。たとえば、MY_APP_NAME-greeting-1-aaaaa は、READY 列が 1/1 の場合に準備状態になります。特定の Pod 名が異なります。中間の数字は新規ビルドごとに増えます。末尾の文字は、Pod の作成時に生成されます。

アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。

ルート情報の例

$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME-greeting   MY_APP_NAME-greeting-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME            MY_APP_NAME-greeting   8080                    None
MY_APP_NAME-name       MY_APP_NAME-name-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME            MY_APP_NAME-name       8080                    None

8.5.5. Circuit Breaker サンプルアプリケーションの OpenShift Container Platform へのデプロイメント

サンプルアプリケーションを OpenShift Container Platform に作成し、デプロイするプロセスは OpenShift Online に似ています。

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。

手順

「Circuit Breaker サンプルアプリケーションの OpenShift Online へのデプロイメント」の説明に従い、OpenShift Container Platform Web コンソールの URL およびユーザー認証情報のみを使用します。

8.5.6. 未変更の Spring Boot Circuit Breaker サンプルアプリケーションとの対話

Spring Boot のサンプルアプリケーションをデプロイした後に、以下のサービスが実行されます。

MY_APP_NAME-name

以下のエンドポイントを公開します。

このサービスの稼働時に名前を返す /api/name エンドポイントと、このサービスが失敗を実証するように設定されたときにエラーが返されます。
/api/state エンドポイント: /api/name エンドポイントの動作を制御し、サービスが正しく機能するか、または失敗を実証するかどうかを判断します。

MY_APP_NAME-greeting

以下のエンドポイントを公開します。

パーソナライズされたグリーティング応答を取得するために呼び出す /api/greeting エンドポイント。
/api/greeting エンドポイントを呼び出すと、要求の処理の一環として、MY_APP_NAME-name サービスの /api/name エンドポイントに対して呼び出しを実行します。/api/name エンドポイントに対する呼び出しは、Circuit Breaker によって保護されます。
リモートエンドポイントが利用可能な場合、name サービスは HTTP コード 200 (OK) で応答し、/api/greeting エンドポイントから以下のグリーティングを受け取ります。
```
{"content":"Hello, World!"}
```
リモートエンドポイントが利用できない場合、name サービスは HTTP コード 500 (Internal server error) で応答し、/api/greeting エンドポイントから事前定義されたフォールバック応答を受け取ります。
```
{"content":"Hello, Fallback!"}
```
Circuit Breaker の状態を返す /api/cb-state エンドポイント。状態は次のいずれかです。
- open: サーキットブレーカーにより、失敗したサービスに要求が到達できないようになります。
- closed: サーキットブレーカーにより、要求がサービスに到達できるようになります。

以下の手順は、サービスの可用性を確認し、障害をシミュレートしてフォールバック応答を受け取る方法を示しています。

curl を使用して、MY_APP_NAME-greeting サービスに対して GET 要求を実行します。これを行うには、Web インターフェイスの Invoke ボタンを使用することもできます。
```
$ curl http://MY_APP_NAME-greeting-MY_PROJECT_NAME.LOCAL_OPENSHIFT_HOSTNAME/api/greeting
{"content":"Hello, World!"}
```
MY_APP_NAME-name サービスの失敗をシミュレートするには、以下を行います。
- Web インターフェイスで トグル ボタンを使用します。
- MY_APP_NAME-name サービスを実行している Pod のレプリカ数を 0 にスケーリングします。
- MY_APP_NAME-name サービスの /api/state エンドポイントに対して HTTP PUT 要求を実行し、その状態を fail に設定します。
```
$ curl -X PUT -H "Content-Type: application/json" -d '{"state": "fail"}' http://MY_APP_NAME-name-MY_PROJECT_NAME.LOCAL_OPENSHIFT_HOSTNAME/api/state
```
/api/greeting エンドポイントを呼び出します。/api/name エンドポイントで複数の要求が失敗する場合:
1. Circuit Breaker が開きます。
2. Web インターフェイスの状態インジケーターが CLOSED から OPEN に変わります。
3. /api/greeting エンドポイントを呼び出すと、Circuit Breaker はフォールバック応答を実行します。
```
$ curl http://MY_APP_NAME-greeting-MY_PROJECT_NAME.LOCAL_OPENSHIFT_HOSTNAME/api/greeting
{"content":"Hello, Fallback!"}
```
名前 MY_APP_NAME-name サービスを、可用性に戻します。これを行うには、以下を行います。
- Web インターフェイスで トグル ボタンを使用します。
- MY_APP_NAME-name サービスを実行する Pod のレプリカ数を 1 にスケーリングします。
- MY_APP_NAME-name サービスの /api/state エンドポイントに対して HTTP PUT 要求を実行し、その状態を OK に戻します。
```
$ curl -X PUT -H "Content-Type: application/json" -d '{"state": "ok"}' http://MY_APP_NAME-name-MY_PROJECT_NAME.LOCAL_OPENSHIFT_HOSTNAME/api/state
```
/api/greeting エンドポイントを再度呼び出します。/api/name エンドポイントでの複数の要求が正常に実行される場合:
1. Circuit Breaker が閉じます。
2. Web インターフェイスの状態インジケーターが OPEN から CLOSED に変わります。
3. Circuit Breaker は、/api/greeting エンドポイントを呼び出す際に Hello World! グリーティングを返します。
```
$ curl http://MY_APP_NAME-greeting-MY_PROJECT_NAME.LOCAL_OPENSHIFT_HOSTNAME/api/greeting
{"content":"Hello, World!"}
```

8.5.7. Circuit Breaker サンプルアプリケーション統合テストの実行

アプリケーションのテストインスタンスをプロジェクトにデプロイします。
そのインスタンスで個別のテストを実行します。
テストが完了したら、プロジェクトからアプリケーションのすべてのインスタンスを削除します。

警告

前提条件

認証された oc クライアント。
空の OpenShift プロジェクト。

手順

次のコマンドを実行して統合テストを実行します。

$ mvn clean verify -Popenshift,openshift-it

8.5.8. Hystrix Dashboard を使用したサーキットブレーカーの監視

Histrix Dashboard を使用すると、イベントストリームから Histrix メトリクスデータを集計し、それを 1 つの画面で表示することで、サービスの正常性を簡単にリアルタイムで監視できます。

前提条件

アプリケーションがデプロイされている。

手順

Minishift または CDK クラスターにログインします。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```
Web コンソールにアクセスするには、ブラウザーを使用して Minishift または CDK URL に移動します。
Circuit Breaker アプリケーションが含まれるプロジェクトに移動します。
```
$ oc project MY_PROJECT_NAME
```
Hystrix Dashboard アプリケーションの YAML テンプレートをインポートします。そのためには、Add to Project をクリックしてから Import YAML / JSON タブを選択し、YAML ファイルの内容をテキストボックスにコピーします。または、次のコマンドを実行できます。
```
$ oc create -f https://raw.githubusercontent.com/snowdrop/openshift-templates/master/hystrix-dashboard/hystrix-dashboard.yml
```
Create ボタンをクリックして、テンプレートに基づいて Histrix Dashboard アプリケーションを作成します。または、次のコマンドを実行できます。
```
$ oc new-app --template=hystrix-dashboard
```
Hystrix Dashboard が含まれる Pod がデプロイされるまで待機します。

Hystrix Dashboard アプリケーションのルートを取得します。

$ oc get route hystrix-dashboard
NAME                HOST/PORT                                                    PATH      SERVICES            PORT      TERMINATION   WILDCARD
hystrix-dashboard   hystrix-dashboard-MY_PROJECT_NAME.LOCAL_OPENSHIFT_HOSTNAME                 hystrix-dashboard   <all>                   None

Dashboard にアクセスするには、ブラウザーで Dashboard アプリケーションルート URL を開きます。Web コンソールの Overview 画面に移動し、Hystrix Dashboard アプリケーションが含まれる Pod の上にあるヘッダーのルート URL をクリックします。
Dashboard を使用して MY_APP_NAME-greeting サービスを監視するには、デフォルトのイベントストリームアドレスを以下のアドレスに置き換え、Monitor Stream ボタンをクリックします。
```
http://MY_APP_NAME-greeting-MY_PROJECT_NAME.LOCAL_OPENSHIFT_HOSTNAME/hystrix.stream
```

関連情報

Histrix Dashboard wiki ページ

8.5.9. サーキットブレーカーリソース

Circuit Breaker パターンの背後にある設計原則に関する背景情報については、以下のリンクを参照してください。

8.6. Spring Boot のセキュアなサンプルアプリケーション

重要

以下の例は、実稼働環境での実行を目的としていません。

上達度レベルの例: Advanced

Secured サンプルアプリケーションは、Red Hat SSO を使用して REST エンドポイントを保護します。この例では、REST API Level 0 の例に展開されます。

Red Hat SSO:

OAuth 2.0 仕様のエクステンションである Open ID Connect プロトコルを実装します。
アクセストークンを発行し、セキュアなリソースに対するさまざまなアクセス権限をクライアントに提供します。

SSO でアプリケーションをセキュアにすると、セキュリティー設定を一元化しつつ、アプリケーションにセキュリティーを追加することができます。

重要

この例では、デモ目的で Red Hat SSO が事前設定されたので、その原則、使用方法、または設定を説明しません。この例を使用する前に、Red Hat SSO に関する基本的な概念を理解していることを確認してください。

8.6.1. Secured プロジェクト構造

SSO のサンプルには以下が含まれます。

保護するつもりである Greeting サービスのソース
SSO サーバーをデプロイするテンプレートファイル (service.sso.yaml)
サービスのセキュリティーを保護するように Keycloak アダプターの設定

8.6.2. Red Hat SSO デプロイメントの設定

この例の service.sso.yaml ファイルには、事前設定された Red Hat SSO サーバーをデプロイするすべての OpenShift 設定項目が含まれます。SSO サーバーの設定は、このサンプルのために簡略化されており、ユーザーとセキュリティー設定が事前に設定された、すぐに使用できる設定を提供します。service.sso.yaml ファイルには非常に長い行が含まれ、gedit などの一部のテキストエディターでは、このファイルの読み取りに問題がある場合があります。

警告

実稼働環境では、この SSO 設定を使用することは推奨されません。具体的には、セキュリティー設定の例に追加された単純化は、実稼働環境での使用に影響を及ぼします。

表8.5 SSO サンプルの簡素化

変更点	理由	推奨事項
デフォルト設定には、yaml 設定ファイルに公開鍵と秘密鍵の両方が含まれます。	これを行ったのは、エンドユーザーが Red Hat SSO モジュールをデプロイして、内部や Red Hat SSO の設定方法を知らなくても使用可能な状態にすることができるためです。	実稼働環境では、秘密鍵をソース制御に保存しないでください。サーバー管理者が追加する必要があります。
設定済みのクライアントがコールバック URL を受け入れます。	各ランタイムにカスタム設定を使用しないように、OAuth2 仕様で必要なコールバックの検証を回避します。	アプリケーション固有のコールバック URL には、有効なドメイン名を指定する必要があります。
クライアントには SSL/TLS が必要ありません。また、セキュアなアプリケーションは HTTPS 上で公開されません。	この例は、ランタイムごとに証明書を生成する必要がないことで単純化されます。	実稼働環境では、セキュアなアプリケーションは単純な HTTP ではなく HTTPS を使用する必要があります。
トークンのタイムアウトがデフォルトの 1 分から 10 分に増えました。	コマンドラインの例を使用した場合のユーザーエクスペリエンスを向上します。	セキュリティーの観点から、攻撃者はアクセストークンが拡張されていると推測する必要があるウィンドウ。潜在的な攻撃者が現在のトークンを推測するのがより困難になるため、このウィンドウを短くすることが推奨されます。

8.6.3. Red Hat SSO レルムモデル

master レルムは、この例のセキュリティーを保護するために使用されます。コマンドラインクライアントとセキュアな REST エンドポイントのモデルを提供する事前設定されたアプリケーションクライアント定義は 2 つあります。

また、Red Hat SSO の master レルムには、admin および alice のさまざまな認証および認可の結果の検証に使用できる 2 つの事前設定されたユーザーも存在します。

8.6.3.1. Red Hat SSO ユーザー

セキュリティーが保護された例のレルムモデルには、ユーザーが 2 つ含まれます。

admin

admin ユーザーのパスワードは admin で、レルム管理者です。このユーザーは Red Hat SSO 管理コンソールに完全アクセスできますが、セキュアなエンドポイントへのアクセスに必要なロールマッピングはありません。このユーザーを使用して、認証されていて認可されていないユーザーの動作を説明できます。

alice

alice ユーザーには password のパスワードがあり、正規のアプリケーションユーザーです。このユーザーは、セキュアなエンドポイントへの認証および認可が成功したアクセスを実証します。ロールマッピングの例は、デコードされた JWT ベアラートークンにあります。

{
  "jti": "0073cfaa-7ed6-4326-ac07-c108d34b4f82",
  "exp": 1510162193,
  "nbf": 0,
  "iat": 1510161593,
  "iss": "https://secure-sso-sso.LOCAL_OPENSHIFT_HOSTNAME/auth/realms/master", 1
  "aud": "demoapp",
  "sub": "c0175ccb-0892-4b31-829f-dda873815fe8",
  "typ": "Bearer",
  "azp": "demoapp",
  "nonce": "90ff5d1a-ba44-45ae-a413-50b08bf4a242",
  "auth_time": 1510161591,
  "session_state": "98efb95a-b355-43d1-996b-0abcb1304352",
  "acr": "1",
  "client_session": "5962112c-2b19-461e-8aac-84ab512d2a01",
  "allowed-origins": [
    "*"
  ],
  "realm_access": {
    "roles": [ 2
      "example-admin"
    ]
  },
  "resource_access": { 3
    "secured-example-endpoint": {
      "roles": [
        "example-admin" 4
      ]
    },
    "account": {
      "roles": [
        "manage-account",
        "view-profile"
      ]
    }
  },
  "name": "Alice InChains",
  "preferred_username": "alice", 5
  "given_name": "Alice",
  "family_name": "InChains",
  "email": "alice@keycloak.org"
}

1: iss フィールドは、トークンを発行する Red Hat SSO レルムインスタンス URL に対応します。トークンを検証するには、セキュアなエンドポイントデプロイメントで設定する必要があります。
2: roles オブジェクトは、グローバルレルムレベルでユーザーに付与されたロールを提供します。この例では、alice には example-admin ロールが付与されています。セキュリティーが保護されたエンドポイントが認可されたロールのレルムレベルを検索していることを確認できます。
3: resource_access オブジェクトには、リソースの固有のロール付与が含まれます。このオブジェクトの下には、セキュアな各エンドポイントのオブジェクトを見つけます。
4: resource_access.secured-example-endpoint.roles オブジェクトには、secured-example-endpoint リソースの alice に付与されるロールが含まれます。
5: preferred_username フィールドは、アクセストークンの生成に使用したユーザー名を提供します。

8.6.3.2. アプリケーションクライアント

OAuth 2.0 仕様では、リソースの所有者の代わりにセキュアなリソースにアクセスするアプリケーションクライアントのロールを定義することができます。master レルムには、以下のアプリケーションクライアントが定義されています。

demoapp: これは、アクセストークンの取得に使用されるクライアントシークレットを持つ confidential タイプのクライアントです。トークンには alice ユーザーの権限が含まれ、alice が Thorntail、Eclipse Vert.x、Node.js、および Spring Boot ベースの REST サンプルアプリケーションデプロイメントにアクセスできるようにします。
secured-example-endpoint: secured-example-endpoint は、関連するリソース (特に Greeting サービス) にアクセスするために example-admin ロールを必要とするベアラーのみのクライアントタイプです。

8.6.4. Spring Boot SSO アダプターの設定

SSO アダプターは クライアント側、または SSO サーバーのクライアントで、Web リソースのセキュリティーを強制するコンポーネントです。ここでは、これは Greeting サービスです。

SSO アダプターとエンドポイントセキュリティーの両方が src/main/resources/application.properties で設定されます。

application.properties ファイルの例

$ # Adapter configuration
keycloak.realm=${realm:master} 1
keycloak.realm-key=...
keycloak.auth-server-url=${sso.auth.server.url} 2
keycloak.resource=${client.id:secured-example-endpoint} 3
keycloak.credentials.secret=${secret:1daa57a2-b60e-468b-a3ac-25bd2dc2eadc} 4
keycloak.use-resource-role-mappings=true 5
keycloak.bearer-only=true 6
# Endpoint security configuration
keycloak.securityConstraints[0].securityCollections[0].name=admin stuff 7
keycloak.securityConstraints[0].securityCollections[0].authRoles[0]=example-admin 8
keycloak.securityConstraints[0].securityCollections[0].patterns[0]=/api/greeting 9

1: 使用するセキュリティーレルム。
2: Red Hat SSO サーバーのアドレス (ビルド時の補間)。
3: 実際の keycloak クライアント の設定。
4: 認証サーバーにアクセスするためのシークレット
5: ユーザーのアプリケーションレベルのロールマッピングのトークンを確認します。
6: 有効な場合、アダプターはユーザーの認証を試行しませんが、ベアラートークンのみを検証します。
7: セキュリティー制約の単純名。
8: セキュアなエンドポイントへのアクセスに必要なロール。
9: セキュアなエンドポイントパスパターン。

8.6.5. Secured サンプルアプリケーションの Minishift または CDK へのデプロイメント

8.6.5.1. Fabric8 Launcher ツールの URL および認証情報の取得

前提条件

Fabric8 Launcher ツールがインストールされ、設定され、実行している。

手順

Minishift または CDK を起動したコンソールに移動します。

実行中の Fabric8 Launcher にアクセスするのに使用できる URL およびユーザー認証情報のコンソール出力を確認します。

Minishift または CDK 起動時のコンソール出力の例

...
-- Removing temporary directory ... OK
-- Server Information ...
   OpenShift server started.
   The server is accessible via web console at:
       https://192.168.42.152:8443

   You are logged in as:
       User:     developer
       Password: developer

   To login as administrator:
       oc login -u system:admin

8.6.5.2. Fabric8 Launcher を使用した Secured サンプルアプリケーションの作成

前提条件

実行中の Fabric8 Launcher インスタンスの URL およびユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Fabric8 Launcher URL に移動し、ログインします。
画面の指示に従って、Spring Boot にサンプルを作成します。デプロイメントタイプについて尋ねられたら、ローカルで構築して実行します。
画面の指示に従ってください。
完了したら、Download as ZIP file ボタンをクリックし、ファイルをハードドライブに保存します。

8.6.5.3. CLI クライアント `oc` の認証

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Minishift または CDK URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して、Minishift または CDK アカウントで CLI クライアント oc を認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.6.5.4. CLI クライアント `oc` を使用した Secured サンプルアプリケーションのデプロイメント

前提条件

Minishift または CDK の Fabric8 Launcher ツールを使用して作成されたサンプルアプリケーション。詳細は「Fabric8 Launcher を使用した Secured サンプルアプリケーションの作成」を参照してください。
Fabric8 Launcher URL。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新しい OpenShift プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
サンプルの ZIP ファイルから service.sso.yaml ファイルを使用して Red Hat SSO サーバーをデプロイします。
```
$ oc create -f service.sso.yaml
```
Maven を使用して Minishift または CDK へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift -DskipTests \
      -DSSO_AUTH_SERVER_URL=$(oc get route secure-sso -o jsonpath='{"https://"}{.spec.host}{"/auth\n"}')
```
このコマンドは、Fabric8 Maven Plugin を使用して Minishift または CDK で S2I プロセスを起動し、Pod を起動します。

このプロセスは、uberjar ファイルと OpenShift リソースを生成し、それらを Minishift または CDK サーバーの現在のプロジェクトにデプロイします。

8.6.6. Secured サンプルアプリケーションの OpenShift Container Platform へのデプロイメント

Minishift または CDK の他に、マイナーな相違点のみが OpenShift Container Platform にサンプルを作成し、デプロイできます。最も重要な相違点は、OpenShift Container Platform でデプロイする前に、Minishift または CDK にサンプルアプリケーションを作成する必要があります。

前提条件

Minishift または CDK を使用して作成された例

8.6.6.1. CLI クライアント `oc` の認証

コマンドラインクライアント oc を使用して OpenShift Container Platform のサンプルアプリケーションを使用するには、OpenShift Container Platform Web インターフェイスによって提供されるトークンを使用してクライアントを認証する必要があります。

前提条件

Red Hat OpenShift Container Platform のアカウント

手順

ブラウザーで OpenShift Container Platform URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して CLI クライアント oc を OpenShift Container Platform アカウントで認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.6.6.2. CLI クライアント `oc` を使用した Secured サンプルアプリケーションのデプロイメント

前提条件

Minishift または CDK の Fabric8 Launcher ツールを使用して作成されたサンプルアプリケーション。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新しい OpenShift プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
サンプルの ZIP ファイルから service.sso.yaml ファイルを使用して Red Hat SSO サーバーをデプロイします。
```
$ oc create -f service.sso.yaml
```
Maven を使用して OpenShift Container Platform へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift -DskipTests \
      -DSSO_AUTH_SERVER_URL=$(oc get route secure-sso -o jsonpath='{"https://"}{.spec.host}{"/auth\n"}')
```
このコマンドは、Fabric8 Maven プラグインを使用して OpenShift Container Platform で S2I プロセスを起動し、Pod を起動します。

このプロセスは、uberjar ファイルと OpenShift リソースを生成し、それらを OpenShift Container Platform サーバーの現在のプロジェクトにデプロイします。

8.6.7. Secured サンプルアプリケーション API エンドポイントへの認証

Secured サンプルアプリケーションは、呼び出し元が認証および認可されている場合に GET 要求を受け入れるデフォルトの HTTP エンドポイントを提供します。クライアントは最初に Red Hat SSO サーバーに対して認証を行い、認証手順によって返されるアクセストークンを使用して Secured サンプルアプリケーションに対して GET 要求を実行します。

8.6.7.1. Secured サンプルアプリケーション API エンドポイントの取得

クライアントを使用して例を操作する場合は、PROJECT_ID サービスである Secured サンプルアプリケーションのエンドポイントを指定する必要があります。

前提条件

Secured サンプルアプリケーションがデプロイされ、実行します。
認証された oc クライアント。

手順

端末アプリケーションで、oc get routes コマンドを実行します。

以下の表の出力例を以下に示します。

例8.1 Secured エンドポイントの一覧

名前	ホスト/ポート	サービス	ポート	終了
secure-sso	secure-sso-myproject.LOCAL_OPENSHIFT_HOSTNAME	secure-sso	(すべて)	passthrough
PROJECT_ID	PROJECT_ID-myproject.LOCAL_OPENSHIFT_HOSTNAME	PROJECT_ID	(すべて)
sso	sso-myproject.LOCAL_OPENSHIFT_HOSTNAME	sso	(すべて)

上記の例では、サンプルエンドポイントは http://PROJECT_ID-myproject.LOCAL_OPENSHIFT_HOSTNAME になります。PROJECT_ID は、developers.redhat.com/launch または Fabric8 Launcher ツールを使用してサンプルを生成する際に入力した名前に基づいています。

8.6.7.2. コマンドラインを使用した HTTP 要求の認証

HTTP POST 要求を Red Hat SSO サーバーに送信してトークンを要求します。以下の例では、CLI ツール jq を使用して JSON 応答からトークン値を抽出します。

前提条件

セキュアなサンプルエンドポイント URL。詳細は「Secured サンプルアプリケーション API エンドポイントの取得」を参照してください。
jq コマンドラインツール (任意)。ツールのダウンロードと、詳細な情報は、https://stedolan.github.io/jq/ を参照してください。

手順

curl、認証情報、<SSO_AUTH_SERVER_URL> でアクセストークンを要求し、jq コマンドを使用して応答からトークンを展開します。

curl -sk -X POST https://<SSO_AUTH_SERVER_URL>/auth/realms/master/protocol/openid-connect/token \
  -d grant_type=password \
  -d username=alice\
  -d password=password \
  -d client_id=demoapp \
  -d client_secret=1daa57a2-b60e-468b-a3ac-25bd2dc2eadc \
  | jq -r '.access_token'

eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJRek1nbXhZMUhrQnpxTnR0SnkwMm5jNTNtMGNiWDQxV1hNSTU1MFo4MGVBIn0.eyJqdGkiOiI0NDA3YTliNC04YWRhLTRlMTctODQ2ZS03YjI5MjMyN2RmYTIiLCJleHAiOjE1MDc3OTM3ODcsIm5iZiI6MCwiaWF0IjoxNTA3NzkzNzI3LCJpc3MiOiJodHRwczovL3NlY3VyZS1zc28tc3NvLWRlbW8uYXBwcy5jYWZlLWJhYmUub3JnL2F1dGgvcmVhbG1zL21hc3RlciIsImF1ZCI6ImRlbW9hcHAiLCJzdWIiOiJjMDE3NWNjYi0wODkyLTRiMzEtODI5Zi1kZGE4NzM4MTVmZTgiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJkZW1vYXBwIiwiYXV0aF90aW1lIjowLCJzZXNzaW9uX3N0YXRlIjoiMDFjOTkzNGQtNmZmOS00NWYzLWJkNWUtMTU4NDI5ZDZjNDczIiwiYWNyIjoiMSIsImNsaWVudF9zZXNzaW9uIjoiMzM3Yzk0MTYtYTdlZS00ZWUzLThjZWQtODhlODI0MGJjNTAyIiwiYWxsb3dlZC1vcmlnaW5zIjpbIioiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbImJvb3N0ZXItYWRtaW4iXX0sInJlc291cmNlX2FjY2VzcyI6eyJzZWN1cmVkLWJvb3N0ZXItZW5kcG9pbnQiOnsicm9sZXMiOlsiYm9vc3Rlci1hZG1pbiJdfSwiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsInZpZXctcHJvZmlsZSJdfX0sIm5hbWUiOiJBbGljZSBJbkNoYWlucyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFsaWNlIiwiZ2l2ZW5fbmFtZSI6IkFsaWNlIiwiZmFtaWx5X25hbWUiOiJJbkNoYWlucyIsImVtYWlsIjoiYWxpY2VAa2V5Y2xvYWsub3JnIn0.mjmZe37enHpigJv0BGuIitOj-kfMLPNwYzNd3n0Ax4Nga7KpnfytGyuPSvR4KAG8rzkfBNN9klPYdy7pJEeYlfmnFUkM4EDrZYgn4qZAznP1Wzy1RfVRdUFi0-GqFTMPb37o5HRldZZ09QljX_j3GHnoMGXRtYW9RZN4eKkYkcz9hRwgfJoTy2CuwFqeJwZYUyXifrfA-JoTr0UmSUed-0NMksGrtJjjPggUGS-qOn6OgKcmN2vaVAQlxW32y53JqUXctfLQ6DhJzIMYTmOflIPy0sgG1mG7sovQhw1xTg0vTjdx8zQ-EJcexkj7IivRevRZsslKgqRFWs67jQAFQA

<SSO_AUTH_SERVER_URL> は secure-sso サービスの URL です。

通常、username、password、client_secret などの属性は、通常、秘密になりますが、上記のコマンドはこの例で提供されているデフォルトの認証情報をデモの目的で使用します。

jq を使用してトークンを抽出しない場合は、curl コマンドのみを実行し、アクセストークンを手動で抽出できます。

注記

-sk オプションは curl に対し、自己署名証明書の失敗を無視します。実稼働環境ではこのオプションを使用しないでください。macOS では、curl バージョン 7.56.1 以降がインストールされている必要があります。また、OpenSSL でビルドする必要があります。

Secured サービスを起動します。アクセス (ベアラー) トークンを HTTP ヘッダーに割り当てます。
```
$ curl -v -H "Authorization: Bearer <TOKEN>" http://<SERVICE_HOST>/api/greeting

{
    "content": "Hello, World!",
    "id": 2
}
```
例8.2 Access (Bearer) トークンが含まれる GET 要求ヘッダーのサンプル
```
> GET /api/greeting HTTP/1.1
> Host: <SERVICE_HOST>
> User-Agent: curl/7.51.0
> Accept: */*
> Authorization: Bearer <TOKEN>
```
<SERVICE_HOST> は、セキュアなサンプルエンドポイントの URL です。詳細は「Secured サンプルアプリケーション API エンドポイントの取得」を参照してください。
アクセストークンの署名を確認します。
アクセストークンは JSON Web トークンであるため、JWT デバッガーを使用してデコードできます。
1. Web ブラウザーで、JWT デバッガーの Web サイトに移動します。
2. Algorithm ドロップダウンメニューから RS256 を選択します。
  注記
  選択後に Web フォームが更新され、正しい RSASHA256(…) 情報が Signature セクションに表示されることを確認します。そうでない場合は、HS256 に切り替えてから RS256 に戻ります。
3. 上部のテキストボックスの VERIFY SIGNATURE セクションに以下のコンテンツを貼り付けます。
```
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoETnPmN55xBJjRzN/cs30OzJ9olkteLVNRjzdTxFOyRtS2ovDfzdhhO9XzUcTMbIsCOAZtSt8K+6yvBXypOSYvI75EUdypmkcK1KoptqY5KEBQ1KwhWuP7IWQ0fshUwD6jI1QWDfGxfM/h34FvEn/0tJ71xN2P8TI2YanwuDZgosdobx/PAvlGREBGuk4BgmexTOkAdnFxIUQcCkiEZ2C41uCrxiS4CEe5OX91aK9HKZV4ZJX6vnqMHmdDnsMdO+UFtxOBYZio+a1jP4W3d7J5fGeiOaXjQCOpivKnP2yU2DPdWmDMyVb67l8DRA+jh0OJFKZ5H2fNgE3II59vdsRwIDAQAB
-----END PUBLIC KEY-----
```
  注記
  これは、Secured サンプルアプリケーションの Red Hat SSO サーバーデプロイメントからのマスターレルム公開鍵です。
4. クライアント出力から Encoded されたボックスに token 出力を貼り付けます。
  Signature Verified 記号がデバッガーページに表示されます。

8.6.7.3. Web インターフェイスを使用した HTTP 要求の認証

セキュアなエンドポイントには、HTTP API の他に、対話する Web インターフェイスも含まれます。

以下の手順は、セキュリティーの実施方法、認証方法、および認証トークンの使用方法を確認するための演習です。

前提条件

セキュアなエンドポイント URL。詳細は「Secured サンプルアプリケーション API エンドポイントの取得」を参照してください。

手順

Web ブラウザーで、エンドポイント URL に移動します。
認証されていない要求を実行します。
1. Invoke ボタンをクリックします。
  図8.1 認証されていないセキュアなサンプル Web インターフェイス
  サービスは、HTTP 401 Unauthorized ステータスコードで応答します。
  図8.2 未認証のエラーメッセージ
認証された要求をユーザーとして実行します。
1. Login ボタンをクリックして Red Hat SSO に対して認証を行います。SSO サーバーにリダイレクトされます。
2. Alice ユーザーとしてログインします。Web インターフェイスにリダイレクトされます。
  注記
  ページ下部のコマンドライン出力に、アクセス (ベアラー) トークンが表示されます。
  図8.3 (Alice として) 認証されたセキュアなサンプル Web インターフェイス
3. 再度 Invoke をクリックして Greeting サービスにアクセスします。
  例外がなく、JSON 応答ペイロードが表示されていることを確認します。つまり、サービスはアクセス (ベアラー) トークンを許可し、Greeting サービスへのアクセスが認可されていることを意味します。
  図8.4 (Alice として) 認証されたグリーティング要求の結果
4. ログアウトします。
認証された要求を管理者として実行します。
1. Invoke ボタンをクリックします。
  これにより、認証されていない要求が Greeting サービスに送信されていることを確認します。
2. Login ボタンをクリックして admin ユーザーとしてログインします。
  図8.5 (admin として) 認証されたセキュアな Web インターフェイスの例
Invoke ボタンをクリックします。
このサービスは、admin ユーザーが Greeting サービスへのアクセスが許可されていないため、HTTP 403 Forbidden ステータスコードで応答します。
図8.6 承認されていないエラーメッセージ

8.6.8. Spring Boot Secured サンプルアプリケーション統合テストの実行

前提条件

認証された oc クライアント。

手順

警告

統合テストを実行すると、サンプルアプリケーションの既存インスタンスがすべて、ターゲット OpenShift プロジェクトから削除されます。サンプルアプリケーションを誤って削除しないようにするには、テストを実行するために別の OpenShift プロジェクトを作成して選択してください。

端末アプリケーションで、プロジェクトのディレクトリーに移動します。
Red Hat SSO サーバーアプリケーションを作成します。
```
oc create -f service.sso.yaml
```
Red Hat SSO サーバーの準備ができるまで待ちます。Web コンソールに移動するか、または oc get pods の出力を表示して、Red Hat SSO サーバーを実行する Pod が準備状態にあるかどうかを確認します。

統合テストを実行します。

mvn clean verify -Popenshift,openshift-it -DSSO_AUTH_SERVER_URL=$(oc get route secure-sso -o jsonpath='{"https://"}{.spec.host}{"/auth\n"}')

8.6.9. セキュアな SSO リソース

OAuth2 仕様の背後にある原則に関する追加情報や、Red Hat SSO および Keycloak を使用してアプリケーションのセキュリティーを保護する方法については、以下のリンクを参照してください。

8.7. Spring Boot のキャッシュの例

重要

以下の例は、実稼働環境での実行を目的としていません。

上達度レベルの例: Advanced

キャッシュサンプルは、キャッシュを使用してアプリケーションの応答時間を長くする方法を示しています。

この例では、以下の方法を示しています。

キャッシュを OpenShift にデプロイします。
アプリケーション内でキャッシュを使用します。

8.7.1. キャッシュの仕組みおよび必要なタイミング

キャッシュを使用すると、特定の期間情報を保存し、アクセスすることができます。元のサービスを繰り返し呼び出すよりも、キャッシュの情報により迅速またはより確実にアクセスすることができます。キャッシュを使用する欠点は、キャッシュされた情報が最新ではないことです。ただし、キャッシュに保存されている各値に 有効期限 または TTL (time to live) に設定すると、この問題を軽減できます。

例8.3 キャッシュの例

service1 および service2 の 2 つのアプリケーションがあるとします。

Service1 は service2 からの値によって異なります。
- service2 からの値が頻繁に変更されると、service1 は一定期間 service2 からの値をキャッシュする可能性があります。
- キャッシュされた値を使用すると、service2 が呼び出される回数を減らすことができます。
service1 が service2 から直接値を取得するのに 500 ミリ秒かかり、キャッシュされた値を取得するのに 100 ミリ秒かかる場合、service1 はキャッシュされた各呼び出しに対してキャッシュされた値を使用することで 400 ミリ秒短くすることができます。
service1 が service2 にキャッシュされていない呼び出しを 1 秒あたり 5 回、10 秒以上行うとすると、呼び出しは 50 になります。
代わりに service1 が 1 秒の TTL でキャッシュされた値の使用を開始した場合は、10 秒で 10 コールに削減されます。

キャッシュサンプルの仕組み

cache サービス、cute name サービス、および greeting サービスがデプロイされ、公開されます。
ユーザーは greeting サービスの Web フロントエンドにアクセスします。
ユーザーは、Web フロントエンドのボタンを使用して greeting HTTP API を呼び出します。
greeting サービスは、cute name サービスの値によって異なります。
- greeting サービスは、最初にその値が cache サービスに保存されているかどうかを確認します。これが存在する場合は、キャッシュされた値が返されます。
- 値がキャッシュされていない場合、greeting サービスは cute name サービスを呼び出し、値を返し、その値を 5 秒の TTL で cache サービスに保存します。
Web フロントエンドは、greeting サービスからの応答と、操作の合計時間を表示します。
ユーザーはサービスを複数回呼び出し、キャッシュされた操作とキャッシュされていない操作の違いを確認します。
- キャッシュされた操作は、キャッシュされていない操作よりもはるかに高速です。
- ユーザーは、TTL の有効期限が切れる前にキャッシュを強制的に消去することができます。

8.7.2. キャッシュサンプルアプリケーションの OpenShift Online へのデプロイ

以下のオプションのいずれかを使用して、OpenShift Online で Cache サンプルアプリケーションを実行します。

developers.redhat.com/launch の使用
CLI クライアント oc の使用

8.7.2.1. developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで developers.redhat.com/launch URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.7.2.2. CLI クライアント `oc` の認証

前提条件

OpenShift Online のアカウント。

手順

ブラウザーで OpenShift Online URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して CLI クライアント oc を OpenShift Online アカウントで認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.7.2.3. CLI クライアント `oc` を使用したキャッシュサンプルアプリケーションのデプロイメント

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。詳細は「developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント」を参照してください。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新規プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
キャッシュサービスをデプロイします。
```
$ oc apply -f service.cache.yml
```
Maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```

アプリケーションのステータスを確認し、Pod が実行していることを確認します。

$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
cache-server-123456789-aaaaa             1/1       Running     0          8m
MY_APP_NAME-cutename-1-bbbbb       1/1       Running     0          4m
MY_APP_NAME-cutename-s2i-1-build   0/1       Completed   0          7m
MY_APP_NAME-greeting-1-ccccc       1/1       Running     0          3m
MY_APP_NAME-greeting-s2i-1-build   0/1       Completed   0          3m

3 つの Pod が完全にデプロイされて起動すると、ステータスは Running でなければなりません。

アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。

ルート情報の例

$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME-cutename   MY_APP_NAME-cutename-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME             MY_APP_NAME-cutename   8080                    None
MY_APP_NAME-greeting   MY_APP_NAME-greeting-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME             MY_APP_NAME-greeting   8080                    None

Pod のルート情報には、アクセスに使用するベース URL が提供されます。上記の例では、http://MY_APP_NAME-greeting-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME をベース URL として使用して greeting サービスにアクセスします。

8.7.3. Cache サンプルアプリケーションの Minishift または CDK へのデプロイ

以下のオプションのいずれかを使用して、Minishift または CDK でキャッシュサンプルアプリケーションをローカルで実行します。

Fabric8 Launcher の使用
CLI クライアント oc の使用

8.7.3.1. Fabric8 Launcher ツールの URL および認証情報の取得

前提条件

Fabric8 Launcher ツールがインストールされ、設定され、実行している。

手順

Minishift または CDK を起動したコンソールに移動します。

実行中の Fabric8 Launcher にアクセスするのに使用できる URL およびユーザー認証情報のコンソール出力を確認します。

Minishift または CDK 起動時のコンソール出力の例

...
-- Removing temporary directory ... OK
-- Server Information ...
   OpenShift server started.
   The server is accessible via web console at:
       https://192.168.42.152:8443

   You are logged in as:
       User:     developer
       Password: developer

   To login as administrator:
       oc login -u system:admin

8.7.3.2. Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Fabric8 Launcher URL に移動します。
画面の指示に従って、Spring Boot でサンプルアプリケーションを作成して起動します。

8.7.3.3. CLI クライアント `oc` の認証

前提条件

実行中の Fabric8 Launcher インスタンスの URL と、Minishift または CDK のユーザー認証情報。詳細は「Fabric8 Launcher ツールの URL および認証情報の取得」を参照してください。

手順

ブラウザーで Minishift または CDK URL に移動します。
ユーザー名の横にある Web コンソールの右上にあるクエスチョンマークアイコンをクリックします。
ドロップダウンメニューで Command Line Tools を選択します。
oc login コマンドをコピーします。
端末にコマンドを貼り付けます。このコマンドは、認証トークンを使用して、Minishift または CDK アカウントで CLI クライアント oc を認証します。
```
$ oc login OPENSHIFT_URL --token=MYTOKEN
```

8.7.3.4. CLI クライアント `oc` を使用したキャッシュサンプルアプリケーションのデプロイメント

前提条件

Minishift または CDK の Fabric8 Launcher ツールを使用して作成されたサンプルアプリケーション。詳細は「Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント」を参照してください。
Fabric8 Launcher ツールの URL。
認証された oc クライアント。詳細は「CLI クライアント oc の認証」を参照してください。

手順

GitHub からプロジェクトのクローンを作成します。
```
$ git clone git@github.com:USERNAME/MY_PROJECT_NAME.git
```
または、プロジェクトの ZIP ファイルをダウンロードして、展開します。
```
$ unzip MY_PROJECT_NAME.zip
```
新規プロジェクトを作成します。
```
$ oc new-project MY_PROJECT_NAME
```
アプリケーションの root ディレクトリーに移動します。
キャッシュサービスをデプロイします。
```
$ oc apply -f service.cache.yml
```
Maven を使用して OpenShift へのデプロイメントを開始します。
```
$ mvn clean fabric8:deploy -Popenshift
```

アプリケーションのステータスを確認し、Pod が実行していることを確認します。

$ oc get pods -w
NAME                             READY     STATUS      RESTARTS   AGE
cache-server-123456789-aaaaa             1/1       Running     0          8m
MY_APP_NAME-cutename-1-bbbbb       1/1       Running     0          4m
MY_APP_NAME-cutename-s2i-1-build   0/1       Completed   0          7m
MY_APP_NAME-greeting-1-ccccc       1/1       Running     0          3m
MY_APP_NAME-greeting-s2i-1-build   0/1       Completed   0          3m

3 つの Pod が完全にデプロイされて起動すると、ステータスは Running でなければなりません。

アプリケーションのサンプルをデプロイして起動すると、そのルートを決定します。

ルート情報の例

$ oc get routes
NAME                 HOST/PORT                                                     PATH      SERVICES        PORT      TERMINATION
MY_APP_NAME-cutename   MY_APP_NAME-cutename-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME             MY_APP_NAME-cutename   8080                    None
MY_APP_NAME-greeting   MY_APP_NAME-greeting-MY_PROJECT_NAME.OPENSHIFT_HOSTNAME             MY_APP_NAME-greeting   8080                    None

8.7.4. キャッシュサンプルアプリケーションの OpenShift Container Platform へのデプロイメント

サンプルアプリケーションを OpenShift Container Platform に作成し、デプロイするプロセスは OpenShift Online に似ています。

前提条件

developers.redhat.com/launch を使用して作成されたサンプルアプリケーション。

手順

「キャッシュサンプルアプリケーションの OpenShift Online へのデプロイ」の説明に従い、OpenShift Container Platform Web コンソールの URL およびユーザー認証情報のみを使用します。

8.7.5. 未変更の Cache サンプルアプリケーションとの対話

前提条件

アプリケーションがデプロイされている。

手順

ブラウザーを使用して greeting サービスに移動します。
サービスの起動 を一度クリックします。
duration の値が 2000 を超えることに注意してください。また、キャッシュ状態が No cached value to A value is cached の形式になっていることに注意してください。
5 秒間待機して、キャッシュ状態が No cached value に戻されるのを確認します。
キャッシュされた値の TTL は 5 秒に設定されています。TTL の期限が切れると、値はキャッシュされなくなります。
Invoke the service を一度クリックして、値をキャッシュします。
キャッシュ状態が A value is cached になっている数秒の間に Invoke the service をさらに数回クリックします。
キャッシュされた値を使用しているため、duration の値が大幅に低いことに注意してください。Clear the cache をクリックすると、キャッシュは空になります。

8.7.6. キャッシュサンプルアプリケーション統合テストの実行

アプリケーションのテストインスタンスをプロジェクトにデプロイします。
そのインスタンスで個別のテストを実行します。
テストが完了したら、プロジェクトからアプリケーションのすべてのインスタンスを削除します。

警告

前提条件

認証された oc クライアント。
空の OpenShift プロジェクト。

手順

次のコマンドを実行して統合テストを実行します。

$ mvn clean verify -Popenshift,openshift-it

8.7.7. リソースのキャッシュ

キャッシュに関する背景および関連情報は、以下を参照してください。

付録A Source-to-Image (S2I) ビルドプロセス

Source-to-Image (S2I) は、アプリケーションソースのあるオンライン SCM リポジトリーから再現可能な Docker 形式のコンテナーイメージを生成するビルドツールです。S2I ビルドを使用すると、ビルド時間を短縮し、リソースとネットワークの使用量を減らし、セキュリティーを改善し、その他の多くの利点を活用して、アプリケーションの最新バージョンを本番環境に簡単に配信できます。OpenShift は、複数のビルドストラテジーおよび入力ソースをサポートします。

詳細は、OpenShift Container Platform ドキュメントの Source-to-Image (S2I) ビルドの章を参照してください。

最終的なコンテナーイメージをアセンブルするには、S2I プロセスに 3 つの要素を提供する必要があります。

GitHub などのオンライン SCM リポジトリーでホストされるアプリケーションソース。
S2I Builder イメージ。アセンブルされたイメージの基盤となり、アプリケーションが実行しているエコシステムを提供します。
必要に応じて、S2I スクリプトによって使用される環境変数およびパラメーターを指定することもできます。

このプロセスは、S2I スクリプトで指定された指示に従ってアプリケーションソースと依存関係を Builder イメージに挿入し、アセンブルされたアプリケーションを実行する Docker 形式のコンテナーイメージを生成します。詳細は、OpenShift Container Platform ドキュメントの S2I build requirements、build options、および how builds work を参照してください。

付録B サンプルアプリケーションのデプロイメント設定の更新

サンプルアプリケーションのデプロイメント設定には、ルート情報や Readiness プローブの場所など、OpenShift でのアプリケーションのデプロイおよび実行に関連する情報が含まれます。サンプルアプリケーションのデプロイメント設定は YAML ファイルのセットに保存されます。Fabric8 Maven プラグインを使用する例では、YAML ファイルは src/main/fabric8/ ディレクトリーにあります。Nodeshift を使用する例として、YAML ファイルは .nodeshift ディレクトリーにあります。

重要

Fabric8 Maven Plugin および Nodeshift が使用するデプロイメント設定ファイルは完全な OpenShift リソース定義である必要はありません。Fabric8 Maven Plugin と Nodeshift の両方がデプロイメント設定ファイルを取り、不足している情報を追加して完全な OpenShift リソース定義を作成できます。Fabric8 Maven Plugin によって生成されるリソース定義は target/classes/META-INF/fabric8/ ディレクトリーにあります。Nodeshift によって生成されるリソース定義は tmp/nodeshift/resource/ ディレクトリーにあります。

前提条件

既存のサンプルプロジェクト。
CLI クライアント oc がインストールされている。

手順

既存の YAML ファイルを編集したり、設定を更新して追加の YAML ファイルを作成します。
- たとえば、サンプルに readinessProbe が設定された YAML ファイルがすでにある場合は、path の値を別の利用可能なパスに変更し、Readiness の有無を確認することができます。
```
spec:
  template:
    spec:
      containers:
        readinessProbe:
          httpGet:
            path: /path/to/probe
            port: 8080
            scheme: HTTP
...
```
- readinessProbe が既存の YAML ファイルで設定されていない場合は、readinessProbe 設定を使用して新規 YAML ファイルを同じディレクトリーに作成することもできます。
Maven または npm を使用して、サンプルの更新バージョンをデプロイします。

設定更新が、デプロイ済みのサンプルに表示されることを確認します。

$ oc export all --as-template='my-template'

apiVersion: v1
kind: Template
metadata:
  creationTimestamp: null
  name: my-template
objects:
- apiVersion: v1
  kind: DeploymentConfig
  ...
  spec:
    ...
    template:
      ...
      spec:
        containers:
          ...
          livenessProbe:
            failureThreshold: 3
            httpGet:
              path: /path/to/different/probe
              port: 8080
              scheme: HTTP
            initialDelaySeconds: 60
            periodSeconds: 30
            successThreshold: 1
            timeoutSeconds: 1
          ...

追加リソース

Web ベースのコンソール、または CLI クライアント oc を使用してアプリケーションの設定を直接更新した場合は、これらの変更を YAML ファイルへエクスポートして追加します。oc export all コマンドを使用して、デプロイされたアプリケーションの設定を表示します。

付録C Fabric8 Maven Plugin でアプリケーションをデプロイする Jenkins フリースタイルプロジェクトの設定

ローカルホストの Maven および Fabric8 Maven Plugin を使用してアプリケーションをデプロイするのと同様に、Jenkins を設定して Maven および Fabric8 Maven プラグインを使用してアプリケーションをデプロイすることができます。

前提条件

OpenShift クラスターへのアクセス。
同じ OpenShift クラスターで実行している Jenkins コンテナーイメージ。
Jenkins サーバーに JDK および Maven がインストールされ、設定されている。
pom.xml で Maven、Fabric8 Maven Plugin、および Red Hat ベースイメージを使用するよう設定されたアプリケーション。
注記
アプリケーションを OpenShift にビルドおよびデプロイする場合は、Spring Boot 2.1.x は OpenJDK 8 および OpenJDK 11 をベースとしたビルダーイメージのみをサポートします。Oracle JDK および OpenJDK 9 のビルダーイメージはサポートされていません。
pom.xml の例
```
<properties>
  ...
  <fabric8.generator.from>registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift:latest</fabric8.generator.from>
</properties>
```
GitHub で利用可能なアプリケーションのソース。

手順

アプリケーションの新規 OpenShift プロジェクトを作成します。
1. OpenShift Web コンソールを開き、ログインします。
2. Create Project をクリックし、新規 OpenShift プロジェクトを作成します。
3. プロジェクト情報を入力し、Create をクリックします。
Jenkins がそのプロジェクトにアクセスできるようにします。
たとえば、Jenkins のサービスアカウントを設定した場合は、アカウントに、アプリケーションのプロジェクトへの edit アクセスがあることを確認してください。
Jenkins サーバーで新しいフリースタイルの Jenkins プロジェクトを作成します。
1. New Item をクリックします。
2. 名前を入力し、Freestyle プロジェクト を選択して OK をクリックします。
3. Source Code Management で Git を選択し、アプリケーションの GitHub URL を追加します。
4. Build で Add build step を選択し、Invoke top-level Maven target を選択します。
5. 以下を Goals に追加します。
```
clean fabric8:deploy -Popenshift -Dfabric8.namespace=MY_PROJECT
```
  MY_PROJECT をアプリケーションの OpenShift プロジェクトの名前に置き換えます。
6. Save をクリックします。
Jenkins プロジェクトのメインページから Build Now をクリックし、アプリケーションの OpenShift プロジェクトへのアプリケーションのビルドおよびデプロイを確認します。
アプリケーションの OpenShift プロジェクトでルートを開いて、アプリケーションがデプロイされていることを確認することもできます。

次のステップ

GITSCM ポーリングを追加すること、または the Poll SCM ビルドトリガーを使用することを検討してください。これらのオプションにより、新規コミットが GitHub リポジトリーにプッシュされるたびにビルドを実行できます。
デプロイ前にテストを実行するビルドステップを追加することを検討してください。

付録D WAR ファイルを使用した Spring Boot アプリケーションのデプロイ

ファット JAR ファイルを使用してサポートされているアプリケーションのパッケージ化とデプロイのワークフローの代わりに、Spring Boot アプリケーションを WAR (Web アプリケーションアーカイブ) ファイルとしてパッケージ化してデプロイできます。アプリケーションが OpenShift で正しくビルドし、デプロイするように、ビルドおよびデプロイメントの設定を行う必要があります。

前提条件

サンプルなどの Spring Boot アプリケーション。
アプリケーションを OpenShift にデプロイするのに使用される Fabric8 Maven Plugin。
アプリケーションのパッケージ化に使用される Spring Boot Maven プラグイン。

手順

war パッケージをプロジェクトの pom.xml ファイルに追加します。
pom.xml の例
```
<project ...>
  ...
  <packaging>war</packaging>
  ...
</project>
```

spring-boot-starter-tomcat をアプリケーションの依存関係として指定します。

pom.xml の例

<project ...>
  ...
  <dependencies>
    ...
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-tomcat</artifactId>
    </dependency>
    ...
  </dependencies>
  ...
</project>

Spring Boot Maven プラグインの Maven ゴール repackage が pom.xml ファイルで定義されているようにしてください。
pom.xml の例
```
<project ...>
...
  <build>
    ...
    <plugins>
      ...
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <executions>
          <execution>
            <goals>
              <goal>repackage</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
...
</project>
```
これにより、アプリケーションの起動に使用される Spring Boot クラスが WAR ファイルに含まれ、これらのクラスの対応するプロパティーが WAR ファイルの MANIFEST.mf ファイルで定義されているようになります。
- Main-Class: org.springframework.boot.loader.WarLauncher
- Spring-Boot-Classes: WEB-INF/classes/
- Spring-Boot-Lib: WEB-INF/lib/
- Spring-Boot-Version: 2.1.15.RELEASE

ARTIFACT_COPY_ARGS 環境変数を pom.xml ファイルに追加します。

Fabric8 Maven プラグインは、ビルドプロセス中にこの変数を使用し、Build および Deploy ツールは WAR ファイル (デフォルトのファット JAR ファイルよりも) を使用してアプリケーションコンテナーイメージを作成します。

pom.xml の例

    ...
    <profile>
      <id>openshift</id>
      <build>
        <plugins>
          <plugin>
            <groupId>io.fabric8</groupId>
            <artifactId>fabric8-maven-plugin</artifactId>
            <executions>
              ...
            </executions>
            <configuration>
                <images>
                    <image>
                        <name>${project.artifactId}:%t</name>
                        <alias>${project.artifactId}</alias>
                        <build>
                            <from>registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift:${openjdk18-openshift.version}</from>
                            <assembly>
                                <basedir>/deployments</basedir>
                                <descriptorRef>artifact</descriptorRef>
                            </assembly>
                            <env>
                                <ARTIFACT_COPY_ARGS>*.war</ARTIFACT_COPY_ARGS>
                                <JAVA_APP_DIR>/deployments</JAVA_APP_DIR>
                            </env>
                            <ports>
                                <port>8080</port>
                            </ports>
                        </build>
                    </image>
                </images>
            </configuration>
          </plugin>
        </plugins>
      </build>
    </profile>
    ...

JAVA_APP_JAR 環境変数を src/main/fabric8/deployment.yml ファイルに追加します。
この変数は Fabric8 Maven Plugin に対して、コンテナーに含まれる WAR ファイルを使用してアプリケーションを起動します。src/main/fabric8/deployment.yml が存在しない場合は、これを作成できます。
deployment.yml の例
```
spec:
  template:
    spec:
      containers:
        ...
          env:
          - name: JAVA_APP_JAR
            value: ${project.artifactId}-${project.version}.war
```
アプリケーションをビルドしてデプロイします。
```
mvn clean fabric8:deploy -Popenshift
```

付録E 追加の Spring Boot リソース

付録F アプリケーション開発リソース

OpenShift でのアプリケーション開発に関する詳細は、以下を参照してください。

OpenShift インタラクティブラーニングポータル

ネットワークの負荷を削減し、アプリケーションのビルド時間を短縮するには、Minishift または CDK に Maven の Nexus ミラーを設定します。

Maven 用の Nexus ミラーリングの設定

付録G 上達度レベル

使用できる各例は、特定の最小知識を必要とする概念について言及しています。この要件は例によって異なります。最小要件と概念は、いくつかの上達度レベルで設定されています。ここで説明するレベルの他に、各例に固有の追加情報が必要になる場合があります。

Foundational

Foundational とされている例は、通常、主題に関する事前の知識を必要としません。この例では、主要な要素、概念、および用語の一般的な認識とデモンストレーションを提供します。この例の説明で直接言及されているものを除き、特別な要件はありません。

Advanced

Advanced サンプルを使用する場合は、Kubernetes および OpenShift の他に、例の主題の領域の一般的な概念および用語について理解していることを前提としています。サービスやアプリケーションの設定、ネットワークの管理など、独自の基本的なタスクを実行できるようにする必要があります。この例ではサービスが必要で、設定が例の範囲に含まれていない場合には、適切に設定する知識があり、サービスの結果として生じる状態のみがドキュメントに記載されていることを前提とします。

Expert

Expert サンプルでは、主題について最も高いレベルの知識が必要です。機能ベースのドキュメントとマニュアルに基づいて多くのタスクを実行することが期待されており、ドキュメントは最も複雑なシナリオを対象としています。

付録H 用語

H.1. 製品およびプロジェクト名

Developer Launcher (developers.redhat.com/launch): Developer Launcher (developers.redhat.com/launch) は、Red Hat が提供するスタンドアロンの入門エクスペリエンスです。これは、OpenShift でのクラウドネイティブ開発の開始に役立ちます。これには、OpenShift にダウンロード、ビルド、およびデプロイできる機能のサンプルアプリケーションが含まれます。
Minishift または CDK: Minishift を使用してマシンで実行している OpenShift クラスター。

H.2. Developer Launcher に固有の用語

例

アプリケーション仕様 (例: REST API を持つ Web サービス)。

この例では、通常、実行する言語やプラットフォームを指定していません。説明には意図した機能のみが含まれています。

サンプルアプリケーション

特定のランタイムにおける特定のサンプルの言語固有の実装。サンプルアプリケーションは、サンプルカタログに記載されています。

たとえば、サンプルアプリケーションは Thorntail ランタイムを使用して実装される REST API を持つ Web サービスです。

サンプルカタログ: サンプルアプリケーションに関する情報が含まれる Git リポジトリー。

ランタイム: アプリケーションの例を実行するプラットフォーム。たとえば、Thorntail または Eclipse Vert.x などです。

Language and Page Formatting Options

Spring Boot 2.1.x ランタイムガイド

Spring Boot 2.1 を使用して、OpenShift およびスタンドアロン RHEL で実行するアプリケーションを開発

前書き

第1章 Spring Boot でのアプリケーション開発の概要

1.1. Red Hat Runtimes でのアプリケーション開発の概要

1.2. Developer Launcher を使用した Red Hat OpenShift でのアプリケーション開発

1.3. Spring Boot の概要

1.3.1. Spring Boot の機能およびフレームワークの概要

1.3.2. サンプルアプリケーションの概要

第2章 Spring Boot を使用するようにアプリケーションを設定

第3章 Developer Launcher を使用したアプリケーションのダウンロードおよびデプロイ

3.1. Developer Launcher の使用

3.2. Developer Launcher を使用したサンプルアプリケーションのダウンロード

3.3. OpenShift Container Platform または CDK (Minishift) へのサンプルアプリケーションのデプロイメント

第4章 Spring Boot ランタイムアプリケーションの開発およびデプロイ

4.1. Spring Boot アプリケーションの開発

4.2. Spring Boot アプリケーションの OpenShift へのデプロイ

4.2.1. Red Hat Enterprise Linux 用の OpenJDK イメージ

4.2.2. OpenShift デプロイメント向け Spring Boot アプリケーションの準備

4.2.3. Fabric8 Maven プラグインを使用した Spring Boot アプリケーションの OpenShift へのデプロイ

4.3. スタンドアロン Red Hat Enterprise Linux への Spring Boot アプリケーションのデプロイ

4.3.1. スタンドアロン Red Hat Enterprise Linux デプロイメント用の Spring Boot アプリケーションの準備

4.3.2. jar を使用したスタンドアロン Red Hat Enterprise Linux への Spring Boot アプリケーションのデプロイ

第5章 Eclipse Vert.x で Spring Boot を使用したリアクティブアプリケーションの開発

5.1. Eclipse Vert.x での Spring Boot の概要

5.2. リアクティブ Spring Web

5.3. WebFlux でのリアクティブ Spring Boot HTTP サービスの作成

5.4. リアクティブ Spring Boot WebFlux アプリケーションで Basic 認証の使用

5.5. リアクティブ Spring Boot アプリケーションで OAuth2 認証の使用。

5.6. リアクティブ Spring Boot SMTP メールアプリケーションの作成

5.7. サーバー向けイベント

5.8. リアクティブ Spring Boot アプリケーションでのサーバー送信イベントの使用

第6章 Spring Boot ベースのアプリケーションのデバッグ

6.1. リモートのデバッグ

6.1.1. デバッグモードでの Spring Boot アプリケーションのローカルでの開始

6.1.2. デバッグモードでの uberjar の起動

6.1.3. デバッグモードでの OpenShift でのアプリケーションの起動

6.1.4. アプリケーションへのリモートデバッガーの割り当て

6.2. デバッグロギング

6.2.1. Spring Boot デバッグロギングの追加

6.2.2. localhost での Spring Boot デバッグログへのアクセス

6.2.3. OpenShift でのデバッグログへのアクセス

第7章 アプリケーションのモニターリング

7.1. OpenShift でのアプリケーションの JVM メトリクスへのアクセス

7.1.1. OpenShift で Jolokia を使用した JVM メトリクスへのアクセス

第8章 利用可能なサンプル Spring Boot

8.1. Spring Boot の REST API Level 0 サンプル

8.1.1. REST API Level 0 設計トレードオフ

8.1.2. REST API Level 0 サンプルアプリケーションの OpenShift Online へのデプロイメント

8.1.2.1. developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント

8.1.2.2. CLI クライアント oc の認証

8.1.2.3. CLI クライアント oc を使用した REST API Level 0 サンプルアプリケーションのデプロイメント

8.1.3. REST API Level 0 サンプルアプリケーションの Minishift または CDK へのデプロイメント

8.1.3.1. Fabric8 Launcher ツールの URL および認証情報の取得

8.1.3.2. Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント

8.1.3.3. CLI クライアント oc の認証

8.1.3.4. CLI クライアント oc を使用した REST API Level 0 サンプルアプリケーションのデプロイメント

8.1.4. REST API Level 0 サンプルアプリケーションの OpenShift Container Platform へのデプロイメント

8.1.5. Spring Boot の未変更の REST API Level 0 サンプルアプリケーションとの対話

8.1.6. REST API Level 0 のサンプルアプリケーション統合テストの実行

8.1.7. REST リソース

8.2. Spring Boot の外部化設定の例

8.2.1. 外部化された設定の設計パターン

8.2.2. 外部化設定設計のトレードオフ

8.2.3. 外部化設定のサンプルアプリケーションの OpenShift Online へのデプロイメント

8.2.3.1. developers.redhat.com/launch を使用したサンプルアプリケーションのデプロイメント

8.2.3.2. CLI クライアント oc の認証

8.2.3.3. CLI クライアント oc を使用した Externalized Configuration アプリケーションのデプロイメント

8.2.4. 外部化設定アプリケーションの Minishift または CDK へのデプロイメント

8.2.4.1. Fabric8 Launcher ツールの URL および認証情報の取得

8.2.4.2. Fabric8 Launcher ツールを使用したサンプルアプリケーションのデプロイメント

8.2.4.3. CLI クライアント oc の認証

8.2.4.4. CLI クライアント oc を使用した Externalized Configuration アプリケーションのデプロイメント

8.2.5. 外部設定サンプルアプリケーションの OpenShift Container Platform へのデプロイメント

8.2.6. Spring Boot の未変更の外部化設定サンプルアプリケーションとの対話

8.2.7. 外部化設定のサンプルアプリケーションの統合テストの実行

8.2.8. 外部化設定リソース

8.3. Spring Boot のリレーショナルデータベースバックエンドのサンプル

8.3.1. リレーショナルデータベースバックエンドの設計トレードオフ

第7章アプリケーションのモニターリング

第8章利用可能なサンプル Spring Boot

8.1.2.2. CLI クライアント `oc` の認証

8.1.2.3. CLI クライアント `oc` を使用した REST API Level 0 サンプルアプリケーションのデプロイメント

8.1.3.3. CLI クライアント `oc` の認証

8.1.3.4. CLI クライアント `oc` を使用した REST API Level 0 サンプルアプリケーションのデプロイメント

8.2.3.2. CLI クライアント `oc` の認証

8.2.3.3. CLI クライアント `oc` を使用した Externalized Configuration アプリケーションのデプロイメント

8.2.4.3. CLI クライアント `oc` の認証

8.2.4.4. CLI クライアント `oc` を使用した Externalized Configuration アプリケーションのデプロイメント

8.3.2.2. CLI クライアント `oc` の認証

8.3.2.3. CLI クライアント `oc` を使用したリレーショナルデータベースバックエンドのサンプルアプリケーションのデプロイメント

8.3.3.3. CLI クライアント `oc` の認証

8.3.3.4. CLI クライアント `oc` を使用したリレーショナルデータベースバックエンドのサンプルアプリケーションのデプロイメント

8.4.2.2. CLI クライアント `oc` の認証

8.4.2.3. CLI クライアント `oc` を使用した Health Check サンプルアプリケーションのデプロイメント

8.4.3.3. CLI クライアント `oc` の認証

8.4.3.4. CLI クライアント `oc` を使用した Health Check サンプルアプリケーションのデプロイメント

8.5.3.2. CLI クライアント `oc` の認証

8.5.3.3. CLI クライアント `oc` を使用した Circuit Breaker サンプルアプリケーションのデプロイメント

8.5.4.3. CLI クライアント `oc` の認証

8.5.4.4. CLI クライアント `oc` を使用した Circuit Breaker サンプルアプリケーションのデプロイメント