Adding an image-based applicationBeta
To add your image-based application to the Marketplace service, complete the preparatory steps. Then:
- Create the basis for the file structure of the service package.
- Describe the service configuration (tariff plans, options).
- Create Terraform manifests describing the infrastructure configuration for your service.
- (Optional) Verify that existing resources are correctly specified in the Terraform manifests.
- (Optional) Test the Terraform manifests locally.
- (Optional) Test the Terraform manifests with the deployment system.
- (Optional) Review the logs and results of the Marketplace agent.
- Upload the service package to Marketplace.
- Test the uploaded service before publication.
- Publish the service image.
- Publish the service in Marketplace.
- Make sure your application meets the Marketplace service requirements.
- Create and upload the image-based application image to VK Cloud.
- Decide on the billing type for your application, and develop tariff plans and options.
- Connect to the vendor account.
All information required to upload an image-based application to Marketplace is prepared as a service package with a specific file structure.
To prepare the file structure:
-
Create a service directory named
<SERVICE_NAME>. -
In the service directory, create a
version.yamlfile. In this file, specify:version: 0.0.1 -
In the
<SERVICE_NAME>directory, create theimages,parametersandplansdirectories. -
Place a service icon file in
.pngor.svgformat into theimagesdirectory. The file size must not exceed 1 MB. The image resolution must be at least 62 × 62 pixels.The service icon will be displayed on the service card:
- in the Marketplace catalog;
- on the Service description tab of the service page.
The service configuration is described using .yaml and .md format files.
-
In the
<SERVICE_NAME>directory, create aservice.yamlfile and fill it in.The
service.yamlfile contains:- general service parameters;
- names of tariff plans (hereinafter
<PLAN_NAME>) as aplansarray; - names of tariff options (hereinafter
<OPTION_NAME>) as aparametersarray in thepreviewsection.
<PLAN_NAME>and<OPTION_NAME>are used only inside the service package and are not displayed in the Marketplace interface.File structure:
undefined
General service parameters
id: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
revision: v. X.X
name: <SERVICE_NAME>
short_description: <SHORT_DESCRIPTION>
singleton:
plans array
plans:
- name: <PLAN_NAME_1>
- name: <PLAN_NAME_2>
preview section
preview: parameters:
- name: <OPTION_NAME_1>
- name: <OPTION_NAME_2>
- name: <OPTION_NAME_3>
<details><summary>General service parameters</summary><table class="tableblock frame-all grid-all stretch"><colgroup><col style="width: 20%;"><col style="width: 40%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">{decodeBase64(TmFtZQ==)}</th><th class="tableblock halign-left valign-top">{decodeBase64(RGVzY3JpcHRpb24=)}</th><th class="tableblock halign-left valign-top">{decodeBase64(Rm9ybWF0)}</th><th class="tableblock halign-left valign-top">{decodeBase64(UmVxdWlyZWQ=)}{decodeBase64()}</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGlkYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(VVVJRDQgc2VydmljZSBpZGVudGlmaWVyIChJRCksIGdlbmVyYXRlZCB1c2luZyBhIFVVSUQ0IGdlbmVyYXRvcg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(c3RyaW5nIChVVUlENCk=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YHJldmlzaW9uYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(U2VydmljZSByZXZpc2lvbi4gVGhlIGNvbWJpbmF0aW9uIG9mIHRoZSByZXZpc2lvbiBhbmQgdGhlIHNlcnZpY2UgSUQgZGV0ZXJtaW5lcyBpdHMgdW5pcXVlbmVzcyBpbiBNYXJrZXRwbGFjZS4gVGhlIHJlbWFpbmluZyBwYXJhbWV0ZXJzIGRlc2NyaWJlIHRoZSBjaGFyYWN0ZXJpc3RpY3Mgb2YgYSBzcGVjaWZpYyBzZXJ2aWNlIHJldmlzaW9u)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(c3RyaW5nLCB1cCB0byAyNTUgY2hhcmFjdGVycw==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YG5hbWVg)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(U2VydmljZSBuYW1l)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(c3RyaW5nLCB1cCB0byAyNTUgY2hhcmFjdGVycw==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YHNob3J0X2Rlc2NyaXB0aW9uYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(QSBicmllZiBkZXNjcmlwdGlvbiBvZiB0aGUgc2VydmljZSB0aGF0IHdpbGwgYmUgZGlzcGxheWVkIG9uIGl0cyBjYXJkOgogICAKICAgKiBpbiB0aGUgTWFya2V0cGxhY2UgY2F0YWxvZzsKICAgKiBvbiB0aGUgKipTZXJ2aWNlIGRlc2NyaXB0aW9uKiogdGFiIG9uIHRoZSBzZXJ2aWNlIHBhZ2UuCiAgIAogICBUaGUgZnVsbCBkZXNjcmlwdGlvbiBvZiB0aGUgc2VydmljZSBpcyBjb250YWluZWQgaW4gdGhlIFtmdWxsX2Rlc2NyaXB0aW9uLm1kIGZpbGVdKC9ydS90b29scy1mb3ItdXNpbmctc2VydmljZXMvdmVuZG9yLWFjY291bnQvcmVmZXJlbmNlL2liLWFwcHMtZnVsbC1kZXNjcmlwdGlvbik=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(c3RyaW5nLCB1cCB0byAxMjAgY2hhcmFjdGVycw==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YHNpbmdsZXRvbmA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(RGV0ZXJtaW5lcyB3aGV0aGVyIHRoZXJlIGlzIGEgbGltaXQgb2Ygb25lIHNlcnZpY2UgaW5zdGFuY2UgcGVyIGNsb3VkIHBsYXRmb3JtIHByb2plY3Q=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(Ym9vbGVhbg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvZW4vYXNzZXRzL25vLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGF1dG9fYmluZGA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(RGV0ZXJtaW5lcyB3aGV0aGVyIGEgc2VydmljZSBiaW5kaW5nIHNob3VsZCBiZSBjcmVhdGVkIGF1dG9tYXRpY2FsbHkgYWZ0ZXIgdGhlIHNlcnZpY2UgaXMgZGVwbG95ZWQ=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(Ym9vbGVhbg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvZW4vYXNzZXRzL25vLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGljb25g)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(VGhlIG5hbWUgb2YgdGhlIHNlcnZpY2UgaWNvbiBmaWxlIGxvY2F0ZWQgaW4gdGhlIGBpbWFnZXNgIGRpcmVjdG9yeSBvZiB0aGUgW3NlcnZpY2UgcGFja2FnZV0oLi4vLi4vLi4vaW5zdHJ1Y3Rpb25zL21hbmFnZS1pYi1hcHBzL2liLWFkZCNzZXJ2aWNlX3BhY2tfc3RydWN0dXJlKQ==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(c3RyaW5nLCB1cCB0byA1MTIgY2hhcmFjdGVycw==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGhlbHBg)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(U2VydmljZSBkb2N1bWVudGF0aW9uIFVSTA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(c3RyaW5nLCB1cCB0byA1MTIgY2hhcmFjdGVycw==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGJpbmRhYmxlYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(RGV0ZXJtaW5lcyB3aGV0aGVyIHNlcnZpY2UgYmluZGluZ3MgY2FuIGJlIGNyZWF0ZWQgZm9yIHRoaXMgc2VydmljZS4gVGhlIHZhbHVlIG11c3QgYmUgYHRydWVg)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(Ym9vbGVhbg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YHBsYW5fdXBkYXRlYWJsZWA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(RGV0ZXJtaW5lcyB3aGV0aGVyIHRoZSB1c2VyIGNhbiBzd2l0Y2ggZnJvbSBvbmUgdGFyaWZmIHBsYW4gdG8gYW5vdGhlciB3aXRob3V0IGRlbGV0aW5nIHRoZSBzZXJ2aWNlLgogICAKICAgVGhlIHBhcmFtZXRlciB2YWx1ZSBhcHBsaWVzIHRvIGFsbCBwbGFucyBvZiB0aGUgc2VydmljZS4KICAgCiAgIEZvciBpbWFnZS1iYXNlZCBhcHBsaWNhdGlvbnMsIHRoZSB2YWx1ZSBtdXN0IGJlIGBmYWxzZWA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(Ym9vbGVhbg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGRlYWN0aXZhdGFibGVg)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(RGV0ZXJtaW5lcyB3aGV0aGVyIHRoZSB1c2Ugb2YgdGhlIHNlcnZpY2UgY2FuIGJlIHRlbXBvcmFyaWx5IHN1c3BlbmRlZA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(Ym9vbGVhbg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGJpbmRpbmdzX3JldHJpZXZhYmxlYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(RGV0ZXJtaW5lcyB3aGV0aGVyIHRoZSBjcmVhdGlvbiBvZiBhIHNlcnZpY2UgYmluZGluZyBzaG91bGQgYmUgcmV0cmllZCBmb3IgYSBjZXJ0YWluIHBlcmlvZCBvZiB0aW1lIGlmIHRoZSBwcmV2aW91cyBhdHRlbXB0IGZhaWxlZA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(Ym9vbGVhbg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGluc3RhbmNlc19yZXRyaWV2YWJsZWA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(RGV0ZXJtaW5lcyB3aGV0aGVyIHRoZSBjcmVhdGlvbiBvZiBhIHNlcnZpY2UgaW5zdGFuY2Ugc2hvdWxkIGJlIHJldHJpZWQgZm9yIGEgY2VydGFpbiBwZXJpb2Qgb2YgdGltZSBpZiB0aGUgcHJldmlvdXMgYXR0ZW1wdCBmYWlsZWQ=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(Ym9vbGVhbg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YHBsYW5zYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(Q29udGFpbnMgdGhlIFtuYW1lcyBvZiB0aGUgdGFyaWZmIHBsYW5zXSgvcnUvdG9vbHMtZm9yLXVzaW5nLXNlcnZpY2VzL3ZlbmRvci1hY2NvdW50L3JlZmVyZW5jZS9pYi1hcHBzLXJlZmVyZW5jZS9pYi1hcHBzLXBhcmFtI2liLWFwcHMtcGFyYW0tc2VydmljZS1wbGFucykgb2YgdGhlIGFwcGxpY2F0aW9u)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(QXJyYXk=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YHByZXZpZXdg)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(Q29udGFpbnMgdGhlIFtuYW1lcyBvZiB0aGUgdGFyaWZmIG9wdGlvbnNdKC9ydS90b29scy1mb3ItdXNpbmctc2VydmljZXMvdmVuZG9yLWFjY291bnQvcmVmZXJlbmNlL2liLWFwcHMtcmVmZXJlbmNlL2liLWFwcHMtcGFyYW0jc2VydmljZV9vcHRpb25zX2Zvcl9tYXRyaXgpIGZvciB0aGUgdGFyaWZmIHBsYW4gbWF0cml4)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(QXJyYXk=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}</p></td></tr></tbody></table><warn>The combination of the `id` and `revision` parameters must be unique within Marketplace. If an application with the same identifier and revision already exists in Marketplace, the service package will not be updated.</warn>Based on the tariff plans and options specified in the `plans` and `preview` arrays, a [tariff plan matrix](/ru/tools-for-using-services/vendor-account/manage-apps/concepts/about#xaas_tariff_matrix) is generated.</details><details><summary>plans array</summary>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:```yamlplans:- 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.
-
In the
<SERVICE_NAME>directory, create afull_description.mdfile and fill it in with a description of the service in Markdown format. The file content will be displayed on the service page in Marketplace.File structure:
<!--A brief general description of the service in 2-3 sentences--><!--Vendor name-->
Billing rules
Useful links
Technical support
License agreement
```
-
In the
parametersdirectory, for each tariff option, create a<OPTION_NAME>.yamlfile and fill it in according to the examples.For paid tariff options during the testing period, specify the minimum service cost to avoid excessive spending.
-
In the
plansdirectory, for each tariff plan, create a<PLAN_NAME>directory. In each<PLAN_NAME>directory, create and fill in aplan.yamlfile:File structure:
undefined
General tariff plan parameters
id: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
revision: v. X.X
name: <PLAN_NAME>
description: <SHORT_DESCRIPTION>
free:
billing section
billing:
cost:
parameters_patch section
parameters_patch: users: schema.const: 5000 volume_data_size: schema.default: 550 schema.minimum: 550
<details><summary>General tariff plan parameters</summary><table class="tableblock frame-all grid-all stretch"><colgroup><col style="width: 18.1818%;"><col style="width: 45.4545%;"><col style="width: 18.1818%;"><col style="width: 18.1819%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">{decodeBase64(IE5hbWU=)}</th><th class="tableblock halign-left valign-top">{decodeBase64(IERlc2NyaXB0aW9u)}</th><th class="tableblock halign-left valign-top">{decodeBase64(IEZvcm1hdA==)}</th><th class="tableblock halign-left valign-top">{decodeBase64(IFJlcXVpcmVk)}{decodeBase64()}</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBpZGA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IFVVSUQ0IHRhcmlmZiBwbGFuIGlkZW50aWZpZXIgKElEKSwgZ2VuZXJhdGVkIHVzaW5nIGEgVVVJRDQgZ2VuZXJhdG9y)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBzdHJpbmcgKFVVSUQ0KWA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGByZXZpc2lvbmA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IFRhcmlmZiBwbGFuIHJldmlzaW9uLiBUaGUgY29tYmluYXRpb24gb2YgdGhlIHJldmlzaW9uIGFuZCB0aGUgdGFyaWZmIHBsYW4gSUQgZGV0ZXJtaW5lcyBpdHMgdW5pcXVlbmVzcyB3aXRoaW4gdGhlIHNlcnZpY2UuIFRoZSByZW1haW5pbmcgcGFyYW1ldGVycyBkZXNjcmliZSB0aGUgY2hhcmFjdGVyaXN0aWNzIG9mIGEgc3BlY2lmaWMgdGFyaWZmIHBsYW4gcmV2aXNpb24uCiAgIAogICA8d2Fybj4KCiAgIAogICAKICAgSWYgYSB0YXJpZmYgcGxhbiB3aXRoIHRoZSBzYW1lIGlkZW50aWZpZXIgYW5kIHJldmlzaW9uIGFscmVhZHkgZXhpc3RzIGZvciB0aGlzIHNlcnZpY2UsIHRoZSBwbGFuIHdpbGwgbm90IGJlIHVwZGF0ZWQKICAgCiAgIAoKICAgPC93YXJuPg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBzdHJpbmdgLCB1cCB0byAyNTUgY2hhcmFjdGVycw==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBuYW1lYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IFRlY2huaWNhbCBuYW1lIG9mIHRoZSB0YXJpZmYgcGxhbiwgd2hpY2ggaXMgbm90IGRpc3BsYXllZCBpbiB0aGUgTWFya2V0cGxhY2UgaW50ZXJmYWNlLiBDYW4gY29udGFpbiBvbmx5IExhdGluIGxldHRlcnMgYW5kIHRoZSBgX2AgY2hhcmFjdGVy)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBzdHJpbmdgLCB1cCB0byAyNTUgY2hhcmFjdGVycw==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBkZXNjcmlwdGlvbmA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IE5hbWUgb2YgdGhlIHRhcmlmZiBwbGFuLCB3aGljaCBpcyBkaXNwbGF5ZWQgaW4gdGhlIE1hcmtldHBsYWNlIGludGVyZmFjZQ==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBzdHJpbmdgLCB1cCB0byAyNTUgY2hhcmFjdGVycw==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBmcmVlYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IERldGVybWluZXMgd2hldGhlciB0aGUgdGFyaWZmIHBsYW4gaXMgZnJlZQ==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBib29sZWFuYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBiaWxsaW5nYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IFtUaGUgYmlsbGluZyBzZWN0aW9uIG9mIHRoZSB0YXJpZmYgcGxhbl0oI3BsYW5fYmlsbGluZyksIGRldGVybWluZXMgdGhlIGNvc3Qgb2YgdGhlIHRhcmlmZiBwbGFuIGV4Y2x1ZGluZyBwYWlkIHRhcmlmZiBvcHRpb25z)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL25vLnN2ZyAiaW5saW5lIik=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGBwYXJhbWV0ZXJzX3BhdGNoYA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IFtUaGUgcGFyYW1ldGVyc19wYXRjaCBzZWN0aW9uXSgjcGxhbl9vcHRpb25zKSwgc2VsZWN0aXZlbHkgb3ZlcnJpZGVzIHRhcmlmZiBvcHRpb24gcGFyYW1ldGVycyBmb3IgYSBzcGVjaWZpYyBwbGFu)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL25vLnN2ZyAiaW5saW5lIik=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL25vLnN2ZyAiaW5saW5lIik=)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IGByZXNvdXJjZV91c2FnZXNg)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IExpc3Qgb2YgcG9zdHBhaWQgdGFyaWZmIG9wdGlvbnMuCiAgIAogICA8d2Fybj4KCiAgIAogICAKICAgQ2Fubm90IGJlIHNwZWNpZmllZCBmb3IgYSB0YXJpZmYgcGxhbiB3aXRoIHByZXBhaWQgdGFyaWZmIG9wdGlvbnMKICAgCiAgIAoKICAgPC93YXJuPg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IEFycmF5)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IFllcyDigJQgZm9yIGEgcGxhbiB3aXRoIHBvc3RwYWlkIG9wdGlvbnM=)}</p></td></tr></tbody></table>(Optional) If the tariff plan is free, list the postpaid tariff options in the [resource_usage section](../../../reference/ib-apps-reference/ib-plan#plan_parameters).Within a single tariff plan, only options of one [billing type](/en/tools-for-using-services/vendor-account/manage-apps/concepts/about#xaas_billing) are allowed: a tariff plan with prepaid options or a tariff plan with postpaid options.</details><details><summary>billing section of the tariff plan</summary>Specify the tariff plan cost per billing period excluding paid tariff options.A non-zero tariff plan cost can be specified only for the prepaid [billing type](/en/tools-for-using-services/vendor-account/manage-apps/concepts/about#xaas_billing). To make efficient use of the [allocated bonus funds](#preparatory_steps), specify a test cost for the tariff plan during the service testing period in Marketplace.<warn>The cost of using VK Cloud platform computing resources is not included in the cost of the service tariff plan.</warn>Section parameters:<table class="tableblock frame-all grid-all stretch"><colgroup><col style="width: 23.0769%;"><col style="width: 38.4615%;"><col style="width: 15.3846%;"><col style="width: 7.6923%;"><col style="width: 15.3847%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">{decodeBase64(TmFtZQ==)}</th><th class="tableblock halign-left valign-top">{decodeBase64(RGVzY3JpcHRpb24=)}</th><th class="tableblock halign-left valign-top">{decodeBase64(Rm9ybWF0)}</th><th class="tableblock halign-left valign-top">{decodeBase64(UmVxdWlyZWQ=)}</th><th class="tableblock halign-left valign-top">{decodeBase64(RGVmYXVsdCB2YWx1ZQ==)}{decodeBase64()}</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGNvc3Rg)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(Q29zdCBvZiB0aGUgdGFyaWZmIHBsYW4gZm9yIHRoZSBiaWxsaW5nIHBlcmlvZCwgZXhjbHVkaW5nIHBhaWQgdGFyaWZmIG9wdGlvbnMuIFNwZWNpZmllZCBpbiB0aGUgY3VycmVuY3kgb2YgdGhlIGNvdW50cnkgd2hlcmUgTWFya2V0cGxhY2UgaXMgZGVwbG95ZWQuCiAgIAogICBGb3IgYSBmcmVlIHRhcmlmZiBwbGFuIOKAlCBgMGA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGZsb2F0YA==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL2NoZWNrLnN2ZyAiaW5saW5lIik=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(IOKAlA==)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YHJlZnVuZGFibGVg)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(RGV0ZXJtaW5lcyB3aGV0aGVyIGZ1bmRzIGFyZSByZWZ1bmRlZCB0byB0aGUgcHJvamVjdCdzIGJvbnVzIGFjY291bnQgZm9yIHRoZSByZW1haW5pbmcgZGF5cyBvZiB0aGUgYmlsbGluZyBwZXJpb2QgaWYgdGhlIHVzZXIgY2hhbmdlZCB0aGUgdGFyaWZmIHBsYW4gb3IgZGVsZXRlZCB0aGUgc2VydmljZSBpbnN0YW5jZS4KICAgCiAgIFRoZSBwYXJhbWV0ZXIgYWZmZWN0cyB0aGUgZGF0ZSB0aGUgcGF5bWVudCBmb3IgdGhlIHNlcnZpY2UgaXMgY2hhcmdlZCB3aGVuIHRoZSB1c2VyIGNoYW5nZXMgdGhlIHRhcmlmZiBwbGFuIChlZGl0cyB0aGUgdGFyaWZmIG9wdGlvbnMgb3Igc3dpdGNoZXMgdG8gYSBuZXcgb25lKToKICAgCiAgIC0gSWYgYHRydWVgLCB0aGUgZGF0ZSBkb2VzIG5vdCBjaGFuZ2UuCiAgIC0gSWYgYGZhbHNlYCwgdGhlIGRhdGUgaXMgdXBkYXRlZCB0byB0aGUgZGF0ZSB0aGUgdGFyaWZmIHBsYW4gd2FzIGNoYW5nZWQ=)}{decodeBase64()}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGJvb2xlYW5g)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL25vLnN2ZyAiaW5saW5lIik=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YHRydWVg)}{decodeBase64()}</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YGJpbGxpbmdfY3ljbGVfZmxhdGA=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(RHVyYXRpb24gb2YgdGhlIGJpbGxpbmcgcGVyaW9kIGZvciB0aGUgYmlsbGluZy4KICAgCiAgIFJlY29yZCBmb3JtYXQ6IGA8TlVNQkVSX09GX01PTlRIUz4gbW9ucyA8TlVNQkVSX09GX0RBWVM+IGRheXNgLiBGb3IgZXhhbXBsZSwgYDEgbW9ucyAxNSBkYXlzYCwgYDMwIGRheXNgLgogICAKICAgPGluZm8+CgogICAKICAgCiAgIFRoZSBudW1iZXIgb2YgZGF5cyBpbiBhIGBtb25zYCBtb250aCBpcyBjYWxjdWxhdGVkIGJhc2VkIG9uIHRoZSBjYWxlbmRhciB2YWx1ZSwgc28gdGhlIHBlcmlvZHMgYDEgbW9ucyAwIGRheXNgIGFuZCBgMCBtb25zIDMxIGRheXNgIGFyZSBub3QgZXF1YWwgdG8gZWFjaCBvdGhlci4KICAgCiAgIAoKICAgPC9pbmZvPg==)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YHN0cmluZ2A=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(ICFbQWRkaW5nIGFuIGltYWdlLWJhc2VkIGFwcGxpY2F0aW9uXSgvcnUvYXNzZXRzL25vLnN2ZyAiaW5saW5lIik=)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">{decodeBase64(YDEgbW9ucyAwIGRheXNg)}</p></td></tr></tbody></table>Example of filling in the `billing` section:```yamlbilling:cost: 2000refundable: truebilling_cycle_flat: 1 mons 0 days
-
In the
<PLAN_NAME>directory, create and fill in adisplay.yamlfile describing the tariff plan configuration wizard. The tariff plan configuration wizard will be displayed in Marketplace when connecting the service or updating the tariff plan.
-
In the
plans/<PLAN_NAME>directory, create adeploymentdirectory. -
In the
deploymentdirectory, create and fill in:-
A
deploy.tffile with a Terraform manifest describing the infrastructure and the process of deploying the<PLAN_NAME>tariff plan in Marketplace. -
(Optional) A settings.yaml file with the manifest execution settings. If the service package does not contain a
settings.yamlfile, default parameter values will be applied to the Terraform manifests.
-
To reduce the time for testing the Terraform manifests and to avoid attempts to create resources with an incorrect configuration, before testing the manifests it is recommended to verify that the parameters of already existing VK Cloud resources are correctly specified in them, for example: the VM type, the service image, etc.
-
Install Terraform and configure the environment, if this has not been done earlier.
-
In the working directory, run the command:
terraform init -
In the working directory, create a
main.tffile. -
Place in the
main.tffile the requests to the required VK CS provider data sources.Example of a request to the vkcs_compute_flavor data source:
data "vkcs_compute_flavor" "compute" {flavor_id = "4e115a9b-XXXX-95cf130d63c7"}In this example, it is verified that a VM type with ID
4e115a9b-XXXX-95cf130d63c7exists in VK Cloud. -
In the working directory, run the command:
terraform applyWhen prompted for confirmation, enter
yes. -
Wait for the operation to complete. Make sure that no errors occurred when requesting the data sources.
Test the Terraform manifests plans/<PLAN_NAME>/deployment/deploy.tf locally for each tariff plan of your application, using the instruction.
Before uploading the service package to Marketplace, test each Terraform manifest plans/<PLAN_NAME>/deployment/deploy.tf for each plan of your application using the deployment system API:
- Activate API access, if this has not been done earlier.
- Obtain an API access token.
- Upload one of the
plans/<PLAN_NAME>/deployment/deploy.tfmanifests to the deployment system. - Check the current configuration of the uploaded manifest.
- Create a service instance.
- During creation and after creating the instance, check its status. If the status is
failed, find the error description in the instance logs. - Delete the service instance.
- Check the status of the deleted service instance. If the status is
failed, find the error description in the instance logs.
Similarly, test the manifests for the remaining tariff plans of your application.
You can identify errors when deploying a service instance by reviewing the logs and results of the Marketplace agent. They are available if scripts executed using the ivkcs_agent_exec resource are used when deploying your application.
To view the agent logs and results:
-
Connect to the VM where the agent is installed using a remote access protocol or via the VNC console in the VK Cloud management console.
The name of the VM where the agent was installed is specified in the
ivkcs_agent_initorivkcs_user_dataresource in theplans/<PLAN_NAME>/deployment/deploy.tfmanifest. -
To view the logs, run the command
journalctl -u sower. -
To view the results, go to the
/etc/sower/resultdirectory.
-
Pack the service package, i.e. the
<SERVICE_NAME>directory with the service configuration files and Terraform manifests, into a zip archive. The archive size must not exceed 30 MB. -
Upload the archive to Marketplace in one of the following ways:
Vendor accountInfra API- Go to the VK Cloud management console.
- In the Application store section, click the Go to vendor account button.
- On the Service management tab, click the Add service button.
- Select the zip archive on your device for uploading to the system.
- Click the Add button.
After that, the added service will appear in the list of services with the
Hiddenstatus. The uploaded archive file will be sent for validation.A service package uploaded to Marketplace will first go to a test namespace, and after publication — to a public one.
-
After the service upload is complete, log in to the VK Cloud management console and make sure the service is displayed in Marketplace. The uploaded service will be available only to users of the Marketplace test namespaces specified in the service key.
If the service is not displayed in Marketplace after uploading, log out of the management console and log in again.
To check how the service will function in the Marketplace test namespace:
-
Go to the App Store section of the VK Cloud management console.
-
Click the All solutions button.
-
Click on your service card and go to the Tariff plans tab.
-
Make sure that the configuration wizard of each tariff plan is displayed correctly.
-
Connect the service. Make sure that the service instance deployment is completed successfully.
If during service instance deployment the resource described in the manifest failed to be created, the deployment system will restart the service deployment process. Repeated attempts may take up to 1.5 hours and can be disabled in the settings.yaml file.
-
If an error occurred when connecting the service, view the logs using the instructions.
-
Update the service instance:
- Change the values of the tariff options of the current tariff plan.
- Switch to a new tariff plan.
Changing the parameters of resources described in the manifest will start the service instance reinstallation process.
If the deployment system fails to update the resources, it will retry. The process of updating the service instance configuration, taking retries into account, may take up to 1.5 hours. Retries can be disabled in the settings.yaml file.
-
Test the main user scenarios of the service.
-
Delete the service instance.
-
(Optional) Update the service configuration.
- Change the service configuration if testing revealed such a need.
- If test values for the service cost were set in the service configuration for the time of testing and debugging, edit them.
-
Send an email to marketplace@cloud.vk.com.
Specify the service image ID in the email.
The specified image will be published and available to all users of the cloud platform. A reply email will contain the ID of the public service image.
-
In the Terraform manifests
plans/<PLAN_NAME>/deployment/deploy.tf, replace the service image ID with the public service image ID. -
In the service.yaml file, specify a new service revision.
-
Upload the service package with the public service image ID to Marketplace via the vendor dashboard or using a request to the Infra API service.
Send an email to marketplace@cloud.vk.com. Specify the service ID and its revision in the email.
The service package will be moderated. After that, the service will be published on Marketplace.
The service revision being published will be moved from the Marketplace test namespace to the open one specified in the service key. The service will become available to all users who have access to this open namespace.