手順

1. dev.snowdrop:snowdrop-dependencies アーティファクトをプロジェクトの pom.xml の <dependencyManagement> セクションに追加し、<type> 属性値および <scope> 属性値を指定します。

   <project>
     ...
     <dependencyManagement>
       <dependencies>
         <dependency>
           <groupId>dev.snowdrop</groupId>
           <artifactId>snowdrop-dependencies</artifactId>
           <version>2.3.10.Final-redhat-00004</version>
           <type>pom</type>
           <scope>import</scope>
         </dependency>
       </dependencies>
     </dependencyManagement>
     ...
   </project>

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

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

3. BOM およびサポートされる Spring Boot Starters および Spring Boot Maven プラグインを含むリポジトリーの名前と URL を指定します。

     <!-- 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>

4. spring-boot-maven-plugin を Maven がアプリケーションのパッケージ化に使用するプラグインとして追加します。

   <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>

手順

1. dev.snowdrop:snowdrop-dependencies アーティファクトを pom.xml の <parent> セクションに追加します。

   <project>
     ...
     <parent>
       <groupId>dev.snowdrop</groupId>
       <artifactId>snowdrop-dependencies</artifactId>
       <version>2.3.10.Final-redhat-00004</version>
     </parent>
     ...
   </project>

2. spring-boot-maven-plugin を Maven がアプリケーションを pom.xml の <build> セクションにパッケージ化するために使用するプラグインとして追加します。プラグインバージョンは、親 BOM により自動的に管理されます。

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

手順

1. Dekorate OpenShift Spring Starter をアプリケーションの pom.xml ファイルに追加して、Dekorate がアプリケーションのソースコードとリソースファイルを処理できるようにします。

   <project>
     ...
     <dependencies>
        ...
       <dependency>
         <!-- The OpenShift Spring Starter automatically imports the "io.dekorate:openshift-annotations" dependency. -->
         <groupId>io.dekorate</groupId>
         <artifactId>openshift-spring-starter</artifactId>
       </dependency>
       ...
     </dependencies>
   ...
   <project>

2. @SpringBootApplication アノテーションをアプリケーションプロジェクトのメインクラスファイルに追加します。

   package org.acme;
   
   @SpringBootApplication
   public class Application {
   }

3. アプリケーションをパッケージ化して、アプリケーションコードおよびリソースファイルを Dekorate で処理します。

   mvn clean package

4. 生成された OpenShift マニフェストが含まれる target/classes/META-INF/dekorate ディレクトリーに移動します。

手順

1. Dekorate OpenShift Annotations モジュールを、アプリケーションの pom.xml ファイルの依存関係として追加します。

   <project>
     ...
     <dependencies>
        ...
       <dependency>
         <groupId>io.dekorate</groupId>
         <artifactId>openshift-spring-starter</artifactId>
       </dependency>
       ...
     </dependencies>
   ...
   <project>

2. OpenShift へのデプロイ時に、アプリケーションが開始するデフォルトのレプリカ数を設定します。

   1. @OpenshiftApplication アノテーションをアプリケーションのメインソースファイルに追加し、レプリカ数を 2 に設定します。アプリケーションのビルドとデプロイ時に、実行中のメインのアプリケーションコンテナーの 2 つのレプリカで自動的に起動します。

      package org.acme;
      
      import io.dekorate.openshift.annotation.OpenshiftApplication;
      
      // include the parameter for the number of replicas to
      @OpenshiftApplication(replicas=2)
      @SpringBootApplication
      public class Application {
      }

   2. または、アプリケーションの application.properties ファイルに dekorate.openshift.replicas=2 プロパティーを設定します。

      /src/main/resources/application.properties

      dekorate.openshift.replicas=2

3. アプリケーションをパッケージ化します。

   mvn clean package

4. target/classes/META-INF/dekorate に移動し、Dekorate が生成したマニフェストを表示します。デプロイメント設定 YAML テンプレートのレプリカ数は 2 に設定されます。

   ...
   spec:
     replicas: 2
     selector:
       matchLabels:
         app: acme
   ...

手順

1. アプリケーションの pom.xml ファイルに以下の依存関係を追加します。

   <project>
     ...
     <dependencies>
       ...
       <!-- The OpenShift Spring Starter automatically adds "io.dekorate:openshift-annotations" as a transitive dependency -->
       <dependency>
         <groupId>io.dekorate</groupId>
         <artifactId>openshfit-spring-starter</artifactId>
       </dependency>
       ...
     </dependencies>
   ...
   <project>

2. Dekorate 設定プロパティーをプロジェクトの application.properties ファイルまたは application.yml ファイルに追加します。Dekorate プロパティーアノテーションをソースファイルに追加する必要はありません。ソースファイルのアノテーションを使用できますが、これを行う場合は、アノテーションで提供されるパラメーターを application.properties ファイルまたは application.yml ファイルにあるパラメーターで上書きします。

