Iniciar sessãoAgendar apresentação

Capítulo 2.2

As edições por dentro

Como 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.

Esta página foi traduzida por IA a partir do original em inglês. Em caso de dúvida, a página em inglês serve de referência. Ler esta página em inglês

17 minutos de leitura

Duas linhas num ficheiro de valores decidem qual edição uma instalação executa:

# harrow-values.yaml (Helm values): the edition of this installation
edition: enterprise
enterprise:
  enabled: true

Têm de concordar. Defina edition: community com enterprise.enabled: true e o chart para com "edition=community but enterprise.enabled=true: they must agree". Defina edition para qualquer valor diferente de community ou enterprise e ele para com NEXUS_EDITION_INVALID. Esses dois valores escolhem que imagens a instalação utiliza. O que essas imagens ativam a seguir é da responsabilidade da licença, em tempo de execução, um grupo de funcionalidades de cada vez.

Este capítulo analisa isto em detalhe: o que as edições contêm, como um produto se torna em duas compilações, como uma licença se transforma num sim ou num não dentro de um serviço em execução e o que isso significa quando constrói algo próprio. O Capítulo 1.6, Edições e licenças em termos simples, apresenta a perspetiva do comprador; esta é a do engenheiro.

A matriz de edições

Tudo neste capítulo provém de um único ficheiro, a matriz de edições. Esta lista 97 capacidades e atribui um nível a cada uma. A Adverant gera o catálogo de licenças e as regras de menu da consola a partir dela, juntamente com a fronteira entre o código aberto e o código fechado. Quando a matriz muda, todos estes elementos mudam em conjunto.

Existem três edições.

Edição Licença Onde é executada
Community Apache-2.0, código aberto, gratuita O seu hardware, ou na cloud da Adverant
Team Licença Adverant Enterprise Cloud da Adverant: Community mais o conjunto Team
Enterprise Licença Adverant Enterprise, por grupo de funcionalidades O seu hardware, ou na cloud da Adverant

Uma instalação executa uma de duas opções: o valor edition do chart aceita apenas community e enterprise. A Team é uma edição na cloud, e a Enterprise inclui também o conjunto Team, pelo que, no seu próprio hardware, as capacidades Team (o painel de trabalho ancorado ao lado de cada registo, blocos de notas partilhados, política de memória para a organização e o restante) vêm com a Enterprise.

A própria edição Enterprise está dividida em camadas. A base Enterprise é o núcleo fechado: várias organizações e unidades de negócio, aplicação de início de sessão único (SSO) com SAML (Security Assertion Markup Language) e sincronização de diretórios, funções personalizadas com aprovações de quatro olhos, retenção prolongada de auditoria, proteção de dados, as páginas de operador e gestão de clusters. Sobre a base assentam os add-ons, cada um licenciado separadamente, e os pacotes de domínio. O primeiro add-on na tabela, AI Gateway em escala, distribui a carga do encaminhador de IA (inteligência artificial) por réplicas e fornecedores.

Suplemento Também necessita de
Gateway de IA em escala Base
Fábrica de modelos Base
Ideias Base
Chamadas e voz Base
Correio Base
Outras empresas e barreiras Base
Estúdio de blocos de notas Base
Mapa e GeoAI Base
Conectores de dados Base
Agente para agente Base
Salas de decisão e registos selados Base
Operações de receitas Base
Montra digital / marca branca Base
Nexus Edge Base
Aplicações móveis Base
Força de trabalho Base; os agentes em dispositivos periféricos também necessitam do Nexus Edge, as aprovações num telemóvel também necessitam das aplicações móveis
Shield Base
Sandboxes Base
Qualidade (NexusQA) Base

Existem dez pacotes de domínio:

  • Seguros
  • Banca e pagamentos
  • Mercados de capitais e gestão de ativos
  • Governo e setor público
  • Saúde
  • Ciências da vida
  • Infraestruturas críticas e energia
  • Defesa e segurança
  • Serviços jurídicos e profissionais
  • Logística e setor marítimo

