VK Cloud logo

Image-based қосымшаны қосуBeta

Image-based қолданбаңызды Marketplace қызметіне қосу үшін дайындық қадамдарын орындаңыз. Содан кейін:

  1. Қызметтік пакеттің файлдық құрылымының негізін жасаңыз.
  2. Қызметтің конфигурациясын сипаттаңыз (тарифтік жоспарлар, опциялар).
  3. Қызметіңіз үшін инфрақұрылым конфигурациясын сипаттайтын Terraform манифесттерін жасаңыз.
  4. (Қалауыңыз бойынша) Terraform манифестерінде бар ресурстардың дұрыс көрсетілгенін тексеріңіз.
  5. (Қалауыңыз бойынша) Terraform манифесттерін жергілікті түрде тестілендіріңіз.
  6. (Қалауыңыз бойынша) Terraform манифесттерін орналастыру жүйесімен тестілендіріңіз.
  7. (Қалауыңыз бойынша) Marketplace агентінің логтарын және жұмыс нәтижелерін қараңыз.
  8. Қызметтік пакетті Marketplace-ке жүктеңіз.
  9. Жарияланғанға дейін жүктелген қызметті тестілендіріңіз.
  10. Қызметтің образын жариялаңыз.
  11. Қызметті Marketplace-те жариялаңыз.

Дайындық қадамдары

  1. Қолданбаңыз Marketplace қызметінің талаптарына сәйкес келетініне көз жеткізіңіз.
  2. Image-based қолданбаның образын VK Cloud жүйесіне жасаңыз және жүктеңіз.
  3. Қолданбаңыз үшін тарификация түрін анықтаңыз, тарифтік жоспарларды және опцияларды әзірлеңіз.
  4. Жеткізуші кабинетіне қосылыңыз.

1. Қызметтік пакеттің файлдық құрылымының негізін жасаңыз

Image-based қолданбаны Marketplace қызметіне жүктеу үшін қажетті барлық ақпарат белгілі бір файлдық құрылымы бар қызметтік пакет түрінде дайындалады.

Файлдық құрылымды дайындау үшін:

  1. <ИМЯ_СЕРВИСА> атты қызмет директориясын жасаңыз.

  2. Қызмет директориясында version.yaml файлын жасаңыз. Файлда мынаны көрсетіңіз:

    version: 0.0.1
  3. <ИМЯ_СЕРВИСА> директориясында images, parameters және plans директорияларын жасаңыз.

  4. images директориясына .png немесе .svg форматындағы қызмет иконкасы бар файлды орналастырыңыз. Файл өлшемі — 1 МБ-тан аспауы тиіс. Сурет ажыратымдылығы — кемінде 62 × 62 пиксель.

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

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

2. Қызметтің конфигурациясын сипаттаңыз (тарифтік жоспарлар, опциялар)