3. アプリケーションをパッケージ化します。

   mvn clean package

   アプリケーションの Dekorate をビルドすると、アプリケーションプロジェクト内の以下のリソースの設定が解析されます。設定リソースは優先順に解析されます。つまり、異なるタイプの 2 つの異なるリソースが同じ設定パラメーターに異なる値を持っている場合、Dekorate は優先度のリストにあるリソースから取得した値を使用します。たとえば、ソースのアノテーションがパラメーター値を指定するものの、application.yml の同じパラメーターに異なる値が指定されている場合、Dekorate は application.yml から取得する値を使用します。Dekorate は、以下の優先順位でプロジェクトリソースを解析します。

   1. アノテーション
   2. application.properties
   3. application.yaml
   4. application.yml
4. 生成された openshift.json および openshift.yml マニフェストファイルが含まれる target/classes/META-INF/dekorate ディレクトリーに移動します。

手順

1. Dekorate OpenShift Spring Starter を依存関係としてアプリケーションの pom.xml ファイルに追加します。このモジュールは、すべての Dekorate OpenShift Starters に推移的な依存関係として含まれていることに注意してください。

   <project>
     ...
     <dependencies>
        ...
       <dependency>
         <groupId>io.dekorate</groupId>
         <artifactId>openshift-spring-starter</artifactId>
       </dependency>
       ...
     </dependencies>
   ...
   <project>

2. アプリケーションをビルドしてデプロイします。Maven がアプリケーションをコンパイルした後にコンテナーイメージビルドを実行するための -Ddekorate.build=true プロパティーを含めます。Source-to-Image ビルドを自動的に実行する機能は テクノロジープレビュー として提供されることに注意してください。

   $ mvn clean install -Ddekorate.build=true

   Maven でアプリケーションをコンパイルした後に、コマンドラインから Source-to-image ビルドを手動で実行することもできます。

   # Process your application YAML template that is generated by Dekorate:
   $ oc apply -f target/classes/META-INF/dekorate/openshift.yml
   # Execute the Source-to-image build and deploy your application to the OpenShift cluster:
   $ oc start-build example --from-dir=./target --follow

1. アプリケーションで openshift-spring-stater を使用できます。
2. Dekorate は、アプリケーションのタイプを自動的に識別し、OpenShift サービスルートおよびプローブを随時設定できます。
3. Maven がアプリケーションをコンパイルした後に、source-to-image ビルドをトリガーするようにアプリケーションを設定できます。

4. 前提条件

   • Spring Boot および Dekorate を使用するよう設定された Maven ベースのアプリケーションプロジェクト
   • @SpringBootApplication アノテーションがプロジェクトのソースファイルに追加されました。
   • Java JDK 8 または JDK 11 がインストールされている。
   • Maven がインストールされている。
   • oc コマンドラインツールがインストールされている
   • oc コマンドラインツールを使用して OpenShift クラスターにログインしている。

手順

1. Dekorate Spring Starter は、アプリケーションプロジェクトの pom.xml ファイルの依存関係として追加します。

   pom.xml

   <project>
     ...
     <dependencies>
        ...
       <dependency>
         <groupId>io.dekorate</groupId>
         <artifactId>openshift-spring-starter</artifactId>
       </dependency>
       ...
     </dependencies>
   ...
   <project>

2. @SpringBootApplication アノテーションを Main.java クラスに追加します。これにより、アプリケーションをコンパイルする際に source-to-image ビルドを開始できます。

   /src/main/java/io/dekorate/example/sbonopenshift/Main.java

   package io.dekorate.example.sbonopenshift;
   
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   
   @SpringBootApplication
   public class Main {
   
     public static void main(String[] args) {
       SpringApplication.run(Main.class, args);
     }
   
   }

3. Rest コントローラーをアプリケーションに追加します。

   /src/main/java/io/dekorate/example/sbonopenshift/Controller.java

   package io.dekorate.example.sbonopenshift;
   
   import org.springframework.web.bind.annotation.RequestMapping;
   import org.springframework.web.bind.annotation.RestController;
   
   @RestController
   public class Controller {
   
     @RequestMapping("/")
     public String hello() {
       return "Hello world";
     }
   }

   Dekorate Spring スターターによって提供される Spring アプリケーションプロセッサーは Rest コントローラーを自動的に検出し、アプリケーションタイプを Web アプリケーションとして識別します。Web アプリケーションの場合、Dekorate は OpenShift アプリケーションテンプレートを自動的に生成し、以下を設定します。

   • アプリケーションの OpenShift Service ルート
   • アプリケーションのルートでサービスを公開します。
   • Liveness および Readiness プローブの設定
4. アプリケーションをビルドしてデプロイします。Maven がアプリケーションをコンパイルした後に source-to-image ビルドを自動的に実行するには、-Ddekorate.deploy=true プロパティーを含めます。