Création d'un catalogue privé

Les catalogues privés permettent de gérer l'accès aux produits par les utilisateurs de votre compte.

1. Dans la console d' IBM Cloud, accédez à « Gérer > Catalogues », puis cliquez sur « Créer un catalogue ».
2. Entrez un nom et une description pour votre catalogue.
3. Choisissez d'exclure ou d'inclure tous les produits du catalogue IBM Cloud dans votre catalogue privé. Pour plus d'informations sur la manière dont cela affecte la visibilité dans le catalogue, voir Gestion des paramètres de catalogue.
4. Cliquez sur Créer.

Importation d'un logiciel dans votre catalogue privé

Pour importer un logiciel dans votre catalogue privé, procédez comme suit :

1. Sur la page Produits privés, cliquez sur Ajouter.

2. Sélectionnez votre méthode de déploiement.

3. Sélectionnez si vous ajoutez votre produit depuis un référentiel privé ou public. Ou, si vous intégrez un opérateur à partir d'un registre Red Hat, sélectionnez votre type de référentiel Red Hat : Certifié, Marché, Communauté.

   Si vous ajoutez votre produit depuis un référentiel privé, vous pouvez fournir un jeton d'accès personnel ou vous pouvez utiliser un secret. Au lieu de donner aux utilisateurs un jeton d'accès personnel, vous pouvez leur accorder l'accès à un secret, ajouter le jeton à ce secret, puis gérer de manière centralisée tous les jetons et les accès autorisés par le secret.

   • Si vous utilisez un jeton d'accès personnel, sélectionnez Non pour indiquer que vous n'utilisez pas de secret et fournissez votre jeton d'accès personnel.
   • Si vous utilisez un secret, sélectionnez Oui et cliquez sur Sélectionner depuis Secrets Manager. Sélectionnez votre instance de service, le groupe de secrets et le secret. Si vous ne voyez pas votre secret, vérifiez que vous utilisez le groupe de secrets et l'instance de service corrects.

   Le message No service instance available peut s'afficher si vous n'avez pas créé de secret ou si vous n'avez pas l'accès correct pour utiliser des secrets, même si vous avez des instances de service qui sont créées.

4. Entrez votre URL source. Vous pouvez consulter la liste suivante des formats pris en charge par type de logiciel:

   • Helm: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm
   • Opérateur Node-RED : https://github.com/IBM-Cloud/operator-bundle-sample/archive/refs/tags/v0.0.3.tar.gz
   • Ensemble d'opérateurs issu d'un registre « Red Hat OpenShift on IBM Cloud » : à titre d'exemple, sélectionnez « Akka Cluster Operator » dans la liste des opérateurs disponibles du référentiel certifié.
   • Image OVA : https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
   • Modèle Terraform : https://github.com/IBM-Cloud/terraform-sample/releases/tag/v1.0.0
   • Image de serveur virtuel avec Terraform : https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
   • Image de serveur virtuel pour VPC : sélectionnez une image dans la liste des images disponibles importées dans votre VPC ou importez une nouvelle image dans votre compte.

   Une image de serveur virtuel pour VPC ne peut être ajoutée qu'à un seul produit dans un catalogue privé à la fois. Si l'image de serveur virtuel que vous souhaitez importer est déjà importée dans un autre produit, vous devez supprimer l'image de ce produit ou supprimer le produit avant d'ajouter l'image de serveur virtuel à un nouveau produit.

5. Le cas échéant, entrez la version du logiciel au format version principale, version secondaire et révision. Par exemple, entrez la version 1.1.2.

6. Sélectionnez une catégorie de catalogues pour le produit. Les catégories sont utilisées pour organiser les produits du catalogue IBM Cloud en fonction de leur fonction, de leur utilisation ou de solutions communes.

7. Cliquez sur Ajouter un produit.

Ajout de détails d'entrée de catalogue

Lorsque vous publiez votre produit dans le catalogue pour les utilisateurs disposant d'un accès à votre catalogue privé, ils voient une mosaïque avec le nom du produit et d'autres détails ajoutés lors de l'intégration. Outre la catégorie que vous définissez lorsque vous importez votre logiciel, vous pouvez ajouter d'autres filtres liés à l'industrie, à la conformité, aux technologies avec lesquelles il fonctionne, etc. Chacun de ces filtres est utilisé dans le catalogue pour que les utilisateurs trouvent les logiciels qui correspondent à leurs besoins. Dans la section des détails de l'entrée de catalogue, vous pouvez également évaluer et mettre à jour les brèves descriptions, l'URL de la documentation et même les mots clés pour aider les utilisateurs à rechercher et à trouver votre produit rapidement.