Қызметтің конфигурациясы .yaml және .md форматындағы файлдар арқылы сипатталады.

  1. <ИМЯ_СЕРВИСА> директориясында 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>
  2. <ИМЯ_СЕРВИСА> директориясында full_description.md файлын жасап, оны Markdown форматындағы қызмет сипаттамасымен толтырыңыз. Файл мазмұны оның Marketplace-тегі бетінде көрсетіледі.

    Файл құрылымы:

    <!--Қызметтің 2-3 сөйлемнен тұратын қысқаша жалпы сипаттамасы--><!--Жеткізушінің атауы-->## Шешілетін міндеттер<!--Қызметті қандай міндеттерді шешу үшін пайдалануға болады-->## Қызметтің сипаттамалары:<!--Техникалық сипаттамалар, кесте түрінде берген жөн--><!--Инфрақұрылымға қойылатын талаптар, қандай ресурстар пайдаланылуы мүмкін--># Тарификация ережелері<!--Қызмет қандай модель бойынша тарифтеледі, қандай тарифтік жоспарлар бар--># Пайдалы сілтемелер<!--VK Cloud құжаттамасындағы Marketplace бөліміне сілтеме + жеткізуші порталындағы құжаттамаға сілтеме--># Техникалық қолдау<!--Қызметтің техникалық қолдауы, VK Cloud техникалық қолдауы туралы ақпарат, қызметтің техникалық қолдау байланыстары--># Лицензиялық келісім<!--VK Cloud және жеткізуші қызметінің заңды құжаттарына сілтеме-->
  3. parameters директориясында әрбір тарифтік опция үшін <ИМЯ_ОПЦИИ>.yaml файлын жасап, оны мысалдарға сәйкес толтырыңыз.

    Қаражаттың артық жұмсалуына жол бермеу үшін ақылы тарифтік опциялар үшін тестілеу кезеңіне арналған қызметтің ең төменгі құнын көрсетіңіз.

  4. 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: 550   schema.minimum: 550
  5. <ИМЯ_ПЛАНА> директориясында тарифтік жоспардың конфигурация шеберінің сипаттамасы бар display.yaml файлын жасап, толтырыңыз. Тарифтік жоспардың конфигурация шебері қызметті қосу немесе тарифтік жоспарды жаңарту кезінде Marketplace-те көрсетіледі.

3. Қызмет үшін инфрақұрылым конфигурациясын сипаттайтын Terraform манифестерін жасаңыз

  1. plans/<ИМЯ_ПЛАНА> директориясында deployment директориясын жасаңыз.

  2. deployment директориясында мынаны жасап, толтырыңыз:

    • <ИМЯ_ПЛАНА> тарифтік жоспарын Marketplace-те орналастыру процесі мен инфрақұрылымын сипаттайтын Terraform манифесімен deploy.tf файлы.

    • (Қалауыңыз бойынша) манифестті орындау баптаулары бар settings.yaml файлы. Егер қызметтік пакетте settings.yaml файлы болмаса, Terraform манифестеріне әдепкі параметр мәндері қолданылады.

4. (Қалауыңыз бойынша) Terraform манифестерінде бар ресурстардың дұрыс көрсетілгенін тексеріңіз

Terraform манифестерін тестілеу уақытын қысқарту және дұрыс емес конфигурациямен ресурс жасау әрекеттерін болдырмау үшін манифестерді тестілеуден бұрын оларда VK Cloud жүйесінде бұрыннан бар ресурстардың параметрлері дұрыс көрсетілгенін тексеру ұсынылады, мысалы: ВМ түрі, қызмет образы және т.б.

  1. Бұрын жасалмаған болса, Terraform орнатыңыз және ортаны баптаңыз.

  2. Жұмыс директориясында мына команданы орындаңыз:

    terraform init
  3. Жұмыс директориясында main.tf файлын жасаңыз.

  4. main.tf файлына VK CS провайдерінің қажетті деректер көздеріне өтінімдерді орналастырыңыз.

    vkcs_compute_flavor деректер көзіне өтінім мысалы:

    data "vkcs_compute_flavor" "compute" {flavor_id = "4e115a9b-XXXX-95cf130d63c7"}

    Бұл мысалда ID-сы 4e115a9b-XXXX-95cf130d63c7 болатын ВМ түрінің VK Cloud жүйесінде бар екені тексеріледі.

  5. Жұмыс директориясында мына команданы орындаңыз:

    terraform apply

    Растауды сұрағанда yes деп енгізіңіз.

  6. Операцияның аяқталуын күтіңіз. Деректер көздеріне өтінім жасағанда қателер болмағанына көз жеткізіңіз.

5. (Қалауыңыз бойынша) Terraform манифестерін жергілікті түрде тестілендіріңіз

Қолданбаңыздың әрбір тарифтік жоспары үшін plans/<ИМЯ_ПЛАНА>/deployment/deploy.tf Terraform манифестерін нұсқаулықты пайдаланып жергілікті түрде тестілендіріңіз.

