Nereus

A composable API platform: Reefs add the APIs, Nereids look after them, installed at runtime

Nereus

Uma plataforma de APIs componível: Reefs adicionam as APIs, Nereids cuidam delas, instalados em tempo de execução

The idea

What changes when every capability is installed at runtime?

A ideia

O que muda quando toda capacidade é instalada em tempo de execução?

The idea · Installed at runtime

nereus init prepares a cluster

Reefs come later

  • Before: init installs the whole platform
  • Here: a cluster, ready for Reefs
A ideia · Instalado em tempo de execução

nereus init prepara um cluster

Os Reefs vêm depois

  • Antes: o init instala a plataforma inteira
  • Aqui: um cluster, pronto para Reefs
The idea · Installed at runtime

A Nereid adds commands to the CLI

  • Published: commands as data in its status
  • Built: by the CLI at runtime
  • Downloaded: no code
A ideia · Instalado em tempo de execução

Um Nereid acrescenta comandos à CLI

  • Publicados: comandos como dados no seu status
  • Montados: pela CLI em tempo de execução
  • Baixado: nenhum código
The idea · Installed at runtime

All a Nereid publishes to build its commands

A ideia · Instalado em tempo de execução

Tudo o que um Nereid publica para montar os comandos

commands.yaml
3- path: [repo, add]4  help: Add a chart repository.5  arguments:6    - name: name7      help: Name of the repository.8    - name: url9      help: URL of the repository.10  examples:11    - description: add the example chart repository12      command: repo add example https://charts.example.com13- path: [repo, list]14  help: List the chart repositories.15  examples:16    - description: list the chart repositories17      command: repo list
The model

Which words does the platform speak?

O modelo

Que palavras a plataforma fala?

The model · Vocabulary and rules

Three kinds describe a platform

  • Reef: a capability, its own API group
  • Nereid: the controller that looks after it
  • Mandate: binds one Reef to one Nereid
O modelo · Vocabulário e regras

Três kinds descrevem uma plataforma

  • Reef: uma capacidade, com o seu API group
  • Nereid: o controller que cuida dele
  • Mandate: liga um Reef a um Nereid
The model · Vocabulary and rules

Every field has one writer

spec asked, status done

  • spec: the API, or the CLI before it exists
  • status: the Nereid
O modelo · Vocabulário e regras

Todo campo tem um escritor

spec pedido, status feito

  • spec: a API, ou a CLI enquanto ela não existe
  • status: o Nereid
The model · Vocabulary and rules

The Nereid kind

The CLI writes spec, the Nereid status

O modelo · Vocabulário e regras

O kind Nereid

A CLI escreve o spec, o Nereid o status

nereid.yaml
34            spec:35              type: object36              required: [image, reefs]37              properties:39                image:40                  type: string43                reefs:44                  type: array78                # person's login: which login runs the plans of its reef's Instance.79                login:80                  type: string81                  pattern: "^[a-z][a-z0-9-]{0,40}$"82                # The endpoints of its status the edge reef may publish (#1951, OWASP A01): the explicit grant, written by98                    properties:99                      type:
The first slice

What can a person run today?

A primeira fatia

O que uma pessoa consegue rodar hoje?

The first slice · An environment on k3d

Apply the environment Reef

The output says what's next

A primeira fatia · Um environment no k3d

Aplique o Reef environment

A saída diz o que vem depois

~/example
# Apply the environment Reef$ nereus reef apply environment✓ core/reefs/environment created (environment.getnereus.dev/v1alpha1) Next steps:   nereus environment --help  nereus nereid apply <nereid> --reef environment
The first slice · An environment on k3d

The vcluster Nereid's first Mandate becomes the default

A primeira fatia · Um environment no k3d

O primeiro Mandate do Nereid vcluster vira o padrão

~/example
# Apply the vcluster Nereid to the environment Reef$ nereus nereid apply vcluster \    --reef environment✓ core/nereids/vcluster created, Ready, pinned to sha256:3f9c2a7e1b04: see 'nereus environment --help'  core/mandates/vcluster created (reef: environment, nereid: vcluster, default) Next steps:   nereus nereid list # See every Reef and the Nereid that looks after it$ nereus statusREEF            NEREID    VERSION  STATUS  AGEcore            built-in  0.1.0    Ready   5menvironment     vcluster  0.1.0    Ready   20ssecrets         openbao   0.1.0    Ready   5m
The first slice · The scene

The first slice ends with a scene run from the CLI

  • init: a k3d cluster, ready
  • apply: a Reef and its Nereid
  • run: the commands it published
  • delete: they are gone
A primeira fatia · A cena

A primeira fatia termina com uma cena rodada pela CLI

  • init: um cluster k3d, pronto
  • apply: um Reef e o seu Nereid
  • run: os comandos que ele publicou
  • delete: eles somem
Where it is heading

What is the API for?

Para onde vai

Para que serve a API?

Where it is heading · Profiles

A profile lists the Reefs, Nereids and Mandates to install

  • core: only the engine
  • internal-developer-platform:
  • authentication
  • database
  • environment
  • metrics
  • release
  • secrets
Para onde vai · Profiles

Um profile lista os Reefs, Nereids e Mandates a instalar

  • core: só o motor
  • internal-developer-platform:
  • authentication
  • database
  • environment
  • metrics
  • release
  • secrets
Where it is heading · The inspiration

The platform tooling landscape inspired us

Five planes, with one API in front

Source: platformengineering.org/platform-tooling

Para onde vai · A inspiração

O platform tooling landscape nos inspirou

Cinco planos, com uma API na frente

Fonte: platformengineering.org/platform-tooling

Developer Control PlaneIntegration & Delivery PlaneResource PlaneObservabilitySecurityPLATFORM APIMonitoring & LoggingObservabilityFinOpsIncident MgmtCode AnalysisSecretsIdentityPolicyNetwork SecuritySoftware CatalogApp DeclarationGolden PathsVersion ControlCIRegistryOrchestratorIaCDeliveryComputeDataNetworkingServicesCLIENTS{ }IDEapp.yamlAGENTS.md>_CLI$ nereus init$ platform deploy◧PortalBrowse the catalogCreate from template✦Agents“Create a Postgresfor greeting-api”
Where it is heading · internal-developer-platform

What the profile runs today

A dashed line is not in the profile yet

Para onde vai · internal-developer-platform

O que o profile roda hoje

Linha tracejada ainda não está no profile

MandateNereidReefNEREUS APIDeveloper ControlIntegration & DeliveryResourceObservabilitySecuritytenancykept by the APIcatalogcatalogcatalogscmforgejoforgejoreleasefluxfluxbuildbuildkitbuildkitregistryzotzotdeliverykuberneteskubernetesenvironmentvclustervclusterdatabasecloudnative-pgcloudnative-pgedgecloudflareThe edge reef: the cloudflare Nereid#577metricsvictoriametricsvictoriametricssecretsopenbaodefaultauthenticationkeycloakkeycloakauthorizationopenfgaRefine the authorization reef: an openfga Nereid#897policykyvernoRefine the policy reef: a kyverno Nereid#898CLIENTSCLIPortalAgents (MCP)
Where it is heading

Thank you

Para onde vai

Obrigado