Cloud Deployment Manager を使用した Python Bookshelf アプリのデプロイ

Cloud Storage バケットを作成する

以下では、Cloud Storage バケットの作成方法を詳しく説明します。バケットとは、Cloud Storage 内でデータを保持する基本のコンテナです。

1. ターミナル ウィンドウで Cloud Storage バケットを作成します。ここで、YOUR_BUCKET_NAME はバケットの名前を表します。

   gcloud storage buckets create gs://YOUR_BUCKET_NAME

2. Bookshelf アプリでアップロードした画像を表示するには、バケットの Identity and Access Management ポリシーを設定して、legacyObjectReader ロールを allUsers に付与します。

   gcloud storage buckets add-iam-policy-binding gs://YOUR_BUCKET_NAME
   --member=allUsers --role=roles/storage.legacyObjectReader

サンプルアプリのクローン作成

サンプルアプリは GitHub の GoogleCloudPlatform/getting-started-python で入手できます。

1. リポジトリのクローンを作成します。

   git clone https://github.com/GoogleCloudPlatform/getting-started-python.git -b steps
   

2. サンプル ディレクトリに移動します。

   cd getting-started-python/7-gce
   

アプリの構成

1. config.py を編集用に開きます。

   • PROJECT_ID の値をプロジェクト ID に設定します。

   • 値 CLOUD_STORAGE_BUCKET を Cloud Storage バケットの名前に設定します。

2. config.py を保存して閉じます。

ローカル パソコン上でのアプリの実行

1. 隔離された Python 環境を作成し、依存関係をインストールします。

   Linux / MacOS

   virtualenv -p python3 env
   source env/bin/activate
   pip install -r requirements.txt
   

   Windows

   virtualenv -p python3 env
   env\scripts\activate
   pip install -r requirements.txt
   

2. アプリケーションを実行します。

   python main.py
   

3. ブラウザに次のアドレスを入力します。

   http://localhost:8080

ローカル ウェブサーバーを停止するには、Ctrl+C キーを押します。 仮想環境を終了する場合は、「deactivate」と入力します。

サンプルアプリのデプロイ

コードをリポジトリに push する

コードを実行中の Compute Engine インスタンスに取得するにはいくつかの方法があります。そのうちの 1 つは、Cloud Source Repositories を使用するという方法です。 Compute Engine インスタンスに使用可能なすべてのプロジェクトには、Git リポジトリが含まれています。インスタンスは、起動時に最新バージョンのアプリのコードを pull します。Git リポジトリを使用すると、アプリの更新時に新しいイメージやインスタンスを構成する必要がないため便利です。既存のインスタンスを再起動するか、インスタンスを作成するだけで済みます。

1. Git を初めて使用する場合は、git config --global を使用して自分の ID を設定します。

2. Cloud de Confiance コンソールで、リポジトリを作成します。

   リポジトリを作成

3. アプリのコードをプロジェクトのリポジトリに push します。[YOUR_PROJECT_ID] はプロジェクト ID、[YOUR_REPO] リポジトリの名前です。

   git commit -am "Updating configuration"
   git config credential.helper gcloud.sh
   git remote add cloud https://source.developers.google.com/p/[YOUR_PROJECT_ID]/r/[YOUR_REPO]
   git push cloud master
   

デプロイの作成

構成がコミットされ、コードが Cloud Source Repositories にアップロードされると、Deployment Manager を使用してデプロイを作成できます。

1. deployment_manager ディレクトリに移動します。

   cd getting-started-python/7-gce/gce/deployment_manager
   

2. デプロイを作成します。

   gcloud deployment-manager deployments create my-deployment --config config.yaml
   

3. すべてのデプロイのリストを表示します。

   gcloud deployment-manager deployments list
   

4. デプロイと作成されたリソースの説明を取得します。

   gcloud deployment-manager deployments describe my-deployment
   

アプリの表示

転送ルールを作成した後、構成が反映され、トラフィックがインスタンスにルーティングされるまでには数分かかる場合があります。

1. 進行状況を確認するには、次のコマンドを実行します。

   gcloud compute backend-services get-health bookshelf-my-deployment-frontend --global
   

2. 少なくとも 1 つのインスタンスで HEALTHY が報告されたら、ロードバランサの転送 IP アドレスを取得します。

   gcloud compute forwarding-rules list --global
   

   転送ルールの IP アドレスは IP_ADDRESS 列に表示されます。

