Как автоматизировать развертывание приложения для публикации в блоге с помощью GitHub Actions, Node.js, CouchDB и Aptible

Добро пожаловать в руководство по автоматизации развертывания приложений для публикаций в блогах с помощью GitHub Actions, Node.js,

CouchDB и Apible.

Это подробное руководство поможет вам создать, развернуть и управлять приложением для публикации блога с использованием вышеперечисленных инструментов и технологий.

Но сначала позвольте мне дать вам краткий обзор приложения Blogpost , его функций и его основных компонентов. Приложение Blogpost — это веб-приложение, которое позволяет пользователям создавать и публиковать сообщения в блогах.

Пользователи могут писать, редактировать, удалять и просматривать сообщения других пользователей. Приложение использует Node.js в качестве серверной части, CouchDB в качестве базы данных и GitHub Actions в качестве инструмента непрерывной интеграции и развертывания.

Почему я выбрал именно их? Да, причин много, но вот некоторые из основных:

• Node.js — это быстрая, масштабируемая и простая в использовании среда выполнения JavaScript, которая может работать на различных платформах. Он имеет множество библиотек и платформ для веб-разработки, например Express, минималистскую и гибкую среду веб-приложений, которую я буду использовать в этом проекте.

• CouchDB — это надежная, безопасная и мощная система баз данных NoSQL с открытым исходным кодом. Это документо-ориентированная база данных, которая использует JSON для хранения данных.

• GitHub Actions — это гибкий, удобный и интегрированный инструмент, который позволяет автоматизировать рабочие процессы для ваших репозиториев GitHub. Он также имеет множество готовых действий, которые вы можете использовать или настроить в соответствии со своими потребностями, например действие Aptible Deploy, которое я буду использовать в этом проекте для развертывания приложения в Aptible.

• Aptible — это облачная платформа для развертывания и управления контейнерными приложениями, обеспечивающая простые возможности подготовки, масштабирования и мониторинга.

Предварительные условия

Прежде чем приступить к разработке, важно настроить необходимые инструменты и технологии.

• Node.js: убедитесь, что Node.js установлен на вашем компьютере.

• CouchDB: убедитесь, что CouchDB установлен и работает в вашей системе.

• Знание Node.js и JavaScript: твердое понимание основ Node.js и JavaScript.

• Docker: установите и запустите Docker на своем компьютере.

• Учетная запись Aptible: создайте учетную запись Aptible и ознакомьтесь с развертыванием базового приложения.

• Учетная запись Docker Cloud: приобретите учетную запись Docker Cloud для размещения своих приложений.

Разработка приложения Blogpost

Шаг 1. Настройте свой проект Node.js

• Создайте каталог проекта для вашего приложения для публикации в блоге.

• Инициализируйте проект Node.js с помощью npm:

 npm init -y

• Установите фреймворк Express.js, который будет служить основой для бэкэнда:

 npm install express nano

Шаг 2. Настройте CouchDB

• Убедитесь, что CouchDB установлен и работает. Вы можете получить доступ к CouchDB через браузер по адресу http://127.0.0.1:5984/_utils/ .

Шаг 3. Создайте приложение Node.js

• Создайте файл blog.js в каталоге вашего проекта.

• Инициализируйте Express и подключите его к CouchDB:

 const express = require("express"); const nano = require("nano")("http://admin:[email protected]:5984"); const app = express(); const port = 3000; // Middleware to parse JSON data app.use(express.json()); // async function asyncCall() { // // await nano.db.destroy("alice"); // await nano.db.create("blogposts"); // const db = nano.use("blogposts"); // return response; // } // asyncCall(); const db = nano.use("blogposts");