Cada pacote necessita da base Enterprise, e cinco deles necessitam também de um add-on. O pacote de Seguros necessita de Salas de decisão e registos selados. O mesmo acontece com o pacote de Mercados de capitais e gestão de ativos. O pacote de Serviços jurídicos e profissionais necessita desses dois mais o Mail. O de Logística e marítimo necessita de Map e GeoAI. No pacote de Defesa e segurança, os alertas da plataforma também necessitam do Nexus Edge. Os ecrãs de telemóvel de qualquer pacote também necessitam das aplicações móveis. O Capítulo 1.7, Pacotes de domínio e verticais, indica o que cada um contém.

Grupos de funcionalidades

A unidade que uma licença nomeia é o grupo de funcionalidades. Existem 32: a base Community, o conjunto Team, a base Enterprise, um por add-on e um por pacote. Cada capacidade pertence a exatamente um grupo, pelo que uma licença que liste "Base Enterprise, Map e GeoAI, Logística e marítimo" indica precisamente que capacidades esta instalação pode executar.

Nível Capacidades
Community 36
Team 6
Base Enterprise 18
Suplementos 23
Pacotes de domínio 14

Âmbito de concessão

Cada capacidade licenciada tem um âmbito de concessão, que indica a que se associa uma concessão.

  • O âmbito do inquilino abrange as partes em que as pessoas trabalham: Ideias, Mail, Operações de receitas, os pacotes. A licença disponibiliza-os para a instalação e, em seguida, são ativados ou desativados por organização e por unidade de negócio. Uma nova organização nunca herda um estado de "tudo ativo".
  • O âmbito da implementação abrange os cinco elementos que pertencem à instalação como um todo: a importação da licença com os artefactos que obtém, as formas de entrega Enterprise, as páginas de operador, a gestão de clusters e o Nexus Edge.

As capacidades Community não têm qualquer âmbito de concessão. Não necessitam de licença.

Um administrador pode restringir o que a licença permite, para uma organização ou uma unidade. Ninguém o pode alargar a partir do interior da instalação.

Uma pilha vertical de seis faixas. A partir da base: "Base mínima (todas as edições, nunca com acesso pago)"; "Community, Apache-2.0"; uma linha dupla espessa com a etiqueta "@adverant/nexus-spi, a única interface partilhada"; "Base Enterprise, módulos fechados"; "Add-ons (19), cada um licenciado separadamente"; "Pacotes de domínio (10)". À direita, uma caixa "Documento de licença assinado" com uma seta a apontar para as três faixas superiores com a etiqueta "verificado dentro de cada módulo fechado". À esquerda da faixa Community, uma nota "Imagens Community: apenas código aberto".
As edições como camadas, tendo o documento de licença como única autoridade.

Um produto, duas compilações

Existe uma única base de código Nexus. A compilação Community é a sua exportação de código aberto, e a compilação Enterprise é essa exportação mais os módulos fechados.

Uma lista de fronteiras atribui cada ficheiro monitorizado a uma edição. Na maioria dos casos, fá-lo nomeando a capacidade que um ficheiro implementa, e a edição do ficheiro decorre do nível dessa capacidade: uma capacidade Community origina um ficheiro Community, e qualquer elemento Team, base, add-on ou pacote origina um ficheiro Enterprise. Os ficheivos que não são distribuídos em nenhuma das edições são listados com uma justificação. Uma regra sobrepõe-se às restantes: as migrações de base de dados de cada módulo são distribuídas em ambas as edições. Assim, uma base de dados Community e uma base de dados Enterprise têm o mesmo esquema, e mover uma instalação de uma para a outra é apenas uma alteração do que está ativo, sem dados para migrar.

A exportação Community inclui cabeçalhos Apache-2.0 e um ficheiro NOTICE, e cada pacote nela contido é licenciado sob a Apache-2.0, exceto o código de terceiros que mantém a sua própria licença (MIT, BSD e outras) e é copiado tal como estava, e alguns pacotes de kit de desenvolvimento de software (SDK) e de interface de linha de comandos (CLI) que mantêm a sua própria licença MIT. A compilação Enterprise é licenciada sob a licença Adverant Enterprise. Os seus termos permitem a utilização apenas mediante uma licença escrita, pelo período, implementações e grupos de funcionalidades que a licença nomeia. A proibição de engenharia inversa salvaguarda explicitamente os direitos que a legislação da UE lhe confere para estudar o software e descompilá-lo para efeitos de interoperabilidade.

