Integrazione di un'architettura implementabile in un catalogo privato

Quando sei pronto a condividere la tua architettura distribuibile con altri membri della tua organizzazione, puoi aggiungerla a un catalogo privato. Inoltre, è possibile utilizzare il flusso di onboarding per convalidare la propria architettura.

L'integrazione dell'architettura distribuibile in un catalogo privato comporta l'aggiunta del codice sorgente al catalogo, la modifica dei dettagli dell'architettura distribuibile e la successiva convalida. Quindi, si esaminano le stime dei costi e le informazioni di conformità relative all'architettura implementabile. Una volta terminato, puoi condividere l'architettura implementabile o pubblicarla pubblicamente nell' IBM Cloud (Raccolta di architetture implementabili).

Integrazione di un'architettura implementabile in un catalogo — di alto livello per l'integrazione di un'architettura implementabile in un catalogo privato

Prima di iniziare

Prima di poter integrare la tua architettura implementabile, assicurati di soddisfare i seguenti prerequisiti.

Verifica di utilizzare un account Pay-As-You-Go o in abbonamento. Per ulteriori dettagli, consulta la sezione Visualizzazione del tipo di account.
Verifica di disporre dell'accesso necessario per lavorare con cataloghi privati e architetture implementabili.
- Ruolo di manager nel servizio IBM Cloud Schematics
- Ruolo di redattore nel servizio di gestione del catalogo
- Ruolo di visualizzatore su tutti i gruppi di risorse nel tuo account
- SecretsReader ruolo sul servizio Secrets Manager se prevedi di archiviare i tuoi valori protetti in un'istanza di Secrets Manager
- Ruolo del lettore nel servizio Workload Protection
- Altri ruoli richiesti per risorse specifiche nella tua architettura implementabile personalizzata
Crea un catalogo privato.
Assicurati di avere il codice sorgente per la tua architettura distribuibile memorizzato in un repository GitHub o GitLab. Per assistenza su come inserire il codice sorgente in un repository, consulta Configurazione del repository del codice sorgente.

Vuoi vedere come funziona ma non hai un'architettura implementabile pronta all'uso? Utilizza la nostra architettura implementabile di esempio.

Imballaggio del codice sorgente

Per creare il .tgz file necessario per integrare l'architettura distribuibile in un catalogo privato, è necessario creare una versione di rilascio del codice sorgente. Per assistenza nella creazione di una release, consulta Gestione delle release in un repository.

Se utilizzi un repository di codice sorgente privato, assicurati di disporre di un token di accesso personale Git o di un segreto memorizzato in Secrets Manager.

Aggiunta di un'architettura implementabile a un catalogo privato

Per aggiungere la tua architettura distribuibile a un catalogo privato, puoi seguire questi passaggi.

Nella console IBM Cloud, vai alla pagina Gestisci > Cataloghi > Cataloghi privati della console.
Seleziona il catalogo privato a cui desideri aggiungere un prodotto. Si apre la pagina dei dettagli del catalogo.
Clicca su Aggiungi prodotto. Si apre un pannello laterale.
Selezionare Architettura implementabile per Tipo di prodotto.
Seleziona Terraform o Stack come metodo di consegna.
Seleziona il tipo di repository in cui si trova il tuo codice sorgente.

Se il codice sorgente si trova in un repository privato, è necessario autenticarsi utilizzando un token di accesso personale Git o un segreto da Secrets Manager.
Aggiungi un link al tuo codice sorgente nel campo Sorgente URL. Dovrebbe apparire simile a https://github.com/IBM-Cloud/terraform-sample/archive/refs/tags/v1.1.0.tar.gz.

Se stai implementando la tua architettura distribuibile a scopo di test, non è necessario disporre di un .tgz file. È possibile fornire il collegamento al livello principale della propria architettura.
Seleziona una variante.