• Этот код определяет конечные точки API для создания, получения, обновления и удаления сообщений в блоге с использованием базы данных CouchDB.

  
  

 // Create a new blog post app.post("/posts", async (req, res) => { const { title, description, author } = req.body; try { const doc = await db.insert({ title, description, author, createdAt: new Date(), updatedAt: new Date(), }); res.json({ id: doc.id, rev: doc.rev }); } catch (err) { console.error(err); res.status(500).send("Error creating post"); } }); // Get all blog posts app.get("/posts", async (req, res) => { try { const docs = await db.list({ include_docs: true }); res.json(docs.rows); } catch (err) { console.error(err); res.status(500).send("Error retrieving posts"); } }); // Get a specific blog post app.get("/posts/:id", async (req, res) => { const { id } = req.params; try { const doc = await db.get(id); res.json(doc); } catch (err) { console.error(err); res.status(404).send("Post not found"); } }); // Update a blog post app.put("/posts/:id", async (req, res) => { const { id } = req.params; const { title, description } = req.body; try { await db.insert({ _id: id, title, description, updatedAt: new Date(), }); res.json({ message: "Post updated successfully" }); } catch (err) { console.error(err); res.status(500).send("Error updating post"); } }); // Delete a blog post app.delete("/posts/:id", async (req, res) => { const { id } = req.params; try { await db.destroy(id); res.json({ message: "Post deleted successfully" }); } catch (err) { console.error(err); res.status(500).send("Error deleting post"); } }); app.listen(port, () => { console.log(`Blogpost app listening on port ${port}`); });

Тестируем локально:

Тщательное тестирование имеет решающее значение для обеспечения функциональности и надежности вашего проекта. Вот пример документации API, которая поможет вам в процессе тестирования:

API-документация

Базовый URL :

Предполагая, что ваш сервер работает локально через порт 3000, базовый URL-адрес вашего API будет следующим:

 http://localhost:3000

Конечные точки API:

Создать новую публикацию в блоге

• Конечная точка : POST /posts

• Описание : Создает новую публикацию в блоге.

• Тело запроса :

   { "title": "String", "description": "String", "author": "String" }

• Пример :

   POST http://localhost:3000/posts { "title": "Sample Title", "description": "Sample Description", "author": "John Doe" }

Получить все сообщения в блоге

• Конечная точка : GET /posts

• Описание : Получает все сообщения в блоге.

• Ответ :

   [ { "id": "String", "key": "String", "value": { "rev": "String" }, "doc": { "_id": "String", "_rev": "String", "title": "String", "description": "String", "author": "String", "createdAt": "Date", "updatedAt": "Date" } } ]

• Пример :

   GET http://localhost:3000/posts

Получите конкретную публикацию в блоге

• Конечная точка : GET /posts/:id

• Описание : Извлекает конкретную публикацию в блоге по ее идентификатору.

• Параметры :

  • id : идентификатор сообщения в блоге.

• Ответ :

   { "_id": "String", "_rev": "String", "title": "String", "description": "String", "author": "String", "createdAt": "Date", "updatedAt": "Date" }

• Пример :

   GET http://localhost:3000/posts/your-post-id

Обновить сообщение в блоге

• Конечная точка : PUT /posts/:id

• Описание : Обновляет конкретную публикацию в блоге по ее идентификатору.

• Параметры :

  • id : идентификатор сообщения в блоге.

• Тело запроса :

   { "title": "String", "description": "String" }

• Пример :

   PUT http://localhost:3000/posts/your-post-id { "title": "Updated Title", "description": "Updated Description" }

Удалить сообщение в блоге

• Конечная точка : DELETE /posts/:id

• Описание : Удаляет определенную публикацию в блоге по ее идентификатору.

• Параметры :

  • id : идентификатор сообщения в блоге.

• Пример :

   DELETE http://localhost:3000/posts/your-post-id

Пожалуйста, замените your-post-id фактическим идентификатором сообщения в блоге при тестировании запросов GET , PUT и DELETE .

Шаг 4. Dockerize ваше приложение Node.js

Вам необходимо иметь учетную запись Docker Hub. Если вы еще его не создали, зарегистрируйтесь в Docker Hub.

Шаги по отправке Dockerized приложения в Docker Hub:

• Создайте Dockerfile в корневом каталоге вашего проекта Node.js.

 # Use an official Node.js runtime as the base image FROM node:16 # Set the working directory in the container WORKDIR /usr/src/app # Copy package.json and package-lock.json to the working directory COPY package*.json ./ # Install app dependencies RUN npm install # Copy the rest of the application files to the working directory COPY . . # Expose the port the app runs on EXPOSE 3000 # Define the command to run the app CMD ["node", "blog.js"]

