VK Cloud logo

service.yaml file

В файле service.yaml укажите параметры и разделы, показанные в таблице 1.

Таблица 1 — Параметры и разделы в файле service.yaml

Имя

Описание

Формат

Обязательно

id

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

string (UUID4)

service.yaml file

revision

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

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

service.yaml file

name

Имя сервиса

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

service.yaml file

short_description

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

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

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

service.yaml file

singleton

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

boolean

service.yaml file

auto_bind

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

boolean

service.yaml file

icon

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

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

service.yaml file

help

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

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

service.yaml file

bindable

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

boolean

service.yaml file

plan_updateable

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

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

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

boolean

service.yaml file

deactivatable

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

boolean

service.yaml file

bindings_retrievable

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

boolean

service.yaml file

instances_retrievable

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

boolean

service.yaml file

plans

Определяет тарифные планы сервиса (подробнее — в разделе Тарифные планы сервиса)

Массив

service.yaml file

preview

Определяет тарифные опции для матрицы тарифных планов (подробнее — в разделе Тарифные опции для матрицы тарифных планов)

Массив

service.yaml file

На основе тарифных планов и опций, указанных в разделах plans и preview, формируется матрица тарифных планов (подробнее — в разделе Tariff plan matrix).

Пример файла service.yaml приведен в Пример файла service.yaml.

Тарифные планы сервиса

Чтобы указать все тарифные планы сервиса:

  1. Укажите массив plans.

  2. Внутри массива перечислите имена тарифных планов <PLAN_NAME> в ключах name. Имена тарифных планов должны соответствовать именам директорий этих планов.

Перечисление тарифных планов сервиса
plans:    - name: <PLAN_NAME1>    - name: <PLAN_NAME2>

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

Чтобы указать тарифные опции для матрицы тарифных планов (из всех возможных, описанных в директории parameters):

  1. Укажите раздел preview с массивом parameters внутри.

  2. Внутри массива перечислите имена тарифных опций <OPTION_NAME> с помощью ключей name. Имена тарифных опций должны соответствовать именам YAML-файлов parameters/<OPTION_NAME>.yaml.

    Массив может быть пустым.

    В матрице тарифных планов опции будут отображаться с именами, заданными в YAML-файлах.

Перечисление тарифных опций сервиса
preview:    parameters:    - name: <OPTION_NAME1>    - name: <OPTION_NAME2>

Пример файла 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
Was this article helpful?