1. Dans la section des détails de l'entrée de catalogue, cliquez sur l'icône Editer .
2. Vérifiez les informations qui ont été importées avec votre produit et faites les modifications nécessaires.
3. Vérifiez les filtres et les options de l'industrie pour sélectionner les filtres de catalogue qui s'appliquent. Vous pouvez sélectionner jusqu'à cinq filtres de l'industrie.
4. Vérifiez l'aperçu de votre entrée de catalogue pour voir comment votre mosaïque de catalogue s'affiche pour les utilisateurs qui évaluent votre logiciel dans le catalogue.
5. Cliquez sur Sauvegarder lorsque vous êtes satisfait de vos modifications.

Pour plus d'informations, voir Définition des détails de votre produit.

Configuration du logiciel

Ajout de contrats de licence

Fournissez les URL des contrats de licence que les utilisateurs doivent accepter lorsqu'ils installent le produit. Les contrats de licence viennent s'ajouter aux contrats de services IBM Cloud.

1. Cliquez sur « Ajouter des contrats de licence » > « Ajouter une licence ».
2. Entrez le nom et l'URL, puis cliquez sur Mettre à jour > Suivant.

Edition du fichier Readme

Lorsqu'ils installent le logiciel, les utilisateurs peuvent cliquer sur le lien vers votre fichier « readme » pour consulter les informations relatives au produit. Les informations contenues dans le lien « Readme » sont générées à partir du fichier readme que vous avez mis en ligne dans votre dépôt source.

1. Dans l'onglet Modifier le fichier Readme, prévisualisez l'affichage des informations du fichier Readme aux utilisateurs lors de l'installation du logiciel.
2. Pour effectuer des mises à jour, cliquez sur l'icône Éditer en regard du titre de la section Readme.
3. Cliquez sur Sauvegarder.
4. Cliquez sur Suivant.

Si vous importez une image de serveur virtuel pour VPC, le fichier Readme n'est pas généré automatiquement. Copiez et collez le contenu du modèle de fichier Readme et effectuez les mises à jour nécessaires.

Validation du logiciel

Lorsque vous validez votre logiciel, vérifiez que la version actuelle peut être installée sur la cible de déploiement. Les étapes de validation varient en fonction de votre méthode de déploiement.

Pour suivre la progression du processus de validation, cliquez sur Afficher les journaux.

Gérer la conformité

Vous pouvez ajouter des profils et des contrôles à votre logiciel pour prouver qu'il répond aux exigences de sécurité et de conformité. Vous devez utiliser Compliance Manager pour analyser les ressources créées lors de la validation.

Seuls les profils et les contrôles pris en charge par les examens Compliance Manager et validés par Compliance Manager apparaissent dans le catalogue.

Partage du logiciel

Si vous souhaitez partager votre produit avec votre compte ou votre entreprise, cliquez sur le nom du produit dans la fenêtre de navigation pour accéder à la page des détails du produit. Dans le menu Actions, cliquez sur Partager. Sélectionnez l'emplacement où vous souhaitez partager votre produit, puis cliquez sur Partager.

Logiciel d'intégration à votre catalogue à l'aide de l'interface de ligne de commande

Procédez comme suit pour ajouter votre logiciel à l'aide de l'interface de ligne de commande. Vous pouvez utiliser cette tâche dans le cadre d'un processus CI/CD. Pour ajouter un logiciel à partir d'un référentiel privé, vous devez inclure un jeton d'accès personnel.

1. Exécutez le création du catalogue ibmcloud commande pour créer un catalogue privé. Les catalogues privés permettent de gérer l'accès aux produits par les utilisateurs de votre compte.

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

2. Exécutez le Création d'offre de catalogue IBMcloud commande pour ajouter un logiciel à votre catalogue privé.

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

   Si vous souhaitez importer des logiciels à partir d'un référentiel privé, vous pouvez utiliser un jeton d'accès personnel en ajoutant [-- token TOKEN] à votre commande.

3. Exécutez le Catalogue IBMcloud offrant une catégorie d'ajout commande pour ajouter une catégorie à votre produit. Par défaut, la catégorie Outils de développement est ajoutée à votre produit.

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

4. Exécutez le Catalogue IBMcloud offrant une version d'importation pour importer la version du logiciel que vous souhaitez dans votre catalogue.

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

   La liste des formats pris en charge par type de logiciel est la suivante :

   • Helm: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm
   • Opérateur Node-RED : https://github.com/IBM-Cloud/operator-bundle-sample/archive/refs/tags/v0.0.3.tar.gz
   • Ensemble d'opérateurs issu d'un registre « Red Hat OpenShift on IBM Cloud » : à titre d'exemple, sélectionnez « Akka Cluster Operator » dans la liste des opérateurs disponibles du référentiel certifié.
   • Image OVA : https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
   • Modèle Terraform : https://github.com/IBM-Cloud/terraform-sample/releases/tag/v1.0.0
   • Image de serveur virtuel avec Terraform : https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
   • Image de serveur virtuel pour VPC : sélectionnez une image dans la liste des images importées dans votre VPC ou importez une nouvelle image dans votre compte.

