УвійтиЗамовити брифінг

Розділ 2.7

Встановлення редакції Enterprise і застосування ліцензії

Що змінюється під час встановлення редакції Enterprise, як подати запит на ліцензію з вашого облікового запису Adverant, три способи її імпорту з усіма кодами відмови, а також як Harrow Port Authority перевела свій пілотний проєкт із Community на Enterprise на місці без жодних втрат.

Цю сторінку перекладено за допомогою ШІ з англійського оригіналу. Якщо щось незрозуміло, орієнтуйтеся на англійську версію сторінки. Читати цю сторінку англійською

17 хв читання

Інсталяція редакції Enterprise складається з двох половин, і надходять вони різними шляхами. Образи Enterprise постачаються разом із чартом Enterprise і завантажуються за допомогою токена витягування (pull token). Ліцензія надходить у вигляді підписаного файлу з вашого облікового запису Adverant, і ви імпортуєте її в запущену інсталяцію. Жодна з половин не працює без іншої: образи без ліцензії працюють на базовому рівні Community, а ліцензії без образів Enterprise просто нічого вмикати.

В організації Harrow Port Authority ми виконали це саме в такому порядку — через шість тижнів після пілотного розгортання редакції Community, описаного в розділі 2.6 «Встановлення редакції Community у Kubernetes». Оновлення до чарту Enterprise зайняло одне вікно технічного обслуговування, а імпорт ліцензії — дві хвилини. Цей розділ охоплює обидві частини процесу. Він починається зі встановлення з нуля і закінчується переведенням наявної інсталяції Community без перевстановлення.

Дві паралельні доріжки ведуть до одного блоку праворуч із написом «Інсталяція Enterprise». Верхня доріжка: «Обліковий запис Adverant: Завантаження» веде до «Чарт Enterprise та його файл фіксації образів», а потім до «helm install або helm upgrade, edition: enterprise», до якого приєднано бічний блок «токен витягування на кожному вузлі». Нижня доріжка: «Обліковий запис Adverant: Розгортання» веде до «підписаний файл ліцензії», а потім до «імпорт у запущену інсталяцію». Обидві доріжки сходяться в правому блоці. Під ним розташовано підпис: «образи без ліцензії працюють на базовому рівні Community».
Дві половини інсталяції Enterprise та звідки походить кожна з них.

Відмінності від Community

Два значення та чарт, який їх зчитує.

# harrow-values.yaml (Helm values, Enterprise: only these two keys change)
edition: enterprise
enterprise:
  enabled: true

Усе інше у файлі значень залишається точно таким, як і було, насамперед назва інсталяції та зберігачі ключів (custodians). Ці два ключі мають узгоджуватися між собою, і чарт відхиляє edition: enterprise з enterprise.enabled: false або навпаки.

Редакція також повинна відповідати файлу фіксації образів (images lock) чарту. Кожен пакет чарту містить файл фіксації для однієї редакції, і у файлі для Enterprise перелічено образи Community плюс збірки Enterprise. Якщо вказати файл значень Enterprise для чарту Community, рендеринг зупиниться з помилкою files/images.lock.json is the community lock; this install is edition enterprise. Отже, для встановлення Enterprise потрібен саме чарт Enterprise.

Чарт і пакет Enterprise доступні на сторінці «Завантаження» (Downloads) вашого облікового запису Adverant, яка відкривається відповідно до вашої ліцензії. Файл чарту має таку саму назву, як і для редакції Community — nexus-1.0.0-alpha.1.tgz, тому зберігайте їх у різних папках. Перевірте його достовірність точно так, як описано в розділі 2.4 «Отримання та перевірка релізу», за допомогою ключа релізу, відбиток якого ви звірили:

nexusctl verify enterprise/nexus-1.0.0-alpha.1.tgz
tar -xzf enterprise/nexus-1.0.0-alpha.1.tgz -C enterprise
jq -r '.version, .edition' enterprise/nexus/files/images.lock.json
1.0.0-alpha.1
enterprise

