SaaS-қосымшасын қосуBeta
Marketplace сервисі мен SaaS-қосымшасы бір-бірімен SaaS-брокер арқылы VK OSB хаттамасы бойынша өзара әрекеттеседі. Хаттаманы VK Cloud платформасы ұсынады.
SaaS-брокерге қойылатын талаптар:
-
Брокер сервис инстанстарының өмірлік циклін сипаттайтын әдістерді іске асыруы керек. Әдістер схемада көрсетілген.
-
Брокерде сенімді сертификаттау орталығы берген сертификатпен қауіпсіз HTTPS хаттамасы бойынша аутентификация теңшелген болуы керек.
SaaS-қосымшасының жеткізушісі SaaS-брокерді толығымен өз бетінше немесе VK Cloud платформасы ұсынатын үлгі негізінде әзірлейді. Үлгіде дүкен мен брокер арасындағы өзара әрекеттесу бұрыннан іске асырылған. Оны нақты SaaS-қосымшасымен брокердің өзара әрекеттесуін сипаттаумен толықтыру қажет. Үлгі FastAPI фреймворкі негізінде Python тілінде әзірленген.
Бұл нұсқаулық VK Cloud үлгісі негізінде SaaS-брокерді әзірлеу жағдайына арналған.
-
marketplace@cloud.vk.com мекенжайына хат жіберіңіз. Хатта сұраңыз:
- VK OSB хаттамасын;
- SaaS-брокерді әзірлеуге арналған үлгіні;
- Marketplace тесттік және ашық кеңістіктерінің атауларын және оларға кіру мүмкіндігін.
-
marketplace@cloud.vk.com мекенжайына кемінде 62 × 62 пиксель өлшеміндегі SVG форматындағы иконка салынған хат жіберіңіз. Иконкасы бар файлдың өлшемі 1 МБ-тан аспауы керек.
Сервис иконкасы сервис карточкасында көрсетіледі:
- Дүкен каталогында.
- Сервис бетіндегі Сервис сипаттамасы қойындысында.
Жауап хатта JSON сервис конфигурация файлында көрсетілетін иконканың URL мекенжайы жіберіледі.
-
VK Cloud-те тіркеліңіз. Дүкенде қосымшаны тестілеу үшін VK Cloud тіркелгісі қажет.
-
catalog_<СЕРВИС_АТАУЫ>.jsonфайлын жасаңыз. -
JSON-файлда келесі құрылымды пайдалана отырып, сервис конфигурациясын сипаттаңыз:
{"services": [{<ПАРАМЕТРЫ_СЕРВИСА>,"preview": {"parameters": [{"name": "<ИМЯ_ОПЦИИ_1>" // Имя первой тарифной опции},{"name": "<ИМЯ_ОПЦИИ_2>" // Имя второй тарифной опции},...]},"plans": [{ // Описание первого тарифного плана<ПАРАМЕТРЫ_ПЛАНА>,"display": {},"billing": {},"schemas": {}},{ // Описание второго тарифного плана<ПАРАМЕТРЫ_ПЛАНА>,"display": {},"billing": {},"schemas": {}},...]}]}Мұнда:
-
<ПАРАМЕТРЫ_СЕРВИСА>— сервис параметрлері. -
previewжәнеplansсекциялары бірге тарифтік жоспарлар матрицасының көрінісін анықтайды. Матрицадаplansсекциясында көрсетілген барлық тарифтік жоспарлар жәнеpreviewсекциясында көрсетілген тарифтік опциялар бейнеленеді. -
previewсекциясыныңparametersмассиві тарифтік опциялардың атауларын қамтиды, бос болуы мүмкін. Бұл атаулар тек конфигурациялық JSON-файлында қолданылады. Дүкен интерфейсінде тарифтік опциялар осы опциялардың schemas секциясындағыdescriptionпараметрімен берілген атаулармен көрсетіледі. -
plansсекциясы тарифтік жоспарлар мен олардың опцияларын сипаттайды және әр жоспар үшін келесі блоктарды қамтиды:<ПАРАМЕТРЫ_ПЛАНА>— жоспар параметрлері.- display секциясы тарифтік жоспарды конфигурациялау шеберін сипаттайды.
- billing секциясы жоспар мен оның опцияларының құны және тарификациялау тәсілі туралы ақпаратты қамтиды.
- schemas секциясы жоспардың тарифтік опцияларын тізімдейді.
-
-
Сервисіңіздің API-мен өзара әрекеттесуге арналған клиентті әзірлеңіз.
-
Брокер мен сервис арасындағы өзара әрекеттесуді сипаттайтын сервис-менеджерді әзірлеңіз. Ол үшін келесі әдістерді іске асырыңыз:
Әдіс
Кіріс деректер
Тенанттың немесе аккаунттың жасалуы
- Сервиске қосылу кезінде дүкен жасайтын сервис инстансының OSB ID-сі. SaaS-қосымшасы сервис инстансының ID-сін құруы үшін OSB ID SaaS-қосымшасына беріледі. Сервис инстансының ID-сі кестеде төменде сипатталған әдістерде пайдаланылады.
- Тарифтік жоспардың ID-сі.
- Сервис конфигурациясының JSON-файлында plans.schemas.service_instance.create бөлімінде сипатталған жоспардың тарифтік опциялары.
- (Қалау бойынша) Пайдаланушы туралы ақпаратты қамтитын контекст: электрондық пошта, жобаның бірегей идентификаторы (PID)
Тенанттың немесе аккаунттың жаңартылуы
- Сервис инстансының ID-сі.
- Тарифтік жоспардың ID-сі.
- Сервис конфигурациясының JSON-файлында plans.schemas.service_instance.update бөлімінде сипатталған жоспардың тарифтік опциялары
Тенанттың немесе аккаунттың алынуы және жойылуы
Сервис инстансының ID-сі
Сервис привязкаларын (bindings) жасау
- Сервис инстансының ID-сі.
- Сервис конфигурациясының JSON-файлында plans.schemas.service_binding.create бөлімінде сипатталған сервис привязкаларының параметрлері.
- (Қалау бойынша) Пайдаланушы туралы ақпаратты қамтитын контекст: электрондық пошта, жобаның бірегей идентификаторы (PID)
Сервис привязкаларын алу және жою
- Сервис инстансының ID-сі.
- Сервис привязкасының ID-сі
-
Клиентті сервис-менеджерге интеграциялаңыз.
-
Брокерде аутентификацияны теңшеңіз.
-
SaaS-қосымшасында постапайттық тарифтік опциялар бар болса және олар бойынша метрикалар pull-модель бойынша жиналса, қосымша әрекеттерді орындаңыз:
-
Сервис-менеджерде SaaS-қосымшасының іс жүзінде пайдаланылған ресурстары бойынша есеп алудың әдісін іске асырыңыз. Сұрауға жауап ретінде брокер дүкенге есепті беруі керек.
-
Сервис-менеджерде брокерге есеп өңделгені туралы (есеп бойынша ақша алынды немесе жоспарланды) хабарлайтын әдісті іске асырыңыз.
-
-
Брокер орналасқан директорияға өтіңіз.
-
Сервис конфигурациясы бар
catalog_<СЕРВИС_АТАУЫ>.jsonфайлынresourcesішкі директориясына қойыңыз. -
resources/plan_mapping.jsonфайлында көрсетіңіз:-
<СЕРВИС_АТАУЫ>— сервис атауы. -
<ЖОСПАР_ID>—catalog_<СЕРВИС_АТАУЫ>.jsonфайлында көрсетілген тарифтік жоспарлардың ID-сі. -
<SAAS_ЖОСПАР_ID>(форматstring) —<ЖОСПАР_ID>тарифтік жоспарларының ID-сіне сәйкес келетін сервис жағындағы тарифтік жоспарлардың ID-сі.{"<СЕРВИС_АТАУЫ>": {"<ЖОСПАР_ID>": <SAAS_ЖОСПАР_ID>,"<ЖОСПАР_ID>": <SAAS_ЖОСПАР_ID>}}
plan_mapping.jsonфайлының мазмұны мысалы:{"VKT": {"0dc54b75-XXXX-89d5a47eef71": 1,"312b628e-XXXX-080ab4ca3acb": 2,"e2ae1588-XXXX-3f5081a799a9": 3,"b54e7247-XXXX-7a9dccc22e7b": 4}} -
-
Брокер орналасқан директорияда
.env.exampleфайлының атауын.envетіп өзгертіңіз. -
.envфайлында сервис атауынBROKER_MODEішінде көрсетіңіз:BROKER_MODE=<СЕРВИС_АТАУЫ>
-
Брокер орналасқан директориядағы
.envфайлында орта айнымалыларын сипаттаңыз:BROKER_PROVIDER_CLIENT_ID— SaaS-қосымшасына кіру үшін брокердің атауы.BROKER_PROVIDER_SECRET— брокердің SaaS-қосымшасына кіру паролі.BROKER_PROVIDER_URL— SaaS-қосымшасының URL мекенжайы.BROKER_USERNAME— брокермен сервисаралық өзара әрекеттесу үшін дүкеннің атауы.BROKER_PASSWORD— брокермен сервисаралық өзара әрекеттесу үшін дүкеннің паролі.
-
Брокер орналасқан директориядағы
.envфайлында брокердің БД-на кіру үшін айнымалылардың мәндерін көрсетіңіз. -
Python-кітапханаларын орнатыңыз, команданы орындай отырып:
Linuxpip install -r requirements/prod.txt -
Брокерді іске қосыңыз, команданы орындай отырып:
Linuxgunicorn app.main:app --log-file - --workers ${UVICORN_WORKERS:-1} --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:${BROKER_PORT:-8000} --timeout ${WORKER_TIMEOUT:-90}Брокерді іске қосу командасына жауап мысалы:
INFO: Started server process [34934]INFO: Waiting for application startup.INFO: Application startup complete.INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit) -
Брокерді орнатқаннан кейін браузерде http://0.0.0.0:8000/docs бетін ашыңыз.
Бетте Swagger редакторындағы брокердің API сипаттамасы бар.
-
Келесі параметрлерді пайдалана отырып, API сұрауларын орындаңыз:
- VK OSB хаттамасының нұсқасы мәні
x-broker-api-version(мысалы,"0.1"). .envфайлындағыBROKER_USERNAMEмәні..envфайлындағыBROKER_PASSWORDмәні.
- VK OSB хаттамасының нұсқасы мәні
Образды жинау үшін брокер үлгісінің директориясындағы Dockerfile файлын пайдаланыңыз.
marketplace@cloud.vk.com мекенжайына хат жіберіңіз. Хатта көрсетіңіз:
-
Компания туралы ақпарат:
- компания атауы,
- контактілі тұлға,
- телефон.
-
Сервис инстанстарын жасау кезінде қателіктер туралы хабарламалар келетін пайдаланушының электрондық поштасы.
-
Кестеде келтірілген брокер параметрлері.
Атауы | Сипаттамасы | Форматы | Міндетті |
|---|---|---|---|
| Брокердің атауы | string | |
| Дүкеннен сұраулар жіберілетін URL мекенжайы | string | |
| Брокердің сипаттамасы | string | |
| VK OSB хаттамасының нұсқасы | string | |
| Брокермен сервисаралық өзара әрекеттесу үшін дүкеннің атауы. | string | |
| Брокермен сервисаралық өзара әрекеттесу үшін дүкеннің паролі. | string |
Брокер тіркелгеннен кейін SaaS-қосымшасы дүкеннің тесттік кеңістігінде қолжетімді болады. Дүкеннің ашық кеңістігінде сервис жарияланғаннан кейін ғана қолжетімді болады.
Сервисдің VK Cloud-те қалай жұмыс істейтінін тексеру үшін оны дүкеннің тесттік кеңістігінде тестілеңіз:
-
Сервисді тестілеуге грант алу үшін marketplace@cloud.vk.com мекенжайына хат жіберіңіз. Қаражат VK Cloud-тегі жобаның бонусдық шотына есептеледі.
-
Сервис конфигурациясында көрсетілген тесттік кеңістіктерге кіру мүмкіндігіңіз болмаса, marketplace@cloud.vk.com мекенжайына хат жіберіңіз. Хатта көрсетіңіз:
- JSON сервис конфигурация файлында
metadataпараметрінде көрсетілген Marketplace тесттік кеңістіктерінің атаулары. - Marketplace тесттік кеңістіктеріне кіру қажет болатын пайдаланушының электрондық поштасы.
- JSON сервис конфигурация файлында
-
Өтіңіз VK Cloud жеке кабинетінің Қолданбалар дүкені бөліміне.
-
Барлық шешімдер батырмасын басыңыз.
-
Қызметіңіздің карточкасын басып, Тарифтік жоспарлар қойындысына өтіңіз.
-
Әр тарифтік жоспардың конфигурациялау шебері дұрыс көрсетілетініне көз жеткізіңіз.
-
Сервисті қосыңыз.
-
Сервис инстансын жаңартыңыз:
- Ағымдағы тарифтік жоспардың тарифтік опцияларының мәндерін өзгертіңіз.
- Жаңа тарифтік жоспарға өтіңіз.
-
Сервистің негізгі пайдаланушы сценарийлерін тексеріңіз.
-
Жойыңыз сервис инстансын.
-
Қажет болса, сервис конфигурациясына өзгерістер енгізіңіз:
- Брокер орналасқан директорияның
resourcesішкі директориясына өтіңіз. catalog_<СЕРВИС_АТАУЫ>.jsonжәнеplan_mapping.jsonфайлдарын өңдеңіз.- Тестілеуді тағы бір рет қайталаңыз.
- Брокер орналасқан директорияның
-
Егер тестілеу және отладка кезеңіне сервис конфигурациясында құнның тесттік мәндерін көрсеткен болсаңыз,
catalog_<СЕРВИС_АТАУЫ>.jsonфайлын өңдеп, оған нақты мәндерді көрсетіңіз.
marketplace@cloud.vk.com мекенжайына хат жіберіңіз. Хатта сервис ID-сін және оның ревизиясын көрсетіңіз.
Сервис конфигурациясының модерациясы өткізіледі. Осыдан кейін сервис дүкенде жарияланады.
Жарияланатын сервис ревизиясы дүкеннің тесттік кеңістігінен JSON сервис конфигурация файлында metadata параметрінде көрсетілген ашық кеңістікке ауысады. Сервис осы ашық кеңістікке кіру мүмкіндігі бар барлық пайдаланушыларға қолжетімді болады.
