Файл plan.yamlBeta
Конфигурационный файл plans/<ИМЯ_ПЛАНА>/plan.yaml содержит следующую информацию:
- Общие параметры тарифного плана <ИМЯ_ПЛАНА>.
- Секция billing с параметрами стоимости тарифного плана
<ИМЯ_ПЛАНА>без учета платных тарифных опций. - (Опционально) Секция parameters_patch, которая выборочно переопределяет параметры тарифных опций для плана
<ИМЯ_ПЛАНА>.
Имя | Описание | Формат | Обязательный |
|---|---|---|---|
| Идентификатор тарифного плана UUID4 (ID), сформированный с помощью генератора UUID4 |
|
|
| Ревизия тарифного плана. Сочетание ревизии и ID тарифного плана определяет его уникальность в сервисе. Остальные параметры описывают характеристики конкретной ревизии тарифного плана. |
|
|
| Техническое имя тарифного плана, которое не отображается в интерфейсе Marketplace. Может содержать только латинские буквы и символ |
|
|
| Имя тарифного плана, которое отображается в интерфейсе Marketplace |
|
|
| Определяет, является ли тарифный план бесплатным |
|
|
| Секция billing тарифного плана, определяет стоимость тарифного плана без учета платных тарифных опций |
|
|
| Секция parameters_patch, выборочно переопределяет параметры тарифных опций для конкретного плана |
|
|
| Список постоплатных тарифных опций. | Массив | Да — для плана с постоплатными опциями |
Параметры секции:
Имя | Описание | Формат | Обязательный | Значение по умолчанию |
|---|---|---|---|---|
| Стоимость тарифного плана за отчетный период без учета платных тарифных опций. Задается в валюте страны, где развернут Marketplace. Для бесплатного тарифного плана — |
|
| — |
| Определяет, возвращать или нет на бонусный счет проекта денежные средства за оставшиеся дни расчетного периода, если пользователь изменил тарифный план или удалил инстанс сервиса. Параметр влияет на дату списания оплаты за сервис, когда пользователь изменяет тарифный план (редактирует тарифные опции или переходит на новый):
|
|
|
|
| Длительность отчетного периода для тарификации. Формат записи: |
|
|
|
Пример заполнения секции billing:
billing:cost: 2000refundable: truebilling_cycle_flat: 1 mons 0 days
Ниже показано, как в мастере конфигурации тарифного плана отображается стоимость тарифного плана из этого примера.
В секции выборочно переопределяются параметры тарифных опций для тарифного плана: отдельные параметры или целые секции описания тарифной опции.
Для каждого переопределяемого параметра указывается его имя с путем до корневой секции. Имя параметра и имена его родительских секций разделяются точками.
Пример переопределения параметров тарифных опций:
parameters_patch:users:schema.const: 5000volume_data_size:schema.default: 550schema.minimum: 550
В этом примере новые значения получают:
- параметр
costв секцииschemaтарифной опцииusers; - параметры
defaultиminimumв секцииschemaтарифной опцииvolume_data_size.
Возможные параметры в зависимости от типа тарифной опции приведены в разделе YAML-файл тарифной опции.
Значения параметров, указанные в секции parameters_patch, имеют приоритет над значениями из YAML-файлов тарифных опций.
Если в тарифных планах используются опции, которые сильно отличаются друг от друга:
- Рекомендуется описать каждую опцию отдельным YAML-файлом в директории
parameters. - Не рекомендуется описывать одну тарифную опцию для всех тарифных планов и переопределять большинство ее параметров в разных тарифных планах.
Пример тарифного плана с переопределением параметров тарифных опций:
id: b2b42648-XXXX-b4cddbf010b2revision: v. 1.0name: basicdescription: Базовыйfree: falsebilling:cost: 2000refundable: truebilling_cycle_flat: 1 monsparameters_patch:users:schema.const: 5000volume_data_size:schema.default: 550schema.minimum: 550
Пример бесплатного тарифного плана с постоплатной тарифной опцией:
id: 3aa541d8-XXXX-6dbf542b3f90revision: v. 1.1name: postpaiddescription: Постоплатныйfree: truebilling:cost: 0resource_usages:- storage