Потім запустіть цикл перевірки підписів із розділу 2.4 «Отримання та перевірка релізу» для файлу enterprise/nexus/files/images.lock.json. Він охоплює як образи Enterprise, так і спільні образи.

Токен завантаження

Образи Community є публічними. Образи Enterprise потребують токена витягування зі сторінки «Токени витягування та команди встановлення» (Pull tokens and install commands) вашого облікового запису, налаштованого для середовища виконання контейнерів на ваших вузлах, як показано в розділі 2.4 «Отримання та перевірка релізу», крок 3. У k3s це запис configs для registry.adverant.ai у файлі /etc/rancher/k3s/registries.yaml на кожному вузлі.

Створіть по одному токену на кластер і призначте йому дату закінчення терміну дії, яку ви не пропустите. Коли термін дії токена минає, запущені поди продовжують працювати, але под, перенесений на вузол, де ще немає потрібного образу, не зможе його завантажити. Ми вносимо дату закінчення дії токена в той самий календар, що й для сертифікатів.

Чисте встановлення Enterprise

Якщо ви встановлюєте редакцію Enterprise з нуля, дотримуйтесь покрокових інструкцій у розділі 2.6 «Встановлення редакції Community у Kubernetes» із трьома відмінностями:

  1. Розмістіть токен витягування на кожному вузлі перед кроком 6.

  2. Використайте значення для Enterprise (два ключі, наведені вище) на кроці 4.

  3. На кроці 6 виконайте встановлення із завантаженого файлу чарту Enterprise:

    helm install nexus enterprise/nexus-1.0.0-alpha.1.tgz \
      --namespace nexus -f harrow-values.yaml --timeout 45m

Усе, що відбувається після команди встановлення, є таким самим, як у розділі 2.6 «Встановлення редакції Community у Kubernetes», включно з правилом щодо --wait: не використовуйте його. Якщо натомість ви встановлюєте за допомогою nexusctl, додайте до команди --edition enterprise:

nexusctl install --context harrow-prod --values harrow-values.yaml --edition enterprise

Коли всі робочі навантаження будуть готові, пройдіть процедуру першого запуску, описану в розділі 2.12 «Перший запуск». Ліцензія — це один із шести пунктів, які консоль виводить у списку до того, як будь-хто увійде в систему. Поки її не імпортовано, інсталяція працює на базовому рівні Community, а всі розділи Enterprise відображаються неактивними (сірим кольором) зі значком замка.

Запит на ліцензію

Ліцензія від Adverant видається для ідентифікатора однієї конкретної інсталяції — того самого, який сховище ключів згенерувало під keys.installationName під час встановлення. Тому обліковому запису потрібно знати, яку саме інсталяцію ви маєте на увазі, перш ніж він зможе випустити ліцензію.

  1. Увійдіть до свого облікового запису Adverant за адресою https://account.adverant.ai.
  2. В інсталяції відкрийте «Ця інсталяція» (This installation), а потім — «Ліцензія» (Licence). Там буде показано одноразовий код і відбиток інсталяції.
  3. У своєму обліковому записі відкрийте «Прив'язати розгортання» (Claim a deployment) і введіть цей код. Потім порівняйте відбиток, отриманий обліковим записом, із тим, який показує інсталяція, групу за групою; кожна група має збігатися.
  4. Натисніть кнопку прив'язки. Інсталяція з'явиться в розділі «Розгортання» (Deployments) вашого облікового запису разом зі своєю версією та станом ліцензії.
  5. Adverant випускає ліцензію для цієї інсталяції. Завантажте файл зі свого облікового запису; його названо за ідентифікатором ліцензії — <licence-id>.json.

Код прив'язки діє один раз і протягом короткого часу. Якщо його термін дії закінчиться, обліковий запис відхилить його з помилкою CLAIM_CODE_EXPIRED, а інсталяція покаже новий код.

