Создайте образ для проекта NestJS, разверните его на платформе Google Cloud и узнайте о полезных приемах и советах по обновлению и улучшению развернутых сервисов.
Контейнеры позволяют упаковать программное обеспечение и все его зависимости в легкий, переносимый модуль, который можно запускать и масштабировать как локально, так и в облаке. Google Cloud Run — это сервис, предоставляемый Google Cloud Platform, который позволяет разработчикам развертывать и масштабировать контейнеры практически для любого типа приложений с минимальными усилиями.
Перед запуском контейнеров необходимо собрать образы. Google Cloud Run позволяет собирать их в облаке с помощью buildpacks или локально на компьютере с использованием сред выполнения контейнеров, таких как Docker или Podman. В этой статье мы сосредоточимся на последнем варианте. Мы создадим образ для проекта NestJS и развернем его на Google Cloud Platform. Мы также рассмотрим общие советы по обновлению и улучшению развернутых сервисов.
Предварительные требования
В этом руководстве предполагается, что вы знакомы с серверным программированием на TypeScript и имеете представление о среде выполнения контейнеров, такой как Docker или Podman.
Настройка проекта
Давайте начнем с настройки проекта NestJS, который мы будем развертывать. Откройте терминал и выполните следующую команду:
Приведенная выше команда использует Nest CLI для создания проекта в папке с названием my-nest-backend. Следуйте подсказкам и примите все значения по умолчанию.
Затем установим необходимые зависимости. Выполните эту команду в терминале:
Мы установили модуль config для использования переменных окружения. Позже мы покажем, как добавлять и использовать переменные окружения при развертывании. А пока выполните эту команду в терминале, чтобы создать файл, в котором будут храниться переменные окружения для локальной работы.
Затем обновите файл .env, чтобы он выглядел так:
Теперь обновим содержимое файла app.module.ts.
Мы обновили app.module.ts для использования модуля config. Здесь следует обратить внимание на два момента: когда мы не в производственной среде, мы считываем переменные окружения из файла .env. В производственной среде обратите внимание, что параметр ignoreEnv будет иметь значение true. Это позволяет нашему приложению считывать любые переменные окружения, которые мы внедряем в контейнер при запуске приложения в облаке.
Нам также понадобится один эндпоинт. Давайте обновим файл app.controller.ts следующим образом:
Также обновите файл app.service.ts следующим образом:
Наше демонстрационное приложение имеет один маршрут /, который при вызове запускает метод getHello. Этот метод возвращает значение переменной окружения MESSAGE.
Чтобы увидеть работающее приложение, откройте терминал и выполните следующую команду:
Наше приложение в настоящее время прослушивает порт 3000, как показано в файле main.ts ниже:
Обратите внимание, что приложение прослушивает специальное значение process.env.PORT, если оно предоставлено. Это будет важно в производственной среде, так как это значение будет динамически внедряться при работе приложения внутри контейнера. Пока что, поскольку оно не задано локально, по умолчанию используется порт 3000.
Теперь перейдите по адресу http://localhost:3000, чтобы увидеть работающее приложение, как показано ниже:
Сборка образа
Нам нужно собрать образ приложения, прежде чем запускать его как контейнер. Мы уже упоминали во вводной части, что образ можно собрать как локально, так и удаленно.
При локальной сборке мы можем использовать либо локальные buildpacks, либо, как в нашем случае, среды выполнения контейнеров, такие как Docker или Podman.
Теперь внутри папки my-nest-backend создайте файл с названием Dockerfile и обновите его содержимое следующим образом:
Наш Dockerfile прост: он состоит из двух основных этапов. На первом этапе мы устанавливаем менеджер пакетов pnpm, используем его для установки всех зависимостей, перечисленных в package.json, а затем собираем приложение.
Второй этап просто копирует содержимое с этапа сборки: папку node_modules и созданную папку dist из первого (builder) этапа.
Из соображений безопасности мы также устанавливаем USER в значение test, чтобы команды не выполнялись от имени root. Инструкция EXPOSE просто документирует в метаданных образа, что приложение может прослушивать порт 3000. Наконец, инструкция CMD содержит команду, используемую для запуска контейнера из образа.
Чтобы собрать образ, откройте терминал в директории проекта и выполните следующую команду:
Приведенная выше команда собирает образ. Точка (.) определяет контекст сборки, которым в нашем случае является папка my-nest-backend. Флаг -f указывает файл, в котором находится скрипт сборки. Это необязательно, если файл называется Dockerfile; мы добавили его здесь только для ясности.
Также обратите внимание, что мы указали флаг --platform и установили его в linux/amd64. Это важно для того, чтобы созданный образ работал корректно, особенно если он собирается на компьютере с Apple Silicon.
Мы помечаем образ тегом chrisnw/dummy-app:0002. Это соответствует стандартному формату <DOCKER_HUB_USERNAME>/IMAGE_NAME:TAG. Если у вас нет имени пользователя Docker Hub, вы можете его создать.
Чтобы отправить образ в Docker Hub, выполните следующую команду:
Как видно выше, команда выполняется успешно. Docker-образ отправляется в личный реестр Docker Hub, связанный с указанным именем пользователя.
Развертывание контейнера в Google Cloud Run
Внутренне Google Cloud Run основан на Kubernetes, но с упрощенным интерфейсом. Пользователи могут запускать любые рабочие нагрузки, если они упакованы в контейнер. Вы можете либо предоставить собранный образ, как мы это сделали, либо позволить Cloud Run собрать его за вас, указав путь к исходному коду или используя предоставленные ими buildpacks для сборки в облаке.
Для начала посетите Google Cloud Platform и создайте проект. Обратите внимание, что мы можем использовать gcloud CLI для выполнения всех этих шагов в терминале, но для простоты мы сделаем все через пользовательский интерфейс.
Выберите проект в качестве проекта по умолчанию, как показано ниже.
Затем нам нужно включить биллинг для нашего проекта, чтобы иметь возможность использовать Cloud Run. Выберите Billing на боковой панели.
Затем нажмите «Link a billing account» и выберите аккаунт для привязки.
Теперь, когда биллинг настроен, мы можем перейти в консоль Cloud Run. Самый быстрый способ получить к ней доступ — использовать строку поиска.
Создание сервиса
Теперь нажмите на Cloud Run. Затем на боковой панели выберите Services и нажмите Deploy container.
Мы выбрали опцию Service, потому что она используется для любой рабочей нагрузки, запускаемой по HTTP, как в нашем случае с веб-сервером. Обратите внимание, что сервис можно использовать для запуска одного или нескольких контейнеров.
После нажатия на Deploy container нам будет предложена форма для настройки сервиса перед развертыванием.
Мы выбираем «Deploy from a container image», затем указываем URL образа, который мы только что отправили в Docker Hub. Мы называем наш сервис dummy-app. Обратите внимание, что мы также получаем автоматически сгенерированный URL для доступа к нашему приложению. В нашем случае это https://dummy-app-847822676051.europe-west1.run.app/.
Настройка экземпляров и биллинга
Сервисы могут оплачиваться за запрос или за экземпляр. Биллинг на основе запросов, как следует из названия, означает, что с вас взимается плата за каждый запрос к вашему серверу. Таким образом, меньший трафик означает меньшие расходы, и наоборот.
Однако ваш сервер не сможет выполнять фоновые задачи, такие как задания CRON, или запускать воркеры для обработки задач в очереди, поскольку экземпляры переходят в спящий режим при отсутствии трафика.
Если вашему веб-серверу это необходимо, предпочтительнее выбрать тарификацию на основе экземпляров и указать минимальное количество работающих экземпляров, чтобы сервер был доступен и работал без «холодных стартов». Для нашего небольшого сервера нас устраивает настройка на основе запросов.
Далее нам нужно настроить параметры контейнера. Для памяти и вычислительных ресурсов мы оставляем значения по умолчанию. Мы не стали заполнять поле команды контейнера, так как уже задали ее при сборке образа — то есть CMD ["node", "dist/main.js"], которую мы указали ранее в нашем Dockerfile.
Затем переходим на вкладку «Переменные и секреты» (Variables and Secrets). Мы добавили одну переменную окружения с названием MESSAGE и установили для нее фиктивное значение prod-message. Вы можете добавить несколько переменных, нажав кнопку «Добавить переменную» (Add variable).
Однако для конфиденциальных учетных данных, таких как ключи API или строки подключения к базе данных, которые не должны отображаться в виде открытого текста, вы можете нажать «Ссылаться на секрет» (Reference a secret), чтобы включить Secret Manager API и добавить один или несколько секретов для использования здесь.
Наконец, нажмите кнопку «Создать» (Create), чтобы развернуть сервис. Если все работает правильно, перейдите по URL-адресу, и вы должны увидеть запущенное приложение, как показано ниже:
Внесение изменений и повторное развертывание приложения
Чтобы повторно развернуть наше приложение, давайте внесем изменения в код. Обновите файл app.service.ts.
Мы просто добавили эмодзи в строку, возвращаемую нашим методом getHello. Теперь мы можем приступить к сборке образа, выполнив:
И отправить образ, выполнив:
Теперь на вкладке «Контейнер» (Container) мы обновляем поле, указывающее на новый образ. Нажмите «Просмотреть различия и развернуть» (View diff and deploy), а затем нажмите «Развернуть изменения» (Deploy changes).
Автоматизация для CI/CD
Вместо ручной сборки и публикации образа мы можем сделать этап сборки частью нашего конвейера CI/CD, используя распространенные инструменты, такие как GitHub Actions. Google Cloud Run также предоставляет необходимые сценарии автоматизации, которые мы можем подключить для ускорения сборки, отправки и развертывания образа.
Заключение
Google Cloud Run позволяет разработчикам легко использовать мощные функции Kubernetes, включая его богатую экосистему промежуточного ПО и плагинов, не сталкиваясь с обычной сложностью. Надеемся, что эта демонстрация послужит отправной точкой для развертывания аналогичных рабочих нагрузок в Google Cloud Platform в ваших будущих проектах.