• Пометьте свой образ Docker: откройте терминал/командную строку и перейдите в корневой каталог вашего приложения Node.js, где находится ваш Dockerfile.

  
  

Выполните следующую команду, чтобы создать образ Docker, и пометьте его своим именем пользователя Docker Hub и желаемым именем репозитория:

 docker build -t your-docker-username/blogpost-app:latest .

Замените your-docker-username на имя пользователя Docker Hub, а blogpost-app на желаемое имя репозитория.

Вы получите аналогичный ответ:

 [+] Building 1.1s (10/10) FINISHED docker:desktop-linux => [internal] load .dockerignore 0.0s => => transferring context: 2B 0.0s => [internal] load build definition from Dockerfile 0.0s => => transferring dockerfile: 489B 0.0s => [internal] load metadata for docker.io/library/node:16 1.0s => [1/5] FROM docker.io/library/node:16@sha256:f77a1aef2da8d83e45ec990f45df50f1a286c5fe8bbfb8c6e4246c6389705c0b 0.0s => [internal] load build context 0.0s => => transferring context: 45.31kB 0.0s => CACHED [2/5] WORKDIR /usr/src/app 0.0s => CACHED [3/5] COPY package*.json ./ 0.0s => CACHED [4/5] RUN npm install 0.0s => CACHED [5/5] COPY . . 0.0s => exporting to image 0.0s => => exporting layers 0.0s => => writing image sha256:c5f046a9b99389aea6bf3f503e9b05cce953daf1b3f77ee5fb3f7469dc36c709 0.0s => => naming to docker.io/wise4rmgod/blogpost-app:latest

• Войдите в Docker Hub: аутентифицируйте свой клиент Docker с помощью своей учетной записи Docker Hub, выполнив следующую команду:

 docker login

При появлении запроса введите имя пользователя и пароль Docker Hub.

 Authenticating with existing credentials... Login Succeeded

• Отправьте образ Docker в Docker Hub. После входа в систему отправьте помеченный образ Docker в репозиторий Docker Hub, используя следующую команду:

 docker push your-docker-username/blogpost-app:latest

Эта команда загружает ваш локальный образ в Docker Hub в указанном вами репозитории.

