Docker 環境で Rust Rocket Webサービスを起動する

# Docker 環境で Rust Rocket Webサービスを起動する

こんにちは、@studio_meowtoon です。今回は、WSL Ubuntu の Docker 環境で、Rust Rocket Web アプリケーションをコンテナとして起動する方法を紹介します。
![rocket_on_docker.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3206449/3049eb5f-8760-c29d-8bcc-7ebd963d1560.png)

## 目的

Windows 11 の Linux でクラウド開発します。

こちらから記事の一覧がご覧いただけます。

https://qiita.com/studio_meowtoon/items/6119ab05d8b13527efd8

## 実現すること

ローカル環境の WSL Ubuntu の Docker 環境で、Dockerfile からビルドした Rust Rocket Web サービスのカスタムコンテナイメージを起動します。

**ネイティブイメージ形式のアプリをコンテナとして起動**
```mermaid
flowchart LR
terminal --> app[app]
subgraph Ubuntu
  subgraph Docker
    subgraph container[app-hello-rocket]
      subgraph app[app]
        rocket
      end
    end
  end
end
style Ubuntu fill:#FFBCA4, stroke:#E0460F
style Docker fill:#EEFDFF, stroke:#74B9DC
style container fill:#FFD7E4, stroke:#E13C73
style app fill:#ECECFF, stroke:#9674DC
style rocket fill:#FFFFDE, stroke:#B4AE43
```

**実行環境**

|要素|概要|
|:--|:--|
|terminal|ターミナル|
|Ubuntu|OS|
|Docker|コンテナ実行環境|

**Web サービス コンテナ**

|要素|概要|
|:--|:--|
|app-hello-rocket|カスタムコンテナ|
|app|ネイティブイメージ アプリケーション|
|rocket|Web サーバー機能を含む|

## 技術トピック

### Rocket とは？  

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

### [Rocket (ロケット)](https://rocket.rs/master/overview/)

:::note info
Rocket は、Rust プログラミング言語でのウェブアプリケーション開発のためのフルスタック Web フレームワークです。

|キーワード|内容|
|:--|:--|
|型安全性|Rust の型システムを活用して、コンパイル時のエラーチェックによる堅牢なアプリケーションを構築できます。|
|マクロ|Rocket は独自のプロシージャマクロを使用して、ルーティングやリクエスト・レスポンスの処理を簡潔に行うことができます。|
|非同期処理|Rocket は非同期プログラミングをサポートし、多くのリクエストを効率的に処理できます。|
|リクエスト・レスポンス|リクエストとレスポンスの処理が容易であり、JSON の自動シリアライズ・デシリアライズもサポートされています。|
|静的ファイルの提供|静的ファイルやアセットの提供が簡単にできます。|
|ミドルウェア|Rocket はミドルウェアを使用してリクエストの前後に処理を追加できるため、セキュリティやログ、認証などの機能を容易に組み込むことができます。|
|拡張性|カスタムのデータ型やコンポーネントを統合するための柔軟な仕組みを提供します。|
|ドキュメント|Rocket は充実した公式ドキュメントとコミュニティのサポートを提供し、学習と開発をサポートします。|
:::

</details>

### Dockerfile とは？  

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

### [Dockerfile](https://docs.docker.jp/engine/reference/builder.html#dockerfile)

:::note info
Dockerfile は、Docker コンテナを構築するためのテキストファイルです。Docker コンテナはアプリケーションやサービスを実行するための環境を含む軽量でポータブルな仮想化ユニットです。

