Файл service.yamlBeta

Конфигурационный файл service.yaml содержит следующую информацию:

  • Общие параметры приложения.
  • Массив plans с именами тарифных планов. Эти имена используются только для описания сервисного пакета и не отображаются в интерфейсе Marketplace.
  • Секция preview с именами тарифных опций. Эти имена используются только для описания сервисного пакета и не отображаются в интерфейсе Marketplace.

Общие параметры приложения

Имя

Описание

Формат

Обязательный

id

Идентификатор сервиса UUID4 (ID), сформированный с помощью генератора UUID4

string (UUID4)

Файл service.yaml

revision

Ревизия сервиса. Сочетание ревизии и ID сервиса определяет его уникальность в Marketplace. Остальные параметры описывают характеристики конкретной ревизии сервиса

string, до 255 символов

Файл service.yaml

name

Имя сервиса

string, до 255 символов

Файл service.yaml

short_description

Краткое описание сервиса, которое будет отображаться в его карточке:

  • в каталоге Marketplace;
  • на вкладке Описание сервиса на странице сервиса.

Полное описание сервиса содержится в файле full_description.md

string, до 120 символов

Файл service.yaml

singleton

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

boolean

Файл service.yaml

auto_bind

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

boolean

Файл service.yaml

icon

Имя файла с иконкой сервиса, находящегося в директории images сервисного пакета

string, до 512 символов

Файл service.yaml

help

URL документации сервиса

string, до 512 символов

Файл service.yaml

bindable

Определяет, можно ли создавать сервисные привязки для этого сервиса. Значение должно быть true

boolean

Файл service.yaml

plan_updateable

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

Значение параметра применяется для всех планов сервиса.

Для image-based приложений значение должно быть false

boolean

Файл service.yaml

deactivatable

Определяет, можно ли временно приостановить использование сервиса

boolean

Файл service.yaml

bindings_retrievable

Определяет, нужно ли повторять попытку создания сервисной привязки в течение определенного времени, если предыдущая попытка не удалась

boolean

Файл service.yaml

instances_retrievable

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

boolean

Файл service.yaml

plans

Содержит имена тарифных планов приложения

Массив

Файл service.yaml

preview

Содержит имена тарифных опций для матрицы тарифных планов

Массив

Файл service.yaml

На основании тарифных планов и опций, указанных в массивах plans и preview, формируется матрица тарифных планов.

Массив plans

В массиве plans с помощью ключей name перечисляются имена тарифных планов (<ИМЯ_ПЛАНА>), которые будут доступны пользователю Marketplace.

Пример массива plans:

plans:    - name: free    - name: basic

В этом примере перечислены тарифные планы free и basic. Их конфигурации должны быть описаны в директориях plans/free и plans/basic соответственно. В матрице тарифных планов эти планы будут отображаться с именами, заданными в параметре description файлов plans/free/plan.yaml и plans/basic/plan.yaml.

Секция preview

Секция preview содержит массив parameters. В этом массиве с помощью ключей name перечисляются имена тарифных опций (<ИМЯ_ОПЦИИ>), которые будут доступны пользователю Marketplace. Массив может быть пустым.

Пример секции preview:

preview:  parameters:  - name: groups  - name: products

В этом примере перечислены тарифные опции groups и products. Они должны быть описаны в директории parameters в файлах groups.yaml и products.yaml соответственно. В матрице тарифных планов опции будут отображаться с именами, заданными в параметре description указанных YAML-файлов.

Пример файла service.yaml

id: 72b70199-1823-40c8-aa7e-f43a23ddf380revision: v. 1.0name: VK Testersshort_description: Программа крауд-тестирования с многотысячным коммьюнити бета-тестировщиков и собственной платформой для работы с даннымиsingleton: falseauto_bind: trueicon: icon.pnghelp: http://vk.cc/vktesters_po_faqbindable: trueplan_updateable: falsedeactivatable: falsebindings_retrievable: trueinstances_retrievable: trueplans:- name: free- name: basicpreview:  parameters:  - name: api_requests_daily_limit  - name: groups  - name: products