このドキュメントは、フリートと Anthos Service Mesh を使用する Knative serving の最新バージョンを対象としています。詳細

過去のバージョン（Cloud Run for Anthos）はアーカイブされていますが、既存のユーザーはドキュメントを引き続きご利用いただけます。

利用可能なバージョン

最新
アーカイブ

システムパッケージを使用する

このチュートリアルでは、グラフの説明の入力パラメータを PNG 形式の図に変換する Knative serving カスタムサービスをビルドします。ここでは、Graphviz をシステムパッケージとしてサービスのコンテナ環境にインストールします。リクエストを処理するときに、コマンドラインユーティリティから Graphviz を使用します。

目標

カスタムコンテナを作成し、Dockerfile と一緒にビルドする。
Knative serving サービスを作成、ビルド、デプロイする。
Graphviz dot ユーティリティを使用して図を生成する。
コレクションの DOT 構文図または独自の構文図を投稿してサービスをテストする。

費用

このドキュメントでは、Google Cloud の次の課金対象のコンポーネントを使用します。

料金計算ツールを使うと、予想使用量に基づいて費用の見積もりを生成できます。新しい Google Cloud ユーザーは無料トライアルをご利用いただける場合があります。

始める前に

このチュートリアルは、Knative serving がクラスタにインストールされ、構成されていることを前提としています。
コマンドライン環境が設定され、ツールが最新であることを確認してください。
- Google Cloud 上の GKE クラスタ
- Google Cloud 外の GKE クラスタ

コードサンプルを取得する

使用するコードサンプルを取得するには:

ローカルマシンにサンプルアプリのリポジトリのクローンを作成します。
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/

アーキテクチャを可視化する

基本的なアーキテクチャは次のようになります。

ユーザーのリクエストをウェブサービスから graphviz dot ユーティリティに送信する流れ — 図のソースについては、DOT の説明をご覧ください。

ユーザーが HTTP リクエストを Knative serving サービスに送信し、このサービスが Graphviz ユーティリティを実行して、リクエストを画像に変換します。この画像が HTTP レスポンスとしてユーザーに配信されます。

コードについて

`Dockerfile` で環境構成を定義する

Dockerfile は、サービスで使用する言語と基礎となるオペレーティング環境（Ubuntu など）によって異なります。

このサービスでは、デフォルト以外のシステムパッケージを追加する必要があります。

エディタで Dockerfile を開きます。
Dockerfile RUN ステートメントを探します。このステートメントにより、任意のシェルコマンドを実行して環境を変更できます。Dockerfile に、複数の FROM ステートメントの探索で識別された複数のステージがある場合、そのステートメントは最終ステージにあります。

必要なパッケージとそのインストール方法は、コンテナで宣言されているオペレーティングシステムによって異なります。

ご使用のオペレーティングシステムまたはベースイメージの説明については、適切なタブをクリックして確認してください。
Debian / Ubuntu
```
RUN apt-get update -y && apt-get install -y \
  graphviz \
  && apt-get clean
```
Alpine
Alpine は、フォントサポート用に 2 番目のパッケージを必要とします。
```
RUN apk --no-cache add graphviz ttf-ubuntu-font-family
```
コンテナイメージのオペレーティングシステムを確認するには、FROM ステートメントで名前を確認するか、ベースイメージの README を確認します。たとえば、node から拡張する場合、Docker Hub でドキュメントと親 Dockerfile を見つけることができます。
ローカルでの docker build または Cloud Build を使用してイメージをビルドし、カスタマイズをテストします。

受信リクエストを処理する

サンプルサービスは、受信 HTTP リクエストのパラメータを使用して、適切な dot ユーティリティコマンドを実行するシステムコールを呼び出します。

以下の HTTP ハンドラでは、グラフの説明の入力パラメータが dot クエリ文字列変数から抽出されます。

クエリ文字列で使用するために、グラフの説明に含まれている文字の URL エンコードが必要になる場合があります。

Node.js

app.get('/diagram.png', (req, res) => {
  try {
    const image = createDiagram(req.query.dot);
    res.setHeader('Content-Type', 'image/png');
    res.setHeader('Content-Length', image.length);
    res.setHeader('Cache-Control', 'public, max-age=86400');
    res.send(image);
  } catch (err) {
    console.error(`error: ${err.message}`);
    const errDetails = (err.stderr || err.message).toString();
    if (errDetails.includes('syntax')) {
      res.status(400).send(`Bad Request: ${err.message}`);
    } else {
      res.status(500).send('Internal Server Error');
    }
  }
});

