Kirjaudu sisäänVaraa esittely
Tuki
Versio 1.0.0-alpha.1uusin

Dokumentaatio

Adverant Nexus -dokumentaatio

Julkaisu 1.0.0-alpha.1. Aloita osasta 1, jos Nexus on sinulle uusi; osa 2 on tarkoitettu sen asentajille ja ylläpitäjille.

Osa 1: Kaikille

  • 1.1Mikä Nexus on ja kenelle se on tarkoitettuMitä Adverant Nexus tekee organisaatiolle, kenelle se on rakennettu ja miten sen osat sopivat yhteen – selkeästi kerrottuna käyttäen esimerkkinä Harrow Port Authoritya. Lopuksi esitellään kolme eri versiota yhdessä kappaleessa.
  • 1.2Työpäivä Nexuksen parissaYksi työpäivä Harrow Port Authoritylla aina ensimmäisestä vilkaisusta Tänään-näkymään viimeiseen hyväksyntään. Katsaus näyttää, mitä ihmiset todellisuudessa tekevät Nexuksessa ja missä kukin työtehtävä sijaitsee.
  • 1.3Organisaationne, sen ihmiset ja mikä pysyy yksityisenäMiten Nexus mallintaa organisaation ja sen henkilöstön roolit, kuka voi tehdä ostoja ja lunastuksia Adverant-tilillä, sekä raja sen välillä, mitä pääkäyttäjät näkevät ja mikä pysyy kunkin henkilön yksityisenä tietona.
  • 1.4Tekoäly omilla ehdoillanneMiten Nexus käyttää tekoälyä (AI) organisaation omilla ehdoilla. Organisaatio tuo ja omistaa malliavaimensa, yksi välityskeskus reitittää jokaisen mallikutsun organisaation valitsemille palveluntarjoajille, paikalliset mallit pyörivät sen omilla palvelimilla eikä mitään lähetetä Adverantille salaa.
  • 1.5Luottamus ja vaatimustenmukaisuusNexuksen osat, joissa vaatimustenmukaisuusvastaava työskentelee. Tämä kattaa tarkastuslokin ja sinetöidyt tietueet, toisen henkilön vaativat hyväksynnät sekä tarkistusta odottavat tekoälypäätökset (AI). Lopuksi käsitellään henkilötietopyynnöt ja vaatimustenmukaisuussivut, jotka pitävät todisteet valmiina ennen kuin tarkastaja niitä pyytää.
  • 1.6Versiot ja lisenssit selkokielelläNexuksen kolme versiota ja niiden päälle tulevat 19 lisäosaa ja toimialapakettia sekä se, miten lisenssi toimii yrityksessä. Käsittelee offline-tarkistuksen, mitä kukin lisenssitila tarkoittaa käytännössä, lupaukset jotka jokainen lisenssi pitää sekä siirtymisen Community-versiosta Enterprise-versioon ilman uudelleenasennusta.
  • 1.7Toimialapaketit ja toimialaratkaisutMitä toimialapaketti lisää Nexukseen tietylle toimialalle, Adverantin tarjoamat kymmenen pakettia, miten paketti kytketään päälle yhdelle yksikölle ja mitä paketti vaatii lisenssiltänne.
  • 1.8Missä Nexus pyöriiPaikat, joissa Nexusta voidaan ajaa aina Adverantin EU-pilvestä internetittömään toimipisteeseen ja kenttälaitteisiin, mitä suvereniteetti tarkoittaa käytännössä ja miten valita sopiva vaihtoehto.
  • 1.9AloittaminenKaksi päätöstä ennen aloittamista, mitä IT-tiiminne tekee, ensimmäinen käyttökerta ensimmäisen pääkäyttäjän silmin sekä tarkistuslista asioista, joiden on oltava valmiina ensimmäisenä päivänä.
  • 1.10Poissa työpöydän äärestäNexuksen käyttö puhelimella aina jokaisen version konsolin mobiilinäkymästä natiiveihin iPhone- ja Android-sovelluksiin. Kattaa sen, mikä toimii ilman verkkoyhteyttä ja miten yritys hallinnoi puhelimia.
  • 1.11Muokkaaminen omannäköiseksiTavat, joilla organisaatio muovaa Nexusta yksittäisestä asetuksesta aina omaan toimialaratkaisuun saakka. Lisäksi ohjeet kehittäjien tai kumppanin ohjeistamiseen sekä se, mitä alusta takaa riippumatta siitä, mitä rakennetaan.
  • 1.12Usein kysytyt kysymyksetSelkeät vastaukset kysymyksiin, joita ostajat, johtajat ja tietosuojavastaavat esittävät eniten – mukaan lukien kiusalliset kysymykset rahasta ja pääsystä tietoihinne.

