Creazione di un catalogo privato

I cataloghi privati forniscono un modo per gestire l'accesso ai prodotti per gli utenti nel tuo account.

1. Vai a Manage > Catalogs nella console IBM Cloud e fai clic su Create a catalog.
2. Immettere un nome e una descrizione del catalogo.
3. Seleziona per escludere o includere tutti i prodotti nel catalogo IBM Cloud nel tuo catalogo privato. Per ulteriori informazioni su come questo influisce sulla visibilità nel catalogo, vedi Gestione delle impostazioni del catalogo.
4. Fai clic su Crea.

Importazione di software nel proprio catalogo privato

Completa la seguente procedura per importare il software nel tuo catalogo privato:

1. Dalla pagina Prodotti privati, fare clic su Aggiungi.

2. Selezionare il metodo di distribuzione.

3. Selezionare se si sta aggiungendo il proprio prodotto da un repository privato o pubblico. Oppure, se stai effettuando l'onboarding di un operatore da un registro Red Hat, seleziona il tuo tipo di repository Red Hat: Certified, Marketplace, Community.

   Se stai aggiungendo il prodotto da un repository privato, puoi fornire un token di accesso personale o puoi utilizzare un segreto. Invece di fornire agli utenti un token di accesso personale, è possibile fornire loro l'accesso a un segreto, aggiungere il token a un segreto e gestire centralmente tutti i token e accedere alle autorizzazioni del segreto.

   • Se stai utilizzando un token di accesso personale, seleziona No per indicare che non stai utilizzando un segreto e fornisci il tuo token di accesso personale.
   • Se si utilizza un segreto, selezionare Sì e fare clic su Seleziona da Secrets Manager. Seleziona la tua istanza del servizio, il gruppo di segreti e il segreto. Se non vedi il tuo segreto, assicurati di utilizzare il gruppo di segreti e l'istanza del servizio corretti.

   Il messaggio No service instance available potrebbe essere visualizzato se non hai creato un segreto o se non disponi dell'accesso corretto per utilizzare i segreti, anche se hai creato delle istanze del servizio.

4. Inserisci l' URL e di origine. È possibile esaminare il seguente elenco di formati supportati per tipo di software:

   • Grafico Helm: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm
   • Node-RED: https://github.com/IBM-Cloud/operator-bundle-sample/archive/refs/tags/v0.0.3.tar.gz
   • Bundle di operatori da un registro Red Hat OpenShift on IBM Cloud: per un esempio, selezionare Akka Cluster Operator dall'elenco di operatori disponibili nel repository certificato.
   • Immagine OVA: https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
   • Modello Terraform: https://github.com/IBM-Cloud/terraform-sample/releases/tag/v1.0.0
   • Immagine del server virtuale con Terraform: https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
   • Immagine server virtuale per VPC: seleziona un'immagine dall'elenco di immagini disponibili che sono state importate nel tuo VPC o importa una nuova immagine nel tuo account.

   Un'immagine server virtuale per VPC può essere aggiunta solo a un prodotto all'interno di un catalogo privato alla volta. Se l'immagine server virtuale che si desidera importare è già importata in un altro prodotto, è necessario rimuovere l'immagine da tale prodotto o eliminare il prodotto prima di aggiungere l'immagine server virtuale a un nuovo prodotto.

5. Se applicabile, immettere la versione del software nel formato di versione principale, versione secondaria e revisione. Ad esempio, immettere la versione 1.1.2.

6. Selezionare una categoria di catalogo per il prodotto. Le categorie servono a organizzare i prodotti nel catalogo IBM Cloud in base alla funzione, all'uso o alle soluzioni più comuni.

7. Fare clic su Aggiungi prodotto.

Aggiunta dei dettagli della voce di catalogo

Quando pubblichi il tuo prodotto nel catalogo per gli utenti che hanno accesso al tuo catalogo privato, vedono un riquadro con il nome del prodotto e altri dettagli che vengono aggiunti durante l'onboarding. Oltre alla categoria impostata quando si importa il software, è possibile aggiungere altri filtri correlati al settore, alla conformità, alle tecnologie utilizzate e altro ancora. Ciascuno di questi filtri viene utilizzato nel catalogo per consentire agli utenti di trovare il software adatto alle proprie necessità. Nella sezione dei dettagli della voce di catalogo, potete anche valutare e aggiornare le descrizioni brevi, la documentazione URL e persino le parole chiave per aiutare gli utenti a cercare e trovare rapidamente il vostro prodotto.

