Support
Version 1.0.0-alpha.1dernière version
Documentation
Documentation Adverant Nexus
Version 1.0.0-alpha.1. Commencez par la partie 1 si vous découvrez Nexus ; la partie 2 s'adresse aux personnes qui l'installent et l'exploitent.
Explorer la carte du modèle de connaissancesLe socle commun et chaque pack métier, avec leurs prismes, modules et relations.
Partie 1: Pour tous
- 1.1Qu'est-ce que Nexus et à qui s'adresse-t-ilCe qu'Adverant Nexus apporte à une organisation, à qui il est destiné et comment ses composants s'articulent, expliqué simplement avec Harrow Port Authority pour exemple. Ce chapitre se conclut par une présentation des trois éditions en un paragraphe.
- 1.2Une journée de travail avec NexusUne journée de travail chez Harrow Port Authority, du premier coup d'œil sur la page Aujourd'hui jusqu'à la dernière approbation, illustrant ce que les équipes font concrètement dans Nexus et où réside chaque type de tâche.
- 1.3Votre organisation, ses collaborateurs et ce qui reste privéComment Nexus modélise une organisation et les rôles de ses collaborateurs, qui est habilité à acheter et à revendiquer des droits sur le compte Adverant, et la frontière entre ce que les administrateurs peuvent voir et ce qui reste propre à chacun.
- 1.4L'IA selon vos propres conditionsComment Nexus utilise l'intelligence artificielle (IA) selon les conditions propres à l'organisation. L'organisation apporte et détient ses clés de modèles, un standard unique achemine chaque appel de modèle vers les fournisseurs qu'elle a choisis, les modèles locaux tournent sur ses propres serveurs, et rien n'est envoyé à Adverant à son insu.
- 1.5Confiance et conformitéLes espaces de Nexus dédiés au responsable de la conformité. Cette section couvre le journal d'audit et les enregistrements scellés, les approbations nécessitant une seconde personne et les décisions d'intelligence artificielle (IA) en attente d'examen. Elle se termine par les demandes relatives aux données personnelles et les pages de conformité qui tiennent les preuves prêtes avant même qu'un auditeur ne les demande.
- 1.6Éditions et licences expliquées simplementLes trois éditions de Nexus ainsi que les 19 modules complémentaires et packs métier qui s'y ajoutent, puis le fonctionnement d'une licence pour une entreprise. Ce chapitre couvre la vérification hors ligne et ce que chaque état de licence signifie en pratique, les engagements garantis par chaque licence, et le passage de l'édition Community à Enterprise sans réinstallation.
- 1.7Packs métier et solutions verticalesCe qu'un pack métier apporte à Nexus pour un secteur donné, les dix packs proposés par Adverant, comment activer un pack pour une unité opérationnelle, et ce qu'un pack requiert dans votre licence.
- 1.8Où tourne NexusLes environnements où Nexus peut s'exécuter, du cloud européen d'Adverant jusqu'à un site sans accès à Internet et aux appareils sur le terrain, ce que la souveraineté signifie en pratique, et comment faire votre choix.
- 1.9Premiers pasLes deux décisions à prendre avant de commencer, le rôle de votre équipe informatique, le premier lancement tel que le voit le premier administrateur, et une liste de contrôle de ce qu'il faut préparer pour le premier jour.
- 1.10Loin du bureauUtiliser Nexus sur un téléphone, de l'affichage mobile de la console dans chaque édition jusqu'aux applications natives iPhone et Android. Couvre ce qui fonctionne sans réseau et la gestion des téléphones par l'entreprise.
- 1.11Adapter Nexus à vos besoinsLes façons dont une organisation façonne Nexus, d'un simple paramètre jusqu'à sa propre solution verticale. Explique également comment briefer vos développeurs ou un partenaire, et ce que la plateforme garantit quoi qu'il soit développé.
- 1.12Questions fréquentesDes réponses claires aux questions que les acheteurs, les dirigeants et les délégués à la protection des données posent le plus souvent, y compris les questions délicates sur les coûts et l'accès à vos données.
Partie 2: Pour les équipes IT, DevOps et les développeurs
- 2.1ArchitectureCe dont chaque service du chart Nexus est responsable et les systèmes de stockage sous-jacents, puis les règles qui assurent leur cohésion, de l'identité inter-services jusqu'au chemin emprunté par chaque appel de modèle.
- 2.2Les éditions sous le capotComment Community et Enterprise sont compilées à partir d'un seul produit, comment une licence active des groupes de fonctionnalités à l'exécution, ce qu'une installation Community affiche pour une page Enterprise, et ce que cela implique pour les images que vous téléchargez et les extensions que vous développez.
- 2.3Planifier une installationCe qu'une installation Kubernetes de Nexus requiert avant même de saisir une commande, son dimensionnement, et les deux décisions irréversibles : le nom de l'installation et les dépositaires des clés. Ce chapitre se termine par la fiche de planification remplie de Harrow Port Authority.
- 2.4Obtenir et vérifier une versionOù réside chaque composant d'une version de Nexus, comment récupérer les images Enterprise avec un jeton de tirage, et comment prouver hors ligne que chaque image, chart et téléchargement provient bien d'Adverant sans altération, avant d'installer quoi que ce soit.
- 2.5Vérification préalable avec nexusctlChaque vérification effectuée par `nexusctl preflight`, ce que chacune lit et comment elle échoue, le rapport qu'elle affiche et enregistre, comment ce rapport parvient à la page de vérification préalable de la console, ainsi que chaque option.
- 2.6Installer l'édition Community sur KubernetesUne installation étape par étape de l'édition Community avec Helm, de cert-manager jusqu'à ce que chaque charge de travail soit prête, avec le fichier values expliqué clé par clé, la raison de l'absence de --wait, l'ordre d'exécution des hooks du chart, et la méthode d'installation via nexusctl comme alternative.
- 2.7Installer l'édition Enterprise et appliquer une licenceCe qui change lors de l'installation de l'édition Enterprise, comment demander une licence depuis votre compte Adverant, les trois façons de l'importer avec chaque code de refus, et comment Harrow Port Authority a migré son pilote Community vers Enterprise sur place sans rien perdre.
- 2.8Installations sur machine uniqueInstaller Nexus sur un seul serveur Linux avec nexusctl, ou l'évaluer sur un ordinateur portable avec k3d, et accéder à la console en HTTPS afin que la connexion et les clés d'accès fonctionnent.
- 2.9L'image disque de l'installateurDémarrez un serveur nu ou une machine virtuelle à partir de l'image d'installation de Nexus : elle installe le système d'exploitation, k3s, cert-manager et Nexus sans réseau, en vérifiant chaque fichier avant son utilisation.
- 2.10Installation isolée (air-gap)Transportez une archive hors ligne signée sur un site sans accès à Internet, vérifiez-la à l'aide d'une clé apportée séparément, chargez-la dans votre propre registre et lancez l'installation. Les licences, mises à jour et listes de révocation franchissent également cette séparation manuellement.
- 2.11Variantes : stockages externes, TLS et ingressLes valeurs permettant d'adapter Nexus à un cluster qui n'est pas vierge, TLS (Transport Layer Security) compris, avec les bases de données que vous exploitez déjà, vos propres certificats, un autre contrôleur ingress, les classes de stockage, la messagerie électronique, les proxys, les réplicas et Kubernetes managé.
- 2.12Le premier lancementD'une installation non revendiquée jusqu'aux équipes au travail. Générez le code de revendication, revendiquez l'installation dans un navigateur, créez le premier administrateur avec une clé d'accès, puis connectez l'authentification d'entreprise et invitez tous les autres collaborateurs.
- 2.13LicencesCe que contient un fichier de licence Nexus, comment l'installation le vérifie hors ligne, les six états dans lesquels il peut se trouver, et comment demander, importer, renouveler et révoquer une licence.
- 2.14Fournisseurs et modèles d'IAComment le routeur de fournisseurs d'intelligence artificielle (IA) sélectionne un modèle dans le pool de clés propre à l'organisation, et comment les scripts et outils d'IA accèdent à Nexus depuis l'extérieur.
- 2.15Jour 2 : exploiter NexusLes tâches courantes d'exploitation d'une installation après la première semaine. Ce chapitre commence par le déverrouillage du magasin de clés après un redémarrage et se termine par la désinstallation.
- 2.16Sécurité et réseauCe qu'une installation autorise en entrée et en sortie, comment ses services se prouvent mutuellement leur identité, et les contrôles qu'un opérateur définit ou hérite pour la connexion et la base de données.
- 2.17DépannageLes problèmes que les opérateurs rencontrent le plus souvent, classés selon les symptômes observés. Chaque cas indique la cause, la commande permettant de la confirmer et le correctif, et le chapitre se termine par l'envoi d'une archive de support.
- 2.18Le modèle d'extensionLes six façons d'étendre Nexus, d'un simple paramètre jusqu'à un pack métier, les limites de chacune, et comment les niveaux de confiance et d'isolation déterminent où votre code s'exécute. À lire avant d'ouvrir le kit de développement logiciel (SDK).
- 2.19Les règles dont hérite chaque extensionIsolation sur trois axes, calcul via UNO, IA (intelligence artificielle) via le routeur, clés détenues par l'organisation et vérifications de licence. Ce que chaque règle implique pour votre code, quel point de contrôle l'applique, et pourquoi vous en héritez au lieu de devoir l'écrire.
- 2.20CompétencesComment écrire, tester et publier une compétence du Skills Engine, où elle apparaît une fois en production, et en quoi les compétences de manifeste d'un plugin diffèrent. Inclut un exemple concret de synthèse d'attribution de postes à quai pour Harrow Port Authority.
- 2.21Le SDK de pluginL'installation du SDK (kit de développement logiciel) de plugin, ses outils en ligne de commande, une présentation du modèle complet, le manifeste v2 champ par champ, et les vingt-deux portes de contrôle qui soumettent un plugin aux règles.
- 2.22L'environnement d'exécution de pluginLes modules du SDK (kit de développement logiciel) sur lesquels repose votre plugin, du garde de portée et de la barrière de base de données à la répartition UNO, en passant par la lecture de route d'IA (intelligence artificielle) et les vérifications de licence. Puis les tests sur une base de données réelle, l'enregistrement de vos compétences et l'intégration.
- 2.23Packs métierDe quoi est fait un pack métier et ce que contient son fichier pack.json ; les prismes et le registre des prismes ; les modèles de connaissances, les connecteurs et les surcouches mobiles ; comment un pack est concédé sous licence et activé pour une unité ; et les dix packs fournis par Adverant.
- 2.24Construire une solution verticale sur mesure de bout en boutLa création pas à pas du pack métier Chaîne du froid, du cahier des charges initial jusqu'à une version exécutée pour chaque unité, avec son modèle de connaissances, ses prismes, une compétence, un plugin complet et des données d'exemple. Puis comment étendre un pack existant et comment ajouter un prisme à un pack déjà livré.
- 2.25Construire pour chaque éditionCe qui change lorsqu'une même extension doit fonctionner dans toutes les éditions, sur un site isolé (air-gapped), sur une charge utile Nexus Edge ou sous la propre marque d'un client. Couvre la démarcation de licence pour les modules Enterprise et la livraison hors ligne signée, avec une matrice des actions spécifiques à chaque cible.
- 2.26Développer avec des outils de codage par IAComment développer des extensions Nexus en toute sécurité avec Claude Code et d'autres outils de codage par l'IA (intelligence artificielle). Cela commence par la connexion de votre IDE (environnement de développement intégré) au Workbench et un fichier CLAUDE.md de projet qui intègre les règles de la plateforme, et se termine par six invites détaillées ainsi que la porte de contrôle qui valide chacune d'elles.
- 2.27Scénarios de développementUn recueil de treize réalisations, d'une simple compétence à une livraison en environnement isolé (air-gapped). Chaque recette indique l'objectif, les briques de base, les étapes et les commandes, la porte de contrôle qui prouve son bon fonctionnement, et ce qui change selon l'édition et le mode de livraison.
- 2.28Publier votre extensionComment un plugin ou un pack passe d'une compilation validée aux unités qui l'exécutent, et comment il en est retiré. Versions, révision de mise en production, canaux et installations, signature, approbations de changement, enregistrement d'identité de livraison, migrations, retour arrière et retrait d'une version.
Annexes: Référence
- AAnnexe A : Référence des valeurs HelmChaque clé acceptée par le chart Nexus, son type, ses valeurs autorisées et sa valeur par défaut.
- BAnnexe B : Matrice des éditionsQuelle édition, quel module complémentaire ou quel pack métier inclut chaque fonctionnalité.
- CAnnexe C : Codes d'erreurChaque code de refus que rencontre un opérateur ou un développeur, sa signification et la marche à suivre.
- DAnnexe D : Services et portsChaque service exécuté par le chart, ses ports et la clé de valeurs qui le configure.
- EAnnexe E : GlossaireLes termes utilisés dans les deux parties, expliqués simplement.
- FAnnexe F : L'architecture en un coup d'œilL'ensemble de la plateforme, le cœur open source et ce qui fait l'objet d'une licence par-dessus, chaque mode d'exécution de Nexus, et chacun des dix packs métier, avec un schéma pour chacun.
- GAnnexe G : Dictionnaire de données et modèles de connaissancesLes champs de chaque enregistrement, et ce dont est fait chaque pack métier.
Télécharger
- Part 1, for everyone (PDF) (s'ouvre dans un nouvel onglet) 18 MB
- Part 2, technical, with the appendices (PDF) (s'ouvre dans un nouvel onglet) 40 MB
Les PDF sont en anglais.