A linha de licença

O código Enterprise chega ao Community através de um único pacote: @adverant/nexus-spi, a interface de fornecedor de serviços (SPI). É licenciado sob a Apache-2.0 e contém interfaces e guardas de tipo, sem lógica de execução própria.

Exportação O que é
RouteModule Um módulo de rota licenciado: o seu id, o seu grupo de funcionalidades, os corpos que lê e register(app, ctx)
SpiApp A parte da aplicação HTTP do anfitrião em que um módulo toca: use
SpiContext O que o anfitrião entrega a um módulo: a porta do produto e o guarda de âmbito, o leitor de licenças, o pool de consultas com âmbito definido, endereços a montante, clientes da plataforma
SpiRuntime Os valores do SDK (kit de desenvolvimento de software) de plugins que o anfitrião entrega a um módulo
SpiPlane Os grupos de ecrãs e leituras de ecrã que um plano licenciado adiciona
ScreenModule Um grupo de ecrãs licenciado de uma consola: as suas rotas, ecrãs e menu
GrantCheck A verificação que um módulo licenciado executa no seu próprio grupo de funcionalidades

Uma verificação na compilação aplica a linha. Dentro do código Enterprise, uma importação dos âmbitos de pacotes Community (@adverant/ e @adverant-nexus/) faz falhar a compilação, a menos que seja @adverant/nexus-spi ou um pacote Enterprise. O mesmo acontece com uma importação relativa que saia do repositório, uma dependência file:, link: ou workspace: que aponte para fora dele, um URL Git que nomeie um repositório Community e um replace em Go que aponte para fora dele. Através da linha, o acoplamento é um protocolo de rede ou um módulo carregado no arranque, nunca código-fonte partilhado. A SPI transporta até a sua própria cópia fixa das declarações de tipo do SDK de plugins, porque o SDK é um pacote Community que a linha não admite; em vez disso, o anfitrião entrega a um módulo os valores de tempo de execução do SDK.

Perfis de compilação

A consola e o BFF (backend for frontend) são compilados com um perfil de compilação, que fixa as classes de código dentro da imagem. O perfil Community contém código Community; o perfil Enterprise contém código Community e Enterprise. Cada um recusa-se a iniciar quando o seu perfil contém código que a edição da instalação não tem. O BFF indica-o com PROFILE_OUTSIDE_EDITION e nomeia a imagem a implementar em alternativa. Não é possível colocar uma consola Enterprise numa instalação Community alterando a etiqueta de uma imagem.

À esquerda, uma caixa "Código-fonte Nexus" com uma caixa mais pequena dentro dela, "matriz de edições". Uma seta com a etiqueta "lista de fronteiras" divide-se em duas. A seta superior vai para "Exportação Community (Apache-2.0)" e segue para "Imagens Community". A seta inferior vai para "Compilação Enterprise", que também recebe uma seta da exportação Community e uma de uma caixa "módulos fechados", e produz "Imagens Enterprise". Entre os módulos fechados e a exportação Community, uma barreira com a etiqueta "linha de licença: apenas @adverant/nexus-spi". Uma pequena nota sob ambas as caixas de imagens diz "mesmo esquema de base de dados".
Como uma árvore de código-fonte se torna em duas edições.

Como uma licença ativa grupos de funcionalidades

Uma licença é um documento assinado. A Adverant assina cada licença com duas chaves independentes, e nada mais na instalação decide o que está licenciado. Pode importá-la através das páginas de Licença da consola, com nexusctl licence import <file>, ou enviando o documento para https://<hosts.auth>/api/v1/installation/licence. Uma licença nunca é um valor do chart e nunca é um ficheiro montado. O Capítulo 2.13, Licenças, abrange a importação e a renovação, bem como cada estado pelo qual uma licença passa.