Прив'язати розгортання
Прив'язати розгортання
Прив'язка розгортання в обліковому записі Adverant. Спочатку вводиться одноразовий код, а потім звіряється відбиток групами по чотири символи, щоб ніхто не міг прив'язати інсталяцію, перед якою він безпосередньо не знаходиться.

Існують ще два шляхи, і обидва детально описані в розділі 2.13 «Ліцензії». Програмно-апаратні комплекси (appliances) та периферійні комплекти (edge kits) не мають екрана для відображення коду, тому їх прив'язують за допомогою ключа прив'язки, надрукованого на коробці, який вводять на сторінці «Ввести ключ прив'язки» (Enter a claim key) або зчитують із файлу замовлення виробника. Інсталяція без виходу в зовнішню мережу використовує «Офлайн-обмін» (Offline exchange): вона створює підписаний файл запиту на ліцензію, ви переносите його до свого облікового запису, а назад приносите файл ліцензії. Раз на рік вона таким самим чином формує підписаний звіт про використання. Кожен файл під час такого обміну підписується, тому файл, змінений у дорозі, відхиляється з помилкою LICENCE_REQUEST_SIGNATURE_INVALID для запиту та USAGE_FILE_SIGNATURE_INVALID для файлу використання.

Офлайн-обмін
Офлайн-обмін
Офлайн-обмін в обліковому записі Adverant. Підписані файли переносяться вручну в обох напрямках, і файл, змінений під час передавання, відхиляється із зазначенням конкретної причини.

Що містить файл ліцензії

Ліцензія — це документ JSON у форматі nexus-licence/v1, двічі підписаний компанією Adverant двома незалежними ключами. Вам не потрібно читати його вручну, але корисно знати, що в ньому міститься, коли хтось запитає, що саме ви придбали.

Поле Що це означає
licence_id Власний ідентифікатор ліцензії — UUID (універсальний унікальний ідентифікатор) у нижньому регістрі
type alpha, evaluation або commercial
licensee Назва організації та ідентифікатор клієнта Adverant
scope Інсталяція, для якої видано ліцензію, та будь-які організації, зазначені в дозволі
edition enterprise
grants Групи функцій, які вона розблоковує, кожна для всієї інсталяції або для вказаних організацій
add_ons та domain_packs Можливості, що ліцензуються окремо; однією з них є пакет «Логістика та морські перевезення» (Logistics and maritime pack)
metric Спосіб підрахунку ліцензії — named-seat, per-core або per-environment — та кількість
term starts_on, ends_on, а також кількість днів попередження та пільгового періоду
matrix Версія матриці редакцій, відповідно до якої створено ліцензію
signatures Два підписи Adverant

Ознайомча ліцензія діє щонайбільше 30 днів, максимум для п'яти визначених користувачів і без пільгового періоду. Комерційна ліцензія видає попередження за 30 днів до закінчення терміну дії, а потім за замовчуванням надає 30 днів пільгового періоду. Що відбувається на кожному етапі цієї послідовності, описано в розділі 2.13 «Ліцензії».

Підписи захищають документ саме в тому вигляді, в якому його створила система Adverant. Передавайте його точно таким, яким ви його отримали; не відкривайте його в редакторі, який може автоматично змінити форматування.

Імпорт ліцензії

Імпортувати ліцензію може лише адміністратор інсталяції: власник або адміністратор усієї організації, якій належить інсталяція, увійшовши до неї. Повний адміністратор платформи також може її імпортувати. Ліцензія ніколи не передається як значення чарту чи файл, змонтований у под. Вона надходить до служби входу, nexus-auth, яка перевіряє її офлайн за допомогою кореневих сертифікатів довіри, вбудованих у її власний образ, і записує її в межах однієї транзакції. Імпортувати ліцензію можна трьома способами, і всі вони ведуть до одного результату.

