【公開】AWS Serverless Application Repositoryにアプリケーションを公開してみた

西村祐二

2018.02.22

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

どうも！大阪オフィスの西村祐二です。

AWS Serverless Application RepositoryがGAとなりました！下記が速報記事になります。

【速報】AWS Serverless Application Repositoryが一般利用可能（GA）になりました！

今回はさっそくアプリケーションを公開してみたいと思います。

基本的にAWS Serverless Application Repositoryのドキュメントの手順に従って進めていきます。

公開するために必要なもの

サーバーレスアプリケーションを公開するために必要なものは下記になります。

有効なAWSアカウント
使用されるAWSリソースを定義する有効なAWS Serverless Application Model（AWS SAM）テンプレート
作成したアプリケーション用のパッケージ
アプリケーションを公開する場合、アプリケーションのソースコードを指すURL（GitHubなどのURL）
Readmeファイル
ライセンスファイル
パッケージングしたアプリケーションの保存先のS3バケットに読み取りパーミッションを付与する。

では、必要なものを準備していきます。

必要なものを準備する!

S3バケットを作成し、ポリシーを付与する

アプリケーションを公開できるのは現状、バージニアとオハイオのリージョンだけなので、

今回はバージニアリージョンに「test-lambda-package-okiba」というバケットを作成しました。

また、下記画像のようにAWS Serverless Application RepositoryからのGetObjectを許可するバケットポリシーを付与します。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "Service":  "serverlessrepo.amazonaws.com"
            },
            "Action": "s3:GetObject",
            "Resource": "arn:aws:s3:::<your-bucket-name>/*"
        }
    ]
}

AWS SAMでアプリケーションを作成する

注意点
作成する前にこちらのドキュメントで下記について確認してから作成しましょう。

作成するアプリケーションはAWS Serverless Application Repositoryでサポートされているかどうか。
ポリシーを付与する場合はテンプレートポリシーにあるかどうか。

未サポートのリソースを使っているとアップロードする際にエラーとなります。

また、AWS SAMについては下記ブログが参考になります。

[新ツール] AWS Serverless Application Model (AWS SAM) を使ってサーバーレスアプリケーションを構築する

さて、今回下記のようなアプリケーションを作ってみます。

内容：ユーザによって入力してもらった値をGETして返すだけのアプリケーション
ランタイム：python3.6

▼テンプレートを作成します。

AWSTemplateFormatVersion : '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: It is test python3-app. It is app to return word.

Parameters:
  word:
    Type: String
    Description: The set word is returned

Resources:
  ReturnWordApp:
    Type: AWS::Serverless::Function
    Properties:
      Description: It is test python3-app. It is app to return word.
      Handler: lambda_function.handler
      Runtime: python3.6
      MemorySize: 128
      Timeout: 3
      CodeUri: app.zip
      Environment:
        Variables:
          SET_WORD: !Ref word

▼pythonプログラムを作成します。

""" This is test app. """

import logging
import os
import sys

LOGGER = logging.getLogger()
for h in LOGGER.handlers:
    LOGGER.removeHandler(h)

HANDLER = logging.StreamHandler(sys.stdout)
FORMAT = '%(levelname)s %(asctime)s [%(filename)s:%(funcName)s:%(lineno)d] %(message)s'
HANDLER.setFormatter(logging.Formatter(FORMAT))
LOGGER.addHandler(HANDLER)
LOGGER.setLevel(logging.INFO)


SET_WORD = os.getenv('SET_WORD', 'NOT GET Variable')

def handler(event, context):
    """
    main function
    """
    try:
        print(SET_WORD)
        return SET_WORD
    except Exception as error:
        LOGGER.exception(error)

▼zipにアプリケーションを固めます。

$ zip app.zip ./lambda_function.py -x "*.DS_Store"

▼作成したS3バケットにパッケージしたファイルをアップロードします。

$ aws cloudformation package --template-file app-spec.yml --output-template-file template.yml --s3-bucket test-lambda-package-okiba

Uploading to XXXXXXXXXXXXXXXXXXXXXX  529 / 529.0  (100.00%)
Successfully packaged artifacts and wrote output template to file template.yml.
・
・
・

アプリケーション作成の作業は一旦終了です。ちなみに、作成されたtemplate.ymlをAWS Serverless Application Repositoryにアップロードします。

▼今のファイル構成は下記になります。

$ ls
README.md          app-spec.yml       app.zip            lambda_function.py template.yml

ライセンスファイルの作成

ライセンス形態はとりあえず、MITライセンスとしました。
内容はここから引用しました。

$ vi license.txt

MIT License

Copyright (c) 2018 Yuji Nishimura

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

README.mdの作成

適当にREADMEを作成します。
今回は下記のようなかんじに作成してみまいした。（英語の勉強します。。。）

# About Function

This function is test function of AWS Serverless Application Repository.

This function that returns the set word.

# How to use it?

Please set the WORD in parameter input field displayed on the screen that you want to return.

ex) Hello World.


# License

MIT License (MIT)

This software is released under the MIT License, see LICENSE.txt.

GitHubにアップロードしておく

特にURLならどこでもよいみたいですが、今回はGitHubにアップロードしておきます。

https://github.com/nishimura-yuji/test-serverless-app-repo

※予告なく削除する場合がありますので、ご了承ください。

これで準備は完了です。

AWS Serverless Application Repository にアプリケーションを公開する

※今回作成したアプリケーションは予告なく削除する場合がありますので、ご了承ください。

▼AWS Serverless Application Repositoryのコンソールにアクセスします。

アプリケーションを公開できるのは現状、バージニアとオハイオのリージョンだけなので、
AWS Serverless Application RepositoryのコンソールもS3バケットを作成したバージニアリージョンにしておきます。

▼「アプリケーションの公開」をクリックします。

▼設定項目を埋めていく

▼ライセンスは選択するとそのライセンスの雛形が表示されていました。READMEもはじめからデフォルトの値が入力されていました。

▼SAMのテンプレートは前の作業で出力されたtemplate.ymlを指定します。他の項目をうめて「アプリケーションの公開」をクリックします。（プライベートととしてはじめ公開されます。）

▼下の方のスイッチをクリックすることで公開することができます。反映までに数分かかるようです。

公開したアプリケーションを試してみる

▼Lambdaで関数を作成する際に一番右の「サーバーレスアプリケーションのレポジトリ」をチェックし、検索すると公開したアプリケーションが表示されます。

▼アプリケーションをクリックするとアプリケーションの詳細を確認することができます。今回作成したアプリケーションは入力した値を返すアプリケーションなので、右下のwordに適当な言葉を入力します。今回は「Hello AWS Serverless Application Repository」と入力しました。そして、下にあるdeployのボタンをクリックします。