チェックポイント
Build simple a REST API
/ 20
Create a Revision for Cloud Run
/ 20
Create two cloud storage buckets
/ 10
Create a Pub/Sub topic for receiving notification from storage bucket
/ 10
Create a Pub/Sub subscription
/ 10
Create another build for REST API
/ 15
Create a new Revision
/ 15
Cloud Run を使用して PDF ファイルを作成するサーバーレス アプリをビルドする
GSP644
概要
「Google Cloud Serverless Workshop: Pet Theory」クエストのラボでは、架空のビジネス シナリオの登場人物を支援してサーバーレスへの移行計画を進めていきます。
Lily さんは 12 年前、獣医クリニック チェーン「Pet Theory」を開業しました。現在、Pet Theory では請求書を DOCX 形式でクライアントに送っていますが、ファイルを開けないという苦情が多く寄せられています。クライアント満足度の向上に向けて現状を打開するため、Lily さんは IT 部門の Patrick さんに代替案の調査を依頼しました。
運用チームのメンバーが 1 人しかいないため、望ましいのは運用中のメンテナンスに手間がかからないコスト効率の良いソリューションです。さまざまな選択肢を検討した結果、Patrick さんは Cloud Run を使用することにしました。
Cloud Run はサーバーレスであるため、すべてのインフラストラクチャ管理を抽象化し、オーバーヘッドを心配せずにアプリケーションのビルドに集中できます。しかも、Google サーバーレス プロダクトとして、使用しない場合はゼロにスケールできコストが発生しません。また、コンテナに基づくカスタム バイナリ パッケージを使用できるため、一貫性のある分離されたアーティファクトをビルドできるようになりました。
このラボでは、Cloud Storage に保存されているファイルを PDF に自動的に変換して別のフォルダに保存する、PDF コンバータ ウェブアプリを Cloud Run 上でビルドします。
アーキテクチャ
この図は、使用するサービスの概要と、それらがどのようにつながっているかを示しています。
学習内容
このラボでは、次の作業を行う方法について学びます。
- Node JS アプリケーションをコンテナに変換する。
- Google Cloud Build でコンテナをビルドする。
- クラウドでファイルを PDF ファイルに変換する Cloud Run サービスを作成する。
- Cloud Storage でイベント処理を使用する。
前提条件
これは基礎レベルのラボで、コンソール環境とシェル環境に精通していることを前提としています。Firebase の使用経験は役立ちますが、必須ではありません。このラボを受講する前に、次の Google Cloud Skills Boost ラボを完了しておくことをおすすめします。
ファイルの編集にも慣れている必要があります。ご自身で使い慣れたテキスト エディタ(nano
、vi
など)を使用するか、上部のリボンにある Cloud Shell からコードエディタを起動できます。
準備ができたら下にスクロールし、手順に沿ってラボ環境を設定します。
設定と要件
[ラボを開始] ボタンをクリックする前に
こちらの手順をお読みください。ラボの時間は記録されており、一時停止することはできません。[ラボを開始] をクリックするとスタートするタイマーは、Google Cloud のリソースを利用できる時間を示しています。
このハンズオンラボでは、シミュレーションやデモ環境ではなく、実際のクラウド環境を使ってご自身でラボのアクティビティを行うことができます。そのため、ラボの受講中に Google Cloud にログインおよびアクセスするための、新しい一時的な認証情報が提供されます。
このラボを完了するためには、下記が必要です。
- 標準的なインターネット ブラウザ(Chrome を推奨)
- ラボを完了するために十分な時間を確保してください。ラボをいったん開始すると一時停止することはできません。
ラボを開始して Google Cloud コンソールにログインする方法
-
[ラボを開始] ボタンをクリックします。ラボの料金をお支払いいただく必要がある場合は、表示されるポップアップでお支払い方法を選択してください。 左側の [ラボの詳細] パネルには、以下が表示されます。
- [Google コンソールを開く] ボタン
- 残り時間
- このラボで使用する必要がある一時的な認証情報
- このラボを行うために必要なその他の情報(ある場合)
-
[Google コンソールを開く] をクリックします。 ラボでリソースが起動し、別のタブで [ログイン] ページが表示されます。
ヒント: タブをそれぞれ別のウィンドウで開き、並べて表示しておきましょう。
注: [アカウントの選択] ダイアログが表示されたら、[別のアカウントを使用] をクリックします。 -
必要に応じて、[ラボの詳細] パネルから [ユーザー名] をコピーして [ログイン] ダイアログに貼り付けます。[次へ] をクリックします。
-
[ラボの詳細] パネルから [パスワード] をコピーして [ようこそ] ダイアログに貼り付けます。[次へ] をクリックします。
重要: 認証情報は左側のパネルに表示されたものを使用してください。Google Cloud Skills Boost の認証情報は使用しないでください。 注: このラボでご自身の Google Cloud アカウントを使用すると、追加料金が発生する場合があります。 -
その後次のように進みます。
- 利用規約に同意してください。
- 一時的なアカウントなので、復元オプションや 2 要素認証プロセスは設定しないでください。
- 無料トライアルには登録しないでください。
その後このタブで Cloud Console が開きます。
Cloud Shell をアクティブにする
Cloud Shell は、開発ツールと一緒に読み込まれる仮想マシンです。5 GB の永続ホーム ディレクトリが用意されており、Google Cloud で稼働します。Cloud Shell を使用すると、コマンドラインで Google Cloud リソースにアクセスできます。
- Google Cloud コンソールの上部にある「Cloud Shell をアクティブにする」アイコン をクリックします。
接続した時点で認証が完了しており、プロジェクトに各自の PROJECT_ID が設定されます。出力には、このセッションの PROJECT_ID を宣言する次の行が含まれています。
gcloud
は Google Cloud のコマンドライン ツールです。このツールは、Cloud Shell にプリインストールされており、タブ補完がサポートされています。
- (省略可)次のコマンドを使用すると、有効なアカウント名を一覧表示できます。
-
[承認] をクリックします。
-
出力は次のようになります。
出力:
- (省略可)次のコマンドを使用すると、プロジェクト ID を一覧表示できます。
出力:
出力例:
gcloud
ドキュメントの全文については、gcloud CLI の概要ガイドをご覧ください。
タスク 1. タスクについて
Pet theory では、PDF に変換された請求書をクライアントが確実に開けるようにしたいと考えています。さらに、チームはこの変換を自動化して、オフィス マネージャーである Lisa さんの作業負荷を最小限に抑えたいと考えています。
Pet Theory のコンピュータ コンサルタントである Ruby さんは、IT 部門の Patrick さんから次のメッセージを受け取りました。
Patrick さん(IT 管理者) |
Ruby さん、お世話になっております。 こちらで調べてみたところ、さまざまなファイル形式を PDF に変換するには LibreOffice が良さそうです。 サーバーのメンテナンスを行う必要なく、クラウドで LibreOffice を実行することは可能でしょうか? Patrick |
Ruby さん(ソフトウェア コンサルタント) |
Patrick さん、ご連絡ありがとうございます。 そのようなご要望であれば、ぜひおすすめしたいものがあります。 Next 19 で発表された Cloud Run です。YouTube の動画で視聴したのですが、サーバーレス環境で Cloud Run を使用して LibreOffice を実行できるようです。サーバーのメンテナンスも不要です。 設定に役立つリソースをいくつかお送りしますので、ご確認のほどよろしくお願いいたします。 Ruby |
Patrick さんが Cloud Run の設定とデプロイを行えるようサポートしましょう。
タスク 2. Cloud Run API を有効にする
-
ナビゲーション メニュー()を開き、[API とサービス] > [ライブラリ] をクリックします。検索バーに「Cloud Run」と入力し、検索結果のリストで Cloud Run API を選択します。
-
[有効にする] をクリックします。ブラウザの戻るボタンを 2 回クリックすると、コンソールは次のようになります。
タスク 3. シンプルな Cloud Run サービスをデプロイする
Ruby さんは開発した Cloud Run プロトタイプを、Patrick さんに Google Cloud にデプロイしてもらいたいと思っています。ここで、Patrick さんが Pet Theory の PDF Cloud Run サービスを確立するのをサポートしましょう。
- 新しい Cloud Shell セッションを開き、次のコマンドを実行して Pet Theory のリポジトリのクローンを作成します。
- 次に、現在の作業ディレクトリを lab03 に変更します。
- Cloud Shell コードエディタまたは任意のテキスト エディタで
package.json
を編集します。"scripts" セクションに以下のように"start": "node index.js",
を追加します。
- 次に、Cloud Shell で次のコマンドを実行して、変換スクリプトで使用するパッケージをインストールします。
- 次に、
lab03/index.js
ファイルを開いてコードを確認します。
アプリケーションは、HTTP POST を受け入れる Cloud Run サービスとしてデプロイされます。POST リクエストがアップロードされたファイルに関する Pub/Sub 通知である場合は、サービスによりファイルの詳細がログに書き込まれます。そうでない場合は、サービスにより単に文字列「OK」が返されます。
-
lab03/Dockerfile
というファイルを確認します。
上記のファイルはマニフェストと呼ばれ、Docker コマンドがイメージをビルドするためのレシピを提供します。各行は、Docker に次の情報の処理方法を指示するコマンドで始まります。
- 最初のリストは、ベースイメージが、作成されるイメージのテンプレートとしてノード v12 を使用する必要があることを示しています。
- 最後の行は、実行するコマンドを示しています。この例では、"npm start" を参照しています。
- REST API をビルドしてデプロイするには、Google Cloud Build を使用します。次のコマンドを実行して、ビルドプロセスを開始します。
このコマンドは、コードでコンテナをビルドし、プロジェクトの Container Registry にそのコンテナを配置します。
- Cloud コンソールに戻り、ナビゲーション メニューから [Container Registry] > [イメージ] を選択します。ホストされているコンテナが表示されます。
完了したタスクをテストする
[進行状況を確認] をクリックして、上記のタスクを実行したことを確認します。
- コードエディタのタブに戻り、Cloud Shell で次のコマンドを実行してアプリケーションをデプロイします。
- デプロイが完了すると、次のようなメッセージが表示されます。
- アプリに簡単にアクセスできるように、アプリ用の環境変数
$SERVICE_URL
を作成します。
完了したタスクをテストする
[進行状況を確認] をクリックして、上記のタスクを実行したことを確認します。
- 新しいサービスに匿名の POST リクエストを行います。
これにより、「Your client does not have permission to get the URL
」というエラー メッセージが表示されます。これは「匿名ユーザーはサービスを呼び出せない」ということですので、表示されても問題ありません。
- 次に、承認されたユーザーとしてサービスを呼び出してみます。
「OK
」という応答が得られれば、Cloud Run サービスは正常にデプロイされています。このタスクは以上で完了です。
タスク 4. 新しいファイルがアップロードされたときに Cloud Run サービスをトリガーする
Cloud Run サービスが正常にデプロイされたので、Ruby さんは Patrick さんにデータを変換するためのステージング領域を作成してしてもらうことにします。Cloud Storage バケットは、イベント トリガーを使用して、ファイルがアップロードされて処理が必要になったときにアプリケーションに通知します。
- 次のコマンドを実行して、アップロードされたドキュメント用のバケットを Cloud Storage に作成します。
- 変換後の PDF に使用する別のバケットを次のように作成します。
- 次に Cloud コンソールのタブに戻り、ナビゲーション メニューを開いて、[Cloud Storage] を選択します。バケットが作成されたことを確認します(プラットフォームによって使用される他のバケットも確認できます)。
完了したタスクをテストする
[進行状況を確認] をクリックして、上記のタスクを実行したことを確認します。
- Cloud Shell で次のコマンドを実行して、新しいファイルがドキュメント バケットへのアップロードを完了するたびに、Pub/Sub 通知を送信するように Cloud Storage に指示します。
通知にはトピック「new-doc」というラベルが付けられます。
完了したタスクをテストする
[進行状況を確認] をクリックして、上記のタスクを実行したことを確認します。
- Pub/Sub が Cloud Run サービスをトリガーするために使用する新しいサービス アカウントを作成します。
- 新しいサービス アカウントに PDF コンバータ サービスを呼び出す権限を付与します。
- 次のコマンドを実行して、プロジェクト番号を見つけます。
名前が「qwiklabs-gcp-」で始まるプロジェクトを探します。プロジェクト番号の値は次のコマンドで使用します。
-
PROJECT_NUMBER
環境変数を作成します。[project number] は直前のコマンドで取得したプロジェクト番号に置き換えます。
- プロジェクトで Cloud Pub/Sub 認証トークンを作成できるようにします。
サービス アカウントが存在しない
」というエラーが表示された場合は、Cloud Pub/Sub API を有効にします。すでに有効になっている場合は、いったん無効にしてから再度有効にします。その後、上記のコマンドを再実行してください。
- 最後に、Pub/Sub サブスクリプションを作成して、トピック「new-doc」でメッセージが公開されるときはいつでも PDF コンバータを実行できるようにします。
完了したタスクをテストする
[進行状況を確認] をクリックして、上記のタスクを実行したことを確認します。
タスク 5. ファイルが Cloud Storage にアップロードされたときに Cloud Run サービスがトリガーされるかを確認する
Ruby さんは、アプリケーションが期待どおりに動作していることを確認するために、名前を付けたストレージ バケットにテストデータをアップロードして、Cloud Logging を確認するよう Patrick さんに依頼します。
- テストファイルをアップロード バケットにコピーします。
-
アップロードが完了したら、Cloud コンソールのタブに戻り、ナビゲーション メニューを開いて、[オペレーション] セクションの [ロギング] を選択します。
-
[リソース] プルダウンで、[Cloud Run のリビジョン] を指定して結果をフィルタし、[適用] をクリックします。[クエリを実行] をクリックします。
-
[クエリ結果] で、
file:
で始まるログエントリを探してクリックします。新しいファイルがアップロードされると、Pub/Sub が Cloud Run サービスに送信するファイルデータのダンプが表示されます。 -
このオブジェクトでアップロードしたファイルの名前を確認します。
- 次に、コードエディタのタブに戻り、Cloud Shell で次のコマンドを実行して、
upload
ディレクトリ内のファイルを削除し、ディレクトリをクリーンアップします。
タスク 6. Docker コンテナ
Patrick さんは、すべてのクライアントが請求書を開けるように請求書のバックログを PDF に変換する必要があります。そこで、メールで Ruby さんにサポートを求めることにしました。
Patrick さん(IT 管理者) |
Ruby さん、お世話になっております。 いただいた情報をもとにこのプロセスを自動化したうえで、PDF を請求書の形式として使用できるようにすることも可能だと思います。 昨日少し時間をかけてソリューションをコーディングし、必要なことを実行するための Node.js スクリプトを作成しました。ご確認いただけますか? Patrick |
Patrick さんは、ファイルから PDF を生成するために作成した次のコード フラグメントを Ruby に送信します。
Ruby さんは Patrick さんに返事を書きます。
Ruby さん(ソフトウェア コンサルタント) |
Patrick さん、ご連絡ありがとうございます。 Cloud Run はコンテナを使用するため、その形式でアプリケーションを用意する必要があります。次のステップとしてアプリケーションの Dockerfile マニフェストを作成してください。 作成したコードでは LibreOffice を使用します。そのソフトウェアをインストールするためのコマンドをお送りいただけますか?それをコンテナに含める必要があります。 Ruby |
Patrick さん(IT 管理者) |
Ruby さん、お世話になっております。 早速ありがとうございます。LibreOffice をオフィスのサーバーにインストールするのに、通常は以下のコマンドを使っています。
他にも必要な情報がありましたら、ご連絡ください。 Patrick |
コンテナをビルドするには、いくつかのコンポーネントを統合する必要があります。
Docker コンテナを更新する
すべてのファイルが特定されたら、Dockerfile を作成できます。Ruby さんがコンテナの設定とデプロイを行うのをサポートしましょう。
LibreOffice のパッケージがコンテナに含まれていなかったので、追加する必要があります。Patrick さんからアプリケーションのビルドに使用するコマンドが提供されましたので、Ruby さんはそのコマンドを Dockerfile 内に RUN
コマンドとして追加します。
-
Dockerfile
マニフェストを開き、コマンドラインRUN apt-get update -y && apt-get install -y libreoffice && apt-get clean
を次のように追加します。
新しいバージョンの PDF 変換サービスをデプロイする
-
index.js
ファイルを開き、ファイルの先頭に次のパッケージ要件を追加します。
-
app.post('/', async (req, res)
を次のコードに置き換えます。
- 次に、LibreOffice ドキュメントを処理する次のコードをファイルの末尾に追加します。
-
index.js
ファイルが次のようになっていることを確認します。
index.js
ファイル内のすべてのコードをこのサンプルコードに置き換えることをおすすめします。
- メインロジックは次の関数に含まれています。
ファイルがアップロードされるときはいつでも、このサービスがトリガーされます。上の関数はそれぞれ、次のタスクを実行します(各行 1 タスクずつ)。
- Pub/Sub 通知からファイルの詳細を抽出します。
- Cloud Storage からローカルのハードドライブにファイルをダウンロードします。これは実際には物理ディスクではなく、ディスクのように動作する仮想メモリのセクションです。
- ダウンロードしたファイルを PDF に変換します。
- PDF ファイルを Cloud Storage にアップロードします。環境変数
process.env.PDF_BUCKET
には、PDF を書き込む Cloud Storage バケットの名前が含まれています。後述するサービスをデプロイする際、この変数に値を割り当てます。 - 元のファイルを Cloud Storage から削除します。
index.js
の残りの部分では、このトップレベルのコードによって呼び出される関数を実装します。
ここでサービスをデプロイし、PDF_BUCKET
環境変数を設定します。LibreOffice の処理用に、2 GB の RAM を指定することもおすすめします(--memory
オプションのある行を参照)。
- 次のコマンドを実行してコンテナをビルドします。
完了したタスクをテストする
[進行状況を確認] をクリックして、上記のタスクを実行したことを確認します。
- 最新バージョンのアプリケーションをデプロイします。
コンテナに LibreOffice の部分が含まれているため、このビルドは以前のビルドよりも時間がかかります。待ってる間、立ち上がってストレッチでもしましょう。
[進行状況を確認] をクリックして、目標に沿って進んでいることを確認します。
タスク 7. PDF 変換サービスをテストする
- デプロイ コマンドが完了したら、次のコマンドを実行して、サービスが正しくデプロイされたことを確認します。
-
「
OK
」という応答が得られれば、更新された Cloud Run サービスは正常にデプロイされています。LibreOffice は、DOCX、XLSX、JPG、PNG、GIF などの多くのファイル形式を PDF に変換できます。 -
次のコマンドを実行して、いくつかのサンプル ファイルをアップロードします。
-
Cloud コンソールに戻り、ナビゲーション メニューを開いて [Cloud Storage] を選択します。
-upload
バケットを開き、[更新] ボタンを数回クリックして、ファイルが PDF に変換されるときに、ファイルが 1 つずつ削除される様子を確認します。 -
次に、左側のメニューから [バケット] をクリックし、名前が「-processed」で終わるバケットをクリックします。そのバケットにはすべてのファイルの PDF バージョンが含まれています。PDF ファイルを開いて、適切に変換されていることを確認してください。
-processed
バケット内に表示されていない変換済み PDF ファイルがある場合は、コマンドを再実行してください。
お疲れさまでした
Pet Theory で、元のファイルのアーカイブを PDF に変換するシステムが確立されました。元のファイルを「upload」バケットにアップロードするだけで、PDF コンバータ サービスによりファイルが変換され、「processed」バケットに PDF として書き込まれます。
クエストを完了する
このセルフペース ラボは、「Serverless Cloud Run Development」クエストの一部です。クエストとは学習プログラムを構成する一連のラボのことで、完了すると成果が認められてバッジが贈られます。バッジは公開して、オンライン レジュメやソーシャル メディア アカウントにリンクできます。こちらのクエストに登録すると、すぐにクレジットを受け取ることができます。受講可能な全クエストについては、Google Cloud Skills Boost カタログをご覧ください。
次のラボを受講する
シリーズの次のラボ「Cloud Run と Pub/Sub を使用して復元性に優れた非同期システムをビルドする」でクエストを続行してください。
次のステップと詳細情報
サーバーレス コンテナの詳細: Next 19 の YouTube 動画
Google Cloud トレーニングと認定資格
Google Cloud トレーニングと認定資格を通して、Google Cloud 技術を最大限に活用できるようになります。必要な技術スキルとベスト プラクティスについて取り扱うクラスでは、学習を継続的に進めることができます。トレーニングは基礎レベルから上級レベルまであり、オンデマンド、ライブ、バーチャル参加など、多忙なスケジュールにも対応できるオプションが用意されています。認定資格を取得することで、Google Cloud テクノロジーに関するスキルと知識を証明できます。
マニュアルの最終更新日: 2023 年 10 月 26 日
ラボの最終テスト日: 2023 年 10 月 27 日
Copyright 2024 Google LLC All rights reserved. Google および Google のロゴは Google LLC の商標です。その他すべての企業名および商品名はそれぞれ各社の商標または登録商標です。