6. (Қалауыңыз бойынша) Terraform манифестерін орналастыру жүйесімен тестілендіріңіз

Қызметтік пакетті Marketplace-ке жүктеуден бұрын қолданбаңыздың әрбір жоспары үшін plans/<ИМЯ_ПЛАНА>/deployment/deploy.tf Terraform манифестерінің әрқайсысын орналастыру жүйесінің API көмегімен тестілендіріңіз:

  1. Бұрын жасалмаған болса, API арқылы қолжетімділікті қосыңыз.
  2. API-ге қолжетімділік токенін алыңыз.
  3. Манифестердің бірін — plans/<ИМЯ_ПЛАНА>/deployment/deploy.tf — орналастыру жүйесіне жүктеңіз.
  4. Жүктелген манифестің ағымдағы конфигурациясын тексеріңіз.
  5. Қызмет инстансын жасаңыз.
  6. Инстансты жасау барысында және жасалғаннан кейін оның күйін тексеріңіз. Егер күйі failed болса, инстанстың логтарынан қате сипаттамасын табыңыз.
  7. Қызмет инстансын жойыңыз.
  8. Жойылған қызмет инстансының күйін тексеріңіз. Егер күйі failed болса, инстанстың логтарынан қате сипаттамасын табыңыз.

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

7. (Қалауыңыз бойынша) Marketplace агентінің логтарын және жұмыс нәтижелерін қараңыз

Marketplace агентінің логтары мен жұмыс нәтижелерін қарау арқылы қызмет инстансын орналастыру кезіндегі қателерді анықтауға болады. Олар қолданбаңызды орналастыру кезінде ivkcs_agent_exec ресурсы арқылы орындалатын скрипттер пайдаланылса, қолжетімді болады.

Агенттің логтары мен жұмыс нәтижелерін қарау үшін:

  1. Агент орнатылған ВМ-ге қосылыңыз қашықтан қолжетімділік хаттамасы арқылы немесе VK Cloud жеке кабинетіндегі VNC-консоль көмегімен.

    Агент орнатылған ВМ-нің атауы plans/<ИМЯ_ПЛАНА>/deployment/deploy.tf манифестіндегі ivkcs_agent_init немесе ivkcs_user_data ресурсында беріледі.

  2. Логтарды қарау үшін journalctl -u sower командасын орындаңыз.

  3. Нәтижелерді қарау үшін /etc/sower/result директориясына өтіңіз.

8. Қызметтік пакетті Marketplace-ке жүктеңіз

  1. Қызметтік пакетті, яғни қызметтің конфигурациялық файлдары мен Terraform манифестері бар <ИМЯ_СЕРВИСА> директориясын zip-архивке ораңыз. Архив өлшемі 30 МБ-тан аспауы тиіс.

  2. Архивті Marketplace-ке мына тәсілдердің бірімен жүктеңіз:

    1. VK Cloud жеке кабинетіне өтіңіз.
    2. Қосымшалар дүкені бөлімінде Жеткізуші кабинетіне өту түймесін басыңыз.
    3. Сервистерді басқару қойыншасында Сервис қосу түймесін басыңыз.
    4. Жүйеге жүктеу үшін құрылғыңыздан zip-архивті таңдаңыз.
    5. Қосу түймесін басыңыз.

    Осыдан кейін қосылған қызмет сервистер тізімінде Жасырын күйінде пайда болады. Жүктелген архив файлы валидацияға жіберіледі.

    Marketplace-ке жүктелген қызметтік пакет алдымен тестілік кеңістікке түседі, жарияланғаннан кейін — ашық кеңістікке.

  3. Қызметті жүктеу аяқталғаннан кейін VK Cloud жеке кабинетіне кіріп, қызмет Marketplace-те көрсетілетінін тексеріңіз. Жүктелген қызмет тек қызметтік кілтте көрсетілген Marketplace тестілік кеңістіктерінің пайдаланушыларына ғана қолжетімді болады.

    Егер жүктегеннен кейін қызмет Marketplace-те көрсетілмесе, жеке кабинеттен шығып, қайта кіріңіз.

