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

Розділ 2.2

Редакції зсередини

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

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

17 хв читання

Два рядки у файлі значень визначають, яку редакцію запускає інсталяція:

# harrow-values.yaml (Helm values): the edition of this installation
edition: enterprise
enterprise:
  enabled: true

Вони повинні узгоджуватися. Якщо задати edition: community разом із enterprise.enabled: true, чарт зупиниться з повідомленням «edition=community but enterprise.enabled=true: they must agree». Якщо задати для edition будь-яке значення, крім community або enterprise, він зупиниться з помилкою NEXUS_EDITION_INVALID. Ці два значення визначають, які образи використовує інсталяція. Те, що ці образи потім вмикають, — це вже справа ліцензії під час виконання, по одній групі функцій за раз.

У цьому розділі ми розберемо це детально: що містять редакції, як один продукт перетворюється на дві збірки, як ліцензія стає дозволом або відмовою всередині запущеного сервісу і що це означає, коли ви створюєте власне рішення. У розділі 1.6 «Редакції та ліцензії простими словами» подано погляд покупця; тут — погляд інженера.

Матриця редакцій

Усе описане в цьому розділі походить з одного файлу — матриці редакцій. Вона містить перелік із 97 можливостей і призначає кожній рівень. На її основі Adverant генерує каталог ліцензій і правила меню консолі, а також межу між відкритим і закритим кодом. Коли змінюється матриця, усе це змінюється разом із нею.

Існує три редакції.

Редакція Ліцензія Де працює
Community Apache-2.0, відкритий вихідний код, безкоштовно Ваше обладнання або хмара Adverant
Team Ліцензія Adverant Enterprise Хмара Adverant: Community плюс набір Team
Enterprise Ліцензія Adverant Enterprise, за групами функцій Ваше обладнання або хмара Adverant