|キーワード|内容|
|:--|:--|
|スクリプト形式|Dockerfile はシンプルなスクリプト形式で記述されるため、コンテナのビルドプロセスを自動化することが容易です。|
|レイヤー構造|Docker イメージは Dockerfile の各命令が実行される際にレイヤーとして生成され、再利用やキャッシュが可能な構造となっています。|
|バージョン管理|Dockerfile はテキストベースであるため、コードと同様にバージョン管理システムで管理しやすいです。|
|ポータビリティ|Dockerfile により、アプリケーションとその依存関係が1つのコンテナイメージにパッケージ化されるため、異なる環境間での移植性が高まります。|
|自動化と効率化|Dockerfile を使用することで、アプリケーションのビルドや環境構築を自動化できます。これにより、手動での作業時間やヒューマンエラーが減り、開発・デプロイプロセスが効率的になります。|
|再現性|Dockerfile はビルド手順を完全に定義するため、異なる環境で同じアプリケーションを再現できます。これにより、開発、テスト、本番環境間での一貫性が確保されます。|
|環境の分離|Docker コンテナはホストシステムから分離されるため、アプリケーションの依存関係やライブラリの衝突を回避し、より安全な環境で実行できます。|
|拡張性|Dockerfile を使用することで、カスタムイメージを作成することができます。このため、特定のニーズに合わせてカスタマイズされたコンテナイメージを容易に作成できます。|
:::

</details>

## 開発環境

+ Windows 11 Home 22H2 を使用しています。  