Python

@app.route("/diagram.png", methods=["GET"])
def index():
    """Takes an HTTP GET request with query param dot and
    returns a png with the rendered DOT diagram in a HTTP response.
    """
    try:
        image = create_diagram(request.args.get("dot"))
        response = make_response(image)
        response.headers.set("Content-Type", "image/png")
        return response

    except Exception as e:
        print(f"error: {e}")

        # If no graphviz definition or bad graphviz def, return 400
        if "syntax" in str(e):
            return f"Bad Request: {e}", 400

        return "Internal Server Error", 500

Go


// diagramHandler renders a diagram using HTTP request parameters and the dot command.
func diagramHandler(w http.ResponseWriter, r *http.Request) {
	if r.Method != http.MethodGet {
		log.Printf("method not allowed: %s", r.Method)
		http.Error(w, fmt.Sprintf("HTTP Method %s Not Allowed", r.Method), http.StatusMethodNotAllowed)
		return
	}

	q := r.URL.Query()
	dot := q.Get("dot")
	if dot == "" {
		log.Print("no graphviz definition provided")
		http.Error(w, "Bad Request", http.StatusBadRequest)
		return
	}

	// Cache header must be set before writing a response.
	w.Header().Set("Cache-Control", "public, max-age=86400")

	input := strings.NewReader(dot)
	if err := createDiagram(w, input); err != nil {
		log.Printf("createDiagram: %v", err)
		// Do not cache error responses.
		w.Header().Del("Cache-Control")
		if strings.Contains(err.Error(), "syntax") {
			http.Error(w, "Bad Request: DOT syntax error", http.StatusBadRequest)
		} else {
			http.Error(w, "Internal Server Error", http.StatusInternalServerError)
		}
	}
}

Java

get(
    "/diagram.png",
    (req, res) -> {
      InputStream image = null;
      try {
        String dot = req.queryParams("dot");
        image = createDiagram(dot);
        res.header("Content-Type", "image/png");
        res.header("Content-Length", Integer.toString(image.available()));
        res.header("Cache-Control", "public, max-age=86400");
      } catch (Exception e) {
        if (e.getMessage().contains("syntax")) {
          res.status(400);
          return String.format("Bad Request: %s", e.getMessage());
        } else {
          res.status(500);
          return "Internal Server Error";
        }
      }
      return image;
    });

内部サーバーエラーと無効なユーザー入力を区別する必要があります。このサンプルサービスは、エラーメッセージにユーザー入力の問題を示す文字列 syntax が含まれていない限り、すべての dot コマンドラインエラーに対して内部サーバーエラーを返します。

図を生成する

図を生成するコアロジックは、dot コマンドラインツールを使用して、グラフの説明の入力パラメータを PNG 形式の図に変換します。

Node.js

// Generate a diagram based on a graphviz DOT diagram description.
const createDiagram = dot => {
  if (!dot) {
    throw new Error('syntax: no graphviz definition provided');
  }

  // Adds a watermark to the dot graphic.
  const dotFlags = [
    '-Glabel="Made on Cloud Run"',
    '-Gfontsize=10',
    '-Glabeljust=right',
    '-Glabelloc=bottom',
    '-Gfontcolor=gray',
  ].join(' ');

  const image = execSync(`/usr/bin/dot ${dotFlags} -Tpng`, {
    input: dot,
  });
  return image;
};

Python

def create_diagram(dot):
    """Generates a diagram based on a graphviz DOT diagram description.

    Args:
        dot: diagram description in graphviz DOT syntax

    Returns:
        A diagram in the PNG image format.
    """
    if not dot:
        raise Exception("syntax: no graphviz definition provided")

    dot_args = [  # These args add a watermark to the dot graphic.
        "-Glabel=Made on Cloud Run",
        "-Gfontsize=10",
        "-Glabeljust=right",
        "-Glabelloc=bottom",
        "-Gfontcolor=gray",
        "-Tpng",
    ]

    # Uses local `dot` binary from Graphviz:
    # https://graphviz.gitlab.io
    image = subprocess.run(
        ["dot"] + dot_args, input=dot.encode("utf-8"), stdout=subprocess.PIPE
    ).stdout

    if not image:
        raise Exception("syntax: bad graphviz definition provided")
    return image

