VK Dev Platform logo
Помощь
Обновлена 30 июля 2024 г. в 10:24

Структура и состав VK Dev Platform

В состав VK Dev Platform входят следующие категории сервисов:

  1. Главные модули — сервисы, которые должны обеспечивать базовые и критически важные функции, такие как аутентификация, авторизация, управление пользователями, проектами и другое.

  2. Модули интеграции — сервисы, которые должны обеспечивать интеграцию и управление сервисами VK Dev Platform.

  3. Основные модули — сервисы, обеспечивающие процесс разработки. Включают в себя:

    • Собственные решения VK Tech.
    • Продукты технологических партнеров.
    • Open Source с рядом расширенных возможностей версий CE (Community Edition).
  4. Вспомогательные модули — сервисы, которые должны обеспечивать поддержку работы главных и основных модулей. Они должны выполнять вспомогательные задачи, такие как логирование, сбор метрик, управление событиями и т.д.

Описание сервисов VK Dev Platform приведено в таблице 1.

Таблица 1 — Перечень сервисов VK Dev Platform

Сервис

Назначение

Технология реализации

Главные модули

Сервис оркестрации разработки

Предоставляет командам разработки единый пользовательский интерфейс (Портал управления разработкой) для доступа к набору инструментов и ресурсов разработки в смежных сервисах.

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

Разработка VK Tech

Сервис аутентификации и авторизации

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

Keycloak и разработка VK Tech на базе Casbin

Сервис вебхуков

Обеспечивает автоматическую отправку уведомлений или событий на заданные URL-адреса при определенных действиях или изменениях в VK Dev Platform. Вебхуки обеспечивают интеграцию и взаимодействие с внешними системами в реальном времени

Разработка VK Tech

Модули интеграции

Сервис внешних подключений

Обеспечивает управление подключениями VK Dev Platform к внешним системам, например к VK Cloud или VK Private Cloud

Разработка VK Tech

Сервис развертываний и окружений

Обеспечивает развертывание инфраструктуры стендов под приложения и управление окружениями, а также их ресурсами внутри VK Dev Platform

Разработка VK Tech

Сервис управления раннерами

Обеспечивает управление раннерами в VK Dev Platform

Разработка VK Tech

Сервис интеграции с Сервисом хранения и контроля версий исходного кода и с Сервисом непрерывной интеграции и развертывания ПО

Обеспечивает интеграцию и управление Сервисом хранения и контроля версий исходного кода и Сервисом непрерывной интеграции и развертывания ПО

Разработка VK Tech

Сервис интеграции с Сервисом хранения артефактов ПО

Обеспечивает интеграцию, управление Сервисом хранения артефактов ПО и контролируемое распространение различных артефактов

Разработка VK Tech

Сервис интеграции с Сервисом контроля качества кода

Обеспечивает интеграцию и управление Сервисом контроля качества кода

Разработка VK Tech

Сервис интеграции с Сервисами управления задачами и знаниями

Обеспечивает интеграцию и управление Сервисами управления задачами и знаниями

Разработка VK Tech

Сервис интеграции с Сервисом управления тестированием

Обеспечивает интеграцию и управление Сервисом управления тестированием

Разработка VK Tech

Основные модули

Сервис хранения и контроля версий исходного кода

Обеспечивает хранение и контроль версий исходного кода, а также совместную работу всех участников проекта разработки над ним

GitLab CE

Сервис хранения артефактов ПО

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

По умолчанию Sonatype Nexus Repository Manager CE, по заказу — VK Registry

Сервис непрерывной интеграции и развертывания ПО

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

GitLab CE

Сервис контроля качества кода

Обеспечивает непрерывный анализ и измерение качества программного кода

SonarQube CE

Сервис управления задачами

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

Проекты VK WorkSpace

Сервис управления знаниями

Обеспечивает размещение, хранение и систематизацию различной информации, получаемой в рамках разработки ПО

Проекты VK WorkSpace

Сервис управления тестированием

Обеспечивает:

  • Планирование и выполнение ручных и автоматизированных тестов.
  • Контроль и оптимизацию работы инженеров-тестировщиков.
  • Детальную отчетность по качеству тестируемого ПО

Партнерский продукт Test IT

Вспомогательные модули

Сервисы сбора логов

Обеспечивают сбор, первичную обработку и отправку логов во внешние системы сбора, хранения и обработки логов

Агенты Vector

Сервисы сбора метрик

Обеспечивают сбор инфраструктурных и прикладных метрик и отправку их во внешнюю систему мониторинга

Агенты vmagent

Сервисы сбора событий аудита

Обеспечивают сбор событий аудита сервисов VK Dev Platform и отправку их во внешнюю систему хранения событий аудита

Агенты Vector

Сервис оркестрации разработки

