Skip to content

Commit

Permalink
Merge pull request #798 from seratch/aws-lambda-deployment-ja
Browse files Browse the repository at this point in the history 
Add Japanese translation to AWS Lambda deployment guide
  • Loading branch information
@seratch
seratch authored Feb 17, 2021
2 parents 3f7c25c + a86d740 commit 355f8ef
Showing 1 changed file with 338 additions and 0 deletions.
338 changes: 338 additions & 0 deletions docs/_deployments/ja_aws-lambda.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,338 @@
---
title: AWS Lambda へのデプロイ
order: 0
slug: aws-lambda
lang: ja-jp
layout: tutorial
permalink: /ja-jp/deployments/aws-lambda
---
# AWS Lambda へのデプロイ

<div class="section-content">
このガイドでは、[Bolt for JavaScript][bolt-js]、[Serverless Framework][serverless-framework]、[AWS Lambda][aws-lambda] を使った Slack アプリの準備とデプロイの方法について説明します。
</div>

この手順を全て終わらせたら、あなたはきっと⚡️ [Deploying to AWS Lambda][deploy-aws-lambda-app] のサンプルアプリを動作させたり、それに変更を加えたり、自分のアプリを作ったりすることができるようになるでしょう。

---

### AWS Lambda のセットアップ

[AWS Lambda][aws-lambda] はサーバーレスの Function-as-a-Service（FaaS）プラットフォームです。AWS Lambda を利用すると、サーバーを管理することなく、コードを実行することができます。このセクションでは、ローカルマシンから AWS Lambda にアクセスするための設定を行います。

> 💡 すでにローカルマシンから AWS Lambda へのアクセスに必要な[プロファイルの構成][aws-profiles]が済んでいる場合、このセクションはスキップできます。
**1. AWS アカウントを作成する**

AWS アカウントをまだ持っていない場合は、[アカウントを作成][aws-sign-up]する必要があります。画面に表示される案内に沿って作成しましょう。

> 💡 作成手順の中で請求情報の入力を求められる場合がありますが、ご心配なく。このガイドでは[無料利用枠][aws-pricing]のみを使用します。
**2. AWS のアクセスキーを作成する**

Lambda へのデプロイでは、プログラムから AWS アカウントにアクセスする手段が必要になります。AWS の世界では、このために**アクセスキー ID** と**シークレットアクセスキー**が必要です。

