Как развернуть бессерверный API с помощью AWS SAM CLI и GitHub Actions

Развертывание API с использованием AWS Serverless Application Model (SAM) является эффективным и масштабируемым подходом для облачных приложений.Он упрощает управление инфраструктурой, обеспечивает встроенную поддержку SSL/TLS и беспрепятственно интегрируется с сервисами AWS, такими как CloudFormation, Lambda, S3, Route 53 и CloudWatch. Используя модель без сервера, разработчики могут сосредоточиться на написании логики приложений, в то время как AWS справляется с масштабированием, безопасностью и техническим обслуживанием, что делает его идеальным решением для современных высокодоступных API. Таблица содержимого – Введение: Зачем использовать SAM для развертывания API? – Prerequisites: Install SAM CLI – Шаг 1: Инициализация SAM – Шаг 2: Определите конечную точку API – Шаг 3: Создание и тестирование локально – Шаг 4: Размещение API – Шаг 5: CI / CD с действиями Github – Заключение Intro: Зачем использовать SAM для развертывания API? Это руководство будет направлять вас шаг за шагом, как создать простой API, развернуть его с помощью AWS CloudFormation с SAM CLI, а затем автоматизировать развертывания с помощью GitHub Actions. Это более подробная диаграмма этого рабочего процесса: Предпосылки Предпосылки для местного тестирования. AWS CLI и SAM CLI установлены. Node.js установлены Docker . Учетная запись GitHub AWS CLI и SAM CLI установлены. Node.js установлен Node.js установлен для местного тестирования. Docker Документы Учетная запись GitHub GitHub Предпосылки: Установите SAM CLI Прежде чем погрузиться в учебник, убедитесь, что AWS SAM CLI установлен на вашем компьютере. Ниже приведены шаги установки для macOS и Windows: для macOS (если уже не установлено): Инсталлировать Homebrew Инсталлировать Homebrew /bin/bash -c «$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" /bin/bash -c «$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" : Добавьте клавишу AWS и установите SAM CLI Добавьте клавишу AWS и установите SAM CLI brew tap aws/tapbrew install aws-sam-cli brew tap aws/tapbrew install aws-sam-cli Проверьте установку с помощью sam --version sam — версия Для Windows : Загрузить программу установки SAM CLI Загрузить SAM CLI installer Перейдите на и загрузите последний инсталлятор Windows. официальная страница AWS SAM CLI Перейдите на и загрузите последний инсталлятор Windows. официальная страница AWS SAM CLI официальная страница AWS SAM CLI : Запустить установку Запустить инсталлятор Двойной клик на загруженный файл и следуйте мастеру установки. .exe Двойной клик на загруженный файл и следуйте мастеру установки. .exe .exe и т.д. Путь (если он не добавлен автоматически): Добавьте SAM CLI к PATH Добавить SAM CLI в ПУТЬ Откройте меню «Старт» и найдите «Переменные окружающей среды». Нажмите на «Редактировать переменные окружающей среды». В разделе «Свойства системы» нажмите кнопку «Переменные окружающей среды». В разделе «Переменные окружающей среды» найдите и нажмите «Edit». Path Добавьте каталог, в котором установлен SAM CLI (например, ). C:\Program Files\Amazon\AWS SAM CLI\bin Откройте меню «Пуск» и найдите «Переменные окружающей среды». Нажмите «Редактировать переменные среды системы». В разделе «Свойства системы» нажмите кнопку «Переменные среды». В разделе «Системные переменные» найдите и нажмите «Edit.» Path Добавьте каталог, в котором был установлен SAM CLI (например, ). C:\Program Files\Amazon\AWS SAM CLI\bin C:\Программные файлы\Amazon\AWS SAM CLI\bin : Откройте командное указание и запустите Подтвердить установку sam --version Проверить установку sam — версия Шаг 1: Инициализация SAM CLI Создайте новый репозиторий на вашем компьютере: mkdir aws-serverless-api Создайте новый репозиторий на вашем компьютере: mkdir aws-serverless-api Навигация в каталог: cd aws-serverless-api Навигация в каталог: cd aws-serverless-api и тогда вам будет предложено несколько вариантов. Инициируйте новое приложение SAM: sam init Инициировать новое приложение SAM: sam init Выберите «1 — AWS Quick Start Templates». Выберите для развертывания Lambda-backed serverless API на API Gateway». «7 — Serverless API» Выберите «Node.js 20.x» Выберите или нет для X-Ray-трекинга, так как мы хотим снизить наши затраты, и это всего лишь простой пример Hello World. Если вы делаете сложный API-тренинг в различных сервисах, вы можете разрешить это, чтобы помочь в де «N» Выберите «1 — шаблоны быстрого запуска AWS». «1 — шаблоны быстрого запуска AWS». «1 — шаблоны AWS Quick Start». Выберите для развертывания поддерживаемого Lambda безсерверного API на API Gateway. «7 — Serverless API» «7 — API без сервера» «7 — API без серверов» Выберите «Node.js 20.x» «Node.js 20.x» «Node.js 20.x» Выберите или Нет для рентгеновского отслеживания, так как мы хотим снизить наши затраты, и это всего лишь простой пример Hello World. "N" «N» «N» Я также выбираю для мониторинга облачных часов, так как для этого примера Hello World нам не нужны аналитики производительности. "N" «N» «N» Также для формата json в журнале lambda, так как это всего лишь пример Hello World. «N» «N» «N» Теперь, давайте cd в каталог, который генерировал; я выбрал, чтобы назвать мой проект так давайте пойдем: sam init sam-hello-world sam init sam-hello-world Код cd сам-hello-world cd сам-hello-world Затем откройте проект в VSCode — когда вы открываете проект в VSCode или вашем любимом IDE, вы уже должны видеть много созданных файлов. code. Код Код Понимание генерируемых файлов Вот что делает каждый из файлов, созданных из : sam init sam init – определяет ваш API Gateway, Lambda и другие ресурсы AWS. **template.yaml** – содержит образец управляющих функций Lambda. **src/handlers/** – образец испытательных событий для местного тестирования. **events/** – управляет зависимостью для функций Node.js Lambda. **package.json** .gitignore** – стандартные файлы настроек проекта. – определяет ваш API Gateway, Lambda и другие ресурсы AWS. **template.yaml** → → **template.yaml** – содержит образец оператора функции Lambda. **src/handlers/** **src/handlers/** – Пробные испытательные события для местных испытаний. **events/** * события / * – управляет зависимостями для функций Node.js Lambda. **package.json** **package.json** – Стандартные файлы настроек проекта. **.itignore** **README.md** → **README.md** Мы будем изменять и удалять некоторые из этих файлов, чтобы они соответствовали нашему очень простому API «Hello world». изменить и удалить некоторые из этих файлов, чтобы соответствовать нашему очень простому API «Hello world» Шаг 2: Определите конечную точку API Теперь откройте и замените существующие определения функций Lambda следующим образом: template.yaml template.yaml и AWSTemplateFormatVersion: "2010-09-09" Transform: AWS::Serverless-2016-10-31 Описание: Шаблон AWS SAM для развертывания Node.js/Express API в Lambda Ресурсы: HelloWorldFunction: Type: AWS::Serverless::Function Properties: Handler: src/app.lambdaHandler Runtime: nodejs20.x Events: HelloWorld: Type: Api Properties: Path: / Method: GET AWSTemplateFormatVersion: "2010-09-09" Transform: AWS::Serverless-2016-10-31 Описание: Шаблон AWS SAM для развертывания Node.js/Express API в Lambda Ресурсы: HelloWorldFunction: Type: AWS::Serverless::Function Properties: Handler: src/app.lambdaHandler Runtime: nodejs20.x Events: HelloWorld: Type: Api Properties: Path: / Method: GET Это определяет один маршрут в корне нашего API, который является запросом GET Обновить функцию Lambda В каталоге создадим файл под названием /src app.js / src app.js и В напишем функцию для вывода hello world из нашего маршрута: src/app.js src/app.js и exports.lambdaHandler = async (event) => { return { statusCode: 200, body: JSON.stringify({ message: "Hello, World!" }) }; }; exports.lambdaHandler = async (event) => { return { statusCode: 200, body: JSON.stringify({ message: "Hello, World!" }) }; }; Remove Unnecessary Files Теперь, давайте удалим дополнительные манипуляторы и события, которые генерировал в шаге 1. sam init sam init Откройте терминал в каталоге проекта и : используйте эти команды используйте эти команды rm -rf src/handlers/get-all-items.mjs src/handlers/get-by-id.mjs src/handlers/put-item.mjs rm -rf src/handlers/get-all-items.mjs src/handlers/get-by-id.mjs src/handlers/put-item.mjs rm -rf события/ rm -rf события/ Шаг 3: Создание и тестирование локально Open a terminal in the project directory and follow the steps below: : Строить приложение : Строить приложение Строить приложение вы должны видеть такой выход: sam build вы должны видеть такой выход: sam build sam build и т.д. : Запустите локальный сервер API : Запустите локальный сервер API Запустите локальный сервер API — Обратите внимание, что вам нужно будет иметь установленный для запуска этого локально. Когда удастся, вы должны увидеть контейнер, созданный для нашего API на рабочем столе докера. sam local start-api docker Откройте браузер или используйте в терминале, чтобы проверить конечную точку: curl curl [http://127.0.0.1:3000/] (http://127.0.0.1:3000/] — Обратите внимание, что вам нужно будет иметь установленный, чтобы запустить это локально. Когда это удастся, вы должны увидеть контейнер, созданный для нашего API на рабочем столе докера. sam local start-api docker Откройте браузер или используйте в терминале, чтобы проверить конечную точку: curl — Обратите внимание, что вам нужно будет иметь установленный, чтобы запустить это локально. Когда это удастся, вы должны увидеть контейнер, созданный для нашего API на рабочем столе докера. sam local start-api docker sam local start-api → Название docker Откройте браузер или используйте в терминале, чтобы проверить конечную точку: curl Откройте браузер или используйте в терминале для проверки конечного пункта: curl curl curl [http://127.0.0.1:3000/](http://127.0.0.1:3000/) curl [http://127.0.0.1:3000/](http://127.0.0.1:3000/) curl [http://127.0.0.1:3000/](http://127.0.0.1:3000/) Если вы видите JSON, возвращенный из нашей конечной точки, то вы успешно запустили API локально! Шаг 4: Развернуть API : Теперь, когда мы подтвердили, что наш API работает локально, развернем его в AWS с помощью Упаковка и развертывание API с помощью SAM Упаковка и развертывание API с использованием SAM sam развернуть --guided sam deploy --guided в разделе Это руководящее развертывание позволит вам: Это управляемое развертывание позволит вам: 1. Выберите свое имя стека; мой sam-hello-world sam-hello-world Код 2. Выберите регион AWS; мой us-east-1 us-east-1 Подтвердить изменения до развертывания; я выбрал Y Y и Разрешить создание ролей SAM-CLI, Y Y и Отключите Rollback, выберите мы хотим, чтобы инструмент очистил любые неисправные ресурсы N N 6. HelloWorldFunction не имеет аутентификации; это хорошо? Для целей этого руководства Y Y и Сохраните аргументы в конфигурационном файле Y Y и Конфигурационный файл samconfig.toml samconfig.toml и Конфигурационная среда SAM — оставьте это по умолчанию Теперь, когда мы успешно развернули наш API, давайте автоматизируем этот процесс с GitHub, чтобы всякий раз, когда мы хотим развивать на нашем API, развертывание может автоматически запускаться, просто обязуясь на MAIN или MASTER филиал. Если ваше развертывание было успешным, вы должны видеть ресурсы, успешно созданные так: Когда развертывание будет успешным, и ищите сервис API Gateway. Перейдите в настройки API, скопируйте свой домен вставьте его в вход URL в окне вашего браузера и добавьте `/Prod` в конец вашего URL, чтобы добраться до вашего развернутого конечного пункта API. Войдите в свою учетную запись AWS Войдите в свою учетную запись AWS Мой URL выглядит так: Вы также можете искать Lambda в консоли AWS, чтобы просмотреть вашу развернутую функцию Lambda без сервера, где живет код, который мы написали для этой конечной точки. Шаг 5: CI/CD с действиями Github Инициализируйте Git Repo и перейдите в свою главную ветвь Сначала мы инициализируем хранилище git в каталоге нашего проекта с Затем добавим эти файлы в наш , поскольку мы не хотим их комментировать. git init .gitignore git init Добавить .обозреватель эхо "node_modules/\n.aws-sam/\nsamconfig.toml" >>.gitignore echo "node_modules/\n.aws-sam/\nsamconfig.toml" >>.gitignore Теперь мы уверены, что сможем снять все файлы в проекте: и затем сделать наш первый коммит: git add. и добавить git commit -m "Inicial commit - AWS SAM API setup" git commit -m "Initial commit - AWS SAM API setup" Этот следующий шаг предполагает, что у вас установлен GitHub CLI — это шаг, чтобы мы могли создать репо GitHub из нашего текущего каталога: gh repo create aws-sam-cli-tutorial --public --source=. --remote=origin gh repo create aws-sam-cli-tutorial --public --source=. --remote=origin Если у вас нет GitHub CLI, вы можете создать репо вручную на GitHub, а затем указать каталог на ваш репо с этой командой: Git удаленно добавить источник https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git Git удаленно добавить источник https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git Наконец, давайте переместим наш код на GitHub git push -u origin master git push -u origin master Настройте действия GitHub для CI/CD Давайте создадим файл рабочего процесса действий GitHub: mkdir -p.github/workflows mkdir -p.github/workflows touch.github/workflows/deploy.yml touch.github/workflows/deploy.yml Откройте файл в vscode и вставьте следующую конфигурацию yaml: deploy.yml deploy.yml и название: Загрузить API в AWS CloudFormation на: push: филиалы: - master jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout Code uses: actions/checkout@v3 - name: Install AWS SAM CLI uses: aws-actions/setup-sam@v2 - name: Configure AWS CLI uses: aws-actions/configure-aws-credentials@v2 with: aws-access-key-id: ${ secrets.AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${ secrets.AWS_SECRET_ACCESS_KEY }} aws-region: us-east-1 название: Загрузить API в AWS CloudFormation на: push: филиалы: - master jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout Code uses: actions/checkout@v3 - name: Install AWS SAM CLI uses: aws-actions/setup-sam@v2 - name: Configure AWS CLI uses: aws-actions/configure-aws-credentials@v2 with: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-seccess-key: ${ secrets.AWS_SECRET_ACCESS_KEY }} aws-region: us-east-1 -: name and De В этом файле.yaml для автоматизированного развертывания мы полагаемся на репозитории AWS-Actions из GitHub: для установки SAM CLI и конфигурирования наших аккредитаций — эти репозитории AWS могут измениться в течение нескольких лет, поэтому обновлять по мере необходимости. https://github.com/orgs/aws-actions/repositories https://github.com/orgs/aws-actions/repositories Теперь давайте перейдем на github.com — перейдем к вашим хранилищам, нажмем на хранилище, которое мы создали для этого проекта, перейдем к настройкам, действиям, и вы увидите этот экран, чтобы добавить секреты окружающей среды и хранилища. Мы хотим добавить секреты хранилища для: Мы хотим добавить секреты хранилища для: AWS_ACCESS_KEY_ID AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_SECRET_ACCESS_KEY AWS_REGION AWS_REGION → AWS_S3_BUCKET AWS_S3_BUCKET Чтобы получить эти значения, перейдите на консоль AWS. Для вы хотите использовать тот же регион, который вы развернули с вашего локального компьютера.Если вы не уверены в регионе, ищите облачное образование и найдите стек, который вы создали, нажмите на него, и вы должны увидеть регион в URL. AWS_REGION, АУС_РЕГИОН, Для поиск S3 в консоли AWS и выберите букет, который был создан, когда мы развернули из нашей машины в Шаг 4. AWS_S3_BUCKET, AWS_S3_BUCKET, Для и перейдите в службу IAM в консоли AWS: AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY, AWS_ACCESS_KEY_ID → Добавить AWS_SECRET_ACCESS_KEY, Отсюда создайте пользователя IAM, если у вас еще нет пользователя с доступом, который вы хотите использовать, и добавьте хотя бы следующие сферы разрешений для пользователя: AWSLambdaFullAccess IAMFullAccess AmazonS3FullAccess CloudFormationFullAccess AmazonAPIGatewayАдминистратор AWSLambdaFullAccess IAMFullAccess AmazonS3FullAccess CloudFormationFullAccess AmazonAPIGatewayАдминистратор Вы также можете просто добавить , если вам удобно с этим. После этого мы захотим создать ключ Access и Secret для этого пользователя. Выберите CLI в качестве случая использования для ключа доступа. AdministratorAccess АдминистраторДоступ Теперь вернитесь в GitHub и добавьте секреты репозитория: Хорошо, последний шаг заключается в том, чтобы проверить, что все работает! Обновить свой app.js, чтобы сказать что-то другое; я изменил свое на «Что, мир!» exports.lambdaHandler = async (event) => { return { statusCode: 200, body: JSON.stringify({ message: "What up, World!" }), }; }; exports.lambdaHandler = async (event) => { return { statusCode: 200, body: JSON.stringify({ message: "What up, World!" }), }; }; Затем нажмите изменения на свою главную ветвь. - убедитесь, что вы находитесь на главной ветви, когда нажимаете. git add. git commit -m 'updated message' git push и добавить Обновленное сообщение git commit -m 'updated message' git push В вашем репо GitHub вы должны увидеть выполнение действия и успешно развернуть: Наконец, вернитесь в свой веб-браузер и вставьте URL из API Gateway, который мы настроили. Мой: — и подтвердите, что сообщение было изменено. https://tt40c6vgm3.execute-api.us-east-1.amazonaws.com/Prod https://tt40c6vgm3.execute-api.us-east-1.amazonaws.com/Prod Заключение Поздравления! Вы только что создали трубопровод для развертывания CI/CD для AWS Stack без сервера; теперь вы можете заняться созданием своего API с полезными услугами.