Інсталяція запускає одну з двох: значення edition у чарті приймає лише community та enterprise. Team — це хмарна редакція, а Enterprise також включає набір Team, тому на вашому власному обладнанні можливості Team (робоча панель, закріплена біля кожного запису, спільні блокноти, політика пам'яті для організації та інше) постачаються у складі Enterprise.

Сама редакція Enterprise є багаторівневою. База Enterprise — це закрите ядро: декілька організацій і бізнес-підрозділів, примусовий єдиний вхід (SSO) із SAML (Security Assertion Markup Language) і синхронізацією каталогів, користувацькі ролі із затвердженням за принципом чотирьох очей, тривале зберігання журналів аудиту, захист даних, сторінки оператора та керування кластером. Поверх бази розташовуються доповнення, кожне з яких ліцензується окремо, та галузеві пакети. Перше доповнення в таблиці, AI Gateway at scale, розподіляє навантаження маршрутизатора ШІ (штучного інтелекту) між репліками та провайдерами.

Доповнення Також потребує
Шлюз ШІ у масштабі База
Фабрика моделей База
Ідеї База
Дзвінки та голос База
Пошта База
Інші компанії та інформаційні бар'єри База
Студія нотатника База
Карта та GeoAI База
Конектори даних База
Взаємодія між агентами База
Кімнати рішень і запечатані записи База
Операції з доходами База
Вітрина / White-label База
Nexus Edge База
Мобільні застосунки База
Цифровий штат (Workforce) База; агентам на периферійних пристроях також потрібен Nexus Edge, а для затверджень на телефоні також потрібні Мобільні застосунки
Щит (Shield) База
Пісочниці База
Якість (NexusQA) База

Існує десять галузевих пакетів:

  • Страхування
  • Банківська справа та платежі
  • Ринки капіталу та управління активами
  • Державне управління та державний сектор
  • Охорона здоров'я
  • Науки про життя
  • Критична інфраструктура та енергетика
  • Оборона та безпека
  • Юридичні та професійні послуги
  • Логістика та морські перевезення

Кожному пакету потрібна база Enterprise, а п'ятьом із них також потрібне доповнення. Пакету «Страхування» потрібні «Кімнати ухвалення рішень і опечатані записи». Те саме стосується пакета «Ринки капіталу та управління активами». Пакету «Юридичні та професійні послуги» потрібні ці два доповнення плюс «Пошта». Пакету «Логістика та морські перевезення» потрібні «Карти та GeoAI». У пакеті «Оборона та безпека» для сповіщень платформи також потрібен Nexus Edge. Екранам для телефонів у будь-якому пакеті також потрібні «Мобільні застосунки». У розділі 1.7 «Галузеві пакети та вертикалі» описано вміст кожного з них.

Групи функцій

Одиницею, яку зазначає ліцензія, є група функцій. Усього їх 32: базовий рівень Community, набір Team, база Enterprise, по одній на кожне доповнення та по одній на кожен пакет. Кожна можливість належить рівно до однієї групи, тому ліцензія зі списком «Enterprise base, Map and GeoAI, Logistics and maritime» точно визначає, які саме можливості може запускати ця інсталяція.

Рівень Можливості
Community 36
Team 6
База Enterprise 18
Додаткові модулі 23
Галузеві пакети 14

Обсяг надання прав

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

  • Обсяг тенанта охоплює частини, у яких працюють люди: Ідеї, Пошта, Операції з доходом, пакети. Ліцензія робить їх доступними для інсталяції, а потім вони вмикаються або вимикаються для кожної організації та кожного бізнес-підрозділу. Нова організація ніколи не успадковує стан «усе увімкнено».
  • Обсяг розгортання охоплює п'ять речей, які належать інсталяції загалом: імпорт ліцензії разом з артефактами, які він завантажує, форми постачання Enterprise, сторінки оператора, керування кластером та Nexus Edge.

Можливості Community взагалі не мають обсягу надання прав. Їм не потрібна ліцензія.

Адміністратор може звузити те, що дозволяє ліцензія, для організації чи підрозділу. Ніхто не може розширити ці межі зсередини інсталяції.

Вертикальний стек із шести смуг. Знизу вгору: «Базовий рівень (кожна редакція, ніколи не закривається платним доступом)»; «Community, Apache-2.0»; товста подвійна лінія з підписом «@adverant/nexus-spi, єдиний спільний інтерфейс»; «База Enterprise, закриті модулі»; «Доповнення (19), кожне ліцензується окремо»; «Галузеві пакети (10)». Праворуч — блок «Підписаний документ ліцензії» зі стрілкою, спрямованою до трьох верхніх смуг, із підписом «перевіряється всередині кожного закритого модуля». Ліворуч від смуги Community — примітка «Образи Community: лише відкритий вихідний код».
Редакції як рівні, де документ ліцензії є єдиним джерелом повноважень.

Один продукт, дві збірки

Існує єдина кодова база Nexus. Збірка Community — це її експорт із відкритим вихідним кодом, а збірка Enterprise — це той самий експорт плюс закриті модулі.

Список розмежування відносить кожен відстежуваний файл до певної редакції. Здебільшого він робить це, вказуючи можливість, яку реалізує файл, а редакція файлу випливає з рівня цієї можливості: можливість Community робить файл частиною Community, а будь-що з Team, бази, доповнення чи пакета робить його файлом Enterprise. Файли, які не постачаються в жодній редакції, наводяться із зазначенням причини. Одне правило перетинає всі інші: міграції баз даних кожного модуля постачаються в обох редакціях. Тож база даних Community і база даних Enterprise мають однакову схему, а перехід інсталяції з однієї редакції на іншу — це лише зміна того, що увімкнено, без потреби в міграції даних.

Експорт Community містить заголовки Apache-2.0 та файл NOTICE, і кожен пакет у ньому ліцензовано за Apache-2.0, за винятком стороннього коду, який зберігає власну ліцензію (MIT, BSD та інші) і копіюється без змін, а також кількох пакетів набору засобів розробки ПЗ (SDK) та інтерфейсу командного рядка (CLI), які зберігають власну ліцензію MIT. Збірка Enterprise ліцензується за ліцензією Adverant Enterprise. Її умови дозволяють використання лише за наявності письмової ліцензії, протягом терміну, для розгортань і груп функцій, зазначених у цій ліцензії. Заборона на зворотну розробку (реверс-інжиніринг) прямо зберігає права, які надає вам законодавство ЄС на вивчення програмного забезпечення та його декомпіляцію для забезпечення сумісності.

Лінія ліцензування

Код Enterprise звертається до Community лише через один пакет: @adverant/nexus-spi, інтерфейс постачальника послуг (SPI). Він має ліцензію Apache-2.0 і містить інтерфейси та захисники типів (type guards) без власної логіки часу виконання.

Експорт Що це таке
RouteModule Ліцензований модуль маршрутів: його ідентифікатор, його група функцій, тіла запитів, які він читає, та register(app, ctx)
SpiApp Частина HTTP-застосунку хоста, з якою взаємодіє модуль: use
SpiContext Що хост передає модулю: продуктовий шлюз і захисник обсягу прав, засіб читання ліцензій, пул запитів з обмеженою областю дії, вихідні адреси, клієнти платформи
SpiRuntime Значення SDK (набору засобів розробки ПЗ) плагіна, які хост передає модулю
SpiPlane Групи екранів і операції читання екранів, які додає ліцензована площина
ScreenModule Ліцензована група екранів консолі: її маршрути, екрани та меню
GrantCheck Перевірка, яку ліцензований модуль виконує для власної групи функцій

Перевірка під час збирання забезпечує дотримання цієї лінії. Усередині коду Enterprise імпорт з областей пакетів Community (@adverant/ та @adverant-nexus/) перериває збирання з помилкою, якщо це не @adverant/nexus-spi або пакет Enterprise. Так само збирання переривають відносний імпорт, що виходить за межі репозиторію, залежність file:, link: або workspace:, яка вказує за його межі, URL-адреса Git із назвою репозиторію Community, а також директива Go replace, що вказує за межі репозиторію. Через цю лінію зв'язок здійснюється лише за допомогою мережевого протоколу або модуля, що завантажується під час запуску, і ніколи — через спільний вихідний код. SPI навіть містить власну закріплену копію декларацій типів SDK плагіна, оскільки SDK є пакетом Community, який ця лінія не пропускає; натомість хост передає модулю значення часу виконання SDK.

Профілі збирання

Консоль і BFF (backend for frontend) компілюються з профілем збирання, який фіксує класи коду всередині образу. Профіль Community містить код Community; профіль Enterprise містить код Community та Enterprise. Кожен із них відмовляється запускатися, якщо його профіль містить код, якого немає в редакції інсталяції. BFF повідомляє про це помилкою PROFILE_OUTSIDE_EDITION і вказує образ, який потрібно розгорнути натомість. Ви не можете встановити консоль Enterprise на інсталяцію Community шляхом простої зміни тегу образу.

Ліворуч — один блок «Вихідний код Nexus» із меншим блоком усередині нього «матриця редакцій». Стрілка з підписом «список розмежування» роздвоюється. Верхня стрілка веде до «Експорт Community (Apache-2.0)» і далі до «Образи Community». Нижня стрілка веде до «Збірка Enterprise», яка також приймає стрілку від «Експорт Community» та стрілку від блока «закриті модулі» і створює «Образи Enterprise». Між закритими модулями та експортом Community розташований бар'єр із підписом «лінія ліцензування: лише @adverant/nexus-spi». Невелика примітка під обома блоками образів гласить: «однакова схема бази даних».
Як одне дерево вихідного коду стає двома редакціями.

Як ліцензія вмикає групи функцій

Ліцензія — це підписаний документ. Adverant підписує кожну ліцензію двома незалежними ключами, і ніщо інше в інсталяції не вирішує, що саме ліцензовано. Ви імпортуєте її через сторінки «Ліцензія» в консолі, за допомогою nexusctl licence import <file> або надіславши документ запитом POST на https://<hosts.auth>/api/v1/installation/licence. Ліцензія ніколи не є значенням чарту і ніколи не є змонтованим файлом. У розділі 2.13 «Ліцензії» описано імпорт і поновлення, а також кожен стан, через який проходить ліцензія.

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

type GrantCheck = (featureGroup: string) => Promise<{ entitled: boolean; code?: "LICENCE_LOCKED" }>;

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

Самі модулі також перевіряються. Служба nexus-keys зберігає підписаний маніфест компонентів релізу та ключ, яким його підписано. Вона звіряє кожен скомпільований модуль із цим маніфестом під час запуску та щоночі о 03:53 UTC. Модуль, підпис якого не збігається, ніколи не завантажується, а підписана копія, яку він мав замінити, продовжує працювати; на сторінках оператора це відображається з кодом MODULE_SIGNATURE_INVALID.

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

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

Стан Що бачить користувач
Дозволено Елемент керування відображається звичайним чином
Тизер Елемент керування неактивний (сірий) зі значком замка; під час його відкриття пояснюється, що це таке і хто може це увімкнути
Приховано Нічого; використовується лише для речей, про існування яких роль цієї людини не повинна знати, як-от приватна поштова скринька іншого користувача
Відмовлено з кодом Плашка відмови із зазначенням коду, коли хтось намагається виконати недозволену дію

Ліцензія також має власні стани в міру наближення та настання дати завершення її дії. У кожному з них діють два правила: ліцензія ніколи не зупиняє запущену роботу, а виправлення безпеки ніколи не блокуються.

Що показує Community для сторінки Enterprise

Інсталяція Community зберігає форму продукту. Меню має ті самі рядки, що й в Enterprise, а пункти Enterprise (Ідеї, Рішення, Пошта, Дзвінки, Інші компанії, Агенти, Політики, Відповідність вимогам) відображаються сірим кольором зі значком замка. Нічого не ховається, щоб створити видимість повної редакції, і немає жодних нав'язливих нагадувань.

Відкриття заблокованого рядка показує тизер. Для розділу «Ідеї» там написано «Ідеї є частиною Enterprise», далі йде один абзац про те, що робить модуль «Ідеї», а потім — «Хто може це увімкнути: ваш адміністратор за допомогою ліцензії від Adverant». Пропонуються дві кнопки: «Звернутися до адміністратора» та «Подивитися, як це працює». Ціни немає. Відкриття сторінки нічого не завантажує і нічого не надсилає, а ця пропозиція показується лише один раз.

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

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

LICENCE_LOCKED
This page is part of Nexus Enterprise. This installation runs Nexus Community,
so the page is not here and nothing was read.
- To use it, the installation needs Nexus Enterprise: an administrator can ask Adverant about it
- Every page this installation holds is in the menu

Код наведено для довідки; текстові пояснення призначені для людини, яка це читає.

Базовий рівень

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

Від Community до Enterprise
Від Community до Enterprise
Імпорт ліцензії в інсталяції Community показує, що буде завантажено, що зміниться і що збережеться, перш ніж будь-що відбудеться. На кнопці написано «Завантажити та увімкнути», і нічого не завантажується, доки її не натиснуто.

Образи за редакціями

Кожен образ у релізі перелічено за дайджестом у файлі блокування образів чарту, і сам цей файл блокування належить одній редакції. Чарт звіряє кожен образ, який він генерує, з файлом блокування та із запитаною вами редакцією. Інсталяція Community приймає лише образи Community. Якщо запитати щось інше, вона зупиниться з повідомленням: «a community install takes only community images». Файл блокування Enterprise містить образи Community плюс збірки Enterprise.

Це має значення для того, звідки ви завантажуєте образи. Образи Community є публічними та доступні за адресою registry.adverant.ai/nexus/<service>@sha256:…. Образи Enterprise надходять із того самого реєстру за допомогою токена завантаження (pull token), який ви отримуєте на сторінці «Токени завантаження та команди встановлення» вашого облікового запису Adverant. Інсталяції Community цей токен ніколи не потрібен, і вона ніколи не містить жодного байта закритого коду.

Шлях оновлення зберігає інсталяцію. Коли адміністратор Community імпортує ліцензію Enterprise, консоль зчитує та перевіряє її, а потім показує компоненти, які вона завантажить (скомпільовані модулі, а також пакети й доповнення, зазначені в ліцензії), разом з їхніми розмірами. Кожен компонент перевіряється за ключем релізу Adverant, і групи функцій вмикаються по одній. Користувачі та файли залишаються без змін, як і робочі процеси та канали, оскільки схема бази даних уже була однаковою. У розділі 2.7 «Встановлення Enterprise та застосування ліцензії» цей процес покроково розглянуто для Kubernetes; ізольовані (air-gapped) майданчики імпортують ті самі компоненти з носіїв, як описано в розділі 2.10 «Встановлення в ізольованому середовищі».

Форми постачання та класи захисту

Nexus постачається в шести формах, які в матриці називаються SKU (stock-keeping units — одиниці складського обліку). П'ять із них, окрім Edge, використовують один спільний підписаний пакет і відрізняються лише пакуванням та способом надходження ліцензії.

SKU Що це таке Як надходить ліцензія
saas Хмара Adverant Видається разом із підпискою
onprem-connected Helm у ваш власний Kubernetes Завантажується інсталяцією через її вихідне з'єднання
airgap Той самий пакет, імпортований офлайн Імпортується як файл, із підписаним звітом про використання раз на рік
self-serve-image Образ машини у вашому власному хмарному обліковому записі Сам образ містить лише ліцензії Community та ознайомчі ліцензії; модулі Enterprise надходять після видачі ліцензії, зокрема придбаної через магазин хмарного провайдера
appliance Обладнання, створене виробником оригінального обладнання (OEM), який є його офіційним виробником Ліцензія Enterprise; програмно-апаратний комплекс є однією з форм її постачання
edge Nexus Edge, корисне навантаження на супутниках і дронах або на суднах і транспортних засобах Одна ліцензія на платформу або флот, довгострокова, дійсна в режимі офлайн

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

Клас Що це означає
P1, ніколи не постачається Логіка виконується на боці Adverant; інсталяція містить підписаний клієнт.
P2, опечатаний Конфіденційна віртуальна машина (VM), у яку ви не можете увійти, на обладнанні, до якого ви не маєте фізичного доступу.
P3, захищений нативний код Скомпільований, очищений від символів налагодження та зібраний індивідуально для кожного ліцензіата. Це підвищує витрати часу на читання коду з годин до тижнів.
P4, читабельний Звичайний JavaScript або TypeScript, як у відкритому вихідному коді.
Клас захисту Хмара Adverant Локально з підключенням (Connected on-prem) Ізольоване середовище (Air-gap) Nexus Edge
Відкритий вихідний код (увесь Community) P4 P4 P4 P4
Код найвищої цінності: оцінювання ідей, ядро сховища опечатаних записів, рушій політик маршрутизації, чотири рушії ухвалення рішень пакета «Страхування» P1 P3 або P2 як опечатана Adverant конфіденційна VM у вашому хмарному тенанті P3 Не постачається
Закриті серверні модулі, що ухвалюють рішення: серверний код пакетів, мобільний шлюз P1 P3 P3 Не постачається
Серверний код пакета «Оборона та безпека» P1 P3 P3 P3
Код корисного навантаження Nexus Edge Не постачається Не постачається Не постачається P3
Читабельні клієнтські визначення: застосунки для телефонів, екрани пакетів для телефонів P4 P4 P4 P4

Звідси випливають два наслідки. Жоден захищений компонент не постачається в застосунку для телефона: кожне правило і промпт залишаються на сервері. А цінність, закладена в промптах, рубриках або ланцюжках агентів, є читабельною для того, хто запускає модель, якій вони надсилаються. Там, де модель належить вашій організації, ця цінність захищена ліцензійним договором і нічим іншим. Кожен образ TypeScript, що постачається, спаковано та мініфіковано без карт вихідного коду (source maps), що є радше охайністю, ніж захистом.

Що це означає під час створення розширення

Ваше розширення розташовується на тій самій лінії, що й власні модулі Adverant. Майже все описане в цьому розділі стосується і його.

Ізоляція, ідентифікація та шлях ШІ надаються платформою в обох редакціях. Плагін, створений за допомогою @adverant-nexus/plugin-sdk, успадковує бар'єр запитів з обмеженою областю дії, перевірку токенів і диспетчеризацію UNO, незалежно від того, у якій редакції він працює. Їх перелік наведено в розділі 2.19 «Правила, які успадковує кожне розширення».

Обмеження за редакціями працює для вас так само. Плагін оголошує свої ідентифікатори функцій у блоці entitlements свого маніфесту (featureIdPattern, а також короткий список alwaysOn, що зберігається для перевірок працездатності та сторінки налаштувань) і запитує у платформи вердикт перед тим, як надати доступ до захищеного інтерфейсу. Вердикт ніколи не буває простим булевим значенням. ENTITLEMENT_DENIED (403) означає, що платформа відповіла «ні». ENTITLEMENT_UNREACHABLE (502) означає, що відповіді не було, і ваш плагін повинен відмовити в доступі, а не робити припущення, оскільки збій, витлумачений як «немає прав доступу», непомітно знижує рівень доступу для всіх клієнтів одночасно. Кешуйте позитивну відповідь ненадовго і ніколи не кешуйте відмову.

У редакції Community розробник отримує ті самі початкові шаблони, що й в Enterprise, як для плагінів і лінз, так і для навичок і робочих процесів. Кожен розробник працює в просторі розробки з гілками даних на одному сервері, а код зберігається в GitHub. Шаблони галузевих пакетів і платформи належать до Enterprise. Те саме стосується тимчасового підвищення прав доступу з IDE (інтегрованого середовища розробки): у Community немає окремого продуктивного середовища, до якого можна було б підвищити свій доступ, і консоль повідомляє про це кодом PASS_TIER_REQUIRED.

Розробка в Community
Розробка в Community
Розробка в Community пропонує ті самі шаблони, що й в Enterprise, на одному сервері зі зберіганням коду в GitHub. Сторінка вказує, що саме додає Enterprise, і відмовляє в підвищеному доступі з простою та зрозумілою причиною.

Розширення, яке використовує лише точки стику Community, працює в обох редакціях без змін. Розширення, яке залежить від доповнення, наприклад «Пошта», відображається як заблоковане всюди, де ліцензія не містить цієї групи. У розділі 2.25 «Розробка для кожної редакції» показано, як структурувати розширення для обох редакцій і як тестувати його в кожній із них.