Возможности портала:

  • Централизованное управление проектами разработки, включая:

    • Создание, удаление, редактирование проектов разработки.
    • Выделение необходимых проекту ресурсов и инструментов в смежных сервисах VK Dev Platform, в том числе на основе шаблонизированной конфигурации.
  • Поиск и отображение проектов разработки.

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

  • Отображение всех созданных сущностей в рамках инсталляции VK Dev Platform (при наличии соответствующих прав доступа).

  • Отображение переменных CI/CD.

  • Отображение статистики используемых инструментов и ресурсов в смежных сервисах.

  • Управление подпиской на события VK Dev Platform.

  • Получение оповещений о событиях VK Dev Platform по почте и в интерфейсе Портала управления разработкой.

  • Автодокументирование API.

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

Сервис аутентификации и авторизации

Возможности сервиса:

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

  • Обеспечение работы механизмов SSO между всеми сервисами VK Dev Platform.

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

  • Централизованное управление ролевой моделью Портала управления разработкой.

  • Обеспечение единовременного выхода пользователя из следующих сервисов:

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

Сервис вебхуков

Возможности сервиса:

  • Создание вебхуков, которые обеспечивают автоматическую отправку уведомлений или событий на заданные URL-адреса.
  • Управление подпиской вебхуков на определенные события внутри VK Dev Platform.
  • Просмотр деталей и статуса отправки уведомления.

Сервис внешних подключений

Возможности сервиса:

  • Создание подключений к внешней системе, например к VK Cloud или VK Private Cloud.
  • Настройка URL-адреса расположения внешней системы, например VK Cloud или VK Private Cloud.

Сервис развертываний и окружений

Возможности сервиса:

  • Управление жизненным циклом окружений — создание, просмотр, редактирование, удаление.
  • Создание окружений различных типов: Dev, Test, Stage и Prod.
  • Управление жизненным циклом развертываний — создание, просмотр, редактирование, удаление.
  • Развертывание инфраструктуры на базе Terraform-конфигураций в VK Cloud или VK Private Cloud.
  • Предоставление набора преднастроенных шаблонов развертывания, описывающих целевую инфраструктуру.
  • Отображение списка текущих развертываний, включая отображение шагов развертываний.
  • Отображение развернутых в окружениях ресурсов.
  • Управление развертываниями через API.
  • Отображение статусов и истории CI/CD-развертываний в окружении.

Сервис управления раннерами

Возможности сервиса:

  • Управление проектными CI-раннерами — создание, запуск, просмотр, редактирование, удаление.
  • Управление платформенными CI-раннерами — создание, запуск, просмотр, редактирование, удаление.

Сервис интеграции с Сервисом хранения и контроля версий исходного кода и с Сервисом непрерывной интеграции и развертывания ПО

Возможности сервиса:

  • Управление жизненным циклом репозитория — создание, просмотр, редактирование, удаление.
  • Создание репозитория из предустановленного шаблона.
  • Создание дополнительных атрибутов доступа.
  • Отображение прав и ролей и влияние на них изменений атрибутов доступа.
  • Отображение содержимого шаблона.
  • Привязка к проекту Сервиса контроля качества кода.
  • Настройка правил согласования.

Сервис интеграции с Сервисом хранения артефактов ПО

Возможности сервиса:

  • Управление жизненным циклом хранилища артефактов — создание, просмотр, редактирование, удаление.

  • Создание хранилищ следующих типов – Single Proxy, Single Hosted.

  • Создание репозиториев артефактов следующих типов:

    • APT/YUM — для хранения пакетов ПО для ОС Linux.
    • Docker — для хранения Docker-образов.
    • Maven2 — для хранения артефактов сборки Java-приложений.
    • NuGet — для хранения .NET пакетов.
    • NPM — для хранения артефактов сборок JavaScript/Node.js приложений.
    • Helm — для хранения Helm-чартов.
    • PyPI — для хранения Python-пакетов.
    • Go — для хранения Golang-пакетов.
    • Raw — для хранения бинарных артефактов.
  • Создание хранилища с анонимным доступом.

Сервис интеграции с Сервисом контроля качества кода

Возможности сервиса:

  • Управление жизненным циклом анализатора кода — создание, просмотр, редактирование, удаление.
  • Привязка анализатора кода к репозиторию в Сервисе хранения и контроля версий исходного кода.

Сервис интеграции с Сервисами управления задачами и знаниями

Возможности сервиса: управление жизненным циклом пространств/проектов (продуктов) — создание, просмотр, редактирование и удаление.

Сервис интеграции с Сервисом управления тестированием

Возможности сервиса:

  • Управление жизненным циклом проекта тестирования — создание, редактирование, удаление.
  • Автоматическая синхронизация данных пользователей между VK Dev Platform и Сервисом управления тестированием.

Сервис хранения и контроля версий исходного кода

Возможности сервиса:

  • Хранение исходного кода в репозиториях в виде файлов.
  • Создание локальной копии исходного кода из централизованного репозитория.
  • Синхронизация локальных копий исходного кода с централизованным репозиторием.
  • Предоставление доступа пользователей к исходному коду в централизованных репозиториях по протоколам HTTPS, SSH.
  • Отображение и редактирование кода.
  • Атомарная фиксация внесения изменений в исходный код (commit), позволяющая создать новую версию исходного кода.
  • Ведение и просмотр истории изменений исходного кода с учетом ранее созданных версий.
  • Сравнение разных версий исходного кода с отображением различий между ними.
  • Откат внесенных изменений в программный код.
  • Ведение отдельных веток исходного кода и их слияния.
  • Поддержка процедур ручной проверки кода.
  • Репликация репозиториев во внешние системы контроля версий на периодической основе (push mirroring).