1. Dalla sezione Dettagli voce di Catalogo, fare clic sull'icona Modifica .
2. Rivedere le informazioni importate con il prodotto e apportare le modifiche necessarie.
3. Esaminare i filtri e le opzioni di settore per selezionare i filtri di catalogo da applicare. È possibile selezionare fino a cinque filtri di settore.
4. Controllare l'anteprima della voce di catalogo per vedere come il riquadro del catalogo viene visualizzato agli utenti che stanno valutando il software nel catalogo.
5. Fare clic su Salva quando si è soddisfatti delle proprie modifiche.

Per ulteriori informazioni, consultare Definizione dei dettagli del prodotto.

Configurazione del software

Aggiunta di accordi di licenza

Fornisci gli URL agli accordi di licenza che gli utenti devono accettare quando installano il prodotto. Gli accordi di licenza sono in aggiunta all'accordo di servizi IBM Cloud.

1. Fare clic su Aggiungi accordi di licenza > Aggiungi licenza.
2. Immettere il nome e URL, quindi fare clic su Aggiorna > Avanti.

Modifica del file readme

Quando gli utenti installano il software, possono selezionare il link al file readme per visualizzare le informazioni sul prodotto. Le informazioni nel collegamento Readme vengono generate dal file readme caricato nel repository di origine.

1. Dalla scheda Modifica readme, visualizzare in anteprima come le informazioni nel file readme verranno visualizzate agli utenti quando installano il software.
2. Per effettuare gli aggiornamenti, fare clic su Modifica accanto al titolo della sezione Readme.
3. Fare clic su Salva.
4. Fai clic su Next.

Se stai importando un'immagine del server virtuale per VPC, il file readme non viene generato automaticamente. Copiare e incollare il contenuto del modello file readme e apportare gli aggiornamenti necessari.

Convalida del software

Quando si convalida il proprio software, si conferma che la versione corrente può essere installata correttamente sulla destinazione di distribuzione. Le operazioni di convalida variano in base al proprio metodo di distribuzione.

Per monitorare l'avanzamento del processo di convalida, fare clic su Visualizza log.

Gestisci la conformità

È possibile aggiungere profili e controlli al software per dimostrare che soddisfa i requisiti di sicurezza e conformità. Devi utilizzare Compliance Manager per eseguire la scansione delle risorse create durante la convalida.

Solo i profili e controlli supportati dalle scansioni Compliance Manager e convalidati da Compliance Manager vengono visualizzati nel catalogo.

Condivisione del software

Se vuoi condividere il tuo prodotto con il tuo account o azienda, fai clic sul nome del prodotto nella navigazione per andare alla pagina dei dettagli del prodotto. Dal menu Azioni, fare clic su Condividi. Selezionare il punto in cui si desidera condividere il proprio prodotto e fare clic su Condividi.

Onboarding del software nel catalogo utilizzando la CLI

Completa la seguente procedura per aggiungere il software utilizzando la CLI. È possibile utilizzare questa attività in un processo CI/CD. Per aggiungere software da un repository privato, è necessario includere un token di accesso personale.

1. Esegui il comando ibmcloud catalog create per creare un catalogo privato. I cataloghi privati forniscono un modo per gestire l'accesso ai prodotti per gli utenti nel tuo account.

   ibmcloud catalog create --name CATALOG [--catalog-description "DESCRIPTION"]
   

2. Eseguire il comando ibmcloud catalog offering create per aggiungere software al proprio catalogo privato.

   ibmcloud catalog offering create [--catalog CATALOG-NAME] [--zipurl URL]
   

   Se si desidera importare il software da un repository privato, è possibile utilizzare un token di accesso personale aggiungendo [-- token TOKEN] al comando.

3. Eseguire il comando ibmcloud catalog offering add - category per aggiungere una categoria al prodotto. Per default, la categoria Developer tools viene aggiunta al prodotto.

   ibmcloud catalog offering add-category --catalog CATALOG_NAME [--offering OFFERING] [--category CATEGORY]
   

4. Esegui il comando ibmcloud catalog offering import - version per importare la versione software che desideri nel tuo catalogo.

   ibmcloud catalog offering import-version --catalog CATALOG --offering OFFERING_NAME --zipurl URL
   

   Di seguito viene riportato l'elenco dei formati supportati per tipo di software:

   • Grafico Helm: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm
   • Node-RED: https://github.com/IBM-Cloud/operator-bundle-sample/archive/refs/tags/v0.0.3.tar.gz
   • Bundle di operatori da un registro Red Hat OpenShift on IBM Cloud: per un esempio, selezionare Akka Cluster Operator dall'elenco di operatori disponibili nel repository certificato.
   • Immagine OVA: https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
   • Modello Terraform: https://github.com/IBM-Cloud/terraform-sample/releases/tag/v1.0.0
   • Immagine del server virtuale con Terraform: https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
   • Immagine server virtuale per VPC: selezionare un'immagine dall'elenco di immagini che sono state importate nel VPC o importare una nuova immagine nel tuo account.

