Image-based қосымшаны қосуBeta
Image-based қолданбаңызды Marketplace қызметіне қосу үшін дайындық қадамдарын орындаңыз. Содан кейін:
- Қызметтік пакеттің файлдық құрылымының негізін жасаңыз.
- Қызметтің конфигурациясын сипаттаңыз (тарифтік жоспарлар, опциялар).
- Қызметіңіз үшін инфрақұрылым конфигурациясын сипаттайтын Terraform манифесттерін жасаңыз.
- (Қалауыңыз бойынша) Terraform манифестерінде бар ресурстардың дұрыс көрсетілгенін тексеріңіз.
- (Қалауыңыз бойынша) Terraform манифесттерін жергілікті түрде тестілендіріңіз.
- (Қалауыңыз бойынша) Terraform манифесттерін орналастыру жүйесімен тестілендіріңіз.
- (Қалауыңыз бойынша) Marketplace агентінің логтарын және жұмыс нәтижелерін қараңыз.
- Қызметтік пакетті Marketplace-ке жүктеңіз.
- Жарияланғанға дейін жүктелген қызметті тестілендіріңіз.
- Қызметтің образын жариялаңыз.
- Қызметті Marketplace-те жариялаңыз.
- Қолданбаңыз Marketplace қызметінің талаптарына сәйкес келетініне көз жеткізіңіз.
- Image-based қолданбаның образын VK Cloud жүйесіне жасаңыз және жүктеңіз.
- Қолданбаңыз үшін тарификация түрін анықтаңыз, тарифтік жоспарларды және опцияларды әзірлеңіз.
- Жеткізуші кабинетіне қосылыңыз.
Image-based қолданбаны Marketplace қызметіне жүктеу үшін қажетті барлық ақпарат белгілі бір файлдық құрылымы бар қызметтік пакет түрінде дайындалады.
Файлдық құрылымды дайындау үшін:
-
<ИМЯ_СЕРВИСА>атты қызмет директориясын жасаңыз. -
Қызмет директориясында
version.yamlфайлын жасаңыз. Файлда мынаны көрсетіңіз:version: 0.0.1 -
<ИМЯ_СЕРВИСА>директориясындаimages,parametersжәнеplansдиректорияларын жасаңыз. -
imagesдиректориясына.pngнемесе.svgформатындағы қызмет иконкасы бар файлды орналастырыңыз. Файл өлшемі — 1 МБ-тан аспауы тиіс. Сурет ажыратымдылығы — кемінде 62 × 62 пиксель.Қызмет иконкасы қызмет карточкасында көрсетіледі:
- Marketplace каталогында;
- қызмет бетіндегі Қызметтің сипаттамасы қойыншасында.
Қызметтің конфигурациясы .yaml және .md форматындағы файлдар арқылы сипатталады.
-
<ИМЯ_СЕРВИСА>директориясындаservice.yamlфайлын жасап, оны толтырыңыз.service.yamlфайлы мыналарды қамтиды:- қызметтің жалпы параметрлері;
plansмассиві түріндегі тарифтік жоспарлардың атаулары (бұдан әрі —<ИМЯ_ПЛАНА>);previewсекциясындағыparametersмассиві түріндегі тарифтік опциялардың атаулары (бұдан әрі —<ИМЯ_ОПЦИИ>).
<ИМЯ_ПЛАНА>және<ИМЯ_ОПЦИИ>тек қызметтік пакет ішінде қолданылады және Marketplace интерфейсінде көрсетілмейді.Файл құрылымы:
# Қызметтің жалпы параметрлеріid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXrevision: v. X.Xname: <ИМЯ_СЕРВИСА>short_description: <КОРОТКОЕ_ОПИСАНИЕ>singleton: <ФЛАГ> # true | falseauto_bind: <ФЛАГ> # true | falseicon: <ФАЙЛ> # Қызмет иконкасы бар файлдың атауыhelp: <URL> # Қызмет құжаттамасына сілтемеbindable: <ФЛАГ> # true | falseplan_updateable: <ФЛАГ> # true | falsedeactivatable: <ФЛАГ> # true | falsebindings_retrievable: <ФЛАГ> # true | falseinstances_retrievable: <ФЛАГ> # true | false# plans массивіplans:- name: <ИМЯ_ПЛАНА_1>- name: <ИМЯ_ПЛАНА_2># preview секциясыpreview:parameters:- name: <ИМЯ_ОПЦИИ_1>- name: <ИМЯ_ОПЦИИ_2>- name: <ИМЯ_ОПЦИИ_3> -
<ИМЯ_СЕРВИСА>директориясындаfull_description.mdфайлын жасап, оны Markdown форматындағы қызмет сипаттамасымен толтырыңыз. Файл мазмұны оның Marketplace-тегі бетінде көрсетіледі.Файл құрылымы:
<!--Қызметтің 2-3 сөйлемнен тұратын қысқаша жалпы сипаттамасы--><!--Жеткізушінің атауы-->## Шешілетін міндеттер<!--Қызметті қандай міндеттерді шешу үшін пайдалануға болады-->## Қызметтің сипаттамалары:<!--Техникалық сипаттамалар, кесте түрінде берген жөн--><!--Инфрақұрылымға қойылатын талаптар, қандай ресурстар пайдаланылуы мүмкін--># Тарификация ережелері<!--Қызмет қандай модель бойынша тарифтеледі, қандай тарифтік жоспарлар бар--># Пайдалы сілтемелер<!--VK Cloud құжаттамасындағы Marketplace бөліміне сілтеме + жеткізуші порталындағы құжаттамаға сілтеме--># Техникалық қолдау<!--Қызметтің техникалық қолдауы, VK Cloud техникалық қолдауы туралы ақпарат, қызметтің техникалық қолдау байланыстары--># Лицензиялық келісім<!--VK Cloud және жеткізуші қызметінің заңды құжаттарына сілтеме--> -
parametersдиректориясында әрбір тарифтік опция үшін<ИМЯ_ОПЦИИ>.yamlфайлын жасап, оны мысалдарға сәйкес толтырыңыз.Қаражаттың артық жұмсалуына жол бермеу үшін ақылы тарифтік опциялар үшін тестілеу кезеңіне арналған қызметтің ең төменгі құнын көрсетіңіз.
-
plansдиректориясында әрбір тарифтік жоспар үшін<ИМЯ_ПЛАНА>директориясын жасаңыз. Әрбір<ИМЯ_ПЛАНА>директориясындаplan.yamlфайлын жасап, толтырыңыз:Файл құрылымы:
# Тарифтік жоспардың жалпы параметрлеріid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXrevision: v. X.Xname: <ИМЯ_ПЛАНА>description: <КОРОТКОЕ_ОПИСАНИЕ>free: <ФЛАГ> # true | false# billing секциясыbilling:cost: <СТОИМОСТЬ>refundable: <ФЛАГ> # true | falsebilling_cycle_flat: <ДЛИНА_ОТЧЕТНОГО_ПЕРИОДА># parameters_patch секциясыparameters_patch:users:schema.const: 5000volume_data_size:schema.default: 550schema.minimum: 550 -
<ИМЯ_ПЛАНА>директориясында тарифтік жоспардың конфигурация шеберінің сипаттамасы барdisplay.yamlфайлын жасап, толтырыңыз. Тарифтік жоспардың конфигурация шебері қызметті қосу немесе тарифтік жоспарды жаңарту кезінде Marketplace-те көрсетіледі.
-
plans/<ИМЯ_ПЛАНА>директориясындаdeploymentдиректориясын жасаңыз. -
deploymentдиректориясында мынаны жасап, толтырыңыз:-
<ИМЯ_ПЛАНА>тарифтік жоспарын Marketplace-те орналастыру процесі мен инфрақұрылымын сипаттайтын Terraform манифесіменdeploy.tfфайлы. -
(Қалауыңыз бойынша) манифестті орындау баптаулары бар settings.yaml файлы. Егер қызметтік пакетте
settings.yamlфайлы болмаса, Terraform манифестеріне әдепкі параметр мәндері қолданылады.
-
Terraform манифестерін тестілеу уақытын қысқарту және дұрыс емес конфигурациямен ресурс жасау әрекеттерін болдырмау үшін манифестерді тестілеуден бұрын оларда VK Cloud жүйесінде бұрыннан бар ресурстардың параметрлері дұрыс көрсетілгенін тексеру ұсынылады, мысалы: ВМ түрі, қызмет образы және т.б.
-
Бұрын жасалмаған болса, Terraform орнатыңыз және ортаны баптаңыз.
-
Жұмыс директориясында мына команданы орындаңыз:
terraform init -
Жұмыс директориясында
main.tfфайлын жасаңыз. -
main.tfфайлына VK CS провайдерінің қажетті деректер көздеріне өтінімдерді орналастырыңыз.vkcs_compute_flavor деректер көзіне өтінім мысалы:
data "vkcs_compute_flavor" "compute" {flavor_id = "4e115a9b-XXXX-95cf130d63c7"}Бұл мысалда ID-сы
4e115a9b-XXXX-95cf130d63c7болатын ВМ түрінің VK Cloud жүйесінде бар екені тексеріледі. -
Жұмыс директориясында мына команданы орындаңыз:
terraform applyРастауды сұрағанда
yesдеп енгізіңіз. -
Операцияның аяқталуын күтіңіз. Деректер көздеріне өтінім жасағанда қателер болмағанына көз жеткізіңіз.
Қолданбаңыздың әрбір тарифтік жоспары үшін plans/<ИМЯ_ПЛАНА>/deployment/deploy.tf Terraform манифестерін нұсқаулықты пайдаланып жергілікті түрде тестілендіріңіз.
Қызметтік пакетті Marketplace-ке жүктеуден бұрын қолданбаңыздың әрбір жоспары үшін plans/<ИМЯ_ПЛАНА>/deployment/deploy.tf Terraform манифестерінің әрқайсысын орналастыру жүйесінің API көмегімен тестілендіріңіз:
- Бұрын жасалмаған болса, API арқылы қолжетімділікті қосыңыз.
- API-ге қолжетімділік токенін алыңыз.
- Манифестердің бірін —
plans/<ИМЯ_ПЛАНА>/deployment/deploy.tf— орналастыру жүйесіне жүктеңіз. - Жүктелген манифестің ағымдағы конфигурациясын тексеріңіз.
- Қызмет инстансын жасаңыз.
- Инстансты жасау барысында және жасалғаннан кейін оның күйін тексеріңіз. Егер күйі
failedболса, инстанстың логтарынан қате сипаттамасын табыңыз. - Қызмет инстансын жойыңыз.
- Жойылған қызмет инстансының күйін тексеріңіз. Егер күйі
failedболса, инстанстың логтарынан қате сипаттамасын табыңыз.
Қолданбаңыздың қалған тарифтік жоспарлары үшін манифестерді де осылайша тестілендіріңіз.
Marketplace агентінің логтары мен жұмыс нәтижелерін қарау арқылы қызмет инстансын орналастыру кезіндегі қателерді анықтауға болады. Олар қолданбаңызды орналастыру кезінде ivkcs_agent_exec ресурсы арқылы орындалатын скрипттер пайдаланылса, қолжетімді болады.
Агенттің логтары мен жұмыс нәтижелерін қарау үшін:
-
Агент орнатылған ВМ-ге қосылыңыз қашықтан қолжетімділік хаттамасы арқылы немесе VK Cloud жеке кабинетіндегі VNC-консоль көмегімен.
Агент орнатылған ВМ-нің атауы
plans/<ИМЯ_ПЛАНА>/deployment/deploy.tfманифестіндегіivkcs_agent_initнемесеivkcs_user_dataресурсында беріледі. -
Логтарды қарау үшін
journalctl -u sowerкомандасын орындаңыз. -
Нәтижелерді қарау үшін
/etc/sower/resultдиректориясына өтіңіз.
-
Қызметтік пакетті, яғни қызметтің конфигурациялық файлдары мен Terraform манифестері бар
<ИМЯ_СЕРВИСА>директориясын zip-архивке ораңыз. Архив өлшемі 30 МБ-тан аспауы тиіс. -
Архивті Marketplace-ке мына тәсілдердің бірімен жүктеңіз:
Жеткізуші кабинетіInfra API- VK Cloud жеке кабинетіне өтіңіз.
- Қосымшалар дүкені бөлімінде Жеткізуші кабинетіне өту түймесін басыңыз.
- Сервистерді басқару қойыншасында Сервис қосу түймесін басыңыз.
- Жүйеге жүктеу үшін құрылғыңыздан zip-архивті таңдаңыз.
- Қосу түймесін басыңыз.
Осыдан кейін қосылған қызмет сервистер тізімінде
Жасырынкүйінде пайда болады. Жүктелген архив файлы валидацияға жіберіледі.Marketplace-ке жүктелген қызметтік пакет алдымен тестілік кеңістікке түседі, жарияланғаннан кейін — ашық кеңістікке.
-
Қызметті жүктеу аяқталғаннан кейін VK Cloud жеке кабинетіне кіріп, қызмет Marketplace-те көрсетілетінін тексеріңіз. Жүктелген қызмет тек қызметтік кілтте көрсетілген Marketplace тестілік кеңістіктерінің пайдаланушыларына ғана қолжетімді болады.
Егер жүктегеннен кейін қызмет Marketplace-те көрсетілмесе, жеке кабинеттен шығып, қайта кіріңіз.
Қызметтің Marketplace тестілік кеңістігінде қалай жұмыс істейтінін тексеру үшін:
-
VK Cloud жеке кабинетінің Қосымшалар дүкені бөліміне өтіңіз.
-
Барлық шешімдер түймесін басыңыз.
-
Қызметіңіздің карточкасын басып, Тарифтік жоспарлар қойыншасына өтіңіз.
-
Әр тарифтік жоспардың конфигурация шебері дұрыс көрсетілетінін тексеріңіз.
-
Қызметті қосыңыз. Қызмет инстансын орналастыру сәтті орындалғанын тексеріңіз.
Қызмет инстансын орналастыру кезінде манифестте сипатталған ресурсты жасау мүмкін болмаса, орналастыру жүйесі қызметті орналастыру процесін қайта іске қосады. Қайталау әрекеттері 1,5 сағатқа дейін уақыт алуы мүмкін және оларды settings.yaml файлында өшіруге болады.
-
Қызметті қосу кезінде қате орын алса, нұсқаулықты пайдаланып логтерді қараңыз.
-
Қызмет инстансын жаңартыңыз:
- Ағымдағы тарифтік жоспардың тарифтік опцияларының мәндерін өзгертіңіз.
- Жаңа тарифтік жоспарға өтіңіз.
Манифестте сипатталған ресурс параметрлерін өзгерту қызмет инстансын қайта орнату процесін іске қосады.
Орналастыру жүйесі ресурстарды жаңарта алмаса, оны қайта жасап көреді. Қайталау әрекеттерін ескере отырып, қызмет инстансының конфигурациясын жаңарту процесі 1,5 сағатқа дейін уақыт алуы мүмкін. Қайталау әрекеттерін settings.yaml файлында өшіруге болады.
-
Қызметтің негізгі пайдаланушы сценарийлерін тексеріңіз.
-
Қызмет инстансын жойыңыз.
-
(Қалауыңыз бойынша) Қызмет конфигурациясын жаңартыңыз.
- Тестілеу нәтижесінде мұндай қажеттілік туындаса, қызмет конфигурациясын өзгертіңіз.
- Тестілеу және отладка кезінде қызмет конфигурациясында қызмет құны үшін тестілік мәндер берілген болса, оларды өңдеңіз.
-
marketplace@cloud.vk.com мекенжайына хат жіберіңіз.
Хатта қызметтің образ ID-сын көрсетіңіз.
Көрсетілген образ жарияланып, бұлттық платформаның барлық пайдаланушыларына қолжетімді болады. Жауап хатында қызметтің публичный образының ID-сы жіберіледі.
-
Terraform манифесттерінде
plans/<ИМЯ_ПЛАНА>/deployment/deploy.tfқызметтің образ ID-сын қызметтің публичный образының ID-сына өзгертіңіз. -
service.yaml файлында қызметтің жаңа ревизиясын көрсетіңіз.
-
Қызметтің публичный образының ID-сы бар қызметтік пакетті жеткізуші кабинеты арқылы немесе Infra API қызметіне сұрау жіберу арқылы Marketplace-ке жүктеңіз.
marketplace@cloud.vk.com мекенжайына хат жіберіңіз. Хатта қызметтің ID-сын және оның ревизиясын көрсетіңіз.
Қызметтік пакет модерациядан өткізіледі. Осыдан кейін қызмет Marketplace-те жарияланады.
Жарияланатын қызмет ревизиясы Marketplace тестілік кеңістігінен қызметтік кілтте көрсетілген ашық кеңістікке ауыстырылады. Қызмет осы ашық кеңістікке қолжетімділігі бар барлық пайдаланушыларға қолжетімді болады.