Описание приложения для MarketplaceBeta
Полное описание сервиса отображается на вкладке Описание сервиса страницы сервиса в Marketplace.
Текст описания указывается в конфигурации сервиса:
- Для image-based приложения — в файле
full_description.mdсервисного пакета. - Для SaaS-приложения — в параметре
full_descriptionв JSON-файле.
В общем случае полное описание сервиса содержит следующие разделы:
- Информация о сервисе.
- Правила тарификации.
- Полезные ссылки.
- Техническая поддержка.
- Лицензионное соглашение.
В разделе указывается следующая информация:
-
Краткий обзор сервиса: что представляет собой сервис, какие задачи помогает решать (основные сценарии использования).
-
Кто является поставщиком:
- Вендор.
- Дистрибьютор.
- VK.
-
Информация о поставщике (опционально).
-
Характеристики сервиса, желательно в форме таблицы.
-
Тип сервиса: Image-based.
-
Версия сервиса (при наличии). Например, Usergate 7.01.
-
Версия ОС. Например, Ubuntu 22.04.
-
Категория сервиса. Примеры:
- Аналитика.
- Базы данных.
- Безопасность.
- Инструменты для разработки.
- VPN.
-
-
Варианты развертывания сервиса:
- Одна ВМ.
- Кластер.
-
Какая инфраструктура облачной платформы используется. Например, ВМ, виртуальные сети, DNS.
-
Требования к сети:
- ВМ должна иметь доступ во внешнюю сеть.
- В настройках подсети приватный DNS должен быть выключен.
-
(Опционально) Схемы сервиса и скриншоты интерфейса.
Правила тарификации описываются в свободной форме. Рекомендуется:
- Указать тип тарификации.
- Указать, где можно ознакомиться с тарифными планами, если их несколько. Пример: «С правилами тарификации можно ознакомиться в матрице тарифных планов на странице сервиса».
- Упомянуть, что платные тарифные опции, если они есть, тарифицируются дополнительно к стоимости тарифного плана.
- Описать тарифные планы с договорной ценой, если они есть.
- Объяснить, что стоимость инфраструктуры облачной платформы тарифицируется отдельно.
Пример заполнения подраздела с правилами тарификации (формат Markdown):
# Правила тарификацииСервис предоставляется по модели Bring Your Own License. Тарификация осуществляется только за потребляемую инфраструктуру VK Cloud. Ее стоимость можно оценить в блоке **Детализация** в мастере конфигурации тарифного плана. Итоговая стоимость будет отображена на последней странице мастера конфигурации тарифного плана.
- Ссылка на краткую документацию, описывающую начало работы с сервисом — ссылка на статью Настройка сервисов магазина приложений.
- Ссылка на полную документацию, опубликованную разработчиком сервиса.
Пример заполнения раздела с полезными ссылками (формат Markdown):
# Полезные ссылки- [Документация c первыми шагами](<ССЫЛКА_НА_ПОРТАЛ_ДОКУМЕНТАЦИИ_VK_CLOUD> "На портале документации VK Cloud") — инструкции по получению доступа, первоначальной настройке и началу использования сервиса после развертывания инстанса.- [Полная документация сервиса](<ССЫЛКА_НА_ДОКУМЕНТАЦИЮ_РАЗРАБОТЧИКА> "На сайте поставщика").
В разделе приводятся:
- Правила получения технической поддержки сервиса.
- Правила получения технической поддержки по инфраструктуре облачной платформы.
- Контакты технической поддержки.
Пример заполнения раздела о технической поддержке (формат Markdown):
# Техническая поддержкаУслуга по технической поддержке UserGate NGFW приобретается вместе с лицензией на продукт. Поддержка осуществляется поставщиком на [Портале технической поддержки](https://support.usergate.com/ru) в соответствии с [Регламентом технической поддержки](https://support.usergate.com/ru/technical-support-regulations).По запросу [команда Professional Services](https://cloud.vk.com/professional-services/) VK Cloud осуществляет расширенную техническую поддержку UserGate NGFW.Команда VK Cloud осуществляет техническую поддержку по вопросам функционирования инфраструктуры VK Cloud. Информация об условиях оказания техподдержки и способах обращения находится на странице [Условия оказания поддержки](/ru/start/support/support-info).
В разделе указываются:
-
Ссылки:
- На Пользовательское соглашение магазина приложений
- На пользовательское соглашение сервиса.
-
Для Open Source-решений — дисклеймер о лицензиях Open Source.
Пример заполнения раздела о лицензионном соглашении (формат Markdown):
# Лицензионное соглашениеИспользуя сервис UserGate NGFW, вы соглашаетесь с:- [Пользовательским соглашением магазина приложений](https://cloud.vk.com/docs/ru/start/legal/digital-cloud/marketplace).- [Лицензионным соглашением на использование UserGate NGFW](https://www.usergate.com/ru/usergate-eula).