Wsparcie
Wersja 1.0.0-alpha.1najnowsza
Dokumentacja
Dokumentacja Adverant Nexus
Wydanie 1.0.0-alpha.1. Osobom nowym w systemie Nexus zalecamy rozpoczęcie od Części 1; Część 2 jest przeznaczona dla osób odpowiedzialnych za instalację i utrzymanie systemu.
Poznaj mapę modelu wiedzyWspólny rdzeń i poszczególne pakiety domenowe wraz z ich perspektywami, modułami i relacjami.
Część 1: Dla każdego
- 1.1Czym jest Nexus i dla kogo jest przeznaczonyCo Adverant Nexus robi dla organizacji, dla kogo został zbudowany i jak jego części do siebie pasują – opowiedziane prostymi słowami na przykładzie Harrow Port Authority. Kończy się opisem trzech edycji w jednym akapicie.
- 1.2Dzień roboczy z systemem NexusJeden dzień roboczy w Harrow Port Authority, od pierwszego spojrzenia na widok Dzisiaj (Today) po ostatnie zatwierdzenie, pokazujący, co ludzie faktycznie robią w systemie Nexus i gdzie znajduje się każdy rodzaj pracy.
- 1.3Państwa organizacja, jej pracownicy i to, co pozostaje prywatneJak Nexus modeluje organizację i role pełnione przez jej pracowników, kto może dokonywać zakupów i przypisywać instalacje na koncie Adverant oraz gdzie przebiega granica między tym, co widzą administratorzy, a tym, co pozostaje prywatne dla każdej osoby.
- 1.4AI na Państwa warunkachJak Nexus wykorzystuje sztuczną inteligencję (AI) na warunkach samej organizacji. Organizacja wnosi i posiada własne klucze do modeli, jedna centrala kieruje każde wywołanie modelu do wybranych przez nią dostawców, modele lokalne działają na jej własnych serwerach i nic nie jest wysyłane do Adverant za jej plecami.
- 1.5Zaufanie i zgodność z przepisamiCzęści systemu Nexus, w których na co dzień pracuje specjalista ds. zgodności (compliance officer). Obejmuje dziennik audytu i zapieczętowane rekordy, zatwierdzenia wymagające drugiej osoby oraz decyzje sztucznej inteligencji (AI) oczekujące na przegląd. Kończy się wnioskami dotyczącymi danych osobowych oraz stronami zgodności, które utrzymują dowody w gotowości, zanim poprosi o nie audytor.
- 1.6Edycje i licencje prostymi słowamiTrzy edycje systemu Nexus oraz 19 dodatków i pakietów domenowych ponad nimi, a następnie sposób działania licencji dla firmy. Obejmuje weryfikację offline i praktyczne znaczenie każdego stanu licencji, obietnice dotrzymywane przez każdą licencję oraz przejście z edycji Community do Enterprise bez ponownej instalacji.
- 1.7Pakiety domenowe i rozwiązania branżoweCo pakiet domenowy dodaje do systemu Nexus dla jednej branży, dziesięć pakietów oferowanych przez Adverant, jak pakiet jest włączany dla jednej jednostki i czego pakiet wymaga w Państwa licencji.
- 1.8Gdzie działa NexusMiejsca, w których może działać Nexus – od chmury UE firmy Adverant po ośrodek bez dostępu do internetu i urządzenia w terenie – co w praktyce oznacza suwerenność i jak dokonać wyboru.
- 1.9Pierwsze krokiDwie decyzje przed rozpoczęciem, zadania Państwa zespołu IT, pierwsze uruchomienie widziane oczami pierwszego administratora oraz lista kontrolna tego, co należy przygotować na pierwszy dzień.
- 1.10Z dala od biurkaKorzystanie z systemu Nexus na telefonie, od układu konsoli dostosowanego do telefonu w każdej edycji po natywne aplikacje na telefony iPhone i system Android. Obejmuje to, co działa bez zasięgu, oraz sposób, w jaki firma zarządza telefonami.
- 1.11Dostosowywanie do własnych potrzebSposoby, w jakie organizacja kształtuje system Nexus – od pojedynczego ustawienia po własne rozwiązanie branżowe. A także jak poinstruować programistów lub partnera i co gwarantuje platforma, niezależnie od tego, co zostanie zbudowane.
- 1.12Pytania, które zadają ludzieProste odpowiedzi na pytania, które najczęściej zadają nabywcy, menedżerowie i inspektorzy ochrony danych, w tym te niewygodne, dotyczące pieniędzy i dostępu do Państwa danych.
Część 2: Dla działów IT, DevOps i programistów
- 2.1ArchitekturaZa co odpowiada każda usługa w pakiecie chart systemu Nexus i jakie magazyny danych znajdują się pod nią, a następnie reguły, które łączą je w całość – od tożsamości między usługami po ścieżkę, którą pokonuje każde wywołanie modelu.
- 2.2Edycje od środkaJak edycje Community i Enterprise są budowane z jednego produktu, jak licencja włącza grupy funkcji w czasie wykonywania, co instalacja Community pokazuje w miejscu strony Enterprise oraz co to oznacza dla pobieranych obrazów i budowanych rozszerzeń.
- 2.3Planowanie instalacjiCzego wymaga instalacja systemu Nexus na platformie Kubernetes przed wpisaniem polecenia, jak duża jest, oraz dwie decyzje, których nie można cofnąć: nazwa instalacji i depozytariusze kluczy. Kończy się wypełnionym arkuszem planowania dla Harrow Port Authority.
- 2.4Pobieranie i weryfikacja wydaniaGdzie znajduje się każda część wydania systemu Nexus, jak obrazy Enterprise są pobierane za pomocą tokenu pobierania (pull token) oraz jak udowodnić offline, przed zainstalowaniem czegokolwiek, że każdy obraz, pakiet chart i pobrany plik pochodzą od firmy Adverant w niezmienionej postaci.
- 2.5Kontrola wstępna (preflight) za pomocą nexusctlKażde sprawdzenie wykonywane przez polecenie `nexusctl preflight`, co każde z nich odczytuje i jak zgłasza błąd, raport, który wypisuje i zapisuje, jak ten raport trafia na stronę kontroli wstępnej w konsoli, oraz każda flaga.
- 2.6Instalacja edycji Community na platformie KubernetesPonumerowana instalacja edycji Community za pomocą narzędzia Helm, od cert-manager po gotowość każdego obciążenia (workload), z objaśnieniem pliku wartości klucz po kluczu, dlaczego nie używa się flagi --wait, kolejność, w jakiej uruchamiane są punkty zaczepienia (hooks) pakietu chart, oraz ścieżka instalacji za pomocą nexusctl jako alternatywa.
- 2.7Instalacja edycji Enterprise i stosowanie licencjiCo się zmienia po zainstalowaniu edycji Enterprise, jak wystąpić o licencję z konta Adverant, trzy sposoby jej importu wraz ze wszystkimi kodami odmowy oraz jak organizacja Harrow Port Authority przeniosła swój pilotaż w edycji Community do Enterprise w miejscu, bez utraty danych.
- 2.8Instalacje na pojedynczej maszynieZainstaluj system Nexus na jednym serwerze z systemem Linux za pomocą nexusctl lub przetestuj go na laptopie z k3d i połącz się z konsolą przez HTTPS, aby działało logowanie oraz klucze dostępu (passkeys).
- 2.9Obraz dysku instalatoraUruchom czysty serwer lub maszynę wirtualną z obrazu instalatora Nexus, a zainstaluje on system operacyjny, k3s, cert-manager oraz system Nexus bez dostępu do sieci, sprawdzając każdy plik przed użyciem.
- 2.10Instalacja w środowisku odizolowanym (air-gapped)Przenieś podpisany pakiet offline do lokalizacji bez dostępu do internetu, zweryfikuj go względem klucza dostarczonego osobno, załaduj do własnego rejestru i zainstaluj. Licencje, aktualizacje i listy odwołań również pokonują tę barierę ręcznie.
- 2.11Warianty: zewnętrzne magazyny danych, TLS i ingressWartości dopasowujące system Nexus do klastra, który nie jest pusty – w tym TLS (Transport Layer Security), a także już uruchomione bazy danych, własne certyfikaty, inny kontroler ingress, klasy pamięci masowej, poczta, serwery proxy, repliki oraz zarządzany Kubernetes.
- 2.12Pierwsze uruchomienieOd nieprzypisanej instalacji do gotowości do pracy. Wygeneruj kod przypisania, przejmij instalację w przeglądarce, utwórz pierwszego administratora z kluczem dostępu (passkey), a następnie podłącz logowanie firmowe i zaproś pozostałych użytkowników.
- 2.13LicencjeCo zawiera plik licencji Nexus, jak instalacja sprawdza go w trybie offline, w jakich sześciu stanach może się znajdować oraz jak wystąpić o licencję, zaimportować ją, odnowić i wycofać.
- 2.14Dostawcy i modele AIJak router dostawców sztucznej inteligencji (AI) (AI Provider Router) wybiera model z własnej puli kluczy organizacji oraz jak skrypty i narzędzia AI łączą się z systemem Nexus z zewnątrz.
- 2.15Dzień drugi: eksploatacja systemu NexusRutynowe działania związane z utrzymaniem instalacji po pierwszym tygodniu. Zaczynają się od odpieczętowania magazynu kluczy po restarcie, a kończą na deinstalacji.
- 2.16Bezpieczeństwo i siećJaki ruch przychodzący i wychodzący przepuszcza instalacja, jak jej usługi uwierzytelniają się nawzajem oraz jakie mechanizmy kontrolne operator ustawia lub dziedziczy na potrzeby logowania i bazy danych.
- 2.17Rozwiązywanie problemówProblemy najczęściej napotykane przez operatorów, uporządkowane według objawów. Każdy przypadek zawiera przyczynę, polecenie potwierdzające oraz rozwiązanie, a rozdział kończy się instrukcją wysłania pakietu diagnostycznego.
- 2.18Model rozszerzeńSześć sposobów na rozszerzenie systemu Nexus – od pojedynczego ustawienia po pakiet domenowy – ograniczenia każdego z nich oraz sposób, w jaki poziomy zaufania i izolacji decydują o miejscu wykonania kodu. Przeczytaj ten rozdział przed otwarciem pakietu SDK (software development kit).
- 2.19Reguły dziedziczone przez każde rozszerzenieIzolacja w trzech osiach, obliczenia przez UNO, sztuczna inteligencja (AI) przez router, klucze należące do organizacji oraz weryfikacja licencji. Co każda reguła oznacza dla Twojego kodu, która bramka ją egzekwuje i dlaczego ją dziedziczysz, zamiast pisać samodzielnie.
- 2.20Umiejętności (Skills)Jak napisać, przetestować i opublikować umiejętność silnika Skills Engine, gdzie się ona pojawia po wdrożeniu oraz czym różnią się umiejętności zdefiniowane w manifeście wtyczki. Zawiera praktyczny przykład podsumowania przydziału miejsc postojowych dla Harrow Port Authority.
- 2.21Pakiet Plugin SDKInstalacja pakietu Plugin SDK (software development kit), jego narzędzia wiersza poleceń, przegląd szablonu pełnej usługi, omówienie manifestu v2 pole po polu oraz dwadzieścia dwie bramki pilnujące zgodności wtyczki z regułami.
- 2.22Środowisko uruchomieniowe wtyczekModuły pakietu SDK (software development kit), na których działa wtyczka – od strażnika zakresu i bariery bazy danych po dyspozytora UNO, odczyt trasy sztucznej inteligencji (AI) i weryfikację licencji. Następnie testowanie z użyciem rzeczywistej bazy danych, rejestrowanie umiejętności oraz wdrożenie początkowe (onboarding).
- 2.23Pakiety domenoweZ czego składa się pakiet domenowy i co zawiera jego plik pack.json; soczewki (lenses) i rejestr soczewek; modele wiedzy, konektory i nakładki mobilne; jak pakiet jest licencjonowany i włączany dla jednostki; oraz dziesięć pakietów dostarczanych przez Adverant.
- 2.24Kompleksowe budowanie niestandardowego rozwiązania branżowegoPraktyczny przykład budowy pakietu domenowego Cold chain, od pierwszych założeń po wydanie działające w każdej jednostce, obejmujący model wiedzy, soczewki, umiejętność, wtyczkę full-service oraz dane przykładowe. Następnie omówienie sposobu rozszerzania istniejącego pakietu oraz dodawania soczewki do pakietu, który został już wdrożony.
- 2.25Budowanie dla poszczególnych edycjiCo się zmienia, gdy jedno rozszerzenie musi działać w każdej edycji, w środowisku odizolowanym (air-gapped), w ładunku Nexus Edge lub pod własną marką klienta. Obejmuje granicę licencyjną dla modułów Enterprise oraz podpisywane dostarczanie w trybie offline, wraz z macierzą określającą, co należy zrobić inaczej dla każdego środowiska docelowego.
- 2.26Budowanie z wykorzystaniem narzędzi programistycznych AIJak bezpiecznie budować rozszerzenia systemu Nexus za pomocą Claude Code i innych narzędzi programistycznych opartych na AI (sztucznej inteligencji). Rozdział zaczyna się od połączenia Państwa środowiska IDE (zintegrowanego środowiska programistycznego) z usługą Workbench oraz plikiem projektu CLAUDE.md zawierającym reguły platformy, a kończy na sześciu praktycznych promptach i bramce kontrolnej weryfikującej każdy z nich.
- 2.27Scenariusze budowyZbiór trzynastu przepisów na budowę rozwiązań – od pojedynczej umiejętności po dostawę do środowiska odizolowanego (air-gapped). Każdy przepis określa cel, elementy składowe, kroki i polecenia, bramkę kontrolną potwierdzającą powodzenie oraz różnice w zależności od edycji i formy dostarczenia.
- 2.28Wydawanie rozszerzeniaJak wtyczka lub pakiet przechodzi od pomyślnej kompilacji do jednostek, które je uruchamiają, i jak zostaje z nich wycofana. Wersje, przegląd wydania, kanały i instalacje, podpisywanie, zatwierdzenia zmian, rekord tożsamości dostawy, migracje, wycofywanie zmian (rollback) oraz wygaszanie wersji.
Dodatki: Dokumentacja referencyjna
- ADodatek A: Wykaz wartości HelmKażdy klucz akceptowany przez chart Nexus, jego typ, dozwolone wartości oraz wartość domyślna.
- BDodatek B: Macierz edycjiKtóra edycja, dodatek lub pakiet domenowy zawiera poszczególne możliwości.
- CDodatek C: Kody błędówKażdy kod odmowy, z jakim spotyka się operator lub programista, jego znaczenie oraz sposób postępowania.
- DDodatek D: Usługi i portyKażda usługa uruchamiana przez chart, jej porty oraz klucz wartości, który ją konfiguruje.
- EDodatek E: SłowniczekTerminy używane w obu częściach, wyjaśnione prostym językiem.
- FDodatek F: Architektura w skrócieCała platforma, otwarty rdzeń i elementy licencjonowane ponad nim, każdy sposób uruchamiania systemu Nexus oraz każdy z dziesięciu pakietów domenowych – po jednym diagramie dla każdego zagadnienia.
- GDodatek G: Słownik danych i modele wiedzyPola występujące w każdym rekordzie oraz zawartość każdego pakietu domenowego.
Pobierz
- Part 1, for everyone (PDF) (otwiera się w nowej karcie) 18 MB
- Part 2, technical, with the appendices (PDF) (otwiera się w nowej karcie) 40 MB
Pliki PDF są w języku angielskim.