:::note info
[WSL](https://learn.microsoft.com/ja-jp/windows/wsl/about) の Ubuntu を操作していきますので macOS の方も参考にして頂けます。  
:::

<details>

WSL (Microsoft Store アプリ版) [※ こちらの関連記事からインストール方法をご確認いただけます](https://qiita.com/studio_meowtoon/items/2aaa6579cb8e4fa1d874)

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

Ubuntu [※ こちらの関連記事からインストール方法をご確認いただけます](https://qiita.com/studio_meowtoon/items/2aaa6579cb8e4fa1d874)

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

Docker [※ こちらの関連記事からインストール方法をご確認いただけます](https://qiita.com/studio_meowtoon/items/3bceee25ac67cc73ebbe)

```sh
$ docker --version
Docker version 23.0.1, build a5ee5b1
```

</details>

:::note warn
この記事では基本的に **Ubuntu のターミナルで操作**を行います。**Vim を使用してコピペする方法**を初めて学ぶ人のために、以下の記事で手順を紹介しています。ぜひ挑戦してみてください。
:::

https://qiita.com/studio_meowtoon/items/7771ad48676926e41463

## 作成する Web アプリケーションの仕様

|No|エンドポイント|HTTPメソッド|MIME タイプ|
|:--|:--|:--|:--|
|1|/api/data|GET|application/json|

:::note info
**/api/data** というエンドポイントに対して HTTP GET リクエストを送信すると、JSON データがレスポンスされるシンプルな Web サービスを実装します。
**{"message":"Hello World!"}**
:::

## Hello World を表示する手順

### Rust のインストール

Rust をインストールします。

```sh
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
1) Proceed with installation (default)
2) Customize installation
3) Cancel installation
> 1
```

Rust の環境設定を .bashrc ファイルに追記します。

```sh
$ vim ~/.bashrc
```

一番下へ次の内容を追加します。

```
# Rust Environment
source "$HOME/.cargo/env"
```

設定を反映します。

```sh
$ source ~/.bashrc
```

確認します。

```sh
$ rustc --version
rustc 1.71.1 (eb26296b5 2023-08-03)
```

### プロジェクトの作成

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

```sh
$ mkdir -p ~/tmp/hello-rocket
$ cd ~/tmp/hello-rocket
```

### Cargo.toml ファイルの作成

Cargo.toml ファイルを作成します。

```sh
$ vim Cargo.toml
```

ファイルの内容

```sh:Cargo.toml
[package]
name = "app"
version = "0.1.0"
edition = "2021"

[dependencies]
rocket = { version = "=0.5.0-rc.3", features = ["json"] }
serde = { version = "1.0", features = ["derive"] }
```

### アプリケーションファイルの作成

**main.rs** ファイルを作成します。

```sh
$ mkdir -p src
$ vim src/main.rs
```

ファイルの内容

```rust:src/main.rs
#[macro_use] extern crate rocket;

use rocket::serde::Serialize;
use rocket::serde::json::Json;

#[derive(Serialize)]
struct Response {
    message: String,
}

#[get("/api/data")]
fn api_data() -> Json<Response> {
    let response: Response = Response {
        message: format!("Hello World!"),
    };
    Json(response)
}

#[launch]
fn rocket() -> _ {
    rocket::build().mount("/", routes![api_data])
}
```

### アプリのビルド

アプリをビルドします。

```sh
$ cargo clean
$ cargo build
```

### ローカルで実行

ローカルで実行します。
停止するときは ctrl + C を押します。

```sh
$ ./target/debug/app
```

別ターミナルから curl コマンドで確認します。

```sh
$ curl -v http://localhost:8000/api/data -w '\n'
```

出力

```sh
*   Trying 127.0.0.1:8000...
* Connected to localhost (127.0.0.1) port 8000 (#0)
> GET /api/data HTTP/1.1
> Host: localhost:8000
> User-Agent: curl/7.81.0
> Accept: */*
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< content-type: application/json
< server: Rocket
< x-content-type-options: nosniff
< x-frame-options: SAMEORIGIN
< permissions-policy: interest-cohort=()
< content-length: 26
< date: Sat, 05 Aug 2023 12:45:56 GMT
<
* Connection #0 to host localhost left intact
{"message":"Hello World!"}
```

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

### コンテナイメージをビルド

Dockerfile を作成します。

```sh
$ vim Dockerfile
```

ファイルの内容

```Dockerfile:Dockerfile
# build the app.
FROM rust:1.71 AS build-env

# set the working dir.
WORKDIR /app

# copy the source and dependencies of the app.
COPY src ./src
COPY Cargo.toml Cargo.lock ./

# build the app.
RUN cargo build --release

# set up the container.
FROM debian:12-slim

# set the working dir.
WORKDIR /app

# copy the built app binary from the build-env.
COPY --from=build-env /app/target/release/app ./app

# set the environment variable.
ENV ROCKET_ADDRESS=0.0.0.0

# expose the port.
EXPOSE 8000

# command to run the app.
CMD ["./app"]
```

Docker デーモンを起動します。

```sh
$ sudo service docker start
 * Starting Docker: docker    [ OK ]
```

:::note warn
Docker 環境をお持ちでない場合は、以下の関連記事から Docker Engine のインストール手順をご確認いただけます。
:::

https://qiita.com/studio_meowtoon/items/3bceee25ac67cc73ebbe

コンテナイメージをビルドします。

```sh
$ docker build \
    --no-cache \
    --tag app-hello-rocket:latest .
```

コンテナイメージを確認します。

```sh
$ docker images | grep app-hello-rocket
app-hello-rocket   latest    3658733ff5ea   21 seconds ago   84.3MB
```

:::note info
ここまでの手順で、ローカル環境の **Docker** にアプリの**カスタムコンテナイメージ**をビルドすることができました。
:::

### コンテナを起動

ローカルでコンテナを起動します。
※ コンテナを停止するときは ctrl + C を押します。

```sh
$ docker run --rm \
    --publish 8000:8000 \
    --name app-local \
    app-hello-rocket:latest
```

:::note info
ここまでの手順で、ローカル環境の **Docker** でアプリの**カスタムコンテナ**を起動することができました。
:::

### コンテナの動作確認

別ターミナルから curl コマンドで確認します。

```sh
$ curl -v http://localhost:8000/api/data -w '\n'
```

出力

```sh
*   Trying 127.0.0.1:8000...
* Connected to localhost (127.0.0.1) port 8000 (#0)
> GET /api/data HTTP/1.1
> Host: localhost:8000
> User-Agent: curl/7.81.0
> Accept: */*
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< content-type: application/json
< server: Rocket
< permissions-policy: interest-cohort=()
< x-frame-options: SAMEORIGIN
< x-content-type-options: nosniff
< content-length: 26
< date: Sat, 05 Aug 2023 12:45:05 GMT
<
* Connection #0 to host localhost left intact
{"message":"Hello World!"}
```

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

コンテナの状態を確認してみます。

```sh
$ docker ps
CONTAINER ID   IMAGE                     COMMAND   CREATED              STATUS          PORTS                                       NAMES
3c25d931499d   app-hello-rocket:latest   "./app"   About a minute ago   Up 59 seconds   0.0.0.0:8000->8000/tcp, :::8000->8000/tcp   app-local
```

### コンテナに接続

別ターミナルからコンテナに接続します。  

```sh
$ docker exec -it app-local /bin/sh
```

コンテナに接続後にディレクトリを確認します。
※ コンテナから出るときは ctrl + D を押します。

```
# pwd
/app
# ls -lah
total 9.1M
drwxr-xr-x 1 root root 4.0K Aug 10 05:01 .
drwxr-xr-x 1 root root 4.0K Aug 10 05:02 ..
-rwxr-xr-x 1 root root 9.1M Aug 10 05:01 app
```

top コマンドで状況を確認します。

```
# apt update
# apt install procps
# top
top - 05:10:28 up  5:19,  0 user,  load average: 0.03, 0.28, 0.28
Tasks:   3 total,   1 running,   2 sleeping,   0 stopped,   0 zombie
%Cpu(s):  0.0 us,  0.0 sy,  0.0 ni,100.0 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
MiB Mem :   7897.1 total,   1075.0 free,   2450.2 used,   4667.3 buff/cache
MiB Swap:   2048.0 total,   2027.4 free,     20.6 used.   5446.9 avail Mem

  PID USER      PR  NI    VIRT    RES    SHR S  %CPU  %MEM     TIME+ COMMAND
    1 root      20   0  818768   5008   4440 S   0.0   0.1   0:00.02 app
   19 root      20   0    2576    896    804 S   0.0   0.0   0:00.02 sh
  209 root      20   0    8560   4624   2768 R   0.0   0.1   0:00.00 top
```

コンテナの情報を表示してみます。

```cs
# cat /etc/*-release
PRETTY_NAME="Debian GNU/Linux 12 (bookworm)"
NAME="Debian GNU/Linux"
VERSION_ID="12"
VERSION="12 (bookworm)"
VERSION_CODENAME=bookworm
ID=debian
HOME_URL="https://www.debian.org/"
SUPPORT_URL="https://www.debian.org/support"
BUG_REPORT_URL="https://bugs.debian.org/"
```

:::note warn
このコンテナは Debian GNU/Linux をベースに作成されています。つまり、Debian GNU/Linux と同じように扱うことができます。
:::

### ディレクトリ・ファイル構成

プロジェクトのファイル構成を表示してみます。

```sh
$ tree -L 3
.
├── Cargo.lock
├── Cargo.toml
├── Dockerfile
├── src
│   └── main.rs
└── target
    ├── CACHEDIR.TAG
    └── debug
        ├── app
        ├── app.d
        ├── build
        ├── deps
        ├── examples
        └── incremental
```

## まとめ

WSL Ubuntu の Docker 環境で、Dockerfile からビルドした Rust Rocket Web サービスのカスタムコンテナを起動することができました。

:::note warn
クラウド開発においては、**Dockerfile の理解**は重要です。自動ビルドツールもありますが、手動で書く必要があるケースもあります。**Ubuntu** を使うと **Linux の知識**も身に付きます。最初は難しく感じるかもしれませんが、徐々に進めていけば自信を持って書けるようになります。
:::

どうでしたか？ WSL Ubuntu で、Rust Rocket Web アプリケーションを手軽に実行することができます。ぜひお試しください。今後も Rust の開発環境などを紹介していきますので、ぜひお楽しみにしてください。

## 推奨コンテンツ

https://qiita.com/studio_meowtoon/items/0c4556310fa1c8c5bb97