• Проверка отправки: перейдите в свою учетную запись Docker Hub в Интернете и перейдите в свой репозиторий, чтобы подтвердить, что ваш образ Docker был успешно отправлен.

  

  
  

 aptible deploy --app reactgame --docker-image wise4rmgod/blogpost-app --private-registry-username wise4rmgod --private-registry-password H$(_tS+W~ZBST63

Шаг 5. Возможное развертывание

• Войдите в Aptible через CLI, используя следующую команду:

 aptible login

Вам будет предложено ввести адрес электронной почты и пароль. В случае успеха вы получите ответ, подобный этому:

 Token written to /Users/wisdomnwokocha/.aptible/tokens.json This token will expire after 6 days, 23 hrs (use --lifetime to customize)

• Теперь разверните свое приложение с помощью следующей команды:

Синтаксис:

 aptible deploy --app <app name> --docker-image <docker image in cloud>

Вот пример команды:

 aptible deploy --app reactgame --docker-image wise4rmgod/blogpost-app

Вы получите ответ, подобный следующему:

 INFO -- : Starting App deploy operation with ID: 61135861 INFO -- : Deploying without git repository INFO -- : Writing .aptible.env file... INFO -- : Fetching app image: wise4rmgod/blogpost-app... INFO -- : Pulling from wise4rmgod/blogpost-app INFO -- : 26ee4ff96582: Pulling fs layer INFO -- : 446eab4103f4: Pulling fs layer INFO -- : 2e3c22a0f840: Pulling fs layer INFO -- : a7ab8ad9b408: Pulling fs layer INFO -- : 3808fdf0c601: Pulling fs layer INFO -- : ab9e4075c671: Pulling fs layer INFO -- : 362360c8cef6: Pulling fs layer INFO -- : 928b5d11ac66: Pulling fs layer INFO -- : dc87e077ac61: Pulling fs layer INFO -- : f108e80f4efc: Pulling fs layer INFO -- : 84ac53840ac8: Pulling fs layer INFO -- : e81f21b79a1f: Pulling fs layer INFO -- : 2e3c22a0f840: Downloading: 523 KB / 49.8 MB INFO -- : 446eab4103f4: Downloading: 173 KB / 16.6 MB INFO -- : 26ee4ff96582: Downloading: 483 KB / 47 MB INFO -- : 2e3c22a0f840: Downloading: 25.7 MB / 49.8 MB INFO -- : a7ab8ad9b408: Downloading: 528 KB / 175 MB INFO -- : ab9e4075c671: Downloading: 355 KB / 33.4 MB INFO -- : a7ab8ad9b408: Downloading: 35.3 MB / 175 MB INFO -- : 26ee4ff96582: Pull complete INFO -- : 446eab4103f4: Pull complete INFO -- : 2e3c22a0f840: Pull complete INFO -- : a7ab8ad9b408: Downloading: 71.2 MB / 175 MB INFO -- : a7ab8ad9b408: Downloading: 106 MB / 175 MB INFO -- : a7ab8ad9b408: Downloading: 142 MB / 175 MB INFO -- : a7ab8ad9b408: Pull complete INFO -- : 3808fdf0c601: Pull complete INFO -- : ab9e4075c671: Pull complete INFO -- : 362360c8cef6: Pull complete INFO -- : 928b5d11ac66: Pull complete INFO -- : dc87e077ac61: Pull complete INFO -- : f108e80f4efc: Pull complete INFO -- : 84ac53840ac8: Pull complete INFO -- : e81f21b79a1f: Pull complete INFO -- : Digest: sha256:de9d04d069ca89ebdb37327365a815c88cd40d90cbc5395cc31c351fff1206dd INFO -- : Status: Downloaded newer image for wise4rmgod/blogpost-app:latest INFO -- : No Procfile found in git directory or /.aptible/Procfile found in Docker image: using Docker image CMD INFO -- : No .aptible.yml found in git directory or /.aptible/.aptible.yml found in Docker image: no before_release commands will run INFO -- : Pushing image dualstack-v2-registry-i-0a5ec8cff8e775b34.aptible.in:46022/app-63213/72184c41-7dc6-4313-b10e-749125f72577:latest to private Docker registry... INFO -- : The push refers to repository [dualstack-v2-registry-i-0a5ec8cff8e775b34.aptible.in:46022/app-63213/72184c41-7dc6-4313-b10e-749125f72577] INFO -- : dd387bc6b362: Pushed INFO -- : 586bd9d5efcf: Pushed INFO -- : 8ae0c889ca84: Pushed INFO -- : c91ec53bcc27: Pushing: 522 KB / 93.6 MB INFO -- : aec897bac4f0: Pushed INFO -- : 0ead224631d3: Pushed INFO -- : ad3b30eb29d3: Pushing: 542 KB / 444 MB INFO -- : 2a7587eb01b6: Pushing: 544 KB / 137 MB INFO -- : be36d2a441aa: Pushed INFO -- : 03f6e3800bbe: Pushed INFO -- : a10e482288d1: Pushing: 338 KB / 30.7 MB INFO -- : f9cfc9f6b603: Pushing: 513 KB / 103 MB INFO -- : c91ec53bcc27: Pushing: 31.3 MB / 93.6 MB INFO -- : c91ec53bcc27: Pushing: 62.7 MB / 93.6 MB INFO -- : ad3b30eb29d3: Pushing: 44.5 MB / 444 MB INFO -- : 2a7587eb01b6: Pushing: 34.4 MB / 137 MB INFO -- : a10e482288d1: Pushed INFO -- : ad3b30eb29d3: Pushing: 88.9 MB / 444 MB INFO -- : f9cfc9f6b603: Pushing: 34.6 MB / 103 MB INFO -- : 2a7587eb01b6: Pushing: 68.9 MB / 137 MB INFO -- : ad3b30eb29d3: Pushing: 133 MB / 444 MB INFO -- : f9cfc9f6b603: Pushing: 70.2 MB / 103 MB INFO -- : c91ec53bcc27: Pushed INFO -- : 2a7587eb01b6: Pushing: 103 MB / 137 MB INFO -- : ad3b30eb29d3: Pushing: 178 MB / 444 MB INFO -- : ad3b30eb29d3: Pushing: 224 MB / 444 MB INFO -- : 2a7587eb01b6: Pushed INFO -- : f9cfc9f6b603: Pushed INFO -- : ad3b30eb29d3: Pushing: 270 MB / 444 MB INFO -- : ad3b30eb29d3: Pushing: 312 MB / 444 MB INFO -- : ad3b30eb29d3: Pushing: 355 MB / 444 MB INFO -- : ad3b30eb29d3: Pushing: 401 MB / 444 MB INFO -- : ad3b30eb29d3: Pushed INFO -- : latest: digest: sha256:de9d04d069ca89ebdb37327365a815c88cd40d90cbc5395cc31c351fff1206dd size: 2841 INFO -- : Pulling from app-63213/72184c41-7dc6-4313-b10e-749125f72577 INFO -- : Digest: sha256:de9d04d069ca89ebdb37327365a815c88cd40d90cbc5395cc31c351fff1206dd INFO -- : Status: Image is up to date for dualstack-v2-registry-i-0a5ec8cff8e775b34.aptible.in:46022/app-63213/72184c41-7dc6-4313-b10e-749125f72577:latest INFO -- : Image app-63213/72184c41-7dc6-4313-b10e-749125f72577 successfully pushed to registry. INFO -- : STARTING: Register service cmd in API INFO -- : COMPLETED (after 0.28s): Register service cmd in API INFO -- : STARTING: Derive placement policy for service cmd INFO -- : COMPLETED (after 0.15s): Derive placement policy for service cmd INFO -- : STARTING: Create new release for service cmd INFO -- : COMPLETED (after 0.24s): Create new release for service cmd INFO -- : STARTING: Schedule service cmd .. INFO -- : COMPLETED (after 13.49s): Schedule service cmd INFO -- : STARTING: Stop old app containers for service cmd INFO -- : COMPLETED (after 0.0s): Stop old app containers for service cmd INFO -- : STARTING: Start app containers for service cmd INFO -- : WAITING FOR: Start app containers for service cmd INFO -- : WAITING FOR: Start app containers for service cmd INFO -- : COMPLETED (after 18.4s): Start app containers for service cmd INFO -- : STARTING: Delete old containers for service cmd in API INFO -- : COMPLETED (after 0.0s): Delete old containers for service cmd in API INFO -- : STARTING: Commit app containers in API for service cmd INFO -- : COMPLETED (after 0.26s): Commit app containers in API for service cmd INFO -- : STARTING: Commit service cmd in API INFO -- : COMPLETED (after 0.13s): Commit service cmd in API INFO -- : STARTING: Cache maintenance page INFO -- : COMPLETED (after 0.28s): Cache maintenance page INFO -- : STARTING: Commit app in API INFO -- : COMPLETED (after 0.19s): Commit app in API INFO -- : App deploy successful.

• Посетите панель управления Aptible, чтобы убедиться, что развертывание прошло успешно.

• Нажмите вкладку «Конечная точка» на панели управления и сохраните конечную точку. Это позволит вам опубликовать вашу базу данных в общедоступном Интернете.

• Нажмите «Добавить конечную точку» на следующем экране, чтобы создать новую конечную точку.

Заключение

Это подробное руководство поможет вам создать, развернуть и управлять приложением для публикации блога с помощью Node.js, CouchDB и Aptible.

Вы усвоили основы настройки основных инструментов и технологий, создания серверной части приложения для публикации в блоге, закрепления приложения, отправки образа Docker в Docker Hub и развертывания приложения в Aptible.

Поздравляем с завершением этого подробного руководства и вашим путешествием в разработку облачных приложений с помощью Aptible!