Una variante è un tipo di architettura implementabile che applica capacità o complessità diverse a un'architettura implementabile esistente. Ad esempio, potrebbe esserci una variante Quick Start della vostra architettura implementabile che dispone di funzionalità di base per un'implementazione semplice e a basso costo da testare internamente. Inoltre, potresti avere una variante Standard leggermente più complessa, pronta per essere utilizzata in produzione.
Inserire la versione del software nel formato: versione principale, versione secondaria e revisione. Ad esempio, 1.0.0. In genere, questa versione corrisponde al numero di versione della tua istantanea di rilascio.
Seleziona la categoria in cui desideri raggruppare la tua architettura distribuibile nel catalogo.
Clicca su Aggiungi prodotto. Viene visualizzata la pagina di panoramica del prodotto.

Modifica della voce del catalogo

Dopo aver integrato con successo l'architettura distribuibile nel catalogo privato, è necessario specificare le informazioni che un utente vede quando tenta di utilizzare l'architettura. Le informazioni includono descrizioni del prodotto, link alla documentazione e parole chiave che garantiscono la facile reperibilità del prodotto.

Vai alla pagina Gestisci > Cataloghi > Cataloghi privati della console.
Seleziona il catalogo privato a cui hai aggiunto il tuo prodotto. Si apre la pagina dei dettagli del catalogo.
Seleziona il prodotto che hai precedentemente registrato.
Modifica il modo in cui la tua voce viene visualizzata nel catalogo.
1. Nella sezione dei dettagli della voce del catalogo, clicca su Modifica.
2. Esamina le informazioni importate con l'architettura distribuibile e apporta le modifiche necessarie.
3. Verifica che la tua voce sia visualizzata come previsto controllando l'anteprima della voce nel catalogo.
4. Una volta completata la selezione, clicca su Salva.
Modifica la pagina Informazioni sul tuo prodotto. Quando un utente seleziona il tuo prodotto dal catalogo, viene visualizzata una sezione Informazioni che consente di ottenere maggiori informazioni sul prodotto e sulle funzionalità disponibili.
1. Nel menu a tendina Azioni, seleziona Modifica pagina prodotto.
2. Inserisci una descrizione del tuo prodotto che ne spieghi il valore e i vantaggi per gli utenti.
3. Per aggiungere informazioni specifiche sulle caratteristiche, clicca su Caratteristiche > Aggiungi caratteristica.
4. Aggiungi caratteristiche a livello di prodotto che spiegano i processi, le capacità e i risultati del prodotto. Gli utenti possono vedere le caratteristiche di alto livello del prodotto all'inizio della pagina del prodotto che si applicano al prodotto nel suo complesso, indipendentemente dalle differenze di versione o di architettura. Ad esempio, se il tuo prodotto crea Virtual Private Cloud, puoi aggiungere Creates Virtual Private Clouds come titolo della funzione e Virtual Private Clouds are created for you with the necessary underlying network components. come descrizione della funzione. Per aggiungere funzionalità per variazioni o versioni specifiche, è possibile farlo aggiung endo evidenziazioni.
5. Fai clic su Aggiorna.

Specificare i dettagli tramite la console

Gli utenti vedono le informazioni relative al livello di versione che hai definito come parte della voce del catalogo per il tuo prodotto. Le informazioni fornite nell'ambito di questo flusso possono aiutare gli utenti a comprendere le funzionalità dei singoli componenti ad esso associati.

Per assicurarti che le tue selezioni vengano trasferite nella versione successiva, puoi generare un file manifest. Il file manifest, ibm_catalog.json, è la fonte di verità per la tua voce nel catalogo. Contiene tutte le informazioni sul tuo prodotto e sulle selezioni che hai effettuato. Dopo aver generato il file, è necessario aggiungerlo al livello principale del repository del codice sorgente. Se preferisci lavorare sul codice, le seguenti sezioni possono essere configurate direttamente tramite il file manifest. Per ulteriori informazioni su come strutturare il file, consulta Modifica locale del file manifest.

Entrare nei dettagli

