The service.yaml fileBeta
The service.yaml configuration file contains the following information:
- General application parameters.
- The plans array with tariff plan names. These names are used only to describe the service package and are not displayed in the Marketplace interface.
- The preview section with tariff option names. These names are used only to describe the service package and are not displayed in the Marketplace interface.
Name | Description | Format | Required |
|---|---|---|---|
| UUID4 service identifier (ID), generated using a UUID4 generator | string (UUID4) | |
| Service revision. The combination of the revision and the service ID determines its uniqueness in Marketplace. The remaining parameters describe the characteristics of a specific service revision | string, up to 255 characters | |
| Service name | string, up to 255 characters | |
| A brief description of the service that will be displayed on its card:
The full description of the service is contained in the full_description.md file | string, up to 120 characters | |
| Determines whether there is a limit of one service instance per cloud platform project | boolean | |
| Determines whether a service binding should be created automatically after the service is deployed | boolean | |
| The name of the service icon file located in the | string, up to 512 characters | |
| Service documentation URL | string, up to 512 characters | |
| Determines whether service bindings can be created for this service. The value must be | boolean | |
| Determines whether the user can switch from one tariff plan to another without deleting the service. The parameter value applies to all plans of the service. For image-based applications, the value must be | boolean | |
| Determines whether the use of the service can be temporarily suspended | boolean | |
| Determines whether the creation of a service binding should be retried for a certain period of time if the previous attempt failed | boolean | |
| Determines whether the creation of a service instance should be retried for a certain period of time if the previous attempt failed | boolean | |
| Contains the names of the tariff plans of the application | Array | |
| Contains the names of the tariff options for the tariff plan matrix | Array |
Based on the tariff plans and options specified in the plans and preview arrays, a tariff plan matrix is generated.
In the plans array, the name keys list the names of the tariff plans (<PLAN_NAME>) that will be available to the Marketplace user.
Example of the plans array:
plans:- name: free- name: basic
In this example, the free and basic tariff plans are listed. Their configurations must be described in the plans/free and plans/basic directories, respectively. In the tariff plan matrix, these plans will be displayed with the names specified in the description parameter of the plans/free/plan.yaml and plans/basic/plan.yaml files.
The preview section contains the parameters array. In this array, the name keys list the names of the tariff options (<OPTION_NAME>) that will be available to the Marketplace user. The array can be empty.
Example of the preview section:
preview:parameters:- name: groups- name: products
In this example, the groups and products tariff options are listed. They must be described in the parameters directory in the groups.yaml and products.yaml files, respectively. In the tariff plan matrix, the options will be displayed with the names specified in the description parameter of the specified YAML files.
id: 72b70199-1823-40c8-aa7e-f43a23ddf380revision: v. 1.0name: VK Testersshort_description: A crowdtesting program with a community of thousands of beta testers and its own platform for working with datasingleton: 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