VK Cloud logo

service.yaml файлыBeta

service.yaml конфигурациялық файлы мына ақпаратты қамтиды:

  • Қосымшаның жалпы параметрлері.
  • plans массиві тарифтік жоспарлардың атауларымен. Бұл атаулар тек сервистік пакетті сипаттау үшін қолданылады және Marketplace интерфейсінде көрсетілмейді.
  • preview секциясы тарифтік опциялардың атауларымен. Бұл атаулар тек сервистік пакетті сипаттау үшін қолданылады және Marketplace интерфейсінде көрсетілмейді.

Қосымшаның жалпы параметрлері

Атауы

Сипаттамасы

Форматы

Міндетті

id

UUID4 генераторының көмегімен жасалған қызметтің идентификаторы (ID) UUID4

string (UUID4)

service.yaml файлы

revision

Қызметтің ревизиясы. Ревизия мен қызметтің ID тіркесімі оның Marketplace шеңберіндегі бірегейлігін анықтайды. Қалған параметрлер қызметтің нақты ревизиясының сипаттамаларын білдіреді

string, 255 таңбаға дейін

service.yaml файлы

name

Қызметтің атауы

string, 255 таңбаға дейін

service.yaml файлы

short_description

Қызметтің карточкасында көрсетілетін қысқаша сипаттама:

  • Marketplace каталогында;
  • қызмет бетіндегі Қызмет сипаттамасы қойындысында.

Қызметтің толық сипаттамасы full_description.md файлында көрсетіледі

string, 120 таңбаға дейін

service.yaml файлы

singleton

Бұлттық платформаның бір жобасына қызметтің бір ғана инстансы шектелетінін немесе шектелмейтінін анықтайды

boolean

service.yaml файлы

auto_bind

Қызметті орналастырғаннан кейін қызметтік байланыстыруды автоматты түрде жасау қажет пе екенін анықтайды

boolean

service.yaml файлы

icon

Қызметтік пакеттің images директориясында орналасқан қызмет иконкасы файлының атауы

string, 512 таңбаға дейін

service.yaml файлы

help

Қызмет құжаттамасының URL мекенжайы

string, 512 таңбаға дейін

service.yaml файлы

bindable

Осы қызмет үшін қызметтік байланыстыруларды жасауға болатынын анықтайды. Мәні true болуы тиіс

boolean

service.yaml файлы

plan_updateable

Пайдаланушы қызметті өшірместен бір тарифтік жоспардан екіншісіне өте алатынын анықтайды.

Параметрдің мәні қызметтің барлық жоспарларына қолданылады.

Image-based қосымшалар үшін мән false болуы тиіс

boolean

service.yaml файлы

deactivatable

Қызметті пайдалануды уақытша тоқтатуға болатынын анықтайды

boolean

service.yaml файлы

bindings_retrievable

Алдыңғы әрекет сәтсіз аяқталған жағдайда, белгілі бір уақыт ішінде қызметтік байланыстыруды жасау әрекетін қайталау қажет пе екенін анықтайды

boolean

service.yaml файлы

instances_retrievable

Алдыңғы әрекет сәтсіз аяқталған жағдайда, белгілі бір уақыт ішінде қызмет инстансын жасау әрекетін қайталау қажет пе екенін анықтайды

boolean

service.yaml файлы

plans

Қосымшаның тарифтік жоспарларының атауларын қамтиды

Массив

service.yaml файлы

preview

Тарифтік жоспарлар матрицасы үшін тарифтік опциялардың атауларын қамтиды

Массив

service.yaml файлы

plans және preview массивтерінде көрсетілген тарифтік жоспарлар мен опциялар негізінде тарифтік жоспарлар матрицасы құрылады.

plans массиві

plans массивінде name кілттерінің көмегімен Marketplace пайдаланушысына қолжетімді болатын тарифтік жоспарлардың атаулары (<ЖОСПАР_АТЫ>) тізіледі.

plans массивінің мысалы:

plans:    - name: free    - name: basic

Бұл мысалда free және basic тарифтік жоспарлары тізілген. Олардың конфигурациялары plans/free және plans/basic директорияларында сипатталуы тиіс. Тарифтік жоспарлар матрицасында бұл жоспарлар plans/free/plan.yaml және plans/basic/plan.yaml файлдарының description параметрінде көрсетілген атаулармен беріледі.

preview секциясы

preview секциясы parameters массивін қамтиды. Бұл массивте name кілттерінің көмегімен Marketplace пайдаланушысына қолжетімді болатын тарифтік опциялардың атаулары (<ОПЦИЯ_АТЫ>) тізіледі. Массив бос болуы мүмкін.

preview секциясының мысалы:

preview:  parameters:  - name: groups  - name: products

Бұл мысалда groups және products тарифтік опциялары тізілген. Олар parameters директориясында сәйкесінше groups.yaml және products.yaml файлдарында сипатталуы тиіс. Тарифтік жоспарлар матрицасында опциялар көрсетілген YAML-файлдардың description параметрінде берілген атаулармен көрсетіледі.

service.yaml файлының мысалы

id: 72b70199-1823-40c8-aa7e-f43a23ddf380revision: v. 1.0name: VK Testersshort_description: Мыңдаған бета-тестерлер қауымдастығы мен деректермен жұмыс істеуге арналған өз платформасы бар крауд-тестілеу бағдарламасыsingleton: 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
Мақала пайдалы болды ма?