Техническое описание сервисов¶

Core компоненты¶

DICTIONARIES¶

Описание функций сервиса: сервис обеспечивает работу со справочниками и отображение справочников внутри портала.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/dictionaries:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c gunicorn --pid /tmp/dictionaries.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate --noinput

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput

3. Инфраструктурные зависимости:

   • Redis.

   • PostgreSQL.

   • Kafka.

4. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

5. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

6. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

7. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

DISCOVERY¶

Описание функций сервиса: сервис обеспечивает работу сервиса наблюдения за состоянием сервисов и позволяет обновлять справочники внутри портала.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/discovery:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную

   • Команда запуска:
     sh -c uvicorn main:app --workers 4 --host 0.0.0.0 --port 8000

   • Инициализация при развертывании:
     sh -c curl --location --request POST http://discovery-backend/api/discovery/internal/init_dictionaries/

3. Инфраструктурные зависимости:

   • Redis.

   • Kafka.

4. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

5. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

6. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

7. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

FILESTORAGE¶

Описание функций сервиса: сервис отвечает за работу с различными файловыми хранилищами в портале.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/filestorage:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c gunicorn --pid /tmp/filestorage-gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate --noinput

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput

3. Сервисные контейнеры:

   • Celery worker: запускается из целевого образа командой sh -c sh -c celery -A application worker -l info
   • Celery beat: запускается из целевого образа командой sh -c sh -c celery -A application beat -l info
   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • Redis.

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 400m
     memory: 2336Mi

NOTIFICATIONS¶