5. Esegui il comando ibmcloud catalog offering version validate per convalidare il software.

   ibmcloud catalog offering version validate --version-locator VERSION_NUMBER --cluster CLUSTER_ID --namespace NAME [--timeout TIMEOUT] [--wait WAIT]
   

   L'installazione del software può richiedere alcuni minuti. Eseguire il comando ibmcloud catalog offering version validate - status per verificare lo stato di validazione interrogando lo stato di validazione del prodotto.

   ibmcloud catalog offering version validate-status --version-locator VERSION_NUMBER [--output FORMAT]
   

6. Eseguire l'account di pubblicazione dell'offerta del catalogo ibmcloud per pubblicare il software per gli utenti nel proprio account.

   ibmcloud catalog offering publish account [--catalog CATALOG][--offering OFFERING]
   

Creazione di un catalogo privato utilizzando l'API

I cataloghi privati forniscono un modo per gestire l'accesso ai prodotti per gli utenti nel tuo account. È possibile creare un catalogo privato a livello di programmazione richiamando l'API di gestione dei cataloghi, come illustrato nella seguente richiesta di esempio. Per ulteriori informazioni, consulta Catalog Management API per la creazione di un catalogo.

String label = "{label}";
String shortDesc = "{shortDesc}";
CreateCatalogOptions createOptions = new CreateCatalogOptions.Builder().label(label).shortDescription(shortDesc).build();
Response<Catalog> response = service.createCatalog(createOptions).execute();
System.out.println(response.getResult());

label = "{label}";
shortDesc = "{shortDesc}";
response = await service.createCatalog({ 'label': label, 'shortDescription': shortDesc });
console.log(response);

label = "{label}"
shortDesc = "{shortDesc}"
response = self.service.create_catalog(label=label, short_description=shortDesc)
print(response)

label := "{label}"
shortDesc := "{shortDesc}"
createOptions := service.NewCreateCatalogOptions()
createOptions.SetLabel(label)
createOptions.SetShortDescription(shortDesc)
_, response, _ := service.CreateCatalog(createOptions)
fmt.Println(response)

Importazione del software nel tuo catalogo privato utilizzando l'API

È possibile importare in modo programmatico il software nel catalogo richiamando l'API Gestione catalogo come mostrato nella seguente richiesta di esempio. Questa API crea il software e lo importa. Per informazioni dettagliate sull'API, vedi Catalog Management API.

id = "{id}";
offeringURL = "{offeringURL}";
ImportOfferingOptions offeringOptions = new ImportOfferingOptions.Builder().catalogIdentifier(id).zipurl(offeringURL).build();
Response<Offering> response = service.importOffering(offeringOptions).execute();
System.out.println(response.getResult());

id = "{id}";
offeringURL = "{offeringURL}";
response = await service.importOffering({ 'catalogIdentifier': id, 'zipurl': offeringURL });
console.log(response);

id = "{id}"
offeringURL = "{offeringURL}"
response = self.service.import_offering(catalog_identifier=id, zipurl=offeringURL)
print(response)

id := "{id}"
offeringURL := "{offeringURL}"
offeringOptions := service.NewImportOfferingOptions(id, offeringURL)
_, response, _ := service.ImportOffering(offeringOptions)
fmt.Println(response)

Convalida del software utilizzando l'API

È possibile verificare il proprio prodotto a livello di programmazione richiamando l'API di gestione del catalogo, come illustrato nella seguente richiesta di esempio. Questo processo può richiedere diversi minuti. Per informazioni dettagliate sull'API, vedi Catalog Management API.

String authRefreshToken = "{authRefreshToken}";
String versionLocator = "{versionLocator}";
ValidationInstallOptions installOptions = new ValidationInstallOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocId(versionLocator).build();
Response<Void> response = service.validationInstall(installOptions).execute();
System.out.println(response.getResult());

versionLocator = "{versionLocator}";
authRefreshToken = "{authRefreshToken}";
response = await service.validationInstall({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });
console.log(response);

authRefreshToken="{authRefreshToken}"
versionLocator = "{versionLocator}"
response = self.service.validation_install(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken)
print(response)

versionLocator := "{versionLocator}"
authRefreshToken := "{authRefreshToken}"
installOptions := service.NewValidationInstallOptions(versionLocator, authRefreshToken)
response, _ := service.ValidationInstall(installOptions)
fmt.Println(response)