Osa 2: IT:lle, DevOpsille ja kehittäjille

  • 2.1ArkkitehtuuriMitä kukin Nexus-kaavion palvelu omistaa ja mitkä tietovarastot ovat sen alla, sekä säännöt, jotka pitävät ne yhdessä aina palveluiden välisestä identiteetistä polkuun, jonka jokainen mallikutsu kulkee.
  • 2.2Versiot konepellin allaMiten Community ja Enterprise rakennetaan yhdestä tuotteesta, miten lisenssi kytkee ominaisuusryhmät päälle ajon aikana, mitä Community-asennus näyttää Enterprise-sivun kohdalla ja mitä tämä tarkoittaa noudettaville levykuville ja rakennettaville laajennuksille.
  • 2.3Asennuksen suunnitteluMitä Nexuksen Kubernetes-asennus vaatii ennen kuin kirjoitatte yhtäkään komentoa, kuinka suuri se on ja kaksi päätöstä, joita ei voi perua: asennuksen nimi ja avainten haltijat. Lopuksi Harrow Port Authorityn täytetty suunnittelulomake.
  • 2.4Julkaisun noutaminen ja varmentaminenMissä kukin Nexus-julkaisun osa sijaitsee, miten Enterprise-levykuvat noudetaan noutotunnisteella (pull token) ja miten todistetaan offline-tilassa ennen minkään asentamista, että jokainen levykuva, kaavio ja lataus on tullut Adverantilta muuttumattomana.
  • 2.5Esitarkistus nexusctl-työkalullaJokainen tarkistus, jonka `nexusctl preflight` tekee, mitä kukin niistä lukee ja miten se epäonnistuu, sen tulostama ja tallentama raportti, miten raportti päätyy konsolin esitarkistussivulle sekä jokainen valitsin.
  • 2.6Community-version asentaminen KubernetesiinCommunity-version vaiheittainen asennus Helmillä aina cert-managerista siihen, kunnes jokainen työkuorma on valmis. Sisältää values-tiedoston selityksen avain avaimelta, miksi --wait-valitsinta ei käytetä, järjestyksen jossa kaavion koukut (hooks) ajetaan sekä vaihtoehtoisen nexusctl install -asennustavan.
  • 2.7Enterprise-version asentaminen ja lisenssin käyttöönottoMikä muuttuu, kun asennat Enterprise-version, kuinka pyydät lisenssin Adverant-tililtäsi, kolme tapaa tuoda se kaikkine hylkäyskoodeineen sekä kuinka Harrow Port Authority päivitti Community-pilottinsa suoraan Enterprise-versioon menettämättä mitään.
  • 2.8Yhden koneen asennuksetAsenna Nexus yhdelle Linux-palvelimelle nexusctl-työkalulla tai arvioi sitä kannettavalla tietokoneella k3d:n avulla, ja yhdistä konsoliin HTTPS-yhteydellä, jotta kirjautuminen ja avainkoodit toimivat.
  • 2.9AsennuslevykuvaKäynnistä tyhjä palvelin tai virtuaalikone Nexuksen asennuslevykuvalta, niin se asentaa käyttöjärjestelmän, k3s:n, cert-managerin ja Nexuksen ilman verkkoyhteyttä tarkistaen jokaisen tiedoston ennen sen käyttöä.
  • 2.10Ilmarakoasennus (air-gapped)Vie allekirjoitettu offline-paketti toimipisteeseen, jossa ei ole internet-yhteyttä, vahvista se erikseen tuodulla avaimella, lataa se omaan rekisteriisi ja asenna. Myös lisenssit, päivitykset ja sulkulistat siirretään ilmaraon yli manuaalisesti.
  • 2.11Muunnelmat: ulkoiset tietovarastot, TLS ja ingressArvot, joilla Nexus sovitetaan muuhun kuin tyhjään klusteriin, mukaan lukien TLS (Transport Layer Security), jo käytössäsi olevat tietokannat, omat varmenteesi, toinen ingress-ohjain, tallennusluokat, sähköposti, välityspalvelimet, replikat ja hallinnoitu Kubernetes.
  • 2.12Ensimmäinen käyttökertaLunastamattomasta asennuksesta työn ääreen. Luo lunastuskoodi, lunasta asennus selaimessa, luo ensimmäinen pääkäyttäjä avainkoodilla, yhdistä sitten yrityksen kirjautuminen ja kutsu kaikki muut.
  • 2.13LisenssitMitä Nexuksen lisenssitiedosto sisältää, kuinka asennus tarkistaa sen offline-tilassa, sen kuusi mahdollista tilaa ja kuinka pyydät, tuot, uusit ja peruutat lisenssin.
  • 2.14Tekoälytarjoajat ja -mallitKuinka tekoälyn (AI) Provider Router valitsee mallin organisaation omasta avainvarannosta, ja kuinka komentosarjat ja tekoälytyökalut tavoittavat Nexuksen ulkopuolelta.
  • 2.15Toinen päivä: Nexuksen ylläpitoAsennuksen rutiininomainen ylläpito ensimmäisen viikon jälkeen. Se alkaa avainsäilön sinetin avaamisesta uudelleenkäynnistyksen jälkeen ja päättyy asennuksen poistamiseen.
  • 2.16Tietoturva ja verkkoMitä asennus päästää sisään ja ulos, kuinka sen palvelut todistavat identiteettinsä toisilleen sekä hallintakeinot, jotka ylläpitäjä asettaa tai perii kirjautumista ja tietokantaa varten.
  • 2.17VianmääritysOngelmat, joita ylläpitäjät kohtaavat useimmin, järjestettyinä oireiden mukaan. Jokaisesta kerrotaan syy, sen vahvistava komento ja korjaus, ja luku päättyy tukipaketin lähettämiseen.
  • 2.18LaajennusmalliKuusi tapaa laajentaa Nexusta asetuksesta toimialapakettiin, kunkin rajoitukset sekä kuinka luottamus- ja eristystasot määräävät, missä koodisi suoritetaan. Lue tämä ennen kuin avaat ohjelmistokehityspaketin (SDK).
  • 2.19Säännöt, jotka jokainen laajennus periiEristys kolmella akselilla, laskenta UNOn kautta, tekoäly (AI) reitittimen kautta, organisaation omistamat avaimet ja lisenssitarkistukset. Mitä kukin sääntö tarkoittaa koodillesi, mikä portti valvoo sitä ja miksi perit sen sen sijaan, että kirjoittaisit sen itse.
  • 2.20Taidot (Skills)Kuinka kirjoitat, testaat ja julkaiset Skills Engine -taidon, missä se näkyy julkaisun jälkeen ja kuinka lisäosan manifestitaidot eroavat siitä. Sisältää käytännön esimerkin laituripaikkojen jakamisen yhteenvedosta Harrow Port Authoritylle.
  • 2.21Plugin SDKPlugin SDK -ohjelmistokehityspaketin asentaminen, sen komentorivityökalut, täyden palvelun mallipohjan esittely, v2-manifesti kenttä kentältä sekä 22 porttia, jotka varmistavat, että lisäosa noudattaa sääntöjä.
  • 2.22Lisäosan ajoaika (runtime)SDK-ohjelmistokehityspaketin moduulit, joiden päällä lisäosasi toimii, aina vaikutusalueen vartijasta (scope guard) ja tietokanta-aidasta UNO-välitykseen, tekoälyreitin (AI) lukuun ja lisenssitarkistuksiin. Sen jälkeen testaus oikeaa tietokantaa vasten, taitojen rekisteröinti ja käyttöönotto.
  • 2.23ToimialapaketitMistä toimialapaketti koostuu ja mitä sen pack.json sisältää; linssit ja linssirekisteri; tietomallit, liittimet ja mobiilikerrokset; kuinka paketti lisensoidaan ja otetaan käyttöön yksikölle; sekä Adverantin toimittamat kymmenen pakettia.
  • 2.24Räätälöidyn toimialaratkaisun rakentaminen alusta loppuunKylmäketjun toimialapaketin käytännön toteutus ensimmäisestä toimeksiannosta aina jokaista yksikköä palvelevaan julkaisuun asti, sisältäen tietomallin, näkymät, taidon, täyden palvelun liitännäisen ja testiaineiston. Lisäksi käydään läpi, miten olemassa olevaa pakettia laajennetaan ja miten jo toimitettuun pakettiin lisätään näkymä.
  • 2.25Rakentaminen eri versioilleMikä muuttuu, kun yhden laajennuksen on toimittava jokaisessa versiossa, ilmavälitteisessä ympäristössä, Nexus Edge -kokoonpanossa tai asiakkaan oman brändin alla. Käsittelee Enterprise-moduulien lisenssirajan ja allekirjoitetun offline-toimituksen sekä sisältää matriisin siitä, mitä kussakin kohteessa on tehtävä toisin.
  • 2.26Rakentaminen tekoälypohjaisilla koodaustyökaluillaKuinka rakentaa Nexus-laajennuksia turvallisesti Claude Coden ja muiden tekoälypohjaisten koodaustyökalujen avulla. Aloitetaan yhdistämällä kehitysympäristönne (IDE, integroitu kehitysympäristö) Workbenchiin ja määrittämällä projektin CLAUDE.md, joka sisältää alustan säännöt, ja lopuksi käydään läpi kuusi valmista kehotetta sekä tarkistusportti, joka todentaa niistä jokaisen.
  • 2.27RakennusskenaariotKolmentoista toteutuksen keittokirja yksittäisestä taidosta aina ilmavälitteiseen toimitukseen. Jokainen resepti sisältää tavoitteen, rakennuspalikat, vaiheet ja komennot, toimivuuden todentavan tarkistusportin sekä tiedot siitä, mikä muuttuu version ja toimitusmuodon mukaan.
  • 2.28Laajennuksen julkaiseminenKuinka liitännäinen tai paketti etenee onnistuneesta koontiversiosta sitä ajaviin yksiköihin, ja kuinka se poistetaan käytöstä. Versiot, julkaisukatselmointi, kanavat ja asennukset, allekirjoittaminen, muutoshallinnan hyväksynnät, toimitusidentiteettitietue, migraatiot, palautus ja version poistaminen käytöstä.

Liitteet: Viiteopas

Lataaminen

PDF-tiedostot ovat englanninkielisiä.