Підтримка
Версія 1.0.0-alpha.1найновіша
Документація
Документація Adverant Nexus
Випуск 1.0.0-alpha.1. Почніть із частини 1, якщо ви вперше працюєте з Nexus; частина 2 призначена для тих, хто його встановлює та обслуговує.
Огляд карти моделі знаньСпільне ядро та кожен галузевий пакет із їхніми ракурсами, модулями та зв'язками.
Частина 1: Для всіх
- 1.1Що таке Nexus і для кого він призначенийЩо Adverant Nexus робить для організації, для кого він створений і як поєднуються його частини — простими словами на прикладі Harrow Port Authority. Наприкінці — опис трьох редакцій в одному абзаці.
- 1.2Робочий день із NexusОдин робочий день у Harrow Port Authority — від першого погляду на розділ Today до останнього погодження, що показує, чим саме люди займаються в Nexus і де виконується кожен вид роботи.
- 1.3Ваша організація, її люди та що залишається приватнимЯк Nexus моделює організацію та ролі її співробітників, хто має право купувати й заявляти права в обліковому записі Adverant, а також межа між тим, що бачать адміністратори, і тим, що залишається приватним для кожної людини.
- 1.4ШІ на ваших умовахЯк Nexus використовує штучний інтелект (ШІ) на власних умовах організації. Організація використовує власні ключі моделей і володіє ними, єдиний комутатор спрямовує кожен виклик моделі до обраних нею постачальників, локальні моделі працюють на її власних серверах, і нічого не надсилається до Adverant потай від неї.
- 1.5Довіра та відповідність вимогамЧастини Nexus, у яких постійно працює фахівець із комплаєнсу. Розділ охоплює журнал аудиту та запечатані записи, погодження, що потребують другої особи, і рішення штучного інтелекту (ШІ), які очікують на перевірку. Наприкінці йдеться про запити щодо персональних даних і сторінки комплаєнсу, які тримають доказову базу напоготові ще до того, як про неї запитає аудитор.
- 1.6Редакції та ліцензії простими словамиТри редакції Nexus та 19 додаткових модулів і галузевих пакетів до них, а також принцип роботи ліцензії для бізнесу. Охоплює офлайн-перевірку та практичне значення кожного стану ліцензії, зобов'язання, які виконує кожна ліцензія, і перехід із редакції Community на Enterprise без перевстановлення.
- 1.7Галузеві пакети та вертикаліЩо галузевий пакет додає до Nexus для окремої індустрії, десять пакетів, які пропонує Adverant, як увімкнути пакет для одного підрозділу та що потрібно для пакета у вашій ліцензії.
- 1.8Де працює NexusМісця, де може працювати Nexus — від хмари Adverant у ЄС до майданчика без інтернету та пристроїв на виїзді, що на практиці означає суверенітет і як зробити вибір.
- 1.9Початок роботиДва рішення перед стартом, що робить ваша ІТ-команда, перший запуск очима першого адміністратора та контрольний список того, що слід підготувати в перший день.
- 1.10Поза робочим місцемВикористання Nexus на телефоні — від мобільного інтерфейсу консолі в кожній редакції до нативних застосунків для iPhone та Android. Охоплює те, що працює без зв'язку, і те, як компанія керує телефонами.
- 1.11Налаштування під себеСпособи, якими організація адаптує Nexus — від окремого параметра до власної вертикалі. А також як поставити завдання розробникам чи партнеру та що гарантує платформа незалежно від того, що буде створено.
- 1.12Часті запитанняПрості відповіді на запитання, які найчастіше ставлять покупці, керівники та інспектори із захисту даних, включно з незручними запитаннями про гроші та доступ до ваших даних.
Частина 2: Для ІТ-фахівців, DevOps і розробників
- 2.1АрхітектураЗа що відповідає кожен сервіс у чарті Nexus і які сховища лежать в його основі, а також правила, що об'єднують їх у єдине ціле — від автентифікації між сервісами до шляху, який проходить кожен виклик моделі.
- 2.2Редакції зсерединиЯк Community та Enterprise збираються з одного продукту, як ліцензія вмикає групи функцій під час виконання, що інсталяція Community показує на місці сторінки Enterprise, і що це означає для образів, які ви завантажуєте, та розширень, які ви створюєте.
- 2.3Планування інсталяціїЩо потрібно для встановлення Nexus у Kubernetes ще до введення першої команди, який обсяг ресурсів необхідний, а також два незворотні рішення: назва інсталяції та зберігачі ключів. Наприкінці наведено заповнений робочий аркуш планування для Harrow Port Authority.
- 2.4Отримання та перевірка релізуДе зберігається кожна частина релізу Nexus, як завантажуються образи Enterprise за допомогою токена доступу (pull token), і як офлайн, ще до початку встановлення, довести, що кожен образ, чарт і завантажений файл надійшли від Adverant без змін.
- 2.5Попередня перевірка за допомогою nexusctlКожна перевірка, яку виконує `nexusctl preflight`, що саме вона зчитує та за яких умов завершується помилкою, звіт, який вона виводить і зберігає, як цей звіт потрапляє на сторінку попередньої перевірки в консолі, а також опис усіх прапорців.
- 2.6Встановлення редакції Community у KubernetesПокрокове встановлення редакції Community за допомогою Helm — від cert-manager до готовності всіх робочих навантажень, із поясненням кожного ключа у файлі значень (values), чому не використовується прапорець --wait, у якому порядку виконуються хуки чарту, а також альтернативний спосіб встановлення через nexusctl install.
- 2.7Встановлення редакції Enterprise і застосування ліцензіїЩо змінюється під час встановлення редакції Enterprise, як подати запит на ліцензію з вашого облікового запису Adverant, три способи її імпорту з усіма кодами відмови, а також як Harrow Port Authority перевела свій пілотний проєкт із Community на Enterprise на місці без жодних втрат.
- 2.8Встановлення на одну машинуВстановіть Nexus на один сервер Linux за допомогою nexusctl або протестуйте його на ноутбуці через k3d і підключіться до консолі за протоколом HTTPS, щоб працювали вхід у систему та ключі доступу (passkeys).
- 2.9Дисковий образ інсталятораЗавантажте фізичний сервер або віртуальну машину з образу інсталятора Nexus, і він без підключення до мережі встановить операційну систему, k3s, cert-manager та Nexus, перевіряючи кожен файл перед використанням.
- 2.10Встановлення в ізольованому середовищі (air-gapped)Перенесіть підписаний офлайн-пакет на майданчик без інтернету, перевірте його за допомогою ключа, доставленого окремо, завантажте у власний реєстр і встановіть. Ліцензії, оновлення та списки відкликання також переносяться через ізольований контур вручну.
- 2.11Варіанти конфігурації: зовнішні сховища, TLS та ingressПараметри (values), які адаптують Nexus до вже наявного кластера, включно з TLS (Transport Layer Security), а також базами даних, які ви вже використовуєте, власними сертифікатами, іншим контролером ingress, класами сховищ, поштою, проксі-серверами, репліками та керованим Kubernetes.
- 2.12Перший запускВід неактивованої інсталяції до початку роботи користувачів. Створіть код активації (claim code), заявіть права на інсталяцію в браузері, створіть першого адміністратора з ключем доступу, а потім підключіть корпоративний вхід і запросіть усіх інших.
- 2.13ЛіцензіїЩо містить файл ліцензії Nexus, як інсталяція перевіряє його офлайн, у яких шести станах він може перебувати, а також як подати запит на ліцензію, імпортувати, поновити та відкликати її.
- 2.14Провайдери та моделі ШІЯк маршрутизатор провайдерів штучного інтелекту (ШІ) — AI Provider Router — вибирає модель із власного пулу ключів організації, та як скрипти й інструменти ШІ звертаються до Nexus ззовні.
- 2.15Повсякденна експлуатація NexusРегулярні завдання з обслуговування інсталяції після першого тижня роботи: від розблокування сховища ключів після перезапуску до видалення системи.
- 2.16Безпека та мережаЯкий вхідний і вихідний трафік пропускає інсталяція, як її сервіси підтверджують свою автентичність один одному, а також засоби контролю, які оператор налаштовує або успадковує для входу в систему та бази даних.
- 2.17Усунення несправностейПроблеми, з якими оператори стикаються найчастіше, згруповані за зовнішніми проявами. Для кожної наведено причину, команду для її підтвердження та спосіб вирішення, а завершується розділ надсиланням пакета діагностики до служби підтримки.
- 2.18Модель розширенняШість способів розширити Nexus — від налаштування до галузевого пакета, — межі кожного з них і те, як рівні довіри та ізоляції визначають, де виконується ваш код. Прочитайте цей розділ, перш ніж відкривати набір засобів розробки (SDK).
- 2.19Правила, які успадковує кожне розширенняІзоляція за трьома осями, обчислення через UNO, ШІ (штучний інтелект) через маршрутизатор, ключі у власності організації та перевірки ліцензій. Що кожне правило означає для вашого коду, який контрольний рубіж (gate) забезпечує його виконання і чому ви успадковуєте цю логіку, а не пишете її самі.
- 2.20Навички (Skills)Як написати, протестувати й опублікувати навичку Skills Engine, де вона з'являється після публікації та чим відрізняються навички з маніфесту в плагіні. Містить практичний приклад зведення про розподіл причалів для Harrow Port Authority.
- 2.21Plugin SDKВстановлення Plugin SDK (набору засобів розробки), його інструменти командного рядка, огляд шаблону повноцінного сервісу, детальний розбір усіх полів маніфесту v2, а також двадцять два контрольні рубежі, які перевіряють плагін на відповідність правилам.
- 2.22Середовище виконання плагінаМодулі SDK (набору засобів розробки), на базі яких працює ваш плагін: від захисника області видимості (scope guard) і бар'єра бази даних до диспетчеризації UNO, читання маршруту ШІ (штучного інтелекту) та перевірок ліцензії. Далі — тестування на реальній базі даних, реєстрація навичок і початкове підключення (onboarding).
- 2.23Галузеві пакетиЗ чого складається галузевий пакет і що містить його файл pack.json; лінзи (lenses) та реєстр лінз; моделі знань, конектори та мобільні накладки; як пакет ліцензується і вмикається для підрозділу; а також десять пакетів, які постачає Adverant.
- 2.24Повний цикл створення власної галузевої вертикаліПрактичний приклад збирання галузевого пакета для холодового ланцюга (Cold chain): від першого технічного завдання до релізу, що працює в кожному підрозділі, включно з моделлю знань, лінзами, навичкою, повнофункціональним плагіном і тестовими даними. А також про те, як розширити вже наявний пакет і як додати лінзу до вже випущеного пакета.
- 2.25Збирання для кожної редакціїЩо змінюється, коли одне розширення має працювати в кожній редакції, на ізольованому (air-gapped) майданчику, у складі корисного навантаження Nexus Edge або під власним брендом клієнта. Охоплює межі ліцензування для модулів Enterprise і підписане офлайн-доставлення, а також матрицю відмінностей для кожної цільової платформи.
- 2.26Розробка за допомогою ШІ-інструментів для написання кодуЯк безпечно створювати розширення Nexus за допомогою Claude Code та інших інструментів програмування на базі ШІ (штучного інтелекту). Розділ починається з підключення вашої IDE (інтегрованого середовища розробки) до Workbench і файлу проєкту CLAUDE.md, що містить правила платформи, а завершується шістьма опрацьованими промптами та контрольною перевіркою, яка підтверджує кожен із них.
- 2.27Сценарії збиранняЗбірник із тринадцяти рецептів збирання: від однієї навички до доставлення в ізольоване середовище. Кожен рецепт містить мету, будівельні блоки, кроки й команди, контрольну перевірку, що підтверджує результат, а також відмінності залежно від редакції та форми доставлення.
- 2.28Випуск вашого розширенняЯк плагін або пакет проходить шлях від успішної збірки до підрозділів, які його запускають, і як він виводиться з експлуатації. Версії, перевірка релізу, канали та встановлення, підписання, погодження змін, запис ідентичності доставлення, міграції, відкат і виведення версії з обігу.
Додатки: Довідник
- AДодаток A: Довідник значень HelmКожен ключ, який приймає чарт Nexus, його тип, допустимі значення та значення за замовчуванням.
- BДодаток B: Матриця редакційЯка редакція, додатковий модуль або галузевий пакет містить кожну можливість.
- CДодаток C: Коди помилокКожен код відмови, з яким стикається оператор або розробник, що він означає та що робити.
- DДодаток D: Сервіси та портиКожен сервіс, який запускає чарт, його порти та ключ значень, що його налаштовує.
- EДодаток E: ГлосарійТерміни, вживані в обох частинах, простою мовою.
- FДодаток F: Огляд архітектуриУся платформа, відкрите ядро та те, що ліцензується поверх нього, кожен спосіб запуску Nexus і кожен із десяти галузевих пакетів — по одній діаграмі на кожен елемент.
- GДодаток G: Словник даних і моделі знаньПоля в кожному записі та склад кожного галузевого пакета.
Завантаження (Download)
- Part 1, for everyone (PDF) (відкривається в новій вкладці) 18 MB
- Part 2, technical, with the appendices (PDF) (відкривається в новій вкладці) 40 MB
PDF-файли викладено англійською мовою.