🍿 [IAM ユーザーを作成してアクセスキーをダウンロードする手順](https://www.youtube.com/watch?v=KngM5bfpttA)を紹介する短い動画を参考にしてみてください。

> 💡 **すでに IAM ユーザーの作成が完了している場合は、**AWS の公式ガイドに従って [IAM ユーザーのアクセスキーを作成][aws-iam-user]してください。
**3. AWS CLI をインストールする**

AWS では [macOS、Windows、Linux][aws-cli-install] にインストールして利用できるコマンドラインインターフェイス（CLI）のツールが用意されています。

macOS では、[最新の .pkg インストーラーをダウンロード](https://awscli.amazonaws.com/AWSCLIV2.pkg)して AWS CLI をインストールできます。

**4. AWS プロファイルを構成する**

AWS CLI を使ってプロファイルを構成します。プロファイルはローカルマシンに置かれ、アクセスキーのペアを保管します。この CLI やその他のツールは、このプロファイルを使って AWS にアクセスします。

[プロファイルを構成][aws-cli-configure]する最も簡単な方法は、次のコマンドを実行し、プロンプトに従って入力する方法です。

```zsh
aws configure
# AWS Access Key ID [None]: <AWS のアクセスキー>
# AWS Secret Access Key [None]: <AWS のシークレットアクセスキー>
# Default region name [None]: us-east-1
# Default output format [None]: json
```

> 💡 [Default region name][aws-cli-region] と [Default output format][aws-cli-output-format] は最も望ましい設定でカスタマイズしてください。
これでローカルマシンから AWS にアクセスするための設定が完了しました。👏 次は、同じように Serverless Framework も設定していきましょう。

---

### Serverless Framework をセットアップする

[Serverless Framework](https://www.serverless.com/open-source/) では、AWS Lambda 向けのアプリの設定、デバッグ、デプロイを簡単に行うためのツールが用意されています。

**1. Serverless Framework CLI をインストールする**

Serverless でも [macOS、Windows、Linux](https://www.serverless.com/framework/docs/getting-started/) にインストールして利用できるコマンドラインインターフェイス（CLI）のツールが用意されています。インストールには npm を使用します。次のコマンドを実行してください。

```shell
npm install --save-dev serverless
```

> 💡 [Serverless CLI をグローバルにインストールする](https://www.serverless.com/framework/docs/getting-started/)こともできます。その場合は`npm install -g serverless` というコマンドを実行します。
インストールが完了したら Serverless CLI をテストするため、利用可能なコマンドを表示してみましょう。

```shell
npx serverless help
```

Serverless のツールのセットアップが完了しました。次に、AWS Lambda 関数として実行する Bolt アプリの準備へと進みましょう。

---

### Bolt Slack アプリを入手する

まだ Bolt アプリを自分で作成したことがない場合は、[入門ガイド][getting-started-guide]を参照してください。テンプレートのアプリをクローンするには、以下のコマンドを実行します。

```shell
git clone https://github.com/slackapi/bolt-js-getting-started-app.git
```

用意した Bolt アプリのディレクトリに移動します。

```shell
cd bolt-js-getting-started-app/
```

Bolt アプリを用意できました。次に AWS Lambda と Serverless Framework に対応するための準備をします。

---

### アプリをセットアップする

**1. アプリを AWS Lambda に対応させる**

デフォルトでは、Bolt アプリがリッスンするのは HTTP リクエストです。このセクションでは Bolt アプリの[`レシーバー`](https://slack.dev/bolt-js/concepts#receiver)に手を加えて、Lambda 関数のイベントをリッスンするように変更します。


まず、[Serverless Express](https://github.com/vendia/serverless-express) モジュールをインストールします。このモジュールを使って Express HTTP リクエストを Lambda 関数のイベントに変換します。

```bash
npm install @vendia/serverless-express
```

次に、`app.js` のソースコードのなかで[モジュールのインポートを行う部分](https://github.com/slackapi/bolt-js-getting-started-app/blob/main/app.js#L1)を編集し、Bolt の Express レシーバーと AWS Serverless Express モジュールを require します。

```javascript
const { App, ExpressReceiver } = require('@slack/bolt');
const serverlessExpress = require('@vendia/serverless-express');
```

その後、[ソースコードのなかで Bolt アプリの初期化を行う部分](https://github.com/slackapi/bolt-js-getting-started-app/blob/main/app.js#L3-L7)を編集して、AWS Serverless Express を使ったカスタムのレシーバーを作成します。

```javascript
// カスタムのレシーバーを初期化します
const expressReceiver = new ExpressReceiver({
signingSecret: process.env.SLACK_SIGNING_SECRET,
// `processBeforeResponse` オプションは、あらゆる FaaS 環境で必須です。
// このオプションにより、Bolt フレームワークが `ack()` などでリクエストへの応答を返す前に
// `app.message` などのメソッドが Slack からのリクエストを処理できるようになります。FaaS では
// 応答を返した後にハンドラーがただちに終了してしまうため、このオプションの指定が重要になります。
processBeforeResponse: true
});

// ボットトークンと、AWS Lambda に対応させたレシーバーを使ってアプリを初期化します。
const app = new App({
token: process.env.SLACK_BOT_TOKEN,
receiver: expressReceiver
});
```

最後に、アプリのソースコードの末尾にある [HTTP サーバーを起動する部分](https://github.com/slackapi/bolt-js-getting-started-app/blob/main/app.js#L40-L45)を編集して、AWS Lambda 関数のイベントに応答するようにします。

```javascript
// Lambda 関数のイベントを処理します
module.exports.handler = serverlessExpress({
app: expressReceiver.app
});
```

完成したアプリのソースコードは、⚡️[deploy-aws-lambda][deploy-aws-lambda-app/app.js] のサンプルのようになります。

**2. serverless.yml を追加する**

Serverless Framework のプロジェクトでは、アプリの設定とデプロイに `serverless.yml` ファイルを使用します。

アプリのルートディレクトリに `serverless.yml` という名前のファイルを新規作成し、次の内容を貼りつけます。

```yaml
service: serverless-bolt-js
frameworkVersion:'2'
provider:
name: aws
runtime: nodejs12.x
environment:
SLACK_SIGNING_SECRET: ${env:SLACK_SIGNING_SECRET}
SLACK_BOT_TOKEN: ${env:SLACK_BOT_TOKEN}
functions:
slack:
handler: app.handler
events:
- http:
path: slack/events
method: post
plugins:
- serverless-offline
```
> 💡 `SLACK_SIGNING_SECRET` と `SLACK_BOT_TOKEN` の環境変数は、ローカルマシンで設定しておく必要があります。[Slack の環境変数をエクスポートする方法](/bolt-js/tutorial/getting-started#setting-up-your-local-project)を入門ガイドで参照してください。

**3. serverless-offline モジュールをインストールする**

ローカルでの開発を容易にするため、`serverless-offline` モジュールを使ってデプロイ対象の関数をエミュレートできるようにしましょう。

次のコマンドを実行して、開発用の devDependencies としてインストールします。

```bash
npm install --save-dev serverless-offline
```

これで Bolt アプリを AWS Lambda と Serverless に対応させることができました。次はアプリの実行とデプロイに進みます。

---

### アプリをローカルで実行する

アプリを AWS Lambda 関数に応答させるための準備が完了したので、次にローカルでアプリを実行できるように環境を設定します。

**1. ローカルのサーバーを起動する**

まず、AWS Lambda 関数のイベントをリッスンするため、`serverless offline` コマンドを実行します。

```zsh
npx serverless offline --noPrependStageInUrl
```

次に、ngrok を使って Slack のイベントをローカルマシンに転送します。

```zsh
ngrok http 3000
```

> 💡 パブリック URL の作成方法と、ローカルマシンへのリクエストの転送方法については、[ngrok の使い方][getting-started-guide-setting-up-events]を参照してください。

**2. リクエスト URL を変更する**

次に、[Slack アプリの設定](https://api.slack.com/apps)を開き、**リクエスト URL** を ngrok のウェブアドレスに変更します。

> 💡 **リクエスト URL** は `/slack/events` で終わる文字列で、例えば `https://abc123.ngrok.io/slack/events` のようになります。

まず、サイドバーの「**Interactivity & Shortcuts**」を選択し、**リクエスト URL** を更新します。

![「Interactivity & Shortcuts」ページ](../assets/interactivity-and-shortcuts-page.png "「Interactivity & Shortcuts」ページ")

次に、サイドバーの「**Event Subscriptions**」を選択し、**リクエスト URL** を更新します。

![「Event Subscriptions」ページ](../assets/event-subscriptions-page.png "「Event Subscriptions」ページ")

**3. Slack アプリをテストする**

Slack アプリをテストします。今作った Bolt アプリを Slack のチャンネルに招待し、半角の小文字で「hello」と入力してみましょう。[入門ガイド][getting-started-guide]のとおり、アプリから応答があるはずです。

> 👩‍💻 hello<br/>
> 🤖 Hey there @Jane!

応答がない場合、**リクエスト URL** を確認してからもう一度試してみてください。

> 💡 **動作の仕組み** : ngrok と Serverless のコマンドは同じポートを使用するように設定されています（デフォルトでは「3000」）。**リクエスト URL** に向けて送信された Slack イベントは、ローカルマシンの ngrok で受信されます。このリクエストはさらに Serverless Offline に転送されます。Serverless Offline は AWS Lambda 関数のイベントをエミュレートしていて、Bolt アプリのレシーバーをトリガーさせます。 🛫🛬 長旅ですね。

---

### アプリをデプロイする

AWS Lambda 向けのアプリのプロビジョニング、パッケージング、デプロイには、Serverless Framework のツールが利用できます。アプリのデプロイが完了したら、アプリのリクエスト URL を更新して、「hello」と入力した時にアプリが応答できるようにします。✨

**1. AWS Lambda にアプリをデプロイする**

次のコマンドを使って AWS Lambda にアプリをデプロイします。

```shell
npx serverless deploy
# Serverless:Packaging service...
# ...
# endpoints:
# POST - https://atuzelnkvd.execute-api.us-east-1.amazonaws.com/dev/slack/events
# ...
```

アプリのデプロイが成功すると、**エンドポイント**が発行されます。これをアプリの**リクエスト URL** に指定します。発行された**エンドポイント**をコピーして、次のセクションで使います。

> 💡 **エンドポイント**は、`/slack/events` で終わる文字列です。

**2. Slack アプリの設定を更新する**

Slack からのイベントやアクションの送信先となる**リクエスト URL** に、発行された AWS Lambda の**エンドポイント**を指定します。[Slack アプリの構成](https://api.slack.com/apps)を開き、先ほどコピーしたエンドポイントを**リクエスト URL** に貼りつけます。

まず、サイドバーの「**Interactivity & Shortcuts**」を選択し、**リクエスト URL** を更新します。

![「Interactivity & Shortcuts」ページ](../assets/interactivity-and-shortcuts-page.png "「Interactivity & Shortcuts」ページ")

次に、サイドバーの「**Event Subscriptions**」を選択し、**リクエスト URL** を更新します。

![「Event Subscriptions」ページ](../assets/event-subscriptions-page.png "「Event Subscriptions」ページ")

**3. Slack アプリをテストする**

アプリのデプロイと、Slack の設定の更新が完了しました。動作を試してみましょう。

「[アプリをローカルで実行する](#run-the-app-locally)」のセクションで行った操作と同様に、アプリを招待した Slack チャンネルを開いて「hello」と入力します。アプリが応答し、同じように挨拶してくれるはずです。

> 👩‍💻 hello<br/>
> 🤖 Hey there @Jane!

**4. 更新をデプロイする**

Slack アプリの開発を継続していくなら、更新したアプリをデプロイする必要が出てくるでしょう。それをやってみるために、「goodbye」というメッセージに応答するようにアプリを変更してみましょう。

次のコードを `app.js` に追加します（[GitHub でソースコードを確認できます][deploy-aws-lambda-app/app.js]）。

```javascript
// 「goodbye」というメッセージの着信をリッスンします
app.message('goodbye', async ({ message, say }) => {
// イベントがトリガーされたチャンネルに向けて say() でメッセージを送信します
await say(`See ya later, <@${message.user}> :wave:`);
});
```

先ほどと同じコマンドを使って更新をデプロイします。

```shell
npx serverless deploy
```

デプロイが完了したら、アプリを参加させた Slack チャンネルを開いて、半角の小文字で「goodbye」と入力してみましょう。Slack アプリに「See you later」と表示されるはずです。

---

### 次のステップ

⚡️[AWS Lambda を使った最初の Bolt for JavaScript アプリ][deploy-aws-lambda-app]をデプロイできました。🚀

基本的なアプリのデプロイができましたので、次はアプリのカスタマイズやモニタリングを行う方法を調べてみましょう。

- [AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) と [Serverless Framework](https://www.serverless.com/framework/docs/providers/aws/guide/intro/) の理解を深める。
- [Bolt の基本的な概念](/bolt-js/concepts#basic)と [Serverless のプラグイン](https://www.serverless.com/framework/docs/providers/aws/guide/plugins/)を活用してアプリを拡張する。
- [Bolt の応用コンセプト](/bolt-js/concepts#logging)でログの記録についての知識を深めたり、[Serverless でのログメッセージの表示方法](https://www.serverless.com/framework/docs/providers/aws/cli-reference/logs/)について確認したりする。
- Serverless の [AWS Lambda のテスト環境](https://www.serverless.com/framework/docs/providers/aws/guide/testing/)や[デプロイ環境](https://www.serverless.com/framework/docs/providers/aws/guide/deploying/)を本格的に活用する。

[aws-cli-configure]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config
[aws-cli-install]: https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html
[aws-cli-output-format]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-format
[aws-cli-region]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-region
[aws-iam-user]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-creds
[aws-lambda]: https://aws.amazon.com/lambda/
[aws-pricing]: https://aws.amazon.com/lambda/pricing/
[aws-profiles]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-profiles
[aws-sign-up]: https://aws.amazon.com/
[bolt-js]: /bolt-js
[deploy-aws-lambda-app]: https://github.com/slackapi/bolt-js/tree/main/examples/deploy-aws-lambda
[deploy-aws-lambda-app/app.js]: https://github.com/slackapi/bolt-js/tree/main/examples/deploy-aws-lambda/app.js
[getting-started-guide-setting-up-events]: https://slack.dev/bolt-js/tutorial/getting-started#setting-up-events
[getting-started-guide]: /bolt-js/tutorial/getting-started
[serverless-framework]: https://serverless.com/

0 comments on commit 355f8ef

Please sign in to comment.