VK Cloud logo

Service parameters

In the JSON file, specify the service parameters listed in table 1.

Table 1 — Service parameters

Name

Description

Format

Required

id

Service identifier UUID4 (ID) generated using the UUID4 generator

string (UUID4)

Service parameters

revision

Service revision. The combination of the revision and the service ID determines its uniqueness in the store. The remaining parameters describe the characteristics of a specific service revision

string, up to 255 characters

Service parameters

name

Service name

string, up to 255 characters

Service parameters

short_description

Brief description of the service that will be displayed on its card in the store

string, up to 120 characters

Service parameters

full_description

Full description of the service that will be displayed on its page (for more details, see the section Full service description)

string

Service parameters

singleton

Determines whether there is a limit of one service instance per cloud platform project

boolean

Service parameters

auto_bind

Determines whether a service binding should be created automatically after the service is deployed

boolean

Service parameters

icon

URL of the service icon (for more details, see the section Icon).

The icon file size must not exceed 1 MB. The image size must be at least 62×62 pixels

string, up to 512 characters

Service parameters

help

URL of the service documentation

string, up to 512 characters

Service parameters

bindable

Determines whether service bindings can be created for this service

boolean

Service parameters

plan_updateable

Determines whether a user can switch from one tariff plan to another without deleting the service.

The parameter value applies to all service plans.

The value can be overridden for a specific plan (for more details, see the section — Tariff plan parameters)

boolean

Service parameters

deactivatable

Determines whether the use of the service can be temporarily suspended

boolean

Service parameters

bindings_retrievable

Determines whether the attempt to create a service binding should be retried for a certain period of time if the previous attempt failed

boolean

Service parameters

instances_retrievable

Determines whether the attempt to create a service instance should be retried for a certain period of time if the previous attempt failed

boolean

Service parameters

metadata

Determines the test and public store namespaces in which the service tariff plans will be available.

Test namespaces are specified in the test_ns key.

Public namespaces are specified in the prod_ns key.

To obtain the namespace names, send an email to marketplace@cloud.vk.com.

The value can be overridden for a specific tariff plan.

If the parameter is not set, specify the parameter of the same name for each tariff plan separately in the plans section (for more details, see the section — Tariff plan parameters).

map, keys — string

Service parameters

Was this article helpful?