https://github.com/annamihailovna/prettypets-docker-ci_cd
PrettyPets - приложение для обмена фото любимцев. Проект запущен на виртуальном удалённом сервере в трёх контейнерах: nginx, PostgreSQL и Django+Gunicorn. Автоматизация деплоя: CI/CD.
https://github.com/annamihailovna/prettypets-docker-ci_cd
django django-rest-framework docker docker-compose dockerhub github-actions gunicorn nginx postgresql python
Last synced: 6 months ago
JSON representation
PrettyPets - приложение для обмена фото любимцев. Проект запущен на виртуальном удалённом сервере в трёх контейнерах: nginx, PostgreSQL и Django+Gunicorn. Автоматизация деплоя: CI/CD.
- Host: GitHub
- URL: https://github.com/annamihailovna/prettypets-docker-ci_cd
- Owner: AnnaMihailovna
- Created: 2023-07-21T20:05:24.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-31T20:04:26.000Z (about 2 years ago)
- Last Synced: 2023-09-01T15:16:56.034Z (about 2 years ago)
- Topics: django, django-rest-framework, docker, docker-compose, dockerhub, github-actions, gunicorn, nginx, postgresql, python
- Language: JavaScript
- Homepage:
- Size: 343 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Проект "PrettyPets"
---
### Описание
PrettyPets — социальная сеть для обмена фотографиями любимых питомцев.Проект
состоит из бэкенд-приложения на Django и фронтенд-приложения на React.
Проект запущен на виртуальном удалённом сервере в трёх контейнерах: nginx, PostgreSQL и Django+Gunicorn. Заготовленный контейнер с фронтендом используется для сборки файлов. Контейнер с проектом обновляется на Docker Hub.
В PrettyPets можно:
* Зарегистрироваться.
* Добавить фото питомца.
* Удалить питомца.
* Подобрать окраску питомца.
* Рассказать о достижениях питомца.
* Указать год рождения питомца.
### Технологический стек
[](https://www.python.org/)
[](https://www.djangoproject.com/)
[](https://www.django-rest-framework.org/)
[](https://www.postgresql.org/)
[](https://nginx.org/ru/)
[](https://gunicorn.org/)
[](https://www.docker.com/)
[](https://www.docker.com/)
[](https://www.docker.com/products/docker-hub)
[](https://github.com/features/actions)
### Как запущен
В файле settings.py в разрешенные хосты добавим id удаленного сервера и доменное имя проекта
```
ALLOWED_HOSTS = ['xxx.xxx.xxx.xxx', '127.0.0.1', 'localhost', 'prettykittygram.hopto.org']
```
В корневой директории создан файл .env с переменными окружения
```
POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_DB=
DB_HOST=
DB_PORT=
TOKEN=
```
Собраны образы из нужных директорий для frontend, backend и nginx. Образы проверены, загружены на Docker Hub и будут использоваться для запуска контейнеров в файле конфигурации docker-compose.production.yml
На удаленном сервере создала директорию kittygram/, в неe скопировала файлы docker-compose.production.yml и .env командой из корневой директории на локальном компе
```
scp -i path_to_SSH/SSH_name docker-compose.production.yml \
username@server_ip:/home/username/kittygram/docker-compose.production.yml
scp -i path_to_SSH/SSH_name .env\
username@server_ip:/home/username/kittygram/.env
```
Для запуска Docker Compose в режиме демона выполните команду на сервере в папке kittygram/ с флагом -d:
```
sudo docker compose -f docker-compose.production.yml up -d
```
Выполнила миграции, соберала статику, создала суперпользователя
```
docker compose -f docker-compose.production.yml exec backend python manage.py makemigrations
docker compose -f docker-compose.production.yml exec backend python manage.py migrate
docker compose -f docker-compose.production.yml exec backend python manage.py collectstatic
sudo docker compose -f docker-compose.production.yml exec backend cp -r /app/collected_static/. /app/backend_static/static/
docker compose -f docker-compose.production.yml exec backend python manage.py createsuperuser
```
Настроила внешний Nginx так, чтобы он отправлял в докер все запросы без исключения — и запросы к приложению, и запросы к статике. На сервере в редакторе nano открыла конфиг Nginx: nano /etc/nginx/sites-enabled/default. Изменила настройки location в секции server.
```
location /media/ {
proxy_set_header Host $http_host;
proxy_pass http://127.0.0.1:8000;
}
location / {
proxy_pass http://127.0.0.1:8000;
}
```
Выполнила команду проверки конфигурации:
```
sudo nginx -t
```
Перезагрузила конфиг Nginx
```
sudo service nginx reload
```
## Автоматизация деплоя: CI/CD
Workflow написан так, что каждый git push в ветку main является событием-триггером для запуска тестирования и деплоя.
При возникновении события-триггера GitHub Actions читает файл с описанием workflow и для каждой отдельной задачи-job этого workflow выделяет отдельный раннер, который будет выполнять эту задачу.
На раннере GitHub Actions, надо развернуть докер. Код проекта на раннере есть, докерфайлы тоже есть — надо выполнить билд и прямо с раннера запушить образы на Docker Hub.
На боевом сервере надо перезапустить контейнеры, чтобы они создались из обновлённых образов. Раннер должен аутентифицироваться от моего имени на докерхабе — чтобы запушить образы. А потом аутентифицироваться и на боевом сервере — чтобы перезапустить контейнеры.
Секретные данные можно спрятать на платформе GitHub Actions, в специальном хранилище. Значения из этого хранилища будут переданы в переменные, доступ к которым будет только у раннера при запуске воркфлоу.
Переменные c токенами, паролями и другими приватными данными на платформе GitHub Actions называют secrets, хранят их в разделе Secrets.
Для отслеживания выполнения workflow в GitHub Actions, можно подключить к работе Telegram-бота.
### Развёрнутый проект:
http://prettykittygram.hopto.org
(временно приостановлено, переезжаем)
### Над проектом работала (бэкенда и деплой)
[AnnaMihailovna](https://github.com/AnnaMihailovna/)