A verificação que importa é executada dentro de cada módulo fechado, no próprio grupo de funcionalidades desse módulo, antes de este responder. Esse é o contrato GrantCheck da SPI:

type GrantCheck = (featureGroup: string) => Promise<{ entitled: boolean; code?: "LICENCE_LOCKED" }>;

A verificação reside no módulo fechado porque uma verificação escrita em código aberto poderia simplesmente ser eliminada. Uma licença falsificada conta como ausência de licença. Um módulo cujo grupo de funcionalidades não seja nomeado pela licença responde com LICENCE_LOCKED.

Os próprios módulos também são verificados. O nexus-keys contém o manifesto de partes assinadas da versão e a chave que o assinou. Ele verifica cada módulo compilado em relação a esse manifesto no arranque e novamente todas as noites às 03:53 UTC. Um módulo cuja assinatura não corresponda nunca é carregado, e a cópia assinada que este teria substituído continua em execução; as páginas de operador mostram-no com MODULE_SIGNATURE_INVALID.

Partes compiladas
Partes compiladas
A página de partes compiladas lista cada módulo licenciado com o seu grupo de funcionalidades, versão e verificação de assinatura. Uma cópia alterada que tenha falhado na sua verificação aparece como uma placa de recusa, e a cópia assinada manteve-se em execução.

Acima da verificação do módulo situa-se a camada de apresentação, que decide como uma capacidade aparece a cada pessoa. Esta combina as concessões da licença com o plano da organização e a função da pessoa, e cada controlo acaba num de quatro estados.

Estado O que a pessoa vê
Com direito O controlo, desenhado normalmente
Demonstração O controlo a cinzento com um cadeado; ao abri-lo, explica-se o que é e quem o pode ativar
Oculto Nada; utilizado apenas para elementos cuja existência a função desta pessoa não deve conhecer, como a caixa de correio privada de outra pessoa
Recusado com um código Uma placa de recusa que nomeia o código, quando alguém tenta uma ação que não é permitida

A licença também tem os seus próprios estados à medida que se aproxima e ultrapassa a sua data de fim. Duas regras mantêm-se em todos eles: uma licença nunca interrompe o trabalho em execução e as correções de segurança nunca são retidas.

O que a edição Community mostra numa página Enterprise

Uma instalação Community mantém a forma do produto. O menu tem as mesmas linhas que a Enterprise, e as linhas Enterprise (Ideias, Decisões, Mail, Chamadas, Outras empresas, Agentes, Políticas, Conformidade) são desenhadas a cinzento com um ícone de cadeado. Nada é ocultado para fazer a edição parecer completa, e nada incomoda com avisos insistentes.

Abrir uma linha bloqueada mostra uma demonstração. Para Ideias, lê-se "Ideias faz parte da edição Enterprise", seguido de um parágrafo sobre o que a funcionalidade Ideias faz, e depois "Quem pode ativar: o seu administrador, através de uma licença da Adverant". Oferece dois botões, "Pedir ao seu administrador" e "Ver o que faz". Não há preço. Abrir a página não carrega nada nem envia nada, e a promoção é mostrada uma única vez.

Algo que não tem
Algo que não tem
Uma área bloqueada na edição Community indica quem a pode ativar e o que a edição Community já lhe oferece. A linha permanece no menu, a cinzento com um cadeado, para que o produto tenha o mesmo aspeto em ambas as edições.

Digitar o endereço de uma página exclusiva da edição Enterprise também leva a um local útil. A consola Community conhece os endereços das páginas que não detém e envia qualquer uma delas para a sua página de edição, dentro da moldura normal com o menu. A página desenha a placa de funcionalidade bloqueada:

LICENCE_LOCKED
This page is part of Nexus Enterprise. This installation runs Nexus Community,
so the page is not here and nothing was read.
- To use it, the installation needs Nexus Enterprise: an administrator can ask Adverant about it
- Every page this installation holds is in the menu

O código está lá para referência; as frases destinam-se à pessoa que as lê.

A base mínima