5. Exécutez le Validation de la version de l'offre du catalogue IBMcloud commande pour valider le logiciel.

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

   Le déploiement du logiciel peut nécessiter quelques minutes. Exécutez le Statut de validation de la version de l'offre de catalogue IBMcloud pour vérifier l'état de validation en interrogeant l'état de validation du produit.

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

6. Exécutez le Compte de publication d'offre de catalogue IBMcloud pour publier votre logiciel aux utilisateurs de votre compte.

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

Création d'un catalogue privé à l'aide de l'API

Les catalogues privés permettent de gérer l'accès aux produits par les utilisateurs de votre compte. Vous pouvez créer un catalogue privé à l'aide d'un programme en appelant l'API Catalog Management comme indiqué dans la demande d'exemple suivante. Pour plus d'informations, voir API de gestion de catalogue pour la création d'un catalogue.

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)

Importation d'un logiciel dans votre catalogue privé à l'aide de l'API

Vous pouvez importer des logiciels à l'aide d'un programme dans votre catalogue en appelant l'API de gestion de catalogue, comme indiqué dans la demande d'exemple suivante. Cette API crée le logiciel et l'importe également. Pour plus d'informations sur l'API, voir API Catalog Management.

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)

Validation de votre logiciel à l'aide de l'API

Vous pouvez valider votre produit à l'aide d'un programme en appelant l'API de gestion de catalogue, comme indiqué dans la demande d'exemple suivante. Ce processus peut prendre quelques minutes. Pour plus d'informations sur l'API, voir API Catalog Management.

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)

Publication de votre logiciel sur votre compte à l'aide de l'API

Vous pouvez publier à l'aide d'un programme votre logiciel sur votre compte en appelant l'API de gestion de catalogue, comme indiqué dans la demande d'exemple suivante.

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)

Création d'un catalogue privé à l'aide de Terraform

Procédez comme suit pour créer un catalogue privé à l'aide de Terraform.

1. Ajoutez votre argument à votre fichier main.tf. L'exemple ci-après crée un catalogue privé à l'aide de la ressource ibm_cm_catalog, label représentant un nom d'affichage permettant d'identifier le catalogue.

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

   Pour plus d'informations, consultez les détails de la référence des arguments sur la page « Gestion du catalogue Terraform ».

2. Une fois que vous avez terminé de générer votre fichier de configuration, initialisez l'interface de ligne de commande Terraform. Pour plus d'informations, voir Initialisation des répertoires de travail.

   terraform init
   

3. Mettez à disposition les ressources à partir du fichier main.tf. Pour plus d'informations, voir Mise à disposition d'une infrastructure avec Terraform.

   1. Exécutez terraform plan pour générer un plan d'exécution Terraform afin de prévisualiser les actions proposées.

      terraform plan
   

   1. Exécutez terraform apply pour créer les ressources définies dans le plan.

      terraform apply
   

Importation d'un produit dans votre catalogue à l'aide de Terraform

Procédez comme suit pour importer un produit dans votre catalogue privé à l'aide de Terraform.

1. Ajoutez votre argument à votre fichier main.tf. L'exemple ci-après ajoute votre produit à l'aide de la ressource ibm_cm_offering, label représentant un nom d'affichage permettant d'identifier le produit.

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

   Pour plus d'informations, consultez les détails de la référence des arguments sur la page « Gestion du catalogue Terraform ».

2. Une fois que vous avez terminé de générer votre fichier de configuration, initialisez l'interface de ligne de commande Terraform. Pour plus d'informations, voir Initialisation des répertoires de travail.

   terraform init
   

3. Mettez à disposition les ressources à partir du fichier main.tf. Pour plus d'informations, voir Mise à disposition d'une infrastructure avec Terraform.

   1. Exécutez terraform plan pour générer un plan d'exécution Terraform afin de prévisualiser les actions proposées.

      terraform plan
   

   1. Exécutez terraform apply pour créer les ressources définies dans le plan.

      terraform apply
   

Importation d'une version de votre logiciel à l'aide de Terraform

Après avoir ajouté votre produit, procédez comme suit pour ajouter une version de votre logiciel à l'aide de Terraform.

1. Ajoutez votre argument à votre fichier main.tf. L'exemple ci-après permet d'accéder à la version de logiciel à l'aide de la ressource cm_version, offering_id identifiant le logiciel.

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

   Pour plus d'informations, consultez les détails de la référence des arguments sur la page « Gestion du catalogue Terraform ».

2. Une fois que vous avez terminé de générer votre fichier de configuration, initialisez l'interface de ligne de commande Terraform. Pour plus d'informations, voir Initialisation des répertoires de travail.

   terraform init
   

3. Mettez à disposition les ressources à partir du fichier main.tf. Pour plus d'informations, voir Mise à disposition d'une infrastructure avec Terraform.

   1. Exécutez terraform plan pour générer un plan d'exécution Terraform afin de prévisualiser les actions proposées.

      terraform plan
   

   1. Exécutez terraform apply pour créer les ressources définies dans le plan.

      terraform apply