@yo41sawada です。
前回 こちらの記事 で Azure Spring Cloud に注目しているといった矢先、
嬉しいニュースが飛び込んできました。
というわけで早速試してみたので、それを共有しようと思います。
この記事で共有すること
この記事で言及しないこと
- Azure(ポータル/ CLI ) の基本的な操作・用語や Microsoft アカウントを準備するための手順
- Java & Spring を用いた基本的なウェブアプリケーション開発や Maven を用いたビルドに関する知識や手順
動作環境
動作環境は以下の通りです。ちなみに今回 Java については、こちらも先日発表になった Microsoft 独自の OpenJDK ディストリビューションである「Microsoft Build of OpenJDK」を使っています( 2021 年 4 月 15 日時点ではプレビュー版)。それはまた別の機会があれば。
- OS : Windows 10 Pro (19042.867)
- Java : Microsoft Build of OpenJDK 11.0.10
- Maven : 3.8.1
- Azure CLI : 2.17.1
全体の流れ
先に大まかな流れを押さえておきましょう。
- 環境セットアップ( Java / Maven / Azure CLI )
- デプロイする Spring Web アプリケーションの準備
- 東日本リージョンへの Azure Spring Cloud リソース追加
- 上記リソースへのアプリ追加
- ビルドしたアプリケーション(jar)のデプロイ
環境セットアップ( Java / Maven / Azure CLI )
詳細な手順は省きますが、今回はコマンド( Git Bash )を用いる部分もあるので、
正しくインストール出来ているかを確認するようにしましょう。
Java
Microsoft Build of OpenJDK は こちら からダウンロードページに遷移し(「 Download 」ボタンをクリック)、インストーラをダウンロードしてインストールします。
私の場合は、以下のインストーラを用いました。
- microsoft-jdk-11.0.10.9-windows-x64.msi
インストールが完了したら、 Git Bash にて以下のコマンドを実行して JDK がインストールされていることを確認します。
$ java -version
例えば以下のように表示されれば成功です。
openjdk version "11.0.10" 2021-01-19
OpenJDK Runtime Environment Microsoft-18724 (build 11.0.10+9)
OpenJDK 64-Bit Server VM Microsoft-18724 (build 11.0.10+9, mixed mode)
Maven
Maven の場合は こちら からアーカイブファイルをダウンロードした後、解凍して環境変数の設定を行います。
私の場合は、以下のアーカイブファイルを用いました。
- apache-maven-3.8.1-bin.zip
解凍と環境変数の設定が完了したら、 Git Bash にて以下のコマンドを実行して mvn コマンドが実行できることを確認します。
$ mvn -v
例えば以下のように表示されれば成功です。
Apache Maven 3.8.1 (05c21c65bdfed0f71a2f2ada8b84da59348c4c5d)
Maven home: C:\develop\apache-maven-3.8.1
Java version: 11.0.10, vendor: Microsoft, runtime: C:\Program Files\Microsoft\jdk-11.0.10.9-hotspot
Default locale: ja_JP, platform encoding: MS932
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"
Azure CLI
Azure CLI は こちら からダウンロードページに遷移し(「〇〇へのインストール」リンクをクリック)、インストーラをダウンロードしてインストールします。
私の場合は、以下のインストーラを用いました。
- azure-cli-2.17.1.msi
インストールが完了したら、 続けて以下のコマンドを実行して Azure CLI 用の Azure Spring Cloud 拡張機能をインストールします。
$ az extension add --name spring-cloud
インストールが完了したら、以下のコマンドを実行して Azure CLI と Azure Spring Cloud 拡張機能がインストールされていることを確認します。
$ az --version
例えば以下のように表示されれば成功です。私の場合は更新のアナウンスが表示されていますが、これは記事執筆時点での Azure CLI 最新バージョンが 2.22.0 であるためです。ここではそのまま続けていきますが、入手できる最新の Azure CLI を用いても問題無いと思います。
azure-cli 2.17.1 *
core 2.17.1 *
telemetry 1.0.6
Extensions:
spring-cloud 2.3.1
Python location 'C:\Program Files (x86)\Microsoft SDKs\Azure\CLI2\python.exe'
Extensions directory 'C:\Users\{USER NAME}\.azure\cliextensions'
Python (Windows) 3.6.8 (tags/v3.6.8:3c6b436a57, Dec 23 2018, 23:31:17) [MSC v.1916 32 bit (Intel)]
Legal docs and information: aka.ms/AzureCliLegal
You have 2 updates available. Consider updating your CLI installation with 'az upgrade'
Please let us know how we are doing: https://aka.ms/azureclihats
and let us know if you're interested in trying out our newest features: https://aka.ms/CLIUXstudy
そのまま Microsoft アカウントでログインしましょう。
$ az login
デプロイする Spring Web アプリケーションの準備
環境のセットアップが完了したら、早速 Azure Spring Cloud 向けアプリケーションを用意していきましょう。ここではイチから準備する方法とショートカットする方法を紹介しますが、問題無くビルドして jar を作成できることがゴールです。
イチから
イチから準備する場合は、公式のドキュメントに方法が記載されているので、その通り進めていきましょう。
まずは Spring Initializr にアクセスし、プロジェクトを準備します。こちら から Spring Initializr へアクセスすれば予め Azure Spring Cloud 向けの Dependencies を追加したプロジェクトが設定されているので、「 GENERATE 」 ボタンをクリックしてアーカイブをダウンロードしてください。
ダウンロードが完了したらそのアーカイブを一度解凍し、 HellospringApplication.java と同じディレクトリに API 用の HelloController.java を用意します。
package com.example.hellospring;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMapping;
@RestController
public class HelloController {
@RequestMapping("/")
public String index() {
return "Welcome to Japan East!!!";
}
}
HelloController.java の準備が出来たら、Maven を使ってプロジェクトをビルドします。
$ mvn clean package
面倒な方向け
ドキュメントや上記に記載した内容を読んで進めることを省略したい方は、 こちら からサンプルプロジェクトをダウンロードなりクローンなりした上でビルドしてください。
東日本リージョンへの Azure Spring Cloud リソース追加
それではいよいよ東日本リージョンの Azure Spring Cloud リソースを追加していきます。
- Azure ポータル に Microsoft アカウントを用いてログインし、ホーム画面にて「リソースの作成」をクリックします。
- 「新規」ページの「 Marketplace を検索」フォームに、「 Azure Spring Cloud 」と入力します。
- 検索結果に表示された「 Azure Spring Cloud 」の「作成」をクリックします。
- 表示された「 Azure Spring Cloud 」リソース作成画面の「基本」タブにて以下を入力します。
- タブを下にスクロールし、「確認と作成」をクリックします。
- 問題無く検証が終了したことを確認し、「作成」をクリックします。
- リソースのデプロイ画面が表示されるので、完了を待ちます。なおこの辺りから「 Microsoft.AppPlatform 」という表現が出てきますが、気にせず進めて下さい。
- 作成された Azure Spring Cloud のリソースを確認します。
上記リソースへのアプリ追加
続いて、準備した東日本リージョンの Azure Spring Cloud リソースへ、アプリを追加していきます。
- Azure Spring Cloud リソースの 「設定」 > 「アプリ」に、何も表示されていないことを確認します。
- Git Bash を起動し、以下のコマンドを実行することでアプリを追加します。先ほど作成したリソースを例にあげると、以下のようになります。
- アプリ名(例.hellospring )← ここだけ考える
- サービス名( welcome-japaneast-asc )
- リソースグループ名( RG_Demo4ASC )
$ az spring-cloud app create -n アプリ名 -s サービス名 -g リソースグループ名 --assign-endpoint true
- コマンドの実行結果に「 App create succeeded 」と表示されていれば、アプリの追加は成功です。
- 再度 Azure ポータルに戻り、 Azure Spring Cloud リソースの 「設定」 > 「アプリ」において、追加したアプリ(例.hellospring )が表示されていることを確認します。
- 追加したアプリ名のリンクをクリックし、「概要」に表示された「URL」をクリックします。
- Azure Spring Cloud のページが表示されていることを確認します。
ビルドしたアプリケーション(jar)のデプロイ
最後に、追加したアプリに先程ビルドした jar をデプロイしていきます。
- Git Bash を起動し、以下のコマンドを実行することでアプリへ jar をデプロイします。先ほど追加したアプリを例にあげると、以下のようになります。
- アプリ名( hellospring )
- サービス名( welcome-japaneast-asc )
- リソースグループ名( RG_Demo4ASC )
- ビルドした jar の配置されているパス(例:target/hellospring-0.0.1-SNAPSHOT.jar )
$ az spring-cloud app deploy -n アプリ名 -s サービス名 -g リソースグループ名 --jar-path ビルドした jar の配置されているパス
- コマンドが問題無く終了していれば、デプロイは成功です。
- 先程と同様に Azure Spring Cloud リソースへ追加したアプリ名のリンクをクリックし、「概要」に表示された「URL」をクリックします。
- API のレスポンスが正しく返っていることを確認します。
以上が東日本リージョンの Azure Spring Cloud にアプリケーションをデプロイする手順です。うまくいきましたか?
ハマりやすいところ
最後に少しだけ、ハマりやすいところ(自分が進めていて不安になったところや少し躓いたところ)を紹介しておきますので、他にもあればコメントなど頂けると嬉しいです。
リソースのデプロイに 20 分くらいかかった
Azure ポータルを用いて Azure Spring Cloud リソースを追加した際のデプロイに 20 分程時間がかかりました。東日本リージョンだからなのかは切り分けできていませんが、ここは気長に待ちましょう。
ResourceNotFoundError に遭遇した
「az spring-cloud app create ~」コマンドを実行した時に、リソースグループ名が見つからないというエラーに遭遇しました。これは Azure CLI コマンドを操作している方は一度は遭遇するのではというあるあるなのですが、Azure CLI を操作している際にログインしている Microsoft アカウントのサブスクリプションが適切に指定されていない場合等に起こります。焦らず、以下のようにサブスクリプションを指定するコマンドを実行しましょう。サブスクリプションは適宜読み替えてください(例:Pay-As-You-Go )。
$ az account set -s サブスクリプション名
ビルドしたアプリケーションをデプロイしたのに変化が無い
正しくデプロイできているのであれば、ブラウザのキャッシュが原因です。落ち着いて、F5 等でリロードしましょう。
おわりに
いかがだったでしょうか。Spring や Azure を触っている方であれば、東日本リージョンに Azure Spring Cloud のアプリケーションを簡単にデプロイできたのではないかと思います。一方でここで紹介しなかった機能や画面も多いので、例えば以下のような内容について確認出来たら、こちらで共有していこうと思います。
- 価格レベルの変更
- Automation 有効化
- Java インプロセスエージェント有効化
- 既存の仮想ネットワークへのデプロイ