Pubblicazione del software sul tuo account utilizzando l'API

Puoi pubblicare in modo programmatico il tuo software nel tuo account richiamando l'API di gestione del catalogo come mostrato nella seguente richiesta di esempio.

String versionLocator = "{versionLocator}";
AccountPublishVersionOptions publishOption = new AccountPublishVersionOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.accountPublishVersion(publishOption).execute();
System.out.println(response.getResult());

versionLocator = "{versionLocator}";
response = await service.accountPublishVersion({ 'versionLocId': versionLocator});
console.log(response);

versionLocator = "{versionLocator}"
response = self.service.account_publish_version(version_loc_id=versionLocator)
print(response)

versionLocator := "{versionLocator}"
publishOptions := service.NewAccountPublishVersionOptions(versionLocator)
response, _ := service.AccountPublishVersion(publishOptions)
fmt.Println(response)

Creazione di un catalogo privato utilizzando Terraform

Utilizza la seguente procedura per creare un catalogo privato utilizzando Terraform.

1. Aggiungere l'argomento al proprio file main.tf. Il seguente esempio crea un catalogo privato utilizzando la risorsa ibm_cm_catalog, dove label è un nome di visualizzazione per identificare il catalogo.

   resource "ibm_cm_catalog" "cm_catalog" {
   label = "label"
   short_description = "short_description"
   }
   

   Per ulteriori informazioni, vedi i dettagli di riferimento dell'argomento nella pagina Terraform Catalog Management.

2. Dopo aver terminato la creazione del file di configurazione, inizializza la CLI Terraform. Per ulteriori informazioni, consultare la sezione Inizializzazione delle directory di lavoro.

   terraform init
   

3. Eseguire il provisioning delle risorse dal file main.tf. Per ulteriori informazioni, vedi Provisioning dell'infrastruttura con Terraform.

   1. Eseguire terraform plan per generare un piano di esecuzione Terraform per visualizzare in anteprima le azioni proposte.

      terraform plan
   

   1. Eseguire terraform apply per creare le risorse definite nel piano.

      terraform apply
   

Importazione di un prodotto nel tuo catalogo utilizzando Terraform

Utilizza la seguente procedura per importare un prodotto nel tuo catalogo privato utilizzando Terraform.

1. Aggiungere l'argomento al proprio file main.tf. Il seguente esempio aggiunge il prodotto utilizzando la risorsa ibm_cm_offering, dove label è un nome di visualizzazione per identificare il prodotto.

   resource "ibm_cm_offering" "cm_offering" {
   catalog_id = "catalog_id"
   label = "label"
   tags = [ "tags" ]
   }
   

   Per ulteriori informazioni, vedi i dettagli di riferimento dell'argomento nella pagina Terraform Catalog Management.

2. Dopo aver terminato la creazione del file di configurazione, inizializza la CLI Terraform. Per ulteriori informazioni, consultare la sezione Inizializzazione delle directory di lavoro.

   terraform init
   

3. Eseguire il provisioning delle risorse dal file main.tf. Per ulteriori informazioni, vedi Provisioning dell'infrastruttura con Terraform.

   1. Eseguire terraform plan per generare un piano di esecuzione Terraform per visualizzare in anteprima le azioni proposte.

      terraform plan
   

   1. Eseguire terraform apply per creare le risorse definite nel piano.

      terraform apply
   

Importazione di una versione del tuo software utilizzando Terraform

Dopo aver aggiunto il tuo prodotto, utilizza la seguente procedura per aggiungere una versione del tuo software utilizzando Terraform.

1. Aggiungere l'argomento al proprio file main.tf. Il seguente esempio accede alla versione del software utilizzando la risorsa cm_version, dove offering_id identifica il software.

   resource "cm_version" "cm_version" {
   catalog_identifier = "catalog_identifier"
   offering_id = "offering_id"
   zipurl = "zipurl"
   }
   

   Per ulteriori informazioni, vedi i dettagli di riferimento dell'argomento nella pagina Terraform Catalog Management.

2. Dopo aver terminato la creazione del file di configurazione, inizializza la CLI Terraform. Per ulteriori informazioni, consultare la sezione Inizializzazione delle directory di lavoro.

   terraform init
   

3. Eseguire il provisioning delle risorse dal file main.tf. Per ulteriori informazioni, vedi Provisioning dell'infrastruttura con Terraform.

   1. Eseguire terraform plan per generare un piano di esecuzione Terraform per visualizzare in anteprima le azioni proposte.

      terraform plan
   

   1. Eseguire terraform apply per creare le risorse definite nel piano.

      terraform apply