3. ブラウザで、リストから取得した IP アドレスを入力します。

   アプリが Cloud de Confianceで実行されるようになりました。

コードについて

デプロイの構成

デプロイがどのように構成されているかは、config.yaml で確認できます。

imports:
- name: bookshelf.jinja
  path: ./bookshelf.jinja

resources:
- name: bookshelf
  type: bookshelf.jinja
  properties:
    zone: us-central1-f
    machine-type: n1-standard-1
    machine-image: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/family/debian-9
    min-instances: 1
    max-instances: 10
    target-utilization: 0.6
    scopes:
    - https://www.googleapis.com/auth/cloud-platform

この構成ファイルでは、テンプレート ファイルをリソースとして読み込み、bookshelf という名前のリソースの定義に使用します。テンプレートはパラメータとして複数のプロパティを持っています。Deployment Manager 構成ファイルの作成に関する詳細については、構成の作成をご覧ください。

デプロイ テンプレートのスキーマの構成

スキーマ ファイル bookshelf.jinja.schema を確認します。これは、デプロイがその構成ファイルに提供するパラメータを定義し、ドキュメント化します。構成スキーマの詳細については、スキーマの使用をご覧ください。

info:
  title: Bookshelf GCE Deploy
  author: Google Inc.
  description: Creates a GCE Deployment

imports:
- name: startup-script
  path: ../startup-script.sh

required:
- zone
- machine-type
- min-instances
- max-instances
- scopes

properties:
  zone:
    description: Zone to create the resources in.
    type: string
  machine-type:
    description: Type of machine to use
    type: string
  machine-image:
    description: The OS image to use on the machines
    type: string
  min-instances:
    description: The minimum number of VMs the autoscaler will create
    type: integer
  max-instances:
    description: The maximum number of VMs the autoscaler will create
    type: integer
  target-utilization:
    description: The target CPU usage for the autoscaler to base its scaling on
    type: number
  scopes:
    description: A list of scopes to create the VM with
    type: array
    minItems: 1
    items:
      type: string

デプロイ テンプレートの構成

テンプレートは複数のリソースを定義し、自動スケーリングされ、負荷分散されたマネージド インスタンス グループを作成します。作成されたリソースの完全な説明については、テンプレート内の Compute Engine の Bookshelf チュートリアルをご覧ください。

Deployment Manager ではクラウド リソースを宣言型の方法で定義できますが、リソースの構成の大部分はそのリソースの API によって定義されます。たとえば、インスタンス テンプレート リソースの構成オプションのほとんどは、Compute Engine API のリファレンス ドキュメント内にあるインスタンス テンプレートのリソース定義で確認できます。

テンプレートは、Jinja テンプレート言語を使用して作成します。Deployment Manager のテンプレート作成時には、Jinja または Python を使用できます。Jinja にはより宣言的であるという利点があるため、Python より読みやすく、理解しやすいとされています。一部の複雑なデプロイについては、Python の完全な表現力により簡略化できる場合があります。この場合、必要なリソースの作成には Jinja で十分です。

テンプレート内では、特定の環境変数が自動的に設定されます。これらには、env ディクショナリを使用してアクセスできます。この場合、作成されたリソースに名前を割り当てるときに再利用する名前としてデプロイの名前が参照されます。使用可能な環境変数については、Deployment Manager のドキュメントの環境変数の使用をご覧ください。

{% set NAME = "bookshelf-" + env["deployment"] %}
{% set SERVICE = "bookshelf-" + env["deployment"] + "-frontend" %}

テンプレートは、Compute Engine チュートリアルで使用されるのと同じ起動スクリプトを使用します。スクリプトのコンテンツがテンプレートに挿入され、Jinja インデント ディレクティブによりコンテンツが正しくインデントされます。

            value: |
{{imports['startup-script']|indent(14, true)}}

Deployment Manager Jinja テンプレートでは、テンプレートの他の場所で作成されたリソースを参照することもできます。次の例では、バックエンド サービスはマネージド インスタンス グループのリファレンスを使用して、参照先のインスタンス グループを取得します。

- group: $(ref.{{ NAME }}-frontend-group.instanceGroup)
  zone: {{ properties['zone'] }}

config.yaml で指定されたプロパティはテンプレートで使用できます。

minNumReplicas: {{ properties['min-instances'] }}
maxNumReplicas: {{ properties['max-instances'] }}
loadBalancingUtilization:
  utilizationTarget: {{ properties['target-utilization'] }}