Описание функций сервиса: сервис обеспечивает работу уведомлений внутри портала.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/notifications:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c cp -r /app/static/* /static/ %srv.command%%srv.command% gunicorn --pid /tmp/gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput || exit 0

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

NOTIFICATIONS-WEBSOCKETS¶

Описание функций сервиса: сервис отвечает за работу и отображение уведомлений пользователя в правом верхнем углу портала.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/notifications-websockets:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную SERVER_PORT
   • Команда запуска:
     python server.py

3. Инфраструктурные зависимости:

   • Kafka.

4. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

5. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

6. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

7. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

PAGES¶

Описание функций сервиса: сервис отвечает за работу и отображения главной страницы портала, за работу и отображение виджетов на главной странице портала.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/pages:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c cp -r /app/static/* /static/ %srv.command%%srv.command% gunicorn --pid /tmp/gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload
   • Миграции:
     sh -c python manage.py migrate
   • Инициализация при развертывании:
     sh -c python manage.py create_default_data
   • Инициализация при обновлении:
     sh -c python manage.py change_default_data || exit 0
   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput || exit 0

3. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

4. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

5. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

6. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

7. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

PROFILE¶

Описание функций сервиса: сервис обеспечивает работу с профилями пользователей на портале.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/profile:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c cp -r /app/static/* /static/ %srv.command%%srv.command% gunicorn --pid /tmp/gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput || exit 0

3. Сервисные контейнеры:

   • Celery worker: запускается из целевого образа командой sh -c sh -c celery -A application worker -l info
   • Celery beat: запускается из целевого образа командой sh -c sh -c celery -A application beat -l info
   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • Redis.

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

ROLES¶

Описание функций сервиса: сервис отвечает за разделение пользователей по ролям в рамках ролевой модели, и за доступы и разрешения у данных ролей.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/roles:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную SERVER_PORT
   • Команда запуска:
     sh -c uvicorn main:app --host 0.0.0.0 --port 8000 --workers 8

   • Миграции:
     sh -c alembic upgrade head

   • Создание пользователя панели администратора:
     sh -c python create_admin_panel_user.py $DJANGO_SUPERUSER_USERNAME $DJANGO_SUPERUSER_PASSWORD

3. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

   • Keycloak API.

4. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

5. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

6. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

7. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

Сервисы VKPH¶

ASYNCBLOGS¶

Описание функций сервиса: сервис представляет собой рабочий инструмент коммуникации сотрудников внутри компании, предназначенный для обмена экспертными знаниями, информацией и опытом.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/asyncblogs:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную
   • Команда запуска:
     sh -c uvicorn main:app --host 0.0.0.0 --port 8000 --workers 8
   • Миграции:
     sh -c alembic upgrade head

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python -m kafka_consumer

4. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

   • Keycloak API.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

CALENDAR¶

Описание функций сервиса: сервис замещает функции планирования времени в почтовом корпоративном программном обеспечении. Также в календаре сервиса можно планировать персональное рабочее время, отражая в нём задачи пользователя и привязывая их к времени в календаре.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/calendar:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c cp -r /app/static/* /static/ %srv.command%%srv.command% gunicorn --pid /tmp/gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate --noinput

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput || exit 0

3. Сервисные контейнеры:

   • Celery worker: запускается из целевого образа командой sh -c sh -c celery -A application worker -l info
   • Celery beat: запускается из целевого образа командой sh -c sh -c celery -A application beat -l info
   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • Redis.

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

CMS¶

Описание функций сервиса: сервис позволяет хранить данные в виде веб страниц с иерархией в виде групп страниц или без нее в виде страниц.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/cms:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную
   • Команда запуска:
     sh -c uvicorn main:app --workers 8 --host 0.0.0.0 --port 8000

   • Миграции:
     sh -c alembic upgrade head

   • Создание пользователя панели администратора:
     sh -c python create_admin_panel_user.py $DJANGO_SUPERUSER_USERNAME $DJANGO_SUPERUSER_PASSWORD

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python -m kafka_sdk.async_consumer

4. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

COMMENTS¶

Описание функций сервиса: сервис позволяет пользователям писать, редактировать, удалять комментарии в разных разделах портала.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/comments:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную SERVER_PORT
   • Команда запуска:
     sh -c uvicorn main:app --workers 8 --host 0.0.0.0 --port 8000

   • Миграции:
     sh -c alembic upgrade head

   • Создание пользователя панели администратора:
     sh -c python create_admin_panel_user.py $DJANGO_SUPERUSER_USERNAME $DJANGO_SUPERUSER_PASSWORD

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python -m kafka_consumer

4. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

EVENTS¶

Описание функций сервиса: сервис позволяет информировать сотрудников организации о корпоративных мероприятиях. Корпоративные мероприятия, создаваемые в данном сервисе, могут носить уведомляющий, обучающий, развивающий, информационный, а также развлекающий характер.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/events:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c gunicorn --pid /tmp/gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate --noinput %srv.migrations%%srv.migrations% python manage.py createcachetable

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput

3. Сервисные контейнеры:

   • Celery worker: запускается из целевого образа командой sh -c sh -c celery -A application worker -l info

   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • Redis.

   • PostgreSQL.

   • Kafka.

   • Keycloak API.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

FRONTEND¶

Описание функций сервиса: сервис отвечает за внешний вид портала, отображение интерактивных элементов и контента.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/frontend:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную NULL
   • Команда запуска:
     /app/start.sh

3. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

4. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

5. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

6. Ресурсы:

   • requests:
     cpu: null
     memory: null

GAMIFICATION¶

Описание функций сервиса: сервис содержит в себе инструменты для вовлечения работников в жизнь компании и проявления корпоративно полезной инициативы.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/gamification:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c gunicorn --pid /tmp/gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput || exit 0

3. Сервисные контейнеры:

   • Celery worker: запускается из целевого образа командой sh -c sh -c celery -A application.celery_app worker -l info
   • Celery beat: запускается из целевого образа командой sh -c sh -c celery -A application.celery_app beat -l info
   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • Redis.

   • PostgreSQL.

   • Kafka.

   • Keycloak API.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

GROUPS¶

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

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/groups:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c cp -r /app/static/* /static/ %srv.command%%srv.command% gunicorn --pid /tmp/gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput

3. Сервисные контейнеры:

   • Celery worker: запускается из целевого образа командой sh -c sh -c celery -A application.celery_app worker -l info
   • Celery beat: запускается из целевого образа командой sh -c sh -c celery -A application.celery_app beat -l info
   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • Redis.

   • PostgreSQL.

   • Kafka.

   • Keycloak API.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

IDEAS¶

Описание функций сервиса: сервис предоставляет возможность пользователю предлагать свои идеи, оценивать и комментировать идеи других пользователей. Идея после рассмотрения может быть одобрена или отклонена.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/ideas:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c gunicorn --pid /tmp/gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload
   • Миграции:
     sh -c python manage.py migrate --noinput

3. Сервисные контейнеры:

   • Celery worker: запускается из целевого образа командой sh -c sh -c celery -A application.celery_app worker -l info -c 2

   • Kafka consumer: запускается из целевого образа командой sh -c /bin/sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • Redis.

   • PostgreSQL.

   • Kafka.

   • Keycloak API.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 100m
     memory: 128Mi

MEETINGS¶

Описание функций сервиса: сервис позволяет осуществить бронирования сотрудниками компании корпоративных помещений (переговорных комнат, конференц-залов, спортивных площадок) для организации встреч и мероприятий.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/meetings:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c cp -r /app/static/* /static/ %srv.command%%srv.command% gunicorn --pid /tmp/gunicorn.pid meeting_rooms.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput || exit 0

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

   • Keycloak API.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

NEWS¶

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

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/news:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную
   • Команда запуска:
     sh -c uvicorn main:app --workers 8 --host 0.0.0.0 --port 8000
   • Миграции:
     sh -c alembic upgrade head

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c /bin/sh -c /app/scripts/kafka_consumer.sh

4. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

POLLS¶

Описание функций сервиса: сервис позволяет прикрепить мини-опрос к посту пользователя.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/polls:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c cp -r /app/static/* /static/ %srv.command%%srv.command% gunicorn --pid /tmp/gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput || exit 0

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

   • Keycloak API.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

REACTIONS¶

Описание функций сервиса: сервис отвечает за реакции.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/reactions:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную SERVER_PORT
   • Команда запуска:
     /bin/sh -c /app/scripts/start.sh
   • Миграции:
     sh -c alembic upgrade head

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python -m kafka_sdk.async_consumer

4. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

REPORTS¶

Описание функций сервиса: сервис позволяет администраторам системы получать данные по 3 метрикам посещения пользователями портала: DAU, MAU, Sticky factor, с возможностью их выгрузки в Excel. Также в сервисе реализован вывод рейтингов по социальной активности пользователей: топ 10 сообществ, топ 5 постов и лучший автор постов.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/reports:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную
   • Команда запуска:
     sh -c cp -r /app/static/* /static/ %srv.command%%srv.command% /app/docker/cmd.sh

   • Миграции:
     sh -c python manage.py migrate

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput || exit 0

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • Redis.
   • PostgreSQL.
   • ClickHouse.
   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

SETTINGS¶

Описание функций сервиса: сервис позволяет пользователям настраивать различные разделы портала.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/settings:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную
   • Команда запуска:
     sh -c /app/docker/cmd.sh

   • Миграции:
     sh -c alembic upgrade head

   • Создание пользователя панели администратора:
     sh -c python create_admin_panel_user.py $DJANGO_SUPERUSER_USERNAME $DJANGO_SUPERUSER_PASSWORD

3. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

   • Keycloak API.

4. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

5. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

6. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

7. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

TAGS¶

Описание функций сервиса: сервис отвечает за теги.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/tags:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную SERVER_PORT
   • Команда запуска:
     /bin/sh -c /app/scripts/start.sh
   • Миграции:
     sh -c alembic upgrade head

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python -m kafka_sdk.async_consumer

4. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

TASKS¶

Описание функций сервиса: сервис предназначен для организации взаимодействия сотрудников компании в рамках выполнения проектной деятельности.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/tasks:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную GUNICORN_BIND
   • Команда запуска:
     sh -c cp -r /app/static/* /static/ %srv.command%%srv.command% gunicorn --pid /tmp/filestorage-gunicorn.pid application.wsgi:application --reload --reload-extra-file /tmp/touch.reload

   • Миграции:
     sh -c python manage.py migrate

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput

3. Сервисные контейнеры:

   • Celery worker: запускается из целевого образа командой sh -c sh -c celery -A application worker -l info
   • Celery beat: запускается из целевого образа командой sh -c sh -c celery -A application beat -l info
   • Kafka consumer: запускается из целевого образа командой sh -c sh -c python manage.py kafka_consumer

4. Инфраструктурные зависимости:

   • Redis.

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

TERMSOFUSE¶

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

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/termsofuse:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную
   • Команда запуска:
     sh -c cp -r /app/static/* /static/ %srv.command%%srv.command% /app/docker/cmd.sh

   • Миграции:
     sh -c python manage.py migrate

   • Создание пользователя панели администратора:
     sh -c python manage.py createsuperuser --noinput || exit 0

3. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

4. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

5. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

6. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

7. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi

TIMELINES¶

Описание функций сервиса: сервис представляет собой естественную среду отображения контента для пользователей в формате информационной ленты на Главной странице и в Профиле пользователей.

Переменные окружения:

1. Целевой образ:

   • docker.people-hub.ru/ph/timelines:release-peoplehub-v4-17-1

2. Запуск контейнера:

   • Порт контейнера:
     8000. Для изменения изменить переменную SERVER_PORT
   • Команда запуска:
     /bin/sh -c /app/scripts/start.sh

   • Миграции:
     /bin/sh -c /app/scripts/migrate.sh

   • Создание пользователя панели администратора:
     sh -c python src/commands/create_admin_panel_user.py $DJANGO_SUPERUSER_USERNAME $DJANGO_SUPERUSER_PASSWORD

3. Сервисные контейнеры:

   • Kafka consumer: запускается из целевого образа командой sh -c /bin/sh -c /app/scripts/kafka_consumer.sh

4. Инфраструктурные зависимости:

   • PostgreSQL.

   • Kafka.

5. Проксирование:

   • Для работы необходимо проксирование запросов с основного домена по префиксу пути из переменной API_BASE_URL

6. Блокировки: для безопасности необходимо исключить или блокировать из проксирования запросы

   • $API_BASE_URL/internal/* внутренние ресурсы
   • $API_BASE_URL/admin/ панель администратора Django

7. Проверки:

   • health-check: get запросы по адресу $API_BASE_URL/internal/healthcheck

8. Ресурсы:

   • requests:
     cpu: 200m
     memory: 256Mi