Dopo aver aggiunto l'architettura distribuibile a un catalogo privato, è possibile utilizzare una procedura guidata passo passo nella console per aggiornare le informazioni generali sul prodotto. Per accedere alla pagina della console, è possibile seguire i seguenti passaggi.

Vai alla pagina Gestisci > Cataloghi > Cataloghi privati della console.
Seleziona il catalogo privato in cui hai aggiunto il tuo prodotto. Si apre la pagina dei dettagli del catalogo.
Seleziona il prodotto che hai precedentemente registrato.
Nella scheda Versioni, seleziona la versione del tuo prodotto per cui desideri fornire informazioni.
Utilizza le seguenti informazioni come guida per configurare i dettagli dell'architettura implementabile.

Configurazione dei dettagli della versione

Nella scheda Configura versione è possibile rivedere e aggiornare le informazioni relative alla versione specifica dell'architettura. È possibile configurare i dettagli dell'implementazione, definire l'accesso IAM richiesto e specificare le notifiche di modifica che si desidera comunicare agli utenti.

Se desideri estendere la tua architettura implementabile, puoi farlo sovrapponendola ad altre architetture. È possibile includere le dipendenze richieste dall'architettura, insieme ad architetture opzionali che aiutano ad ampliare la soluzione per un caso d'uso particolare. Per ulteriori informazioni, consultare Estensione di un'architettura implementabile durante l'onboarding.

Se la tua architettura distribuibile richiede una versione specifica di Terraform runtime, puoi sovrascrivere la versione predefinita. Se hai incluso TF_VERSION come variabile di input nel tuo repository del codice sorgente, dovrebbe essere stato aggiornato automaticamente quando hai creato la voce del catalogo.

Le variabili di input sono i parametri specificati dagli utenti quando utilizzano il prodotto. È possibile rivedere e modificare le variabili di input e output importate con il codice sorgente oppure aggiungere variabili all'architettura distribuibile come parte di questo passaggio. Quando si aggiungono variabili, è possibile aggiornare se sono obbligatorie, visibili o il formato in cui devono essere fornite.

Quando rilasci una nuova versione del tuo prodotto, potrebbero esserci delle modifiche che desideri comunicare agli utenti prima che inizino a utilizzare la nuova versione. È possibile suddividere le informazioni in tre categorie: modifiche sostanziali, nuove funzionalità e aggiornamenti generali.

Modifiche significative: descrivere in dettaglio tutte le modifiche apportate al codice della nuova versione che potrebbero causare problemi agli utenti che utilizzano una versione precedente.
Nuove funzionalità: evidenzia tutte le nuove funzionalità offerte dalla nuova versione che potrebbero interessare agli utenti.
Aggiornamenti: descrivere eventuali aggiornamenti generali apportati alla nuova versione. Ad esempio, correzioni di bug o miglioramenti alle funzionalità esistenti.

Compresi preamboli e postille

È possibile eseguire un pre-script o un post-script per le architetture distribuibili prima o dopo la convalida, la distribuzione e la rimozione della distribuzione. Gli script sono configurati per una versione specifica dell'architettura distribuibile, come specificato nel file manifest del catalogo, e devono essere eseguiti e convalidati tramite i progetti.

Gli script sono facoltativi per un'offerta, ma se vengono utilizzati devono essere presenti nel repository in una directory denominata scripts. I file di script devono rispettare la seguente convenzione di <action>-<stage>-ansible-playbook.yaml denominazione. Le opzioni disponibili action sono deploy, validate, e undeploy. Opzioni per stage include pre e post. Al momento sono supportati solo gli script ansible in formato playbook.

Tutti gli script devono poter essere eseguiti più volte senza errori. Ad esempio, uno script pre-distribuzione o post-distribuzione deve funzionare correttamente, anche se viene eseguito più volte. Gli script post-distribuzione potrebbero aggiungere risorse a un database di gestione del catalogo e devono assicurarsi di non aggiungere risorse duplicate se eseguiti più di una volta.

