{"id":19900581,"url":"https://github.com/annamihailovna/prettypets-docker-ci_cd","last_synced_at":"2025-05-02T23:31:02.179Z","repository":{"id":190853745,"uuid":"669282474","full_name":"AnnaMihailovna/prettypets-docker-ci_cd","owner":"AnnaMihailovna","description":"PrettyPets - приложение для обмена фото любимцев. Проект запущен на виртуальном удалённом сервере в трёх контейнерах: nginx, PostgreSQL и Django+Gunicorn. Автоматизация деплоя: CI/CD.","archived":false,"fork":false,"pushed_at":"2023-08-31T20:04:26.000Z","size":351,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-09-01T15:16:56.034Z","etag":null,"topics":["django","django-rest-framework","docker","docker-compose","dockerhub","github-actions","gunicorn","nginx","postgresql","python"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AnnaMihailovna.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-07-21T20:05:24.000Z","updated_at":"2023-09-01T15:16:59.345Z","dependencies_parsed_at":null,"dependency_job_id":"7f5b5f9a-2994-41a0-b738-6fa1b4205671","html_url":"https://github.com/AnnaMihailovna/prettypets-docker-ci_cd","commit_stats":null,"previous_names":["annamihailovna/kittygram_final","annamihailovna/prettypets-docker-ci_cd"],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnnaMihailovna%2Fprettypets-docker-ci_cd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnnaMihailovna%2Fprettypets-docker-ci_cd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnnaMihailovna%2Fprettypets-docker-ci_cd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnnaMihailovna%2Fprettypets-docker-ci_cd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AnnaMihailovna","download_url":"https://codeload.github.com/AnnaMihailovna/prettypets-docker-ci_cd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224341455,"owners_count":17295271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","django-rest-framework","docker","docker-compose","dockerhub","github-actions","gunicorn","nginx","postgresql","python"],"created_at":"2024-11-12T20:12:41.707Z","updated_at":"2024-11-12T20:12:42.421Z","avatar_url":"https://github.com/AnnaMihailovna.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Проект \"PrettyPets\"\n---\n### Описание\nPrettyPets — социальная сеть для обмена фотографиями любимых питомцев.Проект\nсостоит из бэкенд-приложения на Django и фронтенд-приложения на React.\nПроект запущен на виртуальном удалённом сервере в трёх контейнерах: nginx, PostgreSQL и Django+Gunicorn. Заготовленный контейнер с фронтендом используется для сборки файлов. Контейнер с проектом обновляется на Docker Hub.\n\nВ PrettyPets можно:\n* Зарегистрироваться.\n* Добавить фото питомца.\n* Удалить питомца.\n* Подобрать окраску питомца.\n* Рассказать о достижениях питомца.\n* Указать год рождения питомца.\n\n### Технологический стек\n[![Python](https://img.shields.io/badge/-Python-464646?style=flat\u0026logo=Python\u0026logoColor=56C0C0\u0026color=cd5c5c)](https://www.python.org/)\n[![Django](https://img.shields.io/badge/-Django-464646?style=flat\u0026logo=Django\u0026logoColor=56C0C0\u0026color=0095b6)](https://www.djangoproject.com/)\n[![Django REST Framework](https://img.shields.io/badge/-Django%20REST%20Framework-464646?style=flat\u0026logo=Django%20REST%20Framework\u0026logoColor=56C0C0\u0026color=cd5c5c)](https://www.django-rest-framework.org/)\n[![PostgreSQL](https://img.shields.io/badge/-PostgreSQL-464646?style=flat\u0026logo=PostgreSQL\u0026logoColor=56C0C0\u0026color=0095b6)](https://www.postgresql.org/)\n[![Nginx](https://img.shields.io/badge/-NGINX-464646?style=flat\u0026logo=NGINX\u0026logoColor=56C0C0\u0026color=cd5c5c)](https://nginx.org/ru/)\n[![gunicorn](https://img.shields.io/badge/-gunicorn-464646?style=flat\u0026logo=gunicorn\u0026logoColor=56C0C0\u0026color=0095b6)](https://gunicorn.org/)\n[![Docker](https://img.shields.io/badge/-Docker-464646?style=flat\u0026logo=Docker\u0026logoColor=56C0C0\u0026color=cd5c5c)](https://www.docker.com/)\n[![Docker-compose](https://img.shields.io/badge/-Docker%20compose-464646?style=flat\u0026logo=Docker\u0026logoColor=56C0C0\u0026color=0095b6)](https://www.docker.com/)\n[![Docker Hub](https://img.shields.io/badge/-Docker%20Hub-464646?style=flat\u0026logo=Docker\u0026logoColor=56C0C0\u0026color=cd5c5c)](https://www.docker.com/products/docker-hub)\n[![GitHub%20Actions](https://img.shields.io/badge/-GitHub%20Actions-464646?style=flat\u0026logo=GitHub%20actions\u0026logoColor=56C0C0\u0026color=0095b6)](https://github.com/features/actions)\n\n### Как запущен\nВ файле settings.py в разрешенные хосты добавим id удаленного сервера и доменное имя проекта\n```\nALLOWED_HOSTS = ['xxx.xxx.xxx.xxx', '127.0.0.1', 'localhost', 'prettykittygram.hopto.org']\n```\nВ корневой директории создан файл .env с переменными окружения\n```\nPOSTGRES_USER=\nPOSTGRES_PASSWORD=\nPOSTGRES_DB=\nDB_HOST=\nDB_PORT=\nTOKEN=\n```\nСобраны образы из нужных директорий для frontend, backend  и nginx. Образы проверены, загружены на Docker Hub и будут использоваться для запуска контейнеров в файле конфигурации docker-compose.production.yml\n\nНа удаленном сервере создала директорию kittygram/, в неe скопировала файлы docker-compose.production.yml и .env командой из корневой директории на локальном компе\n```\nscp -i path_to_SSH/SSH_name docker-compose.production.yml \\\n    username@server_ip:/home/username/kittygram/docker-compose.production.yml\nscp -i path_to_SSH/SSH_name .env\\\n    username@server_ip:/home/username/kittygram/.env \n```\n\nДля запуска Docker Compose в режиме демона выполните команду на сервере в папке kittygram/ с флагом -d:\n```\nsudo docker compose -f docker-compose.production.yml up -d\n```\nВыполнила миграции, соберала статику, создала суперпользователя\n```\ndocker compose -f docker-compose.production.yml exec backend python manage.py makemigrations\ndocker compose -f docker-compose.production.yml exec backend python manage.py migrate\ndocker compose -f docker-compose.production.yml exec backend python manage.py collectstatic\nsudo docker compose -f docker-compose.production.yml exec backend cp -r /app/collected_static/. /app/backend_static/static/\ndocker compose -f docker-compose.production.yml exec backend python manage.py createsuperuser\n```\nНастроила внешний Nginx так, чтобы он отправлял в докер все запросы без исключения — и запросы к приложению, и запросы к статике. На сервере в редакторе nano открыла конфиг Nginx: nano /etc/nginx/sites-enabled/default. Изменила настройки location в секции server.\n```\nlocation /media/ {\n        proxy_set_header Host $http_host;\n        proxy_pass http://127.0.0.1:8000;\n}\nlocation / {\n        proxy_pass http://127.0.0.1:8000;\n}\n```\nВыполнила команду проверки конфигурации:\n```\nsudo nginx -t\n```\nПерезагрузила конфиг Nginx\n```\nsudo service nginx reload\n```\n## Автоматизация деплоя: CI/CD\nWorkflow написан так, что каждый git push в ветку main является событием-триггером для запуска тестирования и деплоя.\nПри возникновении события-триггера GitHub Actions читает файл с описанием workflow и для каждой отдельной задачи-job этого workflow выделяет отдельный раннер, который будет выполнять эту задачу.\nНа раннере GitHub Actions, надо развернуть докер. Код проекта на раннере есть, докерфайлы тоже есть — надо выполнить билд и прямо с раннера запушить образы на Docker Hub.\nНа боевом сервере надо перезапустить контейнеры, чтобы они создались из обновлённых образов. Раннер должен аутентифицироваться от моего имени на докерхабе — чтобы запушить образы. А потом аутентифицироваться и на боевом сервере — чтобы перезапустить контейнеры.\nСекретные данные можно спрятать на платформе GitHub Actions, в специальном хранилище. Значения из этого хранилища будут переданы в переменные, доступ к которым будет только у раннера при запуске воркфлоу.  \nПеременные c токенами, паролями и другими приватными данными на платформе GitHub Actions называют secrets, хранят их в разделе Secrets.\nДля отслеживания выполнения workflow в GitHub Actions, можно подключить к работе Telegram-бота.\n\n### Развёрнутый проект:\nhttp://prettykittygram.hopto.org\n\n(временно приостановлено, переезжаем)\n\n### Над проектом работала (бэкенда и деплой)\n[AnnaMihailovna](https://github.com/AnnaMihailovna/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fannamihailovna%2Fprettypets-docker-ci_cd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fannamihailovna%2Fprettypets-docker-ci_cd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fannamihailovna%2Fprettypets-docker-ci_cd/lists"}