Alguns elementos nunca têm acesso pago, em qualquer edição, sob qualquer estado de licença: noções básicas de administração e segurança, separação de inquilinos, exportação de dados, encerramento de sessão e todos os ecrãs de recusa. Uma instalação Community tem todos eles. Uma instalação Enterprise cuja licença tenha terminado também os mantém: os artefactos Enterprise deixam de ser oferecidos, e a base Community e a exportação de dados permanecem. Pode sempre retirar os seus dados.

De Community para Enterprise
De Community para Enterprise
Importar uma licença numa instalação Community mostra o que será obtido, o que muda e o que é mantido, antes de qualquer ação acontecer. O botão diz "Obter e ativar", e nada é obtido até que seja premido.

Imagens por edição

Cada imagem numa versão é listada, por resumo criptográfico (digest), no bloqueio de imagens do chart, e o próprio bloqueio pertence a uma edição. O chart verifica cada imagem que processa em relação ao bloqueio e à edição que solicitou. Uma instalação Community aceita apenas imagens Community. Se lhe pedir qualquer outra coisa, ela para: "a community install takes only community images". Um bloqueio Enterprise contém as imagens Community mais as compilações Enterprise.

Isso importa para o local de onde faz a transferência (pull). As imagens Community são públicas, em registry.adverant.ai/nexus/<service>@sha256:…. As imagens Enterprise provêm do mesmo registo com um token de transferência, que obtém na página "Tokens de transferência e comandos de instalação" da sua conta Adverant. Uma instalação Community nunca necessita desse token e nunca contém um único byte de código fechado.

O caminho de atualização mantém a instalação. Quando um administrador Community importa uma licença Enterprise, a consola lê-a e verifica-a e, em seguida, mostra as partes que irá obter (os módulos compilados e os pacotes e add-ons que a licença nomeia) com os respetivos tamanhos. Cada parte é verificada em relação à chave de versão da Adverant, e os grupos são ativados um de cada vez. As pessoas e os ficheiros permanecem como estão, assim como os fluxos de trabalho e os canais, porque o esquema já era o mesmo. O Capítulo 2.7, Instalar a edição Enterprise e aplicar uma licença, explica o processo passo a passo no Kubernetes; os locais isolados da rede (air-gapped) importam as mesmas partes a partir de suportes físicos, conforme descreve o capítulo 2.10, Instalação isolada da rede.

Formas de entrega e classes de proteção

O Nexus é distribuído em seis formas de entrega, às quais a matriz chama SKUs (unidades de manutenção de stock). As cinco formas além do Edge partilham um único pacote assinado e diferem no empacotamento e na forma como a licença chega.

SKU O que é Como chega a licença
saas Cloud da Adverant Emitida com a subscrição
onprem-connected Helm no seu próprio Kubernetes Transferida pela instalação através da sua ligação de saída
airgap O mesmo pacote, importado offline Importada como um ficheiro, com uma declaração de utilização assinada uma vez por ano
self-serve-image Uma imagem de máquina na sua própria conta na cloud A imagem em si contém apenas licenças Community e de avaliação; os módulos Enterprise chegam assim que uma licença é emitida, incluindo uma comprada através da loja da cloud
appliance Hardware construído por um fabricante de equipamento original (OEM), que é o seu fabricante de registo Uma licença Enterprise; o equipamento (appliance) é uma das suas formas de entrega
edge Nexus Edge, a carga útil em satélites e drones, ou em embarcações e veículos Uma licença por plataforma ou frota, de longa duração, válida enquanto estiver offline

A proteção é a outra metade da entrega, e vale a pena ser claro sobre isso. Uma vez que o código é executado em hardware que controla, nenhuma técnica o torna ilegível. Por isso, a Adverant classifica o seu código em classes de proteção e decide, para cada forma de entrega, até onde cada classe pode viajar. Existem quatro níveis:

Classe O que significa
P1, nunca distribuído A lógica é executada na Adverant; a instalação contém um cliente assinado.
P2, selado Uma máquina virtual (VM) confidencial na qual não pode iniciar sessão, em hardware no qual não pode tocar.
P3, código nativo reforçado Compilado, limpo de símbolos (stripped) e construído por licenciado. Aumenta o custo de leitura do código de horas para semanas.
P4, legível JavaScript ou TypeScript comum, tal como é o código aberto.
Classe de proteção Cloud da Adverant No local (on-prem) ligado Isolado da rede (air-gap) Nexus Edge
Código aberto (toda a edição Community) P4 P4 P4 P4
Código de maior valor: pontuação de ideias, o núcleo do armazenamento de registos selados, o motor de políticas de encaminhamento, os quatro motores de decisão do pacote de Seguros P1 P3, ou P2 como uma VM confidencial selada pela Adverant na sua instância na cloud P3 Não distribuído
Módulos de servidor fechados que decidem: código de servidor de pacotes, o gateway móvel P1 P3 P3 Não distribuído
Código de servidor do pacote de Defesa e segurança P1 P3 P3 P3
Código de carga útil do Nexus Edge Não distribuído Não distribuído Não distribuído P3
Definições de cliente legíveis: aplicações de telemóvel, ecrãs de telemóvel de pacotes P4 P4 P4 P4

Seguem-se duas consequências. Nada protegido é distribuído numa aplicação de telemóvel: cada regra e instrução (prompt) permanece no servidor. E o valor transportado em instruções, rubricas ou cadeias de agentes é legível por quem executa o modelo para o qual é enviado. Onde a sua organização detém o modelo, esse valor é protegido pelo contrato de licença e por mais nada. Cada imagem TypeScript distribuída é agrupada e minificada sem mapas de código-fonte (source maps), o que constitui uma questão de arrumação mais do que de proteção.

O que isto significa quando constrói uma extensão

A sua extensão situa-se na mesma linha que os próprios módulos da Adverant. Quase todo este capítulo se aplica a ela.

O isolamento, a identidade e o caminho de IA vêm com a plataforma em ambas as edições. Um plugin construído com @adverant-nexus/plugin-sdk herda a barreira de consultas com âmbito definido, o verificador de tokens e o despacho UNO, independentemente da edição em que seja instalado. O Capítulo 2.19, As regras que cada extensão herda, lista-os.

O controlo por edição funciona da mesma forma para si. Um plugin declara os seus ids de funcionalidades no bloco entitlements do seu manifesto (featureIdPattern, mais uma pequena lista alwaysOn mantida para verificações de integridade e para a página de definições) e pede um veredito à plataforma antes de servir uma superfície controlada. O veredito nunca é um simples booleano. ENTITLEMENT_DENIED (403) significa que a plataforma respondeu que não. ENTITLEMENT_UNREACHABLE (502) significa que não houve resposta, e o seu plugin deve recusar em vez de assumir, porque uma falha lida como "sem direito" despromove silenciosamente todos os clientes de uma só vez. Guarde um sim em cache brevemente e nunca guarde uma recusa em cache.

Na edição Community, um programador obtém os mesmos modelos iniciais que na Enterprise, tanto para plugins e lentes como para competências e fluxos de trabalho. Cada programador trabalha num espaço de desenvolvimento com ramificações de dados num único servidor, e o código reside no GitHub. Os modelos de pacotes de domínio e de plataforma são exclusivos da edição Enterprise. O mesmo acontece com a elevação de acesso com limite de tempo a partir de um IDE (ambiente de desenvolvimento integrado): na edição Community não existe um ambiente de produção separado para o qual elevar o seu acesso, e a consola indica-o com PASS_TIER_REQUIRED.

Construir na edição Community
Construir na edição Community
Construir na edição Community oferece os mesmos modelos que a Enterprise num único servidor, com o código no GitHub. A página nomeia o que a edição Enterprise adiciona e recusa o acesso elevado com uma justificação simples.

Uma extensão que utilize apenas pontos de integração Community é executada em qualquer uma das edições sem alterações. Uma que dependa de um add-on, o Mail por exemplo, aparece como bloqueada onde quer que a licença não nomeie esse grupo. O Capítulo 2.25, Construir para cada edição, mostra como estruturar uma extensão para ambas e como testá-la em relação a cada uma.