Go


// createDiagram generates a diagram image from the provided io.Reader written to the io.Writer.
func createDiagram(w io.Writer, r io.Reader) error {
	stderr := new(bytes.Buffer)
	args := []string{
		"-Glabel=Made on Cloud Run",
		"-Gfontsize=10",
		"-Glabeljust=right",
		"-Glabelloc=bottom",
		"-Gfontcolor=gray",
		"-Tpng",
	}
	cmd := exec.Command("/usr/bin/dot", args...)
	cmd.Stdin = r
	cmd.Stdout = w
	cmd.Stderr = stderr

	if err := cmd.Run(); err != nil {
		return fmt.Errorf("exec(%s) failed (%w): %s", cmd.Path, err, stderr.String())
	}

	return nil
}

Java

// Generate a diagram based on a graphviz DOT diagram description.
public static InputStream createDiagram(String dot) {
  if (dot == null || dot.isEmpty()) {
    throw new NullPointerException("syntax: no graphviz definition provided");
  }
  // Adds a watermark to the dot graphic.
  List<String> args = new ArrayList<>();
  args.add("/usr/bin/dot");
  args.add("-Glabel=\"Made on Cloud Run\"");
  args.add("-Gfontsize=10");
  args.add("-Glabeljust=right");
  args.add("-Glabelloc=bottom");
  args.add("-Gfontcolor=gray");
  args.add("-Tpng");

  StringBuilder output = new StringBuilder();
  InputStream stdout = null;
  try {
    ProcessBuilder pb = new ProcessBuilder(args);
    Process process = pb.start();
    OutputStream stdin = process.getOutputStream();
    stdout = process.getInputStream();
    // The Graphviz dot program reads from stdin.
    Writer writer = new OutputStreamWriter(stdin, "UTF-8");
    writer.write(dot);
    writer.close();
    process.waitFor();
  } catch (Exception e) {
    System.out.println(e);
  }
  return stdout;
}

安全なサービスを設計する

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 コンテナを構築する方法の詳細を確認します。
1. Dockerfile を使用して、インストールしたシステムパッケージでベースイメージの構成とビルドを行い、Jib のデフォルトベースイメージを上書きします。
  # Use the Official eclipse-temurin image for a lean production stage of our multi-stage build. # https://hub.docker.com/_/eclipse-temurin/ FROM eclipse-temurin:17.0.11_9-jre RUN apt-get update -y && apt-get install -y \ graphviz \ && apt-get clean
```
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz-base
```
  ここで PROJECT_ID は、Google Cloud プロジェクト ID です。
2. Jib で最終的なコンテナを作成し、Container Registry で公開します。
  <plugin> <groupId>com.google.cloud.tools</groupId> <artifactId>jib-maven-plugin</artifactId> <version>3.4.0</version> <configuration> <from> <image>gcr.io/PROJECT_ID/graphviz-base</image> </from> <to> <image>gcr.io/PROJECT_ID/graphviz</image> </to> </configuration> </plugin>
```
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 リクエストを送信します。

生成された図はウェブページに埋め込むことができます。
1. ロードバランサの外部 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 アドレスです。
2. この 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 の説明

既製の図の説明の小コレクションを調べることができます。

選択した .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 コンソールから削除することもできます。

Knative serving に移動

チュートリアルを設定したときに追加した 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 アーキテクチャセンターをご覧ください。

システム パッケージを使用する

目標

費用

始める前に

コードサンプルを取得する

Node.js

Python

Go

Java

Node.js

Python

Go

Java

アーキテクチャを可視化する

コードについて

Dockerfile で環境構成を定義する

受信リクエストを処理する

Node.js

Python

Go

Java

図を生成する

Node.js

Python

Go

Java

安全なサービスを設計する

コードの配布

Node.js

Python

Go

Java

試してみる

クリーンアップ

チュートリアル リソースを削除する

次のステップ

システムパッケージを使用する

`Dockerfile` で環境構成を定義する

チュートリアルリソースを削除する