VK Cloud logo

Развертывание VK Security Gate

VK Security Gate — это платформа анализа безопасности, которая развертывается на выделенной виртуальной машине в вашем проекте VK Cloud и предоставляет возможности для автоматизированного контроля качества кода:

  • статический анализ кода (SAST),
  • анализ зависимостей (SCA),
  • поиск секретов,
  • формирование SBOM.

Возможности сервиса можно расширить через интеграцию с LLM-моделями или вашими внутренними инструментами, такими как CodeQL или Jira. Подробнее о сервисе в официальной документации VK Security Gate.

Используя сервис, вы принимаете лицензионное соглашение сервиса Marketplace и лицензионное соглашение сервиса VK Security Gate.

Чтобы развернуть сервис VK Security Gate в проекте VK Cloud:

  1. Зарегистрируйтесь и перейдите в личный кабинет VK Cloud.

  2. Настройте сеть, чтобы иметь доступ к сервису из интернета:

    1. Создайте сеть с доступом в интернет, если она не была создана ранее.
    2. В настройках подсети, где будет размещена ВМ с развернутым сервисом, отключите опцию Приватный DNS.
  3. Перейдите в раздел Магазин приложений, на странице раздела нажмите кнопку Все решения.

  4. На карточке сервиса VK Security Gate нажмите кнопку Подробнее.

  5. На странице с описанием сервиса нажмите кнопку Подключить.

  6. На вкладке Тарифные планы выберите версию сервиса из списка.

  7. Выберите подходящий тариф:

    • VK Security Gate 10 — до 10 репозиториев и до 1 000 000 строк кода.
    • VK Security Gate 50 — до 50 репозиториев и до 5 000 000 строк кода.
    • VK Security Gate 200 — до 200 репозиториев и до 20 000 000 строк кода.
    • VK Security Gate 500 — до 500 репозиториев и до 50 000 000 строк кода.
  8. Введите данные на странице Параметры сервера.

    1. Укажите параметры виртуальной машины, на которой будет развернут сервис:

      • Зона доступности: выберите зону доступности, где будет запущена ВМ.
      • Тип виртуальной машины: выберите предустановленную конфигурацию ВМ. Для планов VK Security Gate 200 и VK Security Gate 500 оставьте STD3-16-64: этим планам нужно не меньше 16 ядер и 64 ГБ памяти.
      • Сеть: выберите ранее созданную сеть с доступом в интернет и подсеть с отключенной опцией Приватный DNS.
    2. Укажите параметры системного диска и диска с данными.

      • Размер диска: укажите нужный размер диска ВМ в гигабайтах. На диске хранятся база уязвимостей, Kafka, MinIO и рабочие каталоги сканов, поэтому размер не должен быть меньше 100 ГБ.
      • Тип диска: выберите один из типов диска — HDD, SSD или High-IOPS SSD. Для интенсивной нагрузки выберите High-IOPS SSD.
  9. Нажмите кнопку Следующий шаг.

  10. На шаге Параметры продукта укажите параметры:

    • E-mail администратора: укажите рабочий адрес. Он станет логином администратора.

    • Домен, сертификат и публичный адрес: оставьте опцию включенной, если к продукту будут обращаться из интернета. Если отключить опцию, сервис будет доступен только во внутренней сети по IP-адресу ВМ с самоподписанным сертификатом.

    • Сеть мониторинга: укажите значение subnet, чтобы открыть сервис только из выбранной подсети, либо задайте диапазон сети вида 10.20.0.0/16, в которой работают приложения. Посмотреть адрес подсети можно в личном кабинете. Метрики отдаются без пароля, поэтому диапазон лучше сузить.

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

      Активация опции повышает нагрузку на вычислительные ресурсы ВМ с развернутым сервисом, пропорционально количеству новых репозиториев. При необходимости шаблон конфигурации ВМ можно будет изменить, чтобы увеличить производительность ВМ.

  11. (Опционально) На шаге Интеграции включите нужные вам интеграции:

    • Отправка почты: включите, если хотите получать письма с приглашениями и для сброса пароля. Без почты приглашение — ссылка, которую администратор передает пользователю сам. Задайте параметры для отправки почты:

      • SMTP-сервер: укажите имя или IP-адрес вашего SMTP-сервера, например smtp.example.com.
      • Порт SMTP: оставьте значение 465. Поддерживается только SSL (неявный TLS) с логином и паролем.
      • Логин SMTP: укажите вашу учетную запись для входа на SMTP-сервер.
      • Пароль SMTP: укажите пароль от вашей учетной записи без управляющих символов. Обратная косая черта не может стоять в конце пароля или перед одинарной кавычкой.
      • Адрес отправителя: укажите адрес, от имени которого уходят письма, например secgate@example.com.
    • CodeQL: включите опцию, если нужен анализатор CodeQL от GitHub. Он не входит в поставку, лицензию на него вы получаете сами.

      • Ссылка на архив CodeQL: укажите прямую ссылку https на архив CodeQL для Linux в формате tar.gz: релиз GitHub, ваш сервер или временная ссылка на объект в Object Storage. Серверу нужен доступ к этому адресу. Сервер скачает архив сам.
    • AI-триаж находок: включите опцию, если хотите разбирать находки с помощью языковой модели. Подойдет любая модель с API, совместимым с OpenAI. Найденные секреты модель разбирает автоматически, остальные находки — по кнопке в карточке находки. Модель получает фрагменты кода из находок, поэтому выбирайте ее с учетом того, куда уходит код.

      • Адрес модели: укажите базовый адрес без /v1, например https://llm.example.com.
      • Имя модели: укажите имя так, как его принимает API, например gpt-4o-mini.
      • ID проекта LLM: укажите идентификатор проекта, в котором созданы ключи доступа к языковой модели. Продукт автоматически передает этот ID шлюзу при каждом запросе для корректной аутентификации. Если вы используете шлюз, не привязанный к конкретному проекту (например, DeepSeek), оставьте значение none.
      • Ключ API модели: укажите ключ доступа к модели. Если модели ключ не нужен, оставьте значение по умолчанию.
      • Разбирать все SAST-находки автоматически: оставьте опцию отключенной. Включите ее, чтобы модель разбирала каждую новую находку SAST: расход запросов к модели растет с числом находок.
    • Jira: включите опцию, если хотите создавать задачи по находкам. Поддерживаются только Jira Data Center и Jira Server, Jira Cloud не подходит.

      • Адрес Jira: укажите базовый адрес без /rest, например https://jira.example.com.
      • Персональный токен доступа: создайте токен в Jira в разделе Profile → Personal Access Tokens. Лучше выпустить его у отдельной учетной записи с доступом только к нужным проектам: так продукт получит не больше прав, чем нужно.
  12. Нажмите кнопку Следующий шаг.

  13. Ознакомьтесь со стоимостью инфраструктуры для развертывания сервиса и нажмите кнопку Подключить тариф.

    Начнется развертывание облачной инфраструктуры, и откроется страница свойств сервиса. Статус процесса будет отображаться также в разделе Магазин приложений → Мои сервисы.

    После успешного развертывания на вашу почту, привязанную к VK Cloud, придут сообщения:

    • уведомление со ссылкой на инстанс сервиса в личном кабинете VK Cloud;
    • письмо с одноразовой ссылкой на данные для доступа к сервису.
  14. Перейдите по одноразовой ссылке из письма и сохраните данные для доступа к сервису:

    • productURL — адрес веб-интерфейса сервиса;
    • adminEmail и adminPassword — логин и пароль администратора;
    • statusURL — адрес страницы состояния интеграций.
  15. Перейдите в веб-интерфейс сервиса VK Security Gate по адресу productURL с логином adminEmail и паролем adminPassword из письма.

  16. (Опционально) Проверьте состояние подключенных интеграций:

    1. Откройте в браузере адрес statusURL, учетные данные вводить не нужно.

    2. Посмотрите содержимое JSON-файла, отображаемое на странице. Для параметров mail, codeql, ai и jira должно отображаться одно из значений:

      • ok — интеграция подключена,
      • disabled — интеграция отключена,
      • downloading — сервер скачивает архив CodeQL,
      • error — ошибка в подключении или заданных параметрах. Исправьте значения параметров подключения в настройках сервиса.

    Подключенные интеграции видны в продукте:

    • Jira: в веб-интерфейсе откройте Администрирование → Менеджеры задач → Jira и создайте конфигурацию, затем привяжите ее к проекту;
    • CodeQL: в новых сканах через несколько минут появляются задачи codeql-<ЯЗЫК>. Уже завершенные сканы не пересчитываются.
Была ли статья полезна?