Spring Boot WEBサービスを Azure App Service で起動する (ACR カスタムコンテナイメージ)

# Spring Boot WEBサービスを Azure App Service で起動する (ACR カスタムコンテナイメージ)

## 目的

[Spring Boot WEBサービス](https://qiita.com/hiroxpepe/items/4a0f5e077155ce41e7ac)を [Azure App Service](https://learn.microsoft.com/ja-jp/azure/app-service/overview) 環境で起動して理解を深めます。  

## 実現すること

Microsoft Azure App Service に Spring Boot WEBアプリのカスタムコンテナイメージをデプロイします。

## 技術背景

### Microsoft Azure App Service とは？  

<details>
<summary>こちらを展開してご覧いただけます。</summary>

### [Microsoft Azure App Service](https://learn.microsoft.com/ja-jp/azure/app-service/overview)

Microsoft Azure App Service は、Microsoft Azure の PaaS (Platform as a Service) サービスの一つで、WEB アプリケーションやモバイルアプリケーション、API アプリケーションのホスティングに特化したサービスです。  

Azure App Service の主な特徴とメリットは以下のとおりです。  

#### 簡単なデプロイ

Azure App Service は、Azure Portal や Azure CLI、Azure DevOps などのツールを使って、WEB アプリケーションを簡単にデプロイできます。また、多数のプログラミング言語やフレームワークに対応しており、柔軟な開発が可能です。  

#### スケーラビリティ

Azure App Service は、自動スケーリングや手動スケーリングをサポートしており、アプリケーションの負荷に応じて柔軟にスケールできます。  

#### 高可用性

Azure App Service は、グローバルな負荷分散やフェイルオーバー機能を備えており、高い可用性を実現できます。  

#### 統合

Azure App Service は、Azure の他のサービスとシームレスに統合できます。例えば、Azure SQL Database や Azure Storage などのストレージサービスと連携して、アプリケーションのデータ管理を容易にします。  

#### セキュリティ

Azure App Service は、ネットワークセキュリティグループ (NSG) や WEB アプリケーションファイアウォール (WAF) などのセキュリティ機能を提供しており、アプリケーションのセキュリティを高めることができます。  

#### まとめ

これらの特徴とメリットにより、Azure App Service は、開発者や企業にとって、高速かつ柔軟な WEB アプリケーションの開発とデプロイを支援するプラットフォームとして利用されています。  

</details>

## 開発環境

+ Windows 11 Home 22H2 を使用しています。  
+ [WSL](https://learn.microsoft.com/ja-jp/windows/wsl/about) の Ubuntu を操作していきますので macOS の方も参考にして頂けます。  

<details>

WSL (Microsoft Store アプリ版)

```sh
> wsl --version
WSL バージョン: 1.0.3.0
カーネル バージョン: 5.15.79.1
WSLg バージョン: 1.0.47
```

Ubuntu

```sh
$ lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 22.04.1 LTS
Release:        22.04
```

Java JDK [※ Java JDK の導入と Hello World!](https://qiita.com/hiroxpepe/items/8650664e466906a57996)

```sh
$ java -version
openjdk version "11.0.17" 2022-10-18
OpenJDK Runtime Environment (build 11.0.17+8-post-Ubuntu-1ubuntu222.04)
OpenJDK 64-Bit Server VM (build 11.0.17+8-post-Ubuntu-1ubuntu222.04, mixed mode, sharing)
```

Maven [※ Maven の導入と Hello World!](https://qiita.com/hiroxpepe/items/40f7f199b9be7f9e3b5b)

```sh
$ mvn -version
Apache Maven 3.6.3
Maven home: /usr/share/maven
Java version: 11.0.17, vendor: Ubuntu, runtime: /usr/lib/jvm/java-11-openjdk-amd64
```

Docker Desktop

```sh
Version 4.16.3 (96739)
```

```sh
$ docker --version
Docker version 20.10.22, build 3a2c30b
```

```sh
$ docker-compose --version
Docker Compose version v2.15.1
```

</details>

※ この記事では基本的に Ubuntu のターミナルで操作を行います。

## "Hello World" を表示する手順

### Spring Boot WEBサービスの作成

[Spring Boot WEBサービスの Hello World!](https://qiita.com/hiroxpepe/items/4a0f5e077155ce41e7ac) を参照して頂けます。  

### プロジェクトフォルダに移動  

※ ~/tmp/hello-spring-boot をプロジェクトフォルダとします。  

```sh
$ cd ~/tmp/hello-spring-boot
```

### Java アプリをビルド(※参考)  

※ target/app.jar が作成されます。  
※ 下の コンテナイメージを作成する操作でも同時に target/app.jar が作成されるので必須ではありません。  

```sh
$ mvn clean install
```

### コンテナイメージを作成

Dockerfile を編集  
※ 検証時点では素の spring-boot:build-image では動作せず、明示的に *EXPOSE 8080* 設定を付加する必要がありました。

```sh
$ vim Dockerfile
```

ファイルの内容

```sh
EXPOSE 8080
```

コンテナイメージをビルド  
※ ローカルの Docker 環境 (Docker Desktop) に app-hello-spring-boot コンテナイメージが作成されます。  
※ コンテナイメージの作成時間が Unix エポックになるのは spring-boot:build-image の仕様です。  

```sh
$ mvn spring-boot:build-image \
    -Dspring-boot.build-image.imageName=app-hello-spring-boot \
    -Dspring-boot.build-image.dockerfile=Dockerfile
```

コンテナイメージの確認

```sh
$ docker images | grep app-hello-spring-boot
app-hello-spring-boot   latest   e37cc77f2b36   43 years ago   262MB
```

### Azure のアカウントを取得

公式 [Azure の無料アカウントを使ってクラウドで構築](https://azure.microsoft.com/ja-jp/free/)

### Azure CLI でサインイン

[Azure CLI をインストールする手順](https://qiita.com/hiroxpepe/items/20aeb54a676f190d5c96) を参照して頂けます。  

```sh
$ az login
```

※ 最新バージョンに更新する場合

```sh
$ az upgrade
```

### Azure 環境

#### リソースグループ

リソースグループを作成

```sh:Microsoft.Resources/resourceGroups
$ az group create \
    --name rg-hello \
    --location japaneast
```

リソースグループ一覧表示

```sh
$ az group list
```

※ リソースグループを削除する場合

```sh
$ az group delete -n <group>
```

#### コンテナ レジストリ

コンテナ レジストリを作成  
※ --sku Free では作成できません。  
※ --name <name> はパブリックで一意の値が求められます。

```sh:Microsoft.ContainerRegistry/registries
$ az acr create \
    --resource-group rg-hello \
    --name cr20230212 \
    --sku Basic
```

コンテナ レジストリ一覧表示

```sh
$ az acr list
```

コンテナ レジストリログイン資格情報を表示

```sh
$ az acr update -n cr20230212 --admin-enabled true
$ az acr credential show \
    --resource-group rg-hello \
    --name cr20230212
```

```json
{
  "passwords": [
    {
      "name": "password",
      "value": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    },
    {
      "name": "password2",
      "value": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    }
  ],
  "username": "cr20230212"
}
```

※ コンテナ レジストリを削除する場合

```sh
$ az acr delete --n <acr-name>
```

コンテナ レジストリにログイン

```sh
$ az acr login --name cr20230212
```

コンテナイメージをコンテナ レジストリにプュシュ

```sh
$ docker tag app-hello-spring-boot cr20230212.azurecr.io/app-hello-spring-boot:latest
$ docker push cr20230212.azurecr.io/app-hello-spring-boot:latest
```

コンテナ レジストリのイメージを確認

```sh
$ az acr repository list --name cr20230212 --output table
Result
---------------------
app-hello-spring-boot
```

ローカルの コンテナイメージを Azure コンテナ レジストリにプュシュすることが出来ました。

#### App Service プラン

App Service プランを作成

```sh:Microsoft.Web/serverfarms
$ az appservice plan create \
    --resource-group rg-hello \
    --name asp-hello \
    --sku Free \
    --is-linux
```

App Service プランの一覧表示

```sh
$ az appservice plan list
```

※ App Service プランを削除する場合

```sh
$ az appservice plan delete -n <plan> -g <group>
```

#### App Service WEB アプリ

※ Azure App Service に Spring Boot WEBアプリのコンテナイメージをデプロイする方法はいくつかありますが、今回は Azure CLI で ACR 上の コンテナイメージをデプロイする方法を紹介します。  

Web アプリの作成とデプロイ  

```sh:Microsoft.Web/sites
$ az webapp create \
    --resource-group rg-hello \
    --plan asp-hello \
    --name app-hello-spring-boot \
    --deployment-container-image-name cr20230212.azurecr.io/app-hello-spring-boot:latest \
    --docker-registry-server-user cr20230212 \
    --docker-registry-server-password XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```

Web アプリの作成の設定を構成  
※ App Service WEB アプリはデフォルトで 80 番ポートをリッスンする仕様です。  

```sh
$ az webapp config appsettings set \
    --resource-group rg-hello \
    --name app-hello-spring-boot \
    --settings WEBSITES_PORT=8080
```

Web アプリのログ記録の構成

```sh
$ az webapp log config \
    --resource-group rg-hello \
    --name app-hello-spring-boot \
    --docker-container-logging filesystem \
    --application-logging filesystem \
    --web-server-logging filesystem 
```

WEBブラウザーでアクセス

```sh
$ az webapp browse \
    --resource-group rg-hello \
    --name app-hello-spring-boot
```

※ 立ち上がりに少し時間が掛かりますがページが表示されます。 しかし表示されたページ "/" にはコンテンツを設定していません。

改めてWEBブラウザで確認  
※ URLは環境で読み替えて下さい。  

```sh
https://app-hello-spring-boot.azurewebsites.net/api/data
```

WEBブラウザに {"message":"Hello World!"} と表示され、JSON データを取得することが出来ました。  

※ 別ターミナルから curl コマンドで確認

```
$ curl -v https://app-hello-spring-boot.azurewebsites.net/api/data
*   Trying 20.43.67.36:443...
* Connected to app-hello-spring-boot.azurewebsites.net (20.43.67.36) port 443 (#0)
* ALPN, offering h2
* ALPN, offering http/1.1
*  CAfile: /etc/ssl/certs/ca-certificates.crt
*  CApath: /etc/ssl/certs
* TLSv1.0 (OUT), TLS header, Certificate Status (22):
* TLSv1.3 (OUT), TLS handshake, Client hello (1):
* TLSv1.2 (IN), TLS header, Certificate Status (22):
* TLSv1.3 (IN), TLS handshake, Server hello (2):
* TLSv1.2 (IN), TLS handshake, Certificate (11):
* TLSv1.2 (IN), TLS handshake, Server key exchange (12):
* TLSv1.2 (IN), TLS handshake, Server finished (14):
* TLSv1.2 (OUT), TLS header, Certificate Status (22):
* TLSv1.2 (OUT), TLS handshake, Client key exchange (16):
* TLSv1.2 (OUT), TLS header, Finished (20):
* TLSv1.2 (OUT), TLS change cipher, Change cipher spec (1):
* TLSv1.2 (OUT), TLS header, Certificate Status (22):
* TLSv1.2 (OUT), TLS handshake, Finished (20):
* TLSv1.2 (IN), TLS header, Finished (20):
* TLSv1.2 (IN), TLS header, Certificate Status (22):
* TLSv1.2 (IN), TLS handshake, Finished (20):
* SSL connection using TLSv1.2 / ECDHE-RSA-AES256-GCM-SHA384
* ALPN, server accepted to use h2
* Server certificate:
*  subject: C=US; ST=WA; L=Redmond; O=Microsoft Corporation; CN=*.azurewebsites.net
*  start date: Dec 27 21:12:39 2022 GMT
*  expire date: Dec 22 21:12:39 2023 GMT
*  subjectAltName: host "app-hello-spring-boot.azurewebsites.net" matched cert's "*.azurewebsites.net"
*  issuer: C=US; O=Microsoft Corporation; CN=Microsoft Azure TLS Issuing CA 05
*  SSL certificate verify ok.
* Using HTTP2, server supports multiplexing
* Connection state changed (HTTP/2 confirmed)
* Copying HTTP/2 data in stream buffer to connection buffer after upgrade: len=0
* TLSv1.2 (OUT), TLS header, Supplemental data (23):
* TLSv1.2 (OUT), TLS header, Supplemental data (23):
* TLSv1.2 (OUT), TLS header, Supplemental data (23):
* Using Stream ID: 1 (easy handle 0x55b794ea9e80)
* TLSv1.2 (OUT), TLS header, Supplemental data (23):
> GET /api/data HTTP/2
> Host: app-hello-spring-boot.azurewebsites.net
> user-agent: curl/7.81.0
> accept: */*
>
* TLSv1.2 (IN), TLS header, Supplemental data (23):
* TLSv1.2 (OUT), TLS header, Supplemental data (23):
* TLSv1.2 (IN), TLS header, Supplemental data (23):
* TLSv1.2 (IN), TLS header, Supplemental data (23):
* TLSv1.2 (IN), TLS header, Supplemental data (23):
< HTTP/2 200
< content-type: application/json
< date: Mon, 27 Feb 2023 02:51:05 GMT
< set-cookie: ARRAffinity=ae907ce840c6b95b786870ca4c1362dc92f4733f1b7145fe24a6c8a07a0d5ff4;Path=/;HttpOnly;Secure;Domain=app-hello-spring-boot.azurewebsites.net
< set-cookie: ARRAffinitySameSite=ae907ce840c6b95b786870ca4c1362dc92f4733f1b7145fe24a6c8a07a0d5ff4;Path=/;HttpOnly;SameSite=None;Secure;Domain=app-hello-spring-boot.azurewebsites.net
<
* TLSv1.2 (IN), TLS header, Supplemental data (23):
* Connection #0 to host app-hello-spring-boot.azurewebsites.net left intact
{"message":"Hello World!"}
```

ターミナルに {"message":"Hello World!"} と表示され、JSON データを取得することが出来ました。  

※ Azure 側で SSL/TLS対応と HTTP/2プロトコルを使用してくれます。  

## まとめ

+ Ubuntu のシンプルな構成の Java 開発環境で Spring Boot **WEBサービスを** Azure App Service 環境で起動させることが出来ました。

## 参考

公式 [Azure App Service コマンド リファレンス](https://learn.microsoft.com/ja-jp/cli/azure/service-page/azure%20app%20service?view=azure-cli-latest)