9. Жарияланғанға дейін жүктелген қызметті тестілендіріңіз

Қызметтің Marketplace тестілік кеңістігінде қалай жұмыс істейтінін тексеру үшін:

  1. VK Cloud жеке кабинетінің Қосымшалар дүкені бөліміне өтіңіз.

  2. Барлық шешімдер түймесін басыңыз.

  3. Қызметіңіздің карточкасын басып, Тарифтік жоспарлар қойыншасына өтіңіз.

  4. Әр тарифтік жоспардың конфигурация шебері дұрыс көрсетілетінін тексеріңіз.

  5. Қызметті қосыңыз. Қызмет инстансын орналастыру сәтті орындалғанын тексеріңіз.

    Қызмет инстансын орналастыру кезінде манифестте сипатталған ресурсты жасау мүмкін болмаса, орналастыру жүйесі қызметті орналастыру процесін қайта іске қосады. Қайталау әрекеттері 1,5 сағатқа дейін уақыт алуы мүмкін және оларды settings.yaml файлында өшіруге болады.

  6. Қызметті қосу кезінде қате орын алса, нұсқаулықты пайдаланып логтерді қараңыз.

  7. Қызмет инстансын жаңартыңыз:

    1. Ағымдағы тарифтік жоспардың тарифтік опцияларының мәндерін өзгертіңіз.
    2. Жаңа тарифтік жоспарға өтіңіз.

    Манифестте сипатталған ресурс параметрлерін өзгерту қызмет инстансын қайта орнату процесін іске қосады.

    Орналастыру жүйесі ресурстарды жаңарта алмаса, оны қайта жасап көреді. Қайталау әрекеттерін ескере отырып, қызмет инстансының конфигурациясын жаңарту процесі 1,5 сағатқа дейін уақыт алуы мүмкін. Қайталау әрекеттерін settings.yaml файлында өшіруге болады.

  8. Қызметтің негізгі пайдаланушы сценарийлерін тексеріңіз.

  9. Қызмет инстансын жойыңыз.

  10. (Қалауыңыз бойынша) Қызмет конфигурациясын жаңартыңыз.

    1. Тестілеу нәтижесінде мұндай қажеттілік туындаса, қызмет конфигурациясын өзгертіңіз.
    2. Тестілеу және отладка кезінде қызмет конфигурациясында қызмет құны үшін тестілік мәндер берілген болса, оларды өңдеңіз.

10. Қызметтің образын жариялаңыз

  1. marketplace@cloud.vk.com мекенжайына хат жіберіңіз.

    Хатта қызметтің образ ID-сын көрсетіңіз.

    Көрсетілген образ жарияланып, бұлттық платформаның барлық пайдаланушыларына қолжетімді болады. Жауап хатында қызметтің публичный образының ID-сы жіберіледі.

  2. Terraform манифесттерінде plans/<ИМЯ_ПЛАНА>/deployment/deploy.tf қызметтің образ ID-сын қызметтің публичный образының ID-сына өзгертіңіз.

  3. service.yaml файлында қызметтің жаңа ревизиясын көрсетіңіз.

  4. Қызметтің публичный образының ID-сы бар қызметтік пакетті жеткізуші кабинеты арқылы немесе Infra API қызметіне сұрау жіберу арқылы Marketplace-ке жүктеңіз.

11. Қызметті Marketplace-те жариялаңыз

marketplace@cloud.vk.com мекенжайына хат жіберіңіз. Хатта қызметтің ID-сын және оның ревизиясын көрсетіңіз.

Қызметтік пакет модерациядан өткізіледі. Осыдан кейін қызмет Marketplace-те жарияланады.

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

Мақала пайдалы болды ма?