GAEでAPIキーを隠したいとき

React、node.js、Google Cloud Platform (App Enigine)でSORTFULというチームビルディングゲームを作る際に出てきた疑問を、備忘録として記事にまとめています。

はじめに

今回SORTFULを開発するにあたって、Webex APIとSlack APIを使いました。
ここで問題になってくるのが、APIキーの隠し場所です。

そこで私は、GAEにデプロイする際に使うyamlファイルに環境変数として登録する方法を選びました。
以下にその方法を記します。

環境変数を設定する方法

GAE(Google App Engine)では、app.yamlに環境変数を設定できます。(参考：app.yaml構成ファイル)

app.yaml

env_variables:
  MY_VAR: "my value"

ただし、app.yamlはGAEにデプロイされてしまいます。（見ようと思えば誰でも見れる状態）

そこで、.gcloudignoreを使った以下の手順で設定します。
①secret.yamlに環境変数を定義し、
②app.yamlでsecret.yamlをincludeで読み込み、
③.gcloudignoreでsecret.yamlファイルをコミット対象から除外する。

app.yaml

includes:
-secret.yaml

secret.yaml

env_variables:
  webex_token: "********"

.gcloudignore

secret.yaml