このチュートリアルでは、グラフの説明の入力パラメータを PNG
形式の図に変換する Knative serving カスタム サービスをビルドします。ここでは、Graphviz をシステム パッケージとしてサービスのコンテナ環境にインストールします。リクエストを処理するときに、コマンドライン ユーティリティから Graphviz を使用します。
目標
- カスタム コンテナを作成し、Dockerfile と一緒にビルドする。
- Knative serving サービスを作成、ビルド、デプロイする。
- Graphviz dot ユーティリティを使用して図を生成する。
- コレクションの DOT 構文図または独自の構文図を投稿してサービスをテストする。
費用
このドキュメントでは、Google Cloud の次の課金対象のコンポーネントを使用します。
料金計算ツールを使うと、予想使用量に基づいて費用の見積もりを生成できます。
始める前に
- このチュートリアルは、Knative serving がクラスタにインストールされ、構成されていることを前提としています。
- コマンドライン環境が設定され、ツールが最新であることを確認してください。
コードサンプルを取得する
使用するコードサンプルを取得するには:
ローカルマシンにサンプルアプリのリポジトリのクローンを作成します。
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
または、zip 形式のサンプルをダウンロードし、ファイルを抽出してもかまいません。
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
または、zip 形式のサンプルをダウンロードし、ファイルを抽出してもかまいません。
Go
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
または、zip 形式のサンプルをダウンロードし、ファイルを抽出してもかまいません。
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
または、zip 形式のサンプルをダウンロードしてファイルを抽出してもかまいません。
Knative serving サンプルコードが含まれているディレクトリに移動します。
Node.js
cd nodejs-docs-samples/run/system-package/
Python
cd python-docs-samples/run/system-package/
Go
cd golang-samples/run/system_package/
Java
cd java-docs-samples/run/system-package/
アーキテクチャを可視化する
基本的なアーキテクチャは次のようになります。
ユーザーが HTTP リクエストを Knative serving サービスに送信し、このサービスが Graphviz ユーティリティを実行して、リクエストを画像に変換します。この画像が HTTP レスポンスとしてユーザーに配信されます。
コードについて
Dockerfile
で環境構成を定義する
Dockerfile
は、サービスで使用する言語と基礎となるオペレーティング環境(Ubuntu など)によって異なります。
このサービスでは、デフォルト以外のシステム パッケージを追加する必要があります。
エディタで
Dockerfile
を開きます。Dockerfile
RUN
ステートメントを探します。このステートメントにより、任意のシェルコマンドを実行して環境を変更できます。Dockerfile
に、複数のFROM
ステートメントの探索で識別された複数のステージがある場合、そのステートメントは最終ステージにあります。必要なパッケージとそのインストール方法は、コンテナで宣言されているオペレーティング システムによって異なります。
ご使用のオペレーティング システムまたはベースイメージの説明については、適切なタブをクリックして確認してください。
Debian / Ubuntu Alpine Alpine は、フォント サポート用に 2 番目のパッケージを必要とします。コンテナ イメージのオペレーティング システムを確認するには、
FROM
ステートメントで名前を確認するか、ベースイメージの README を確認します。たとえば、node
から拡張する場合、Docker Hub でドキュメントと親Dockerfile
を見つけることができます。ローカルでの
docker build
または Cloud Build を使用してイメージをビルドし、カスタマイズをテストします。
受信リクエストを処理する
サンプル サービスは、受信 HTTP リクエストのパラメータを使用して、適切な dot
ユーティリティ コマンドを実行するシステムコールを呼び出します。
以下の HTTP ハンドラでは、グラフの説明の入力パラメータが dot
クエリ文字列変数から抽出されます。
クエリ文字列で使用するために、グラフの説明に含まれている文字の URL エンコードが必要になる場合があります。
Node.js
Python
Go
Java
内部サーバーエラーと無効なユーザー入力を区別する必要があります。このサンプル サービスは、エラー メッセージにユーザー入力の問題を示す文字列 syntax
が含まれていない限り、すべての dot コマンドライン エラーに対して内部サーバーエラーを返します。
図を生成する
図を生成するコアロジックは、dot コマンドライン ツールを使用して、グラフの説明の入力パラメータを PNG 形式の図に変換します。
Node.js
Python
Go
Java
安全なサービスを設計する
dot
ツールには、ウェブサービスの脆弱性が存在する可能性があります。このリスクを軽減するには、コンテナ イメージを定期的に再ビルドし、graphviz
パッケージの最新バージョンが使用されるようにします。
ユーザーの入力をコマンドライン パラメータとして受け入れるように現在のサンプルを拡張する場合は、コマンド インジェクション攻撃の対策を講じる必要があります。たとえば、次のような方法でインジェクション攻撃を防ぎます。
- サポートされているパラメータの辞書と入力をマッピングする
- 入力値を検証し、既知の安全な範囲内にあることを確認する(正規表現などを使用)
- シェル構文が評価されないように入力をエスケープする
コードの配布
コードを配布するには、Cloud Build でビルドし、Container Registry にアップロードして Knative serving にデプロイします。
次のコマンドを実行してコンテナをビルドし、Container Registry に公開します。
Node.js
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
PROJECT_ID は Google Cloud プロジェクト ID、
graphviz
はサービスに付ける名前です。ビルドが成功すると、ID、作成時間、画像の名前を含む SUCCESS メッセージが表示されます。イメージが Container Registry に保存されます。このイメージは必要に応じて再利用できます。
Python
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
PROJECT_ID は Google Cloud プロジェクト ID、
graphviz
はサービスに付ける名前です。ビルドが成功すると、ID、作成時間、画像の名前を含む SUCCESS メッセージが表示されます。イメージが Container Registry に保存されます。このイメージは必要に応じて再利用できます。
Go
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
PROJECT_ID は Google Cloud プロジェクト ID、
graphviz
はサービスに付ける名前です。ビルドが成功すると、ID、作成時間、画像の名前を含む SUCCESS メッセージが表示されます。イメージが Container Registry に保存されます。このイメージは必要に応じて再利用できます。
Java
このサンプルでは、Jib を使用して一般的な Java ツールにより Docker イメージをビルドします。Jib は、Dockerfile や Docker をインストールせずにコンテナのビルドを最適化します。Jib を使用して Java コンテナを構築する方法の詳細を確認します。Dockerfile を使用して、インストールしたシステム パッケージでベースイメージの構成とビルドを行い、Jib のデフォルト ベースイメージを上書きします。
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz-base
ここで PROJECT_ID は、Google Cloud プロジェクト ID です。
Jib で最終的なコンテナを作成し、Container Registry で公開します。
mvn compile jib:build \ -Dimage=gcr.io/PROJECT_ID/graphviz \ -Djib.from.image=gcr.io/PROJECT_ID/graphviz-base
ここで PROJECT_ID は、Google Cloud プロジェクト ID です。
次のコマンドを使用してデプロイします。
gcloud run deploy graphviz-web --create-if-missing --image gcr.io/PROJECT_ID/graphviz
ここで、PROJECT_ID は Google Cloud プロジェクト ID、
graphviz
は上記のコンテナ名、graphviz-web
はサービス名です。デプロイが完了するまで待ちます。30 秒ほどかかる場合があります。
サービスにコードの更新をデプロイする場合は、上記のステップを繰り返します。サービスをデプロイするたびに、リビジョンが作成されます。準備ができると、トラフィックの送信が自動的に開始します。
試してみる
リクエスト ペイロードで DOT 構文の説明を含む HTTP POST
リクエストを送信し、サービスを試してみましょう。
サービスに HTTP リクエストを送信します。
生成された図はウェブページに埋め込むことができます。
-
ロードバランサの外部 IP を取得するには、次のコマンドを実行します。
kubectl get svc istio-ingressgateway -n ASM-INGRESS-NAMESPACE
ASM-INGRESS-NAMESPACE は、Cloud Service Mesh Ingress が配置されている Namespace に置き換えます。Cloud Service Mesh をデフォルトの構成を使用してインストールした場合は、
istio-system
を指定します。出力は次のようになります。
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) istio-ingressgateway LoadBalancer XX.XX.XXX.XX pending 80:32380/TCP,443:32390/TCP,32400:32400/TCP
ここで、EXTERNAL-IP の値は、ロードバランサの外部 IP アドレスです。
この
EXTERNAL-IP
アドレスを URL に使用して、curl コマンドを実行します。プロトコル(例:http://
)はSERVICE_DOMAIN
に含めないでください。curl -G -H "Host: SERVICE_DOMAIN" http://EXTERNAL-IP/diagram.png \ --data-urlencode "dot=digraph Run { rankdir=LR Code -> Build -> Deploy -> Run }" \ > diagram.png
-
Chrome などの
PNG
ファイルをサポートするアプリケーションで、結果のdiagram.png
ファイルを開きます。次のようになります。
既製の図の説明の小コレクションを調べることができます。
- 選択した
.dot
ファイルのコンテンツをコピーします。 curl
コマンドに貼り付けます。curl -G -H "Host: SERVICE_DOMAIN" http://EXTERNAL-IP/diagram.png \ --data-urlencode "dot=digraph Run { rankdir=LR Code -> Build -> Deploy -> Run }" \ > diagram.png
クリーンアップ
費用が発生しないように、このチュートリアル用に作成したリソースを削除します。
チュートリアル リソースを削除する
このチュートリアルでデプロイした Knative serving サービスを削除します。
gcloud run services delete SERVICE-NAME
SERVICE-NAME は、選択したサービス名です。
Knative serving サービスは、Google Cloud コンソールから削除することもできます。
チュートリアルを設定したときに追加した gcloud のデフォルト構成を削除します。
gcloud config unset run/platform gcloud config unset run/cluster gcloud config unset run/cluster_location
プロジェクト構成を削除します。
gcloud config unset project
このチュートリアルで作成した他の Google Cloud リソースを削除します。
gcr.io/<var>PROJECT_ID</var>/graphviz
という名前のコンテナ イメージを Container Registry から削除します。- このチュートリアル用にクラスタを作成した場合は、クラスタを削除します。
次のステップ
- graphviz アプリを試す。
- 他の graphviz ユーティリティのサポートを追加し、別のアルゴリズムを適用して図を生成する。
- 図を Cloud Storage に保存する。イメージまたは DOT 構文を保存します。
- Cloud Natural Language API を使用して、コンテンツの不正利用を防ぐ対策を講じる。
- Google Cloud に関するリファレンス アーキテクチャ、図、ベスト プラクティスを確認する。Cloud アーキテクチャ センターをご覧ください。