Initial commit

Author: zamula-soft

01_docker_compose/README.md

@@ -0,0 +1,24 @@
+# Проектное задание: Docker-compose
+
+Приступим к улучшению сервиса в области DevOps. Настройте запуск всех компонентов системы — Django, Nginx и Postgresql — с использованием docker-compose.
+
+Для упрощения выполнения задания мы подготовили проект, где настроена работа связки Django + uWSGI + Nginx + Docker. Вы можете взять его за основу, но его придётся дополнительно доработать, чтобы подключить Postgres, а также устранить мелкие ошибки в конфигурировании Django: например, `debug = True` или отсутствие настроек чтения переменных окружения.
+
+Сама заготовка уже показывает админку с примером одного метода API. Однако статика не собирается, миграций нет, конфиги Nginx, uWSGI и Docker, возможно, придётся подправить.
+
+Если вы считаете, что всё нужно сделать по-другому, воспользуйтесь пустой заготовкой проекта и напишите его самостоятельно.
+
+**Требования к работе:**
+
+- Напишите dockerfile для Django.
+- Для настройки Nginx можно пользоваться наработками из этой темы, но ревьюеры будут запускать ваше решение. Перед сдачей проекта убедитесь, что всё работает правильно.
+- Уберите версию Nginx из заголовков. Версии любого ПО лучше скрывать от посторонних глаз, чтобы вашу админку случайно не взломали. Найдите необходимую настройку в официальной документации и проверьте, что она работает корректно. Убедиться в этом можно с помощью «Инструментов разработчика» в браузере.
+- Отдавайте статические файлы Django через Nginx, чтобы не нагружать сервис дополнительными запросами. Перепишите `location` таким образом, чтобы запросы на `/admin` шли без поиска статического контента. То есть, минуя директиву `try_files $uri @backend;`.
+
+**Подсказки и советы:**
+
+- Теории на платформе должно быть достаточно для понимания принципов конфигурирования. Если у вас появятся какие-то вопросы по параметрам, ищите ответы [в официальной документации](https://nginx.org/ru/).
+- Для выполнения задачи про `/admin` нужно посмотреть порядок поиска `location`.
+- Для работы со статикой нужно подумать, как залить данные в файловую систему контейнера с Nginx.
+- Для задания дана базовая структура, которой можно пользоваться.
+- При настройке docker-compose важно проверять пути до папок. Большинство проблем связанно именно с этим.

01_docker_compose/empty_project/Dockerfile

@@ -0,0 +1,27 @@
+FROM python:3.10
+
+WORKDIR /opt/app
+
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+ENV UWSGI_PROCESSES 1
+ENV UWSGI_THREADS 16
+ENV UWSGI_HARAKIRI 240
+ENV DJANGO_SETTINGS_MODULE 'example.settings'
+
+COPY run_uwsgi.sh run_uwsgi.sh
+COPY requirements.txt requirements.txt
+COPY uwsgi/uwsgi.ini uwsgi.ini
+
+RUN  mkdir -p /var/www/static/ \
+     && mkdir -p /var/www/media/ \
+     && mkdir -p /opt/app/static/ \
+     && mkdir -p /opt/app/media/ \
+     && pip install --upgrade pip \
+     && pip install -r requirements.txt
+
+COPY . .
+
+EXPOSE 8000
+
+ENTRYPOINT ["uwsgi", "--strict", "--ini", "uwsgi.ini"]

01_docker_compose/empty_project/app/__init__.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for example project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'example.settings')
+
+application = get_asgi_application()

01_docker_compose/empty_project/docker-compose.yml

@@ -0,0 +1,124 @@
+"""
+Django settings for example project.
+
+Generated by 'django-admin startproject' using Django 4.0.4.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.0/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-@k04vsjy@qv3m573&94kgq_kjj@lad^^d%hr_o2sk!a6+c3ne9'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = ['localhost', '127.0.0.1', '[::1]']
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'movies',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'example.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'example.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/4.0/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.0/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.0/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.0/howto/static-files/
+
+STATIC_URL = 'static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.0/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

01_docker_compose/empty_project/nginx/nginx.conf

@@ -0,0 +1,22 @@
+"""example URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.0/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import include, path
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+    path('api/', include('movies.api.urls')),
+]

01_docker_compose/simple_project/app/Dockerfile

@@ -0,0 +1,16 @@
+"""
+WSGI config for example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'example.settings')
+
+application = get_wsgi_application()

01_docker_compose/simple_project/app/example/__init__.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'example.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

01_docker_compose/simple_project/app/example/asgi.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

01_docker_compose/simple_project/app/example/settings.py

@@ -0,0 +1,6 @@
+from django.urls import path, include
+
+
+urlpatterns = [
+    path('v1/', include('movies.api.v1.urls')),
+]

01_docker_compose/simple_project/app/example/urls.py

@@ -0,0 +1,7 @@
+from django.urls import path
+
+from movies.api.v1 import views
+
+urlpatterns = [
+    path('movies/', views.api),
+]

01_docker_compose/simple_project/app/example/wsgi.py

@@ -0,0 +1,5 @@
+from django.http import HttpResponse
+
+
+def api(request):
+    return HttpResponse("My best API")

01_docker_compose/simple_project/app/manage.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class MoviesConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'movies'

01_docker_compose/simple_project/app/movies/__init__.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

01_docker_compose/simple_project/app/movies/admin.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

01_docker_compose/simple_project/app/movies/api/__init__.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

01_docker_compose/simple_project/app/movies/api/urls.py

@@ -0,0 +1,2 @@
+django==4.0.4
+uwsgi==2.0.20

01_docker_compose/simple_project/app/movies/api/v1/__init__.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -e
+
+chown www-data:www-data /var/log
+
+uwsgi --strict --ini /etc/app/uwsgi.ini

01_docker_compose/simple_project/app/movies/api/v1/urls.py

@@ -0,0 +1,36 @@
+[uwsgi]
+socket = :8000
+protocol = http
+
+uid = www-data
+gid = www-data
+
+master = true
+no-orphans = true
+
+die-on-term = true
+single-interpreter = true
+
+lazy-apps = true
+
+processes = $(UWSGI_PROCESSES)
+threads = $(UWSGI_THREADS)
+enable-threads = true
+
+max-requests = 5000
+
+harakiri = $(UWSGI_HARAKIRI)
+harakiri-verbose = true
+
+vacuum = true
+
+reload-mercy = 10
+
+chdir = /opt/app
+
+wsgi-file = example/wsgi.py
+
+post-buffering = 1048576
+buffer-size = 65535
+static-map = /static=/var/wwww/static
+static-map = /media=/var/wwww/media

01_docker_compose/simple_project/app/movies/api/v1/views.py

@@ -0,0 +1,29 @@
+server {
+    listen       80 default_server;
+    listen       [::]:80 default_server;
+    server_name  _;  # Обслуживает любой хост
+
+    root /data;
+
+    location @backend {
+        proxy_pass http://service:8000;
+    }
+
+    location ~* \.(?:jpg|jpeg|gif|png|ico|css|js)$ {
+        log_not_found off;
+        expires 90d;
+    }
+
+    location / {
+        try_files $uri @backend;
+    }
+
+    error_page  404              /404.html;
+
+    # redirect server error pages to the static page /50x.html
+    #
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   html;
+    }
+}

01_docker_compose/simple_project/app/movies/apps.py

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Static page</title>
+</head>
+<body>
+I'm static
+</body>
+</html>