Suporte
Versão 1.0.0-alpha.1mais recente
Documentação
Documentação do Adverant Nexus
Versão 1.0.0-alpha.1. Comece pela Parte 1 se é novo no Nexus; a Parte 2 destina-se às pessoas que o instalam e executam.
Explore o mapa do modelo de conhecimentoO núcleo partilhado e cada pacote de domínio, com as respetivas lentes, módulos e relações.
Parte 1: Para todos
- 1.1O que é o Nexus e a quem se destinaO que o Adverant Nexus faz por uma organização, para quem foi criado e como as suas partes se encaixam, explicado em palavras simples com a Harrow Port Authority como exemplo. Termina com as três edições num só parágrafo.
- 1.2Um dia de trabalho com o NexusUm dia de trabalho na Harrow Port Authority, desde o primeiro olhar para a página Today até à última aprovação, mostrando o que as pessoas realmente fazem no Nexus e onde se encontra cada tipo de trabalho.
- 1.3A sua organização, as suas pessoas e o que permanece privadoComo o Nexus modela uma organização e as funções que as suas pessoas desempenham, quem pode comprar e reivindicar na conta Adverant, e a fronteira entre o que os administradores podem ver e o que permanece privado para cada pessoa.
- 1.4IA nos seus termosComo o Nexus utiliza a inteligência artificial (IA) nos próprios termos da organização. A organização traz e detém as suas chaves de modelo, uma central encaminha cada chamada de modelo para os fornecedores que escolheu, os modelos locais são executados nos seus próprios servidores e nada é enviado para a Adverant nas suas costas.
- 1.5Confiança e conformidadeAs partes do Nexus onde trabalha um responsável pela conformidade. Abrange o registo de auditoria e os registos selados, as aprovações que necessitam de uma segunda pessoa e as decisões de inteligência artificial (IA) a aguardar revisão. Termina com os pedidos de dados pessoais e as páginas de conformidade que mantêm as evidências prontas antes que um auditor as peça.
- 1.6Edições e licenças em termos simplesAs três edições do Nexus e os 19 suplementos e pacotes de domínio adicionais, seguidos de como funciona uma licença para uma empresa. Abrange a verificação offline e o que cada estado da licença significa na prática, as promessas que cada licença cumpre e a mudança de Community para Enterprise sem reinstalar.
- 1.7Pacotes de domínio e verticaisO que um pacote de domínio acrescenta ao Nexus para um setor, os dez pacotes que a Adverant oferece, como um pacote é ativado para uma unidade e o que um pacote necessita na sua licença.
- 1.8Onde o Nexus é executadoOs locais onde o Nexus pode ser executado, desde a nuvem da UE da Adverant até uma instalação sem internet e dispositivos no terreno, o que significa soberania na prática e como escolher.
- 1.9Primeiros passosAs duas decisões antes de começar, o que faz a sua equipa de TI, a primeira execução tal como o primeiro administrador a vê e uma lista de verificação do que deve ter pronto no primeiro dia.
- 1.10Longe da secretáriaUtilizar o Nexus num telemóvel, desde a disposição para telemóvel da consola em todas as edições até às aplicações nativas para iPhone e Android. Abrange o que funciona sem rede e como uma empresa gere os telemóveis.
- 1.11Torná-lo seuAs formas como uma organização molda o Nexus, desde uma simples definição até uma vertical própria. Inclui também como instruir programadores ou um parceiro, e o que a plataforma garante independentemente do que for construído.
- 1.12Perguntas frequentesRespostas diretas às perguntas que compradores, gestores e encarregados da proteção de dados mais fazem, incluindo as mais incómodas sobre dinheiro e acesso aos seus dados.
Parte 2: Para TI, DevOps e programadores
- 2.1ArquiteturaO que cada serviço no chart do Nexus detém e que repositórios de dados lhe estão subjacentes, seguidos das regras que os mantêm unidos, desde a identidade entre serviços até ao caminho que cada chamada de modelo percorre.
- 2.2As edições por dentroComo as edições Community e Enterprise são construídas a partir de um único produto, como uma licença ativa grupos de funcionalidades em tempo de execução, o que uma instalação Community mostra numa página Enterprise, e o que isso significa para as imagens que transfere e as extensões que constrói.
- 2.3Planear uma instalaçãoO que uma instalação Kubernetes do Nexus necessita antes de introduzir um comando, qual a sua dimensão e as duas decisões irreversíveis: o nome da instalação e os guardiões das chaves. Termina com a folha de planeamento preenchida da Harrow Port Authority.
- 2.4Obter e verificar uma versãoOnde reside cada parte de uma versão do Nexus, como as imagens Enterprise são obtidas com um token de transferência (pull token) e como provar offline que cada imagem, chart e transferência veio da Adverant sem alterações, antes de instalar o que quer que seja.
- 2.5Verificação prévia com o nexusctlCada verificação que o `nexusctl preflight` efetua, o que cada uma lê e como falha, o relatório que apresenta e guarda, como esse relatório chega à página de verificação prévia da consola e todas as opções (flags).
- 2.6Instalar a edição Community no KubernetesUma instalação passo a passo da edição Community com o Helm, desde o cert-manager até todas as cargas de trabalho estarem prontas, com o ficheiro de valores explicado chave a chave, a razão pela qual não existe --wait, a ordem de execução dos hooks do chart e a via de instalação com o nexusctl como alternativa.
- 2.7Instalar a edição Enterprise e aplicar uma licençaO que muda quando instala a edição Enterprise, como solicitar uma licença a partir da sua conta Adverant, as três formas de a importar com todos os códigos de recusa e como a Harrow Port Authority mudou o seu piloto Community para Enterprise no local sem perder nada.
- 2.8Instalações numa única máquinaInstalar o Nexus num único servidor Linux com o nexusctl, ou avaliá-lo num portátil com o k3d, e aceder à consola por HTTPS para que o início de sessão e as chaves de acesso (passkeys) funcionem.
- 2.9A imagem de disco do instaladorArranque um servidor físico ou uma máquina virtual a partir da imagem do instalador do Nexus e esta instalará o sistema operativo, o k3s, o cert-manager e o Nexus sem rede, verificando cada ficheiro antes de ser utilizado.
- 2.10Instalação isolada da rede (air-gapped)Transporte um pacote offline assinado para uma instalação sem internet, verifique-o contra uma chave que trouxe separadamente, carregue-o no seu próprio registo e instale. Licenças, atualizações e listas de revogação também atravessam o isolamento manualmente.
- 2.11Variações: repositórios externos, TLS e ingressOs valores que adaptam o Nexus a um cluster que não está em branco, incluindo TLS (Transport Layer Security), juntamente com bases de dados que já executa, os seus próprios certificados, outro controlador de ingress, classes de armazenamento, correio eletrónico, proxies, réplicas e Kubernetes gerido.
- 2.12A primeira execuçãoDe uma instalação não reivindicada até às pessoas a trabalhar. Gere o código de reivindicação, reivindique a instalação num navegador, crie o primeiro administrador com uma chave de acesso (passkey) e, em seguida, ligue o início de sessão da empresa e convide todos os outros.
- 2.13LicençasO que contém um ficheiro de licença do Nexus, como a instalação o verifica offline, os seis estados em que se pode encontrar e como solicitar, importar, renovar e retirar uma licença.
- 2.14Fornecedores e modelos de IAComo o encaminhador de fornecedores de inteligência artificial (IA) (AI Provider Router) seleciona um modelo do conjunto de chaves da própria organização e como scripts e ferramentas de IA acedem ao Nexus a partir do exterior.
- 2.15Dia dois: operar o NexusO trabalho de rotina de manter uma instalação em funcionamento após a primeira semana. Começa com a abertura do cofre de chaves após um reinício e termina com a desinstalação.
- 2.16Segurança e redeO que uma instalação deixa entrar e sair, como os seus serviços provam a sua identidade uns aos outros e os controlos que um operador define ou herda para o início de sessão e para a base de dados.
- 2.17Resolução de problemasOs problemas que os operadores encontram com mais frequência, organizados pelo que se observa. Cada um indica a causa, o comando que a confirma e a correção, e o capítulo termina com o envio de um pacote de suporte.
- 2.18O modelo de extensõesAs seis formas de estender o Nexus, desde uma definição até um pacote de domínio, os limites de cada uma e como os níveis de confiança e isolamento decidem onde o seu código é executado. Leia isto antes de abrir o kit de desenvolvimento de software (SDK).
- 2.19As regras que cada extensão herdaIsolamento em três eixos, computação através do UNO, IA (inteligência artificial) através do encaminhador, chaves detidas pela organização e verificações de licença. O que cada regra significa para o seu código e que controlo a aplica, e porque é que a herda em vez de a escrever.
- 2.20CompetênciasComo escrever, testar e publicar uma competência do Skills Engine, onde aparece assim que está ativa e como diferem as competências de manifesto num plugin. Inclui um exemplo prático de resumo de atribuição de cais para a Harrow Port Authority.
- 2.21O Plugin SDKInstalar o Plugin SDK (kit de desenvolvimento de software), as suas ferramentas de linha de comandos, uma visita guiada ao modelo de serviço completo, o manifesto v2 campo a campo e as vinte e duas barreiras de controlo que obrigam um plugin a cumprir as regras.
- 2.22O tempo de execução do pluginOs módulos do SDK (kit de desenvolvimento de software) em que o seu plugin é executado, desde a guarda de âmbito e a cerca da base de dados até ao envio UNO, à leitura de rota de IA (inteligência artificial) e às verificações de licença. Depois, os testes contra uma base de dados real, o registo das suas competências e a integração inicial.
- 2.23Pacotes de domínioDe que é feito um pacote de domínio e o que diz o seu pack.json; lentes e o registo de lentes; modelos de conhecimento, conectores e sobreposições móveis; como um pacote é licenciado e ativado para uma unidade; e os dez pacotes que a Adverant disponibiliza.
- 2.24Construir uma solução vertical personalizada de ponta a pontaUma construção prática do pacote de domínio Cold chain, desde o primeiro caderno de encargos até uma versão em execução para todas as unidades, com o seu modelo de conhecimento, lentes, uma competência, um plugin de serviço completo e dados de exemplo. Depois, como estender um pacote já existente e como adicionar uma lente a um pacote que já foi lançado.
- 2.25Construir para cada ediçãoO que muda quando uma extensão tem de funcionar em todas as edições, numa instalação isolada da rede (air-gapped), num pacote de missão do Nexus Edge ou sob a marca própria de um cliente. Abrange a linha de licenciamento para módulos Enterprise e a entrega offline assinada, com uma matriz do que fazer de forma diferente para cada destino.
- 2.26Construir com ferramentas de programação de IAComo construir extensões do Nexus em segurança com o Claude Code e outras ferramentas de programação com IA (inteligência artificial). Começa com a ligação do seu IDE (ambiente de desenvolvimento integrado) ao Workbench e um ficheiro CLAUDE.md de projeto que transporta as regras da plataforma, e termina com seis instruções práticas e a barreira de controlo que valida cada uma delas.
- 2.27Cenários de construçãoUm livro de receitas com treze construções, desde uma única competência até uma entrega em ambiente isolado da rede (air-gapped). Cada receita indica o objetivo, os blocos de construção, os passos e comandos, a barreira de controlo que prova que funcionou e o que muda consoante a edição e a forma de entrega.
- 2.28Lançar a sua extensãoComo um plugin ou pacote passa de uma compilação bem-sucedida para as unidades que o executam, e como volta a sair. Versões, revisão de lançamento, canais e instalações, assinatura, aprovações de alterações, o registo de identidade de entrega, migrações, reversão e descontinuação de uma versão.
Apêndices: Referência
- AApêndice A: Referência de valores HelmCada chave que o chart do Nexus aceita, o seu tipo, os seus valores permitidos e o seu valor predefinido.
- BApêndice B: Matriz de ediçõesQue edição, suplemento ou pacote de domínio inclui cada capacidade.
- CApêndice C: Códigos de erroCada código de recusa que um operador ou programador encontra, o que significa e o que fazer.
- DApêndice D: Serviços e portasCada serviço que o chart executa, as suas portas e a chave de valores que o configura.
- EApêndice E: GlossárioOs termos utilizados em ambas as partes, em linguagem simples.
- FApêndice F: A arquitetura num relanceToda a plataforma, o núcleo aberto e o que é licenciado sobre ele, cada forma de executar o Nexus e cada um dos dez pacotes de domínio, num diagrama para cada caso.
- GApêndice G: Dicionário de dados e modelos de conhecimentoOs campos em cada registo e de que é feito cada pacote de domínio.
Transferir
- Part 1, for everyone (PDF) (abre num novo separador) 18 MB
- Part 2, technical, with the appendices (PDF) (abre num novo separador) 40 MB
Os PDFs estão em inglês.