Per ulteriori informazioni, inclusi alcuni esempi, consultare Creazione di script per un'architettura distribuibile.

Aggiunta di dettagli sull'architettura implementabile

Quando si rende disponibile un'architettura implementabile ad altri utenti nel cloud, è necessario fornire le seguenti informazioni:

Un diagramma dell'architettura che descrive in dettaglio come i componenti dell'architettura implementabile interagiscono tra loro.
Qualsiasi elemento saliente che possa aiutare gli utenti a distinguere quale versione o variante della vostra architettura sia più adatta alle loro esigenze.

Aggiunta di contratti di licenza

Se agli utenti viene richiesto di accettare accordi di licenza oltre al Contratto di servizi IBM Cloud, fornire l' URL e a ciascun accordo.

Modifica del file readme

Documentare le istruzioni per l'installazione dell'architettura implementabile nel file readme.

Convalida della versione

Selezionare l'obiettivo da sottoporre a convalida. Quando un prodotto viene convalidato, le risorse vengono distribuite. Per un'architettura distribuibile autonoma, l'obiettivo può essere uno spazio di lavoro Schematics nel tuo account corrente o un progetto specifico. Per uno stack di architettura distribuibile, è necessario utilizzare un progetto. A seconda dell'opzione selezionata, potrebbero essere necessarie ulteriori informazioni di configurazione. Dopo aver configurato il target, è necessario fornire i valori delle variabili di input e output necessari affinché l'architettura possa essere distribuita correttamente sul target. Dopo aver configurato le variabili, è possibile convalidare la versione.

Non pulire le risorse nel tuo account fino a quando non avrai eseguito la valutazione di conformità nella sezione Gestione della sicurezza e della conformità.

Se la versione non supera la convalida a causa di una scansione CRA, un amministratore dell'account può scegliere di ignorare l'errore e procedere comunque con la distribuzione. Se la convalida non va a buon fine per qualsiasi altro motivo, si consiglia vivamente di risolvere eventuali problemi riscontrati prima di pubblicare la propria offerta.

Revisione dei costi

Assicurati di comprendere appieno i costi associati all'implementazione della tua architettura. La versione deve essere convalidata prima di poter generare un costo stimato.

Gestione della conformità

Quando si rende disponibile un'architettura distribuibile ad altri utenti dell'organizzazione, è possibile specificare i controlli di conformità specifici soddisfatti dall'architettura utilizzando l'installazione predefinita. La conformità ai controlli normativi viene valutata dall' IBM Cloud® Security and Compliance Center Workload Protection (Ufficio per la conformità normativa).

Fai clic su Aggiungi controlli.
Seleziona l'istanza e il criterio di Workload Protection. È possibile scegliere di selezionare una politica predefinita oppure andare su Workload Protection e crearne una personalizzata.
Specificare se l'architettura implementabile soddisfa tutti i controlli previsti dalla politica o se è in grado di soddisfare i requisiti per un sottoinsieme dei controlli.
Se la vostra architettura è in grado di soddisfare solo una parte dei controlli, dovete selezionare quelli che possono essere soddisfatti e aggiungerli.
Utilizza Workload Protection per confermare la conformità con i controlli che hai identificato. Workload Protection utilizza un inventario per monitorare la conformità. I risultati dell'inventario vengono aggiornati quotidianamente. Distribuisci le risorse create dalla tua architettura e attendi che i risultati dell'inventario vengano aggiornati. Per ulteriori informazioni, consulta la sezione dedicata alla revisione e alla definizione delle priorità degli interventi correttivi.
Nella scheda Gestisci conformità dell'interfaccia utente del catalogo, fai clic su Aggiungi risultati.
Seleziona un 'istanza e fai clic su Applica per applicare i risultati dell'inventario più recenti.

Revisione dei requisiti

Una volta completata la procedura guidata, è necessario rivedere le selezioni effettuate e confermare di essere pronti a condividere il prodotto nel catalogo. Quando sei pronto, clicca su Pronto per condividere.

