Podpora
Verzia 1.0.0-alpha.1najnovšia
Dokumentácia
Dokumentácia k Adverant Nexus
Vydanie 1.0.0-alpha.1. Ak s používaním systému Nexus začínate, začnite 1. časťou; 2. časť je určená pre ľudí, ktorí ho inštalujú a prevádzkujú.
Preskúmajte mapu znalostného modeluZdieľané jadro a každý doménový balík s ich pohľadmi, modulmi a vzťahmi.
Časť 1: Pre každého
- 1.1Čo je Nexus a pre koho je určenýČo Adverant Nexus robí pre organizáciu, pre koho je vytvorený a ako do seba jeho časti zapadajú, vysvetlené zrozumiteľne na príklade Harrow Port Authority. Na záver sú v jednom odseku zhrnuté tri edície.
- 1.2Pracovný deň so systémom NexusJeden pracovný deň v Harrow Port Authority, od prvého pohľadu na Dnes až po posledné schválenie, ktorý ukazuje, čo ľudia v systéme Nexus skutočne robia a kde má každý druh práce svoje miesto.
- 1.3Vaša organizácia, jej ľudia a čo zostáva súkromnéAko Nexus modeluje organizáciu a roly jej ľudí, kto môže nakupovať a uplatňovať nároky na účte Adverant a kde je hranica medzi tým, čo vidia správcovia, a tým, čo zostáva súkromné pre každého jednotlivca.
- 1.4AI podľa vašich podmienokAko Nexus využíva umelú inteligenciu (AI) podľa vlastných podmienok organizácie. Organizácia si prináša a vlastní svoje kľúče k modelom, jedna ústredňa smeruje každé volanie modelu k poskytovateľom, ktorých si zvolila, lokálne modely bežia na jej vlastných serveroch a nič sa neposiela spoločnosti Adverant za jej chrbtom.
- 1.5Dôvera a súlad s predpismiČasti systému Nexus, v ktorých denne pracuje špecialista na súlad s predpismi (compliance officer). Zahŕňa auditný záznam a zapečatené záznamy, schválenia vyžadujúce druhú osobu a rozhodnutia umelej inteligencie (AI) čakajúce na posúdenie. Končí žiadosťami týkajúcimi sa osobných údajov a stránkami súladu, ktoré udržiavajú dôkazy pripravené skôr, než si ich vyžiada audítor.
- 1.6Edície a licencie zrozumiteľneTri edície systému Nexus a 19 doplnkov a doménových balíkov navyše, a následne to, ako licencia funguje pre firmu. Pokrýva offline kontrolu a to, čo každý stav licencie znamená v praxi, prísľuby, ktoré dodržiava každá licencia, a prechod z edície Community na Enterprise bez preinštalovania.
- 1.7Doménové balíky a vertikályČo doménový balík pridáva do systému Nexus pre jedno odvetvie, desať balíkov, ktoré Adverant ponúka, ako sa balík zapína pre jednu organizačnú jednotku a čo balík vyžaduje vo vašej licencii.
- 1.8Kde Nexus bežíMiesta, kde môže Nexus bežať, od cloudu spoločnosti Adverant v EÚ až po prevádzku bez internetu a zariadenia v teréne, čo v praxi znamená suverenita a ako si vybrať.
- 1.9ZačínameDve rozhodnutia predtým, než začnete, čo robí váš IT tím, prvé spustenie z pohľadu prvého správcu a kontrolný zoznam toho, čo mať pripravené v prvý deň.
- 1.10Mimo pracovného stolaPoužívanie systému Nexus v telefóne, od rozloženia konzoly pre telefón v každej edícii až po natívne aplikácie pre iPhone a Android. Zahŕňa to, čo funguje bez signálu a ako firma spravuje telefóny.
- 1.11Prispôsobenie na mieruSpôsoby, akými si organizácia prispôsobuje Nexus, od jedného nastavenia až po vlastnú vertikálu. Tiež ako zadať prácu vývojárom alebo partnerovi a čo platforma garantuje bez ohľadu na to, čo sa vytvorí.
- 1.12Otázky, ktoré sa ľudia pýtajúJasné odpovede na otázky, ktoré najčastejšie kladú nákupcovia, manažéri a zodpovedné osoby za ochranu osobných údajov, vrátane tých nepríjemných o peniazoch a prístupe k vašim údajom.
Časť 2: Pre IT, DevOps a vývojárov
- 2.1ArchitektúraČo vlastní každá služba v charte Nexus a ktoré úložiská sa pod ňou nachádzajú, a následne pravidlá, ktoré ich držia pohromade, od identity medzi službami až po cestu, ktorou prechádza každé volanie modelu.
- 2.2Edície pod kapotouAko sú Community a Enterprise zostavené z jedného produktu, ako licencia zapína skupiny funkcií za behu, čo inštalácia Community zobrazuje pre stránku Enterprise a čo to znamená pre obrazy, ktoré sťahujete, a rozšírenia, ktoré vytvárate.
- 2.3Plánovanie inštalácieČo potrebuje inštalácia systému Nexus na Kubernetes predtým, než napíšete príkaz, aká je veľká a dve rozhodnutia, ktoré nemôžete vziať späť – názov inštalácie a správcovia kľúčov. Končí vyplneným plánovacím hárkom pre Harrow Port Authority.
- 2.4Získanie a overenie vydaniaKde sa nachádza každá časť vydania Nexus, ako sa obrazy Enterprise sťahujú pomocou pull tokenu a ako offline dokázať, že každý obraz, chart a stiahnutý súbor prišiel od spoločnosti Adverant nezmenený predtým, než čokoľvek nainštalujete.
- 2.5Predletová kontrola (preflight) pomocou nexusctlKaždá kontrola, ktorú vykonáva `nexusctl preflight`, čo každá z nich číta a ako zlyhá, správa, ktorú vypíše a uloží, ako sa táto správa dostane na stránku predletovej kontroly v konzole a každý príznak.
- 2.6Inštalácia edície Community na KubernetesOčíslovaný postup inštalácie edície Community pomocou nástroja Helm, od cert-manager až po pripravenosť každej pracovnej záťaže (workload), s vysvetlením súboru hodnôt (values) kľúč po kľúči, prečo sa nepoužíva --wait, v akom poradí bežia háky (hooks) chartu a alternatívna cesta inštalácie cez nexusctl.
- 2.7Inštalácia edície Enterprise a aplikovanie licencieČo sa zmení pri inštalácii edície Enterprise, ako požiadať o licenciu z účtu Adverant, tri spôsoby jej importu vrátane všetkých kódov odmietnutia a ako spoločnosť Harrow Port Authority previedla svoju pilotnú prevádzku edície Community priamo na edíciu Enterprise bez akejkoľvek straty dát.
- 2.8Inštalácie na jeden strojNainštalujte Nexus na jeden server so systémom Linux pomocou nástroja nexusctl alebo ho vyskúšajte na prenosnom počítači s k3d a pripojte sa ku konzole cez protokol HTTPS, aby fungovalo prihlasovanie a prístupové kľúče (passkeys).
- 2.9Obraz inštalačného diskuSpustite fyzický server alebo virtuálny stroj z inštalačného obrazu Nexus a systém nainštaluje operačný systém, k3s, cert-manager a Nexus bez pripojenia k sieti, pričom pred použitím skontroluje každý súbor.
- 2.10Inštalácia v izolovanej sieti (air-gapped)Preneste podpísaný offline balík na pracovisko bez internetu, overte ho pomocou kľúča prineseného samostatne, nahrajte ho do vlastného registra a nainštalujte. Licencie, aktualizácie a zoznamy odvolaných certifikátov sa cez túto bariéru prenášajú takisto ručne.
- 2.11Obmeny: externé úložiská, TLS a ingressHodnoty, ktoré prispôsobia Nexus klastru, ktorý nie je prázdny, vrátane TLS (Transport Layer Security), databáz, ktoré už prevádzkujete, vašich vlastných certifikátov, iného kontroléra ingress, tried úložísk, pošty, proxy serverov, replík a spravovaného prostredia Kubernetes.
- 2.12Prvé spustenieOd neprevzatej inštalácie k pracujúcim ľuďom. Vytvorte kód na prevzatie, prevezmite inštaláciu v prehliadači, vytvorte prvého správcu s prístupovým kľúčom (passkey), potom pripojte firemné prihlasovanie a pozvite všetkých ostatných.
- 2.13LicencieČo obsahuje licenčný súbor Nexus, ako ho inštalácia kontroluje v režime offline, šesť stavov, v ktorých sa môže nachádzať, a ako o licenciu požiadať, importovať ju, obnoviť a odobrať.
- 2.14Poskytovatelia a modely AIAko smerovač poskytovateľov umelej inteligencie (AI) vyberá model z vlastného fondu kľúčov organizácie a ako skripty a nástroje AI pristupujú k systému Nexus zvonku.
- 2.15Druhý deň: prevádzka systému NexusBežná práca spojená s prevádzkou inštalácie po prvom týždni. Začína sa odpečatením úložiska kľúčov po reštarte a končí sa odinštalovaním.
- 2.16Bezpečnosť a sieteČo inštalácia prepúšťa dnu a von, ako si jej služby navzájom preukazujú identitu a aké ovládacie prvky nastavuje alebo dedí operátor pre prihlasovanie a databázu.
- 2.17Riešenie problémovProblémy, s ktorými sa operátori stretávajú najčastejšie, zoradené podľa toho, čo vidíte. Pri každom je uvedená príčina, príkaz na jej potvrdenie a oprava; kapitola sa končí odoslaním balíka pre podporu.
- 2.18Model rozšíreníŠesť spôsobov, ako rozšíriť Nexus, od nastavenia až po doménový balík, obmedzenia každého z nich a to, ako úrovne dôvery a izolácie rozhodujú o tom, kde beží váš kód. Prečítajte si to skôr, než otvoríte sadu nástrojov na vývoj softvéru (SDK).
- 2.19Pravidlá, ktoré dedí každé rozšírenieIzolácia v troch osiach, výpočty cez UNO, AI (umelá inteligencia) cez smerovač, kľúče vo vlastníctve organizácie a kontroly licencií. Čo jednotlivé pravidlá znamenajú pre váš kód, ktorá brána ich vynucuje a prečo ich dedíte namiesto toho, aby ste ich písali.
- 2.20Zručnosti (Skills)Ako napísať, otestovať a publikovať zručnosť pre Skills Engine, kde sa zobrazí po nasadení a v čom sa líšia zručnosti v manifeste zásuvného modulu. Obsahuje vypracovaný príklad súhrnu prideľovania kotvísk pre spoločnosť Harrow Port Authority.
- 2.21Plugin SDKInštalácia sady Plugin SDK (sada nástrojov na vývoj softvéru), jej nástroje príkazového riadka, prehliadka šablóny plnohodnotnej služby, manifest v2 pole po poli a dvadsaťdva brán, ktoré dohliadajú na to, aby zásuvný modul dodržiaval pravidlá.
- 2.22Behové prostredie zásuvných modulov (plugin runtime)Moduly SDK (sady nástrojov na vývoj softvéru), na ktorých beží váš zásuvný modul, od strážcu rozsahu (scope guard) a databázového oplotenia až po dispečing UNO, čítanie trasy AI (umelej inteligencie) a kontroly licencií. Následne testovanie oproti reálnej databáze, registrácia vašich zručností a úvodné nastavenie (onboarding).
- 2.23Doménové balíkyZ čoho sa skladá doménový balík a čo uvádza jeho súbor pack.json; optiky (lenses) a register optík; znalostné modely, konektory a mobilné prekrytia; ako sa balík licencuje a zapína pre organizačnú jednotku; a desať balíkov, ktoré dodáva spoločnosť Adverant.
- 2.24Kompletné zostavenie vlastného odvetvového riešeniaPraktické zostavenie doménového balíka Chladiarenský reťazec, od prvého zadania až po vydanie bežiace pre každú jednotku, vrátane jeho znalostného modelu, pohľadov, zručnosti, komplexného zásuvného modulu a ukážkových dát. Následne sa dozviete, ako rozšíriť už existujúci balík a ako pridať pohľad do balíka, ktorý už bol vydaný.
- 2.25Zostavenie pre každú edíciuČo sa mení, keď jedno rozšírenie musí fungovať v každej edícii, v izolovanom prostredí (air-gapped), v balíku pre Nexus Edge alebo pod vlastnou značkou zákazníka. Zahŕňa licenčnú hranicu pre moduly edície Enterprise a podpísané offline doručenie, spolu s maticou rozdielnych postupov pre každý cieľ.
- 2.26Tvorba pomocou programovacích nástrojov s AIAko bezpečne zostavovať rozšírenia pre Nexus pomocou Claude Code a iných nástrojov na programovanie s AI (umelou inteligenciou). Začína sa pripojením vášho IDE (integrovaného vývojového prostredia) k prostrediu Workbench a projektovým súborom CLAUDE.md, ktorý nesie pravidlá platformy, a končí šiestimi praktickými zadaniami a kontrolnou bránou, ktorá každé z nich overí.
- 2.27Scenáre zostaveniaKuchárka trinástich zostavení, od jednej zručnosti až po doručenie do izolovaného prostredia (air-gapped). Každý recept uvádza cieľ, stavebné bloky, kroky a príkazy, kontrolnú bránu, ktorá overí funkčnosť, a to, čo sa mení podľa edície a formy doručenia.
- 2.28Vydanie vášho rozšíreniaAko sa zásuvný modul alebo balík dostane od úspešnej zostavy k jednotkám, ktoré ho spúšťajú, a ako sa z nich opäť stiahne. Verzie, kontrola pred vydaním, kanály a inštalácie, podpisovanie, schvaľovanie zmien, záznam o identite doručenia, migrácie, návrat k predchádzajúcej verzii (rollback) a vyradenie verzie.
Prílohy: Referenčná príručka
- APríloha A: Referenčná príručka hodnôt pre HelmKaždý kľúč, ktorý chart systému Nexus akceptuje, jeho typ, povolené hodnoty a predvolená hodnota.
- BPríloha B: Matica edíciíKtorá edícia, doplnok alebo doménový balík obsahuje jednotlivé funkcie.
- CPríloha C: Chybové kódyKaždý kód odmietnutia, s ktorým sa operátor alebo vývojár stretne, čo znamená a ako postupovať.
- DPríloha D: Služby a portyKaždá služba, ktorú chart spúšťa, jej porty a kľúč v súbore values, ktorý ju konfiguruje.
- EPríloha E: Slovník pojmovPojmy použité v oboch častiach, vysvetlené zrozumiteľne.
- FPríloha F: Prehľad architektúryCelá platforma, otvorené jadro a to, čo je nad ním licencované, každý spôsob prevádzky systému Nexus a každý z desiatich doménových balíkov, pre každý jeden diagram.
- GPríloha G: Dátový slovník a znalostné modelyPolia na každom zázname a z čoho sa skladá každý doménový balík.
Sťahovanie
- Part 1, for everyone (PDF) (otvorí sa na novej karte) 18 MB
- Part 2, technical, with the appendices (PDF) (otvorí sa na novej karte) 40 MB
Súbory PDF sú v angličtine.