Assistenza
Versione 1.0.0-alpha.1ultima
Documentazione
Documentazione di Adverant Nexus
Versione 1.0.0-alpha.1. Inizi dalla Parte 1 se non conosce ancora Nexus; la Parte 2 è destinata a chi lo installa e lo gestisce.
Esplori la mappa del modello di conoscenzaIl nucleo condiviso e ciascun pacchetto di dominio, con le relative lenti, i moduli e le relazioni.
Parte 1: Per tutti
- 1.1Cos'è Nexus e a chi si rivolgeCosa fa Adverant Nexus per un'organizzazione, per chi è progettato e come si integrano le sue parti, spiegato con parole semplici usando Harrow Port Authority come esempio. Si conclude con le tre edizioni riassunte in un paragrafo.
- 1.2Una giornata lavorativa con NexusUna giornata lavorativa presso Harrow Port Authority, dal primo sguardo a Today fino all'ultima approvazione, per mostrare cosa fanno concretamente le persone in Nexus e dove si svolge ogni tipo di attività.
- 1.3La vostra organizzazione, le sue persone e ciò che resta privatoCome Nexus modella un'organizzazione e i ruoli ricoperti dalle sue persone, chi può acquistare e rivendicare sull'account Adverant, e il confine tra ciò che gli amministratori possono vedere e ciò che resta privato per ciascuna persona.
- 1.4L'IA alle vostre condizioniCome Nexus utilizza l'intelligenza artificiale (IA) alle condizioni dell'organizzazione stessa. L'organizzazione fornisce e possiede le proprie chiavi dei modelli, un unico centralino instrada ogni chiamata ai modelli verso i fornitori scelti, i modelli locali vengono eseguiti sui propri server e nulla viene inviato ad Adverant a sua insaputa.
- 1.5Fiducia e conformitàLe aree di Nexus in cui opera quotidianamente un responsabile della conformità. Copre il registro di audit e i record sigillati, le approvazioni che richiedono una seconda persona e le decisioni dell'intelligenza artificiale (IA) in attesa di revisione. Si conclude con le richieste sui dati personali e le pagine di conformità che mantengono le prove pronte prima che un revisore le richieda.
- 1.6Edizioni e licenze in parole sempliciLe tre edizioni di Nexus e i 19 componenti aggiuntivi e pacchetti di dominio disponibili, oltre a come funziona una licenza per un'azienda. Copre la verifica offline e cosa significa in pratica ogni stato della licenza, le garanzie mantenute da ogni licenza e il passaggio da Community a Enterprise senza reinstallare.
- 1.7Pacchetti di dominio e verticaliCosa aggiunge a Nexus un pacchetto di dominio per uno specifico settore, i dieci pacchetti offerti da Adverant, come si attiva un pacchetto per una singola unità e cosa richiede un pacchetto nella vostra licenza.
- 1.8Dove viene eseguito NexusI luoghi in cui Nexus può essere eseguito, dal cloud UE di Adverant a un sito senza connessione internet fino ai dispositivi sul campo, cosa significa sovranità in pratica e come scegliere.
- 1.9Per iniziareLe due decisioni da prendere prima di iniziare, cosa fa il vostro team IT, il primo avvio visto dal primo amministratore e una lista di controllo di ciò che occorre avere pronto il primo giorno.
- 1.10Lontano dalla scrivaniaUsare Nexus su uno smartphone, dal layout mobile della console presente in ogni edizione fino alle app native per iPhone e Android. Spiega cosa funziona senza segnale e come un'azienda gestisce i telefoni.
- 1.11Personalizzare NexusI modi in cui un'organizzazione modella Nexus, da una singola impostazione a un verticale proprio. Inoltre, come dare istruzioni agli sviluppatori o a un partner e cosa garantisce la piattaforma qualunque cosa venga sviluppata.
- 1.12Domande frequentiRisposte chiare alle domande più frequenti di acquirenti, manager e responsabili della protezione dei dati, incluse quelle più scomode sui costi e sull'accesso ai vostri dati.
Parte 2: Per IT, DevOps e sviluppatori
- 2.1ArchitetturaDi cosa è responsabile ciascun servizio nel chart di Nexus e quali archivi risiedono al di sotto, oltre alle regole che li tengono insieme, dall'identità tra i servizi al percorso seguito da ogni chiamata ai modelli.
- 2.2Le edizioni sotto il cofanoCome vengono compilate le edizioni Community ed Enterprise a partire da un unico prodotto, come una licenza attiva i gruppi di funzionalità in fase di esecuzione, cosa mostra un'installazione Community per una pagina Enterprise e cosa significa tutto questo per le immagini che scaricate e le estensioni che sviluppate.
- 2.3Pianificare un'installazioneDi cosa ha bisogno un'installazione Kubernetes di Nexus prima di digitare qualsiasi comando, quali sono le sue dimensioni e le due decisioni irreversibili: il nome dell'installazione e i custodi delle chiavi. Si conclude con il foglio di lavoro di pianificazione compilato da Harrow Port Authority.
- 2.4Ottenere e verificare una releaseDove si trova ciascuna parte di una release di Nexus, come si scaricano le immagini Enterprise con un pull token e come dimostrare offline, prima di installare qualsiasi cosa, che ogni immagine, chart e file scaricato provenga da Adverant senza modifiche.
- 2.5Controlli preliminari con nexusctlOgni verifica effettuata da `nexusctl preflight`, cosa legge ciascuna di esse e come fallisce, il report che stampa e salva, come tale report raggiunge la pagina preflight della console e tutti i flag.
- 2.6Installare Community su KubernetesUn'installazione passo dopo passo dell'edizione Community con Helm, da cert-manager fino a quando ogni workload è pronto, con il file values spiegato chiave per chiave, il motivo per cui non si usa --wait, l'ordine di esecuzione degli hook del chart e il percorso di installazione alternativo tramite nexusctl.
- 2.7Installare Enterprise e applicare una licenzaCosa cambia quando si installa l'edizione Enterprise, come richiedere una licenza dal proprio account Adverant, i tre modi per importarla con tutti i codici di rifiuto e come Harrow Port Authority ha convertito sul posto il proprio progetto pilota Community a Enterprise senza perdere nulla.
- 2.8Installazioni su macchina singolaInstallare Nexus su un singolo server Linux con nexusctl, oppure valutarlo su un laptop con k3d, e raggiungere la console tramite HTTPS affinché l'accesso e le passkey funzionino.
- 2.9L'immagine disco dell'installerAvviate un server bare-metal o una macchina virtuale dall'immagine dell'installer di Nexus per installare il sistema operativo, k3s, cert-manager e Nexus senza rete, verificando ogni file prima dell'uso.
- 2.10Installazione air-gappedTrasportate un bundle offline firmato in un sito privo di connessione internet, verificatelo con una chiave introdotta separatamente, caricatelo nel vostro registry e procedete all'installazione. Anche le licenze, gli aggiornamenti e gli elenchi di revoca attraversano l'isolamento manualmente.
- 2.11Varianti: archivi esterni, TLS e ingressI valori che adattano Nexus a un cluster non vuoto, incluso TLS (Transport Layer Security), insieme a database già in esecuzione, certificati propri, un altro ingress controller, classi di archiviazione, posta elettronica, proxy, repliche e Kubernetes gestito.
- 2.12Il primo avvioDa un'installazione non rivendicata alle persone al lavoro. Generate il codice di rivendicazione, rivendicate l'installazione in un browser, create il primo amministratore con una passkey, quindi collegate il sistema di accesso aziendale e invitate tutti gli altri.
- 2.13LicenzeCosa contiene un file di licenza di Nexus, come l'installazione lo verifica offline, i sei stati in cui può trovarsi e come richiederne, importarne, rinnovarne e revocarne uno.
- 2.14Fornitori e modelli di IACome il Provider Router dell'intelligenza artificiale (IA) seleziona un modello dal pool di chiavi dell'organizzazione e come gli script e gli strumenti di IA raggiungono Nexus dall'esterno.
- 2.15Giorno due: gestione operativa di NexusIl lavoro di routine per gestire un'installazione dopo la prima settimana. Inizia con lo sblocco dell'archivio delle chiavi dopo un riavvio e termina con la disinstallazione.
- 2.16Sicurezza e reteCosa lascia entrare e uscire un'installazione, come i suoi servizi dimostrano reciprocamente la propria identità e i controlli che un operatore imposta o eredita per l'accesso e il database.
- 2.17Risoluzione dei problemiI problemi che gli operatori incontrano più spesso, organizzati in base a ciò che si osserva. Per ciascuno vengono forniti la causa, il comando che la conferma e la soluzione; il capitolo si conclude con l'invio di un bundle di supporto.
- 2.18Il modello di estensioneI sei modi per estendere Nexus, da un'impostazione a un pacchetto di dominio, i limiti di ciascuno e come i livelli di fiducia e isolamento decidono dove viene eseguito il vostro codice. Leggetelo prima di aprire il software development kit (SDK).
- 2.19Le regole che ogni estensione ereditaIsolamento su tre assi, calcolo tramite UNO, IA (intelligenza artificiale) tramite il router, chiavi di proprietà dell'organizzazione e verifiche della licenza. Cosa significa ogni regola per il vostro codice, quale controllo la applica e perché la ereditate invece di doverla scrivere.
- 2.20SkillCome scrivere, testare e pubblicare una skill dello Skills Engine, dove appare una volta attiva e in che modo differiscono le skill del manifest in un plugin. Include un esempio pratico di riepilogo per l'assegnazione degli ormeggi per Harrow Port Authority.
- 2.21Il Plugin SDKInstallazione del Plugin SDK (software development kit), i suoi strumenti da riga di comando, una panoramica del modello full-service, il manifest v2 campo per campo e i ventidue controlli che vincolano un plugin alle regole.
- 2.22Il runtime del pluginI moduli dell'SDK (software development kit) su cui viene eseguito il plugin, dalla protezione dell'ambito e il perimetro del database fino all'invio tramite UNO, alla lettura dell'instradamento dell'IA (intelligenza artificiale) e ai controlli delle licenze. Infine, i test su un database reale, la registrazione delle skill e l'onboarding.
- 2.23Pacchetti di dominioDi cosa è composto un pacchetto di dominio e cosa indica il suo file pack.json; le viste e il registro delle viste; i modelli di conoscenza, i connettori e gli overlay mobili; come un pacchetto viene concesso in licenza e attivato per un'unità; e i dieci pacchetti forniti da Adverant.
- 2.24Costruire una soluzione verticale personalizzata end-to-endUn esempio pratico di creazione del pacchetto di dominio Catena del freddo, dal brief iniziale fino a una release attiva per ogni unità, con il relativo modello di conoscenza, le viste, una skill, un plugin full-service e dati di esempio. A seguire, come estendere un pacchetto già esistente e come aggiungere una vista a uno già rilasciato.
- 2.25Sviluppare per ciascuna edizioneCosa cambia quando un'unica estensione deve funzionare in ogni edizione, in un sito air-gapped, su un payload Nexus Edge o con il marchio del cliente. Copre il confine di licenza per i moduli Enterprise e la distribuzione offline firmata, con una matrice di ciò che occorre fare diversamente per ciascuna destinazione.
- 2.26Sviluppare con strumenti di programmazione basati sull'IACome sviluppare estensioni Nexus in sicurezza con Claude Code e altri strumenti di programmazione basati sull'IA (intelligenza artificiale). Si inizia collegando l'IDE (integrated development environment) al Workbench e con un file CLAUDE.md di progetto che contiene le regole della piattaforma, per concludere con sei prompt pratici e il controllo che convalida ciascuno di essi.
- 2.27Scenari di sviluppoUn ricettario di tredici sviluppi, da una singola skill a una distribuzione air-gapped. Ogni ricetta indica l'obiettivo, i blocchi costitutivi, i passaggi e i comandi, il controllo che ne dimostra il funzionamento e cosa cambia in base all'edizione e alla modalità di distribuzione.
- 2.28Rilasciare l'estensioneCome un plugin o un pacchetto passa da una build superata alle unità che lo eseguono, e come viene eventualmente ritirato. Versioni, revisione del rilascio, canali e installazioni, firma, approvazioni delle modifiche, record dell'identità di distribuzione, migrazioni, rollback e ritiro di una versione.
Appendici: Riferimento
- AAppendice A: Riferimento ai valori HelmOgni chiave accettata dal chart di Nexus, il relativo tipo, i valori consentiti e il valore predefinito.
- BAppendice B: Matrice delle edizioniQuale edizione, componente aggiuntivo o pacchetto di dominio include ciascuna funzionalità.
- CAppendice C: Codici di erroreOgni codice di rifiuto in cui può imbattersi un operatore o uno sviluppatore, cosa significa e cosa fare.
- DAppendice D: Servizi e porteOgni servizio eseguito dal chart, le relative porte e la chiave dei valori che lo configura.
- EAppendice E: GlossarioI termini utilizzati in entrambe le parti, spiegati con parole semplici.
- FAppendice F: L'architettura in sintesiL'intera piattaforma, l'open core e ciò che viene concesso in licenza al di sopra di esso, ciascuna modalità di esecuzione di Nexus e ciascuno dei dieci pacchetti di dominio, con un diagramma per ognuno.
- GAppendice G: Dizionario dei dati e modelli di conoscenzaI campi presenti in ogni record e di cosa è composto ciascun pacchetto di dominio.
Scaricare
- Part 1, for everyone (PDF) (si apre in una nuova scheda) 18 MB
- Part 2, technical, with the appendices (PDF) (si apre in una nuova scheda) 40 MB
I PDF sono in inglese.