VK Cloud logo

Service ParametersBeta

The parameters given in the table are specified in the service configuration JSON file.

Name

Description

Format

Required

id

The service UUID4 identifier (ID) generated using the UUID4 generator

string (UUID4)

Service Parameters

revision

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

string, up to 255 characters

Service Parameters

name

The service name

string, up to 255 characters

Service Parameters

short_description

A short description of the service that will be displayed in its card:

  • in the Marketplace catalog;
  • on the Service description tab on the service page

string, up to 120 characters

Service Parameters

full_description

The full description of the service that will be displayed on its Marketplace page

string

Service Parameters

singleton

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

boolean

Service Parameters

auto_bind

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

boolean

Service Parameters

icon

The URL of the service icon obtained from Marketplace

string, up to 512 characters

Service Parameters

help

The URL of the service documentation

string, up to 512 characters

Service Parameters

bindable

Specifies whether service bindings can be created for this service

boolean

Service Parameters

plan_updateable

Specifies whether the user can switch from one service plan to another without deleting the service.

The parameter value applies to all service plans.

The value can be overridden for a specific plan

boolean

Service Parameters

deactivatable

Specifies whether the service can be temporarily suspended

boolean

Service Parameters

bindings_retrievable

Specifies whether the service binding creation attempt should be retried for some time if the previous attempt failed

boolean

Service Parameters

instances_retrievable

Specifies whether the service instance creation attempt should be retried for some time if the previous attempt failed

boolean

Service Parameters

metadata

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

Test namespaces are specified in the test_ns key.

Public namespaces are specified in the prod_ns key.

The value can be overridden for a specific service plan.

If the parameter is not set, specify the parameter with the same name for each service plan separately in the plans section.

map, keys — string

Service Parameters

Was this article helpful?