Сервис хранения артефактов ПО

Возможности сервиса:

  • Управление репозиториями и хранимыми в них программными артефактами.
  • Загрузка, удаление, распространение и версионирование хранимых программных артефактов.
  • Объединение нескольких репозиториев в единую группу с организацией доступа к артефактам этих репозиториев по единой ссылке.
  • Поддержка работы репозиториев в режиме проксирования запросов к удаленным репозиториям артефактов.
  • Поддержка настройки политик очистки неиспользуемых или устаревших артефактов.
  • Предоставление указанной функциональности через веб-интерфейс, утилиты командной строки и REST-API.

Сервис непрерывной интеграции и развертывания ПО

Возможности сервиса:

  • Использование готовых CI/CD-шаблонов при настройке конвейеров.
  • Маршрутизация исполнения конвейера или отдельных шагов на специализированных вычислительных узлах (CI-раннеры).
  • Управление расписанием запусков конвейеров (по событиям, по времени).
  • Ручной запуск конвейера или отдельных его шагов.
  • Запуск конвейера с заданными параметрами, влияющими на последовательность шагов конвейера или выполнение отдельного шага.
  • Обеспечение модульного подключения различных инструментов обеспечения качества, включенных в состав VK Dev Platform.
  • Запуск задач развертывания новых окружений и развертывания артефактов ПО в них.
  • Развертывание ПО в уже существующих окружениях.
  • Формирование отчетов по активностям сборки, интеграции и развертывания.
  • Проверка состояния интеграций и ресурсов, развернутых в VK Cloud или VK Private Cloud.

Сервис контроля качества кода

Возможности сервиса:

  • Запуск инструментов анализа качества кода для следующих языков программирования и технологий, поддерживаемых SonarQube Community Edition: Java, C, C++, C#, JavaScript, TypeScript, Kotlin, CloudFormation, Terraform, Docker, Ansible, Kubernetes, Helm Charts, Azure Resource Manager/Bicep, Ruby, Go, Scala, Swift, Dart, Flex, Python, PHP, HTML, CSS, XML, VB.NET, T-SQL, PL/SQL, Objective-C и VB6.
  • Сбор, хранение и визуализация метрик качества кода.
  • Сбор, хранение и отображение обнаруженных дефектов качества кода.

Сервис управления задачами

Возможности сервиса:

  • Указание целей и задач проекта, планирование проекта, управление списками задач, дорожными картами, контроль сроков.
  • Настройка жизненного цикла проектных артефактов (задач, дефектов и т.д.).
  • Создание отчетов по проектной деятельности в виде списков, таблиц, досок или графиков. Возможность пользовательской кастомизации отчетов.
  • Просмотр истории изменений по задаче. Отправка уведомлений об изменениях в задаче и упоминании участников.
  • Работа с доской требований и задач проекта.
  • Просмотр и редактирование приоритета задачи или требования.
  • Отслеживание процесса выполнения задачи.
  • Группировка задач по командам, исполнителям, срокам, приоритетам, выпускам.
  • Управление изменениями, контроль требований, иерархия требований.
  • Анализ загрузки сотрудника с поддержкой единовременного назначения сотрудника на несколько задач/проектов.
  • Оценка требований в Story Points.

Сервис управления знаниями

Возможности сервиса:

  • Хранение и управление базой знаний.
  • Управление структурой статей и документов.
  • Связь статей и документов с задачами проекта.
  • Создание и редактирование статей в WYSIWYG-редакторе.
  • Навигация по базе знаний.
  • Размещение ссылок на страницы на других страницах.
  • Вставка контента страницы или задачи.
  • Формирование списка страниц на основе фильтра страниц, вставка списка страниц на страницу.
  • Добавление динамической ссылки на страницу или задачу.
  • Добавление изображений, файлов и диаграмм в статьи.
  • Экспорт страниц и разделов в формат PDF.

Сервис управления тестированием

Возможности сервиса:

  • Создание тест-кейсов и чек-листов, их хранение в библиотеке тестов.
  • Выделение повторяющихся в тест-кейсах действий в общие шаги.
  • Создание пользовательских атрибутов для тест-кейсов и чек-листов.
  • Использование параметров, чтобы не дублировать тест-кейсы для разных итераций.
  • Формирование тестовых наборов для различных конфигураций устройств, ОС и браузеров.
  • Получение системных уведомлений при назначении пользователя на выполнение тестов, упоминании пользователя и назначении пользователя в рамках атрибутов тестов.
  • Запуск автоматизированных тестов и сбор результатов их исполнения.
  • Формирование отчетов по автоматизированным и ручным тестам.
Была ли статья полезна?