Productors OSIRIS JSON

Els productors d’OSIRIS són eines de snapshots de només lectura que es connecten a plataformes d’infraestructura, recopilen dades de topologia i configuració i emeten un document OSIRIS JSON compatible amb l’estàndard. Cada productor està orientat a un proveïdor o plataforma cloud específica.

Què fan els productors

Un productor realitza quatre passos:

Productors disponibles

Els productors es publiquen de manera incremental. Cisco és el primer productor disponible; n’hi ha d’altres de planificats que arribaran més endavant.

Instal·lació

Els productors es distribueixen com a binaris de Go. Cal tenir Go 1.25+ instal·lat.

Instal·la-ho tot (dispatcher principal + tots els productors de proveïdor disponibles):

go install go.osirisjson.org/producers/cmd/...@latest

O instal·la només el que necessitis: el dispatcher principal i un productor específic del proveïdor:

go install go.osirisjson.org/producers/cmd/osirisjson-producer@latest
go install go.osirisjson.org/producers/cmd/osirisjson-producer-cisco@latest

La taula següent mostra tots els packages instal·lables:

El dispatcher principal (osirisjson-producer) descobreix els binaris del proveïdor al teu PATH i enruta l’ordre cap al correcte. Sense ell, has d’invocar el binari del proveïdor directament amb el seu nom complet (per exemple, osirisjson-producer-cisco en lloc de osirisjson-producer cisco).

Assegura’t que $GOPATH/bin (o $HOME/go/bin) sigui al teu PATH.

Forma del CLI del productor

Tots els productors comparteixen un CLI amb estil de dispatcher:

osirisjson-producer <vendor> [subcommand] [flags]

La sortida sempre es valida després mitjançant el CLI d’OSIRIS JSON, per exemple:

osirisjson-producer <vendor> <subcommand> --host device.example.com > snapshot.json
npx @osirisjson/cli validate --profile strict snapshot.json

Flux de treball típic

Per a arquitectes de solucions i auditors, el flux de treball recomanat és:

1. Executa el productor contra la plataforma de destinació amb les credencials adequades.
2. Valida la sortida fent servir @osirisjson/cli amb el perfil strict.
3. Revisa l’snapshot com a artefacte d’arquitectura, desa’l, compara’l al llarg del temps i adjunta’l a auditories.

# Generate snapshot
osirisjson-producer cisco apic -h apic.example.com -u admin > snapshot.json

# Validate
npx @osirisjson/cli validate --profile strict snapshot.json

# Compare with previous snapshot
diff <(jq -S . previous.json) <(jq -S . snapshot.json)

Seguretat

El codi font dels productors s’analitza contínuament amb SonarCloud per detectar vulnerabilitats, code smells i security hotspots. Cada pull request ha de superar una porta de qualitat que exigeix una qualificació de seguretat A abans de poder-se fusionar.

A més, els productors inclouen salvaguardes de seguretat integrades:

• Redacció de secrets - la flag --safe-failure-mode (per defecte: fail-closed) evita que les credencials i els valors sensibles es filtrin a la sortida JSON.
• Accés de només lectura - els productors mai no modifiquen la configuració del dispositiu. Totes les crides d’API i les NETCONF RPC són operacions de només lectura.
• Sense emmagatzematge persistent - els productors no fan cache de credencials ni emmagatzemen dades més enllà del fitxer JSON emès.

Què llegir després

• Consulta les pàgines específiques del productor per proveïdor per veure detalls sobre la instal·lació, els sistemes d’origen, l’autenticació i l’abast de la sortida.
• Llegeix la guia de validació per entendre com verificar la sortida del productor.
• Revisa l’exemple d’infraestructura IT i l’exemple d’infraestructura OT per veure una mostra completa d’un document OSIRIS JSON.