У консолі

Під час першого запуску відкрийте «Шість кроків до першого входу в систему» (Six things before anyone signs in), а потім — «Ліцензія» (Licence). Сторінка «Імпортувати ліцензію» (Import the licence) приймає файл: перетягніть його на сторінку або виберіть вручну. Сторінка перевіряє його офлайн на самій інсталяції, а потім виводить список груп функцій, які він відкриває, із зазначенням способу захисту кожної з них і терміну дії. Групи, не включені до ліцензії, залишаються у списку неактивними (сірим кольором).

Пізніше для такого самого імпорту використовується кнопка Імпортувати нову ліцензію (Import a new licence) на сторінці ліцензії інсталяції. Коли термін дії ліцензії закінчився, сторінка обмеженої ліцензії пропонує кнопку Імпортувати поновлену ліцензію (Import a renewed licence).

Імпортувати ліцензію
Імпортувати ліцензію
Імпорт ліцензії в консолі. Файл перевіряється безпосередньо в інсталяції; сторінка показує, що саме він розблоковує за групами функцій, а файл, який не пройшов перевірку підпису, вважається відсутнім і супроводжується відповідним кодом помилки.

За допомогою nexusctl

nexusctl licence import <licence-id>.json

Команда nexusctl надсилає файл без змін на маршрут імпорту інсталяції від імені адміністратора інсталяції та повідомляє стан ліцензії або код відмови з таблиці нижче.

Через API

Маршрут імпорту є частиною програмного інтерфейсу (API) служби входу за вашою адресою hosts.auth. Тілом запиту є документ ліцензії, байт у байт:

curl -sS -X POST https://auth.harrow.example/api/v1/installation/licence \
  -H "authorization: Bearer <admin-token>" \
  -H "content-type: application/json" \
  --data-binary @<licence-id>.json

<admin-token> — це токен доступу авторизованого адміністратора інсталяції. Використовуйте --data-binary і ніколи не використовуйте -d, оскільки цей параметр видаляє символи перенесення рядка і, відповідно, змінює байти, які ви надсилаєте. Маршрут не приймає рядків запиту (query string) і нічого в тілі запиту, крім самого документа; тіло запиту, яке намагається вказати організацію або особу на верхньому рівні, відхиляється ще до зчитування даних.

У разі успішного імпорту повертається відповідь 201 Created. У скороченому вигляді тіло відповіді виглядає так:

{
  "licence": {
    "licence_id": "<licence-id>",
    "state": "licensed",
    "edition": "enterprise",
    "licensee": {"name": "Harrow Port Authority", "customer_id": "<customer-id>"},
    "term": {"starts_on": "2026-12-01", "ends_on": "2027-11-30", "warn_days": 30, "grace_days": 30},
    "groups": ["enterprise-base", "..."]
  },
  "organizations": 1,
  "tenants_without_organisation": 0
}

organizations підраховує організації в інсталяції, які тепер мають цю ліцензію. tenants_without_organisation підраховує організації, зазначені в ліцензії, яких немає в цій інсталяції.

Коли імпорт відхилено

Відхилений імпорт нічого не змінює: жоден рядок не записується, а чинна ліцензія, якщо вона є, залишається незмінною. Журнал аудиту інсталяції фіксує кожну спробу, включно з відхиленими.