Scaricare il manifesto

Ogni volta che vengono apportate modifiche alla configurazione del prodotto tramite la console, è buona norma generare e scaricare il file manifest per garantire che le modifiche vengano acquisite nelle versioni future del prodotto.

Per scaricare un manifesto, è possibile seguire i seguenti passaggi.

Vai alla pagina Gestisci > Cataloghi > Cataloghi privati della console.
Seleziona il prodotto che è stato precedentemente integrato. Si apre una pagina con i dettagli.
Nella scheda Versioni, seleziona la versione per cui desideri generare un manifesto.
Dal menu a tendina Azioni, selezionare Genera manifesto.
Aggiungi il file nella cartella principale del tuo repository del codice sorgente come ibm_catalog.json.

Scaricare la configurazione del catalogo

Se stai integrando architetture impilabili da un progetto, oltre al file manifest vengono generati altri file aggiuntivi. Se hai apportato modifiche alla configurazione del catalogo utilizzando la console, è buona norma scaricare i file e aggiungerli al repository del codice sorgente, in modo che le modifiche vengano trasferite nella versione successiva.

Vai alla pagina Gestisci > Cataloghi > Cataloghi privati della console.
Seleziona il prodotto che è stato precedentemente integrato. Si apre una pagina con i dettagli.
Nella scheda Versioni, seleziona la versione per cui desideri generare un manifesto.
Dal menu a tendina Azioni, selezionare Genera manifesto.
Aggiungi i file nella cartella principale del tuo repository di codice sorgente.

Aggiungere una variante

È possibile aggiungere ulteriori varianti che costituiscono una nuova versione dell'architettura, progettata per integrare le funzionalità dell'architettura di base implementabile. Se hai creato più varianti in directory di lavoro separate nel tuo repository sorgente e le hai specificate flavors nell'array nel tuo file ibm_catalog.json manifest, devi integrare ciascuna variante separatamente.

A questo punto, hai già inserito la tua prima variante. Ora puoi ricominciare da Aggiungere un'architettura implementabile per integrare la tua prossima variante. Ecco alcuni consigli per integrare la tua prossima variante:

L'origine URL della versione del repository sarà la stessa per tutte le varianti all'interno di quella versione e dovranno essere importate con lo stesso numero di versione. Il nome del prodotto e il numero di versione sono gli elementi che collegano tra loro le varianti, che vengono quindi visualizzate come opzioni nella stessa scheda del catalogo.
Nella pagina Aggiungi dettagli architettura distribuibile, il passaggio 3 prevede l'aggiunta di evidenziazioni. Queste sono note come caratteristiche nel file ibm_catalog.json manifest. Potresti averli già aggiunti nel manifesto, quindi puoi controllarli qui. In caso contrario, procedi e aggiungi alcuni punti salienti. Queste dovrebbero essere brevi caratteristiche relative alle capacità, ai processi, alle potenzialità o ad altre caratteristiche di questa specifica architettura. Utilizzerai lo stesso nome evidenziato in tutte le varianti. La descrizione è dove dovrebbero esserci delle differenze. Ciò consente agli utenti di valutare le differenze nelle architetture utilizzando gli elementi evidenziati nel testo nella pagina dei dettagli del catalogo.

Passi successivi: condivisione e pubblicazione

Ora che l'architettura distribuibile è stata aggiunta a un catalogo privato e i dettagli sono stati impostati, sei pronto per condividere il prodotto con altri membri della tua organizzazione. Per assistenza sulla condivisione, consulta Condivisione del prodotto.

Se desideri pubblicare la tua architettura distribuibile nel catalogo IBM Cloud, puoi utilizzare Partner Center per ottenere l'approvazione e pubblicarla affinché tutti gli utenti possano usufruire della soluzione che hai creato. Per ulteriori informazioni, consulta Pubblicazione dell'architettura distribuibile.