Tariff option YAML fileBeta
A separate YAML file is created for each tariff option, containing:
- a root section;
- a schema section;
- a billing section.
The general structure of tariff option parameters in a YAML file:
# Root levelactions:- ...- ...# schema section, tariff option parametersschema:description: ""hint: ""type: ""tag: ""default: # uses the format specified in schema.typeminimum: # only for schema.type = integermaximum: # only for schema.type = integerpattern: # only for schema.type = stringminLength: # only for schema.type = stringmaxLength: # only for schema.type = stringenum: [] # an array of integer or string, depending on schema.typeconst:datasource:type: ""value_is: ""filter:vcpus: # only for schema.datasource.type = flavorminimum:maximum:ram: # only for schema.datasource.type = flavorminimum:maximum:kind: "" # only for schema.datasource.type = networkshared: # only for schema.datasource.type = networkdisk_class: # only for schema.datasource.type = volume_typeenum: []# billing section, tariff option billingbilling:base:cost:unit:size:measurement: ""
Name | Description |
|---|---|
| This parameter defines the billing method of the option. Format: Possible values:
|
schema — a mandatory section where the main parameters of the tariff option are specified.
Name | Description |
|---|---|
| The name of the tariff option. It is displayed above the input field or the toggle switch. Format: Compatible with any types of tariff options. Full path: |
(optional) | A hint describing the tariff option. It is displayed when the cursor hovers over the hint icon next to the tariff option name. Format: Compatible with any types of tariff options. Full path: |
| The type of the tariff option. Format: Possible values:
Full path: |
| A tag — allows linking several options together. Format: It is used for the datasource tariff option that sets the disk size. Full path: |
| The default value of the tariff option. The format specified in If When using a predefined list of values When using the
If the Full path: |
(optional) | The minimum value of the tariff option. Format: It is used for the tariff option type If the Full path: |
(optional) | The maximum value of the tariff option. Format: It is used for the tariff option type If the Full path: |
(optional) | A regular expression (regex) pattern that the tariff option value must match. Format: It is used for the tariff option type Full path: |
(optional) | The minimum number of characters for the tariff option value. Format: It is used for the tariff option type Full path: |
(optional) | The maximum number of characters for the tariff option value. Format: It is used for the tariff option type Full path: |
| A list of values from which the user will be able to select one. The Incompatible with the When using Full path: |
| Sets a fixed value of the tariff option that cannot be changed. The format specified in Incompatible with the Full path: |
datasource — an additional section within the schema section. It is used to create a tariff option with the configuration of VK Cloud cloud resources: a virtual machine, a network, a subnet, and a disk.
Name | Description |
|---|---|
| The type of the VK Cloud entity. Format: Possible values:
The list of options available to the user is generated automatically depending on the specified value. The user will be able to select one value from the list. Full path: |
| The display type of the available options. Format: Possible values:
Full path: |
| Restricting the available values based on the parameters of VK Cloud entities. Format: Depending on the value specified in
Full path: |
| Restricting the number of vCPUs (only for Format: It contains one or two values:
Full path: |
| Restricting the minimum number of vCPUs. Format: The
Full path: |
| Restricting the maximum number of vCPUs. Format: The
Full path: |
| Restricting the amount of RAM (only for Format: It contains one or two values:
Full path: |
| Restricting the minimum amount of RAM. Format: The
Full path: |
| Restricting the maximum amount of RAM. Format: The
Full path: |
| Which network type the user can use (only for Format: Possible values:
Full path: |
| Enabling or disabling network sharing (only for Format:
Full path: |
| Which disk types are available to the user (only for Format: Full path: |
| A list of Format: Possible values:
Full path: |
billing — a section used to configure billing in prepaid and postpaid tariff options.
Tariff options of the following types can be paid:
- Numeric (
integer,number). Both prepaid and postpaid billing is supported. - Boolean (
boolean). Prepaid billing is supported.
Name | Description |
|---|---|
| The standard value of the tariff option included in the cost of the tariff plan. Format: The standard value is the minimum value that the user can set. If the parameter is not set, the standard value of the tariff option equals Full path: |
|
Format: If the parameter equals Full path: |
unit — an additional section within the billing section. It is used to configure the parameters of the change step of a prepaid or postpaid tariff option of the integer type.
Name | Description |
|---|---|
| The size of the step by which the value of a tariff option of the The value specified in this parameter is billed in accordance with the cost set in the For a postpaid option, the value Format: Full path: |
| The units of measurement of the step specified in the Format: Full path: |