Код Статус Що це означає Що робити
LICENCE_SIGNATURE_INVALID 422 Один із двох підписів Adverant відсутній або не проходить перевірку; файл було змінено після підписання Запитайте файл в Adverant повторно; не редагуйте його
LICENCE_FORMAT_INVALID 422 Файл не є ліцензією, яку може прочитати цей реліз Надішліть файл точно в тому вигляді, в якому його надала система Adverant
LICENCE_ROOT_UNKNOWN 422 Файл підписано ключем, якому ця інсталяція не довіряє Запитайте ліцензію, підписану для кореневих сертифікатів довіри цього релізу, або оновіть систему
LICENCE_MATRIX_MISMATCH 422 Ліцензію створено для матриці редакцій, яку цей реліз не підтримує, або вона надає доступ до групи функцій, невідомої цьому релізу Оновіть систему або запитайте ліцензію, створену для цього релізу
LICENCE_OTHER_INSTALLATION 409 Ліцензію було видано для іншої інсталяції Запитайте ліцензію, видану для ідентифікатора цієї інсталяції
TRANSITION_NOT_PERMITTED 409 Ліцензію з цим ідентифікатором уже було імпортовано; кожна ліцензія імпортується лише один раз Запитайте в Adverant нову ліцензію, якщо потрібно змінити умови
LICENCE_REVOKED 403 Компанія Adverant відкликала цю ліцензію Запитайте в Adverant нову ліцензію
LICENCE_LOCKED 403 Термін дії ліцензії ще не настав; до того часу діє базовий рівень Community Імпортуйте її знову в перший день дії або пізніше
RECORD_NOT_FOUND 404 Інсталяцію ще не оголошено, тому вона не має ідентифікатора для звірки Завершіть крок першого адміністратора (розділ 2.12 «Перший запуск»), а потім виконайте імпорт
VALIDATION_FAILED 400 Тіло запиту неможливо прочитати, його розмір перевищує 1 MiB або було надіслано рядок запиту Надішліть файл як єдиний вміст тіла запиту, без параметрів у рядку запиту

Під час успішного імпорту може повернутися ще один код — як повідомлення, а не відмова: LICENCE_CLOCK_BEHIND_FLOOR означає, що годинник інсталяції показує час, раніший за останній зафіксований нею час, тому ліцензія оцінюється за цим пізнішим часом. Переведення годинника назад ніколи не відновлює прострочену ліцензію. Знизити цей поріг часу може лише токен скидання часу, підписаний Adverant спеціально для цієї інсталяції.

Перехід із Community на Enterprise на місці

Саме так ми зробили в Harrow. Нічого не перевстановлюється і нічого не мігрується: це та сама інсталяція, з тим самим ідентифікатором і тими самими даними, просто в ній увімкнено більше можливостей. Назва інсталяції та зберігачі ключів залишаються точно такими, як і були; під час оновлення хук зберігання (custody hook) перевіряє, чи сховище ключів уже ініціалізовано, і більше нічого не робить.

  1. Розмістіть токен витягування на кожному вузлі та перезапустіть там середовище виконання контейнерів.

  2. Завантажте чарт Enterprise із розділу «Завантаження» (Downloads) та перевірте його і його образи, як описано вище.

  3. Змініть два значення у вашому наявному файлі значень: edition: enterprise та enterprise.enabled: true. Більше нічого не змінюйте.

  4. Запустіть попередню перевірку (preflight) із новим файлом.

    nexusctl preflight --context harrow-prod --values harrow-values.yaml
  5. Оновіть реліз до чарту Enterprise, знову ж таки без --wait.

    helm upgrade nexus enterprise/nexus-1.0.0-alpha.1.tgz \
      --namespace nexus -f harrow-values.yaml --timeout 45m

    Під час оновлення хуки запускаються перед розгортанням нових подів, і кожна міграція застосовує лише ті файли, які вона ще не застосовувала раніше. Згенеровані секрети зчитуються з інсталяції та зберігаються. Helm завершує роботу повідомленням:

    NAME: nexus
    NAMESPACE: nexus
    STATUS: deployed
    REVISION: 2
  6. Дочекайтеся готовності робочих навантажень, точно як описано в розділі 2.6 «Встановлення редакції Community у Kubernetes», крок 7.

    kubectl -n nexus wait --for=condition=Available deploy --all --timeout=900s
  7. Імпортуйте ліцензію одним із трьох наведених вище способів.

  8. У консолі відкрийте «Ця інсталяція» (This installation), далі «Ліцензія» (Licence), а потім — «Перейти на Enterprise» (Move to Enterprise). Сторінка зчитує ліцензію і показує, що буде завантажено та що зміниться, перш ніж відбудуться будь-які дії. Вона також підраховує користувачів і вміст організації та позначає все це як збережене. Натисніть Завантажити та увімкнути (Fetch and switch on). Кожен компонент перевіряється за ключем релізу Adverant перед використанням, і групи функцій вмикаються одна за одною.

Наше вікно обслуговування становило одну годину; сама робота в його межах зайняла близько двадцяти хвилин, більшу частину з яких тривало очікування оновлення схеми під час виконання хуків. Наступного ранку учасники пілотного проєкту увійшли в те саме робоче середовище, де розділи меню Enterprise більше не були неактивними.

Від Community до Enterprise
Від Community до Enterprise
Переведення інсталяції Community на редакцію Enterprise. Сторінка підтверджує справжність ліцензії та виводить список того, що буде завантажено, ще до початку завантаження; користувачі та файли організації позначаються як збережені.

Після імпорту

На сторінці ліцензії в розділі «Ця інсталяція» (This installation) перелічено кожну групу функцій у ліцензії разом із кількістю місць та терміном дії. Там також зазначено, як саме постачається кожна частина: наприклад, скомпільована та ліцензована для групи Enterprise або з відкритим вихідним кодом для базового рівня Community. Групи поза межами ліцензії залишаються у списку неактивними. Адміністратори можуть звузити доступ до групи функцій усередині організації; розширити те, що надає ліцензія, не може ніхто, крім Adverant.

Стан ліцензії обчислюється заново на основі документа та поточної дати під час кожного зчитування, тому закінчення терміну дії відбувається без окремого запланованого завдання. Усі користувачі інсталяції бачать однакове повідомлення в консолі з наближенням кінцевої дати: LICENCE_ENDS_SOON за 30 днів до закінчення, а потім LICENCE_IN_GRACE протягом пільгового періоду. Учасники бачать повідомлення та дати; саму ліцензію бачать лише адміністратори інсталяції. У розділі 2.13 «Ліцензії» описано процес поновлення та етапи закінчення терміну дії.

Ліцензія та що вона відкриває
Ліцензія та що вона відкриває
Це сторінка ліцензії інсталяції Enterprise. Показники у верхній частині відображають кількість місць і термін дії; під ними перелічено кожну групу функцій із зазначенням способу її захисту, а групи, що не входять до ліцензії, залишаються неактивними (сірим кольором).

Якщо виникне помилка

Що ви бачите Причина Що робити
edition=enterprise but enterprise.enabled=false: they must agree Було змінено лише один із двох ключів Змініть обидва
files/images.lock.json is the community lock; this install is edition enterprise Було використано чарт Community Використайте чарт Enterprise із розділу «Завантаження» (Downloads)
image ... is a enterprise image; a community install takes only community images Назва образу Enterprise потрапила в рендеринг редакції Community Перевірте edition та папку чарту
ImagePullBackOff для образу Enterprise після оновлення На вузлі немає токена витягування або термін дії токена закінчився Перевірте registries.yaml на цьому вузлі або створіть новий токен
Код відмови ліцензії Див. таблицю відмов вище Дотримуйтесь інструкцій у відповідному рядку; нічого не було змінено

Коли на сторінці ліцензії відображається редакція Enterprise та очікувані вами групи, інсталяцію ліцензовано. Наступна зупинка — перший запуск у розділі 2.12 «Перший запуск», якщо ви ще не прив'язали інсталяцію. Якщо ви вже це зробили, асистенту все одно потрібні власні ключі моделей штучного інтелекту (ШІ) організації, перш ніж він зможе будь-кому відповідати. У розділі 2.14 «Провайдери та моделі ШІ» показано, як їх підключити.