Файл display.yaml^Beta

Конфигурационный файл display.yaml описывает, как тарифный план будет отображаться в матрице тарифных планов вашего приложения.

Основные секции файла:

Массив описывает страницы мастера конфигурации для тарифного плана. На каждой странице отображается одна или несколько групп тарифных опций. Максимальное количество страниц — 5.

Параметры массива pages:

По умолчанию в мастере конфигурации тарифного плана отображаются все группы тарифных опций (groups), указанные в массиве pages. Для отображения или скрытия групп в зависимости от заданных условий используется конструкция when.

Ниже показано, как будет отображаться мастер конфигурации тарифного плана из этого примера.

Массив описывает элементы инфраструктуры VK Cloud, которые будут тарифицироваться в рамках тарифного плана.

По умолчанию в мастере конфигурации тарифного плана указывается стоимость всех элементов инфраструктуры, описанных в массиве entities. Для отображения или скрытия стоимости инфраструктуры в зависимости от заданных условий используется конструкция when.

Общие параметры массива entities:

Пример описания страницы Настройки сервиса в мастере конфигурации тарифного плана:

 
pages:- name: Настройки сервиса # Имя страницы  groups:  - name: Сервер # Имя группы тарифных опций    parameters:    - name: network # Имя тарифной опции    - name: vm    - name: az  - name: Системный диск    parameters:    - name: volume_size    - name: volume_type

Параметры массива entities для ВМ:

Пример описания ВМ для мастера конфигурации тарифного плана:

 
entities:  - entity: vm    description: Виртуальная машина    count:      const: 1    flavor:      param: ds-flavor # Имя тарифной опции    disks:      - type:          param: root_type        size:          param: root_size      - type:          param: data_type        size:          param: data_size

Ниже показано, как будет отображаться информация о стоимости инфраструктуры из этого примера в мастере конфигурации тарифного плана.

Параметры массива entities для балансировщика нагрузки:

Пример описания балансировщика нагрузки для мастера конфигурации тарифного плана:

 
entities:  - entity: load_balancing    count:      param: number_balancing # Имя тарифной опции

Параметры массива entities для внешнего IP-адреса:

Пример описания внешнего IP-адреса для мастера конфигурации тарифного плана:

 
entities:  - entity: floating_ip    count:      const: 1

Конструкция when управляет условным ветвлением при отображении мастера тарифного плана. Она содержит:

• Тип условия:

  • when.in — проверка равенства значений, заданных параметрами key и values. Условие выполнено, если значение key равно хотя бы одному из значений values.
  • when.not_in — проверка неравенства значений, заданных параметрами key и values. Условие выполнено, если значение key не равно ни одному из значений values.

• Критерии. Задаются параметрами key и values одним из способов:

  • Через параметр param — чтобы использовать значение конкретной тарифной опции.
  • Через параметр const — чтобы использовать фиксированное значение.

  В key можно задать одно значение, в values — одно или несколько.

Структура when в формате YAML:

 
when:  in: # или not_in    key:      param: <ИМЯ_ОПЦИИ> # или const: <ЗНАЧЕНИЕ>    values:      - const: <ЗНАЧЕНИЕ>      - param: <ИМЯ_ОПЦИИ>      ...

Здесь:

• <ИМЯ_ОПЦИИ> — имя тарифной опции, совпадающее с именем YAML-файла этой опции.
• <ЗНАЧЕНИЕ> — фиксированное значение.

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

Одна и та же тарифная опция может использоваться в конструкциях when в разных группах. В зависимости от значения тарифной опции в мастере конфигурации будут отображаться те или иные группы.

При использовании конструкции when страница с группами тарифных опций будет скрыта, если одновременно выполняются следующие условия:

• В рамках одной страницы все группы имеют конструкцию when.
• В мастере конфигурации тарифного плана заданы такие значения тарифных опций, что условия во всех группах на этой странице не выполняются.

Пример использования конструкции when в массиве pages:

 
pages:- name: Настройки бекапа # Имя страницы  groups:  - name: High-frequency бекап # Имя группы тарифных опций    parameters:    - name: frequency_per_day # Имя тарифной опции    when:      in:        key:          param: backup_method # Имя тарифной опции        values:          - const: high-frequency

В этом примере группа High-frequency бекап с тарифной опцией frequency_per_day отобразится, если в мастере конфигурации пользователь выбрал значение high-frequency для тарифной опции backup_method. Далее пользователь сможет выбрать частоту создания бекапов.

Тарифная опция backup_method:

• может использоваться в конструкции when в других группах;
• должна быть указана в массиве parameters в другой группе.

Тарифная опция frequency_per_day не может использоваться в других группах:

• в конструкции when — потому что поддерживается только один уровень иерархии условий;
• в parameters — потому что одна тарифная опция может быть указана только в одной группе.

В массиве entities конструкция when используется, чтобы задать условие, которое определяет, нужно ли в мастере конфигурации тарифного плана отображать стоимость элемента инфраструктуры, описанного в массиве entities.

Пример использования конструкции when в массиве entities:

 
entities:  - entity: vm    description: alkair_software    when:      in:        key:          param: need_install_alkair_software # Имя тарифной опции        values:          - const: true    flavor:      const: 6a7a0690-943a-4921-936e-2849970ccfba # Тип ВМ (CPU, RAM). В этом примере ВМ с 2 CPU и 3 ГБ RAM    count:      const: 1    disks:      - type:          const: high-iops # Тип диска        size:          const: 500 # Размер диска

В этом примере приведена настройка отображения стоимости ВМ для ПО Алькаир. Если пользователь выберет для тарифной опции need_install_alkair_software значение true, в мастере конфигурации тарифного плана будет отображена стоимость ВМ, описанной в элементе entities.entity.