Intégration de logiciels à votre catalogue privé
Le processus d'intégration de votre logiciel inclut l'importation d'une version de votre catalogue privé, la configuration des détails du déploiement, la définition des exigences de licence et la validation que la version peut être installée sur l'infrastructure cible dont vous avez besoin.
Avant de commencer
-
Téléversez votre code source dans une version de votre dépôt sur GitHub, GitLab, ou Azure. Pour plus d'informations, voir Configuration de votre référentiel de code source.
-
Vérifiez que vous disposez d'un compte Paiement à la carte ou Abonnement. Pour plus d'informations, voir Affichage de votre type de compte.
-
Assurez-vous que le rôle Editeur vous est affecté sur le service de gestion des catalogues. Voir Affectation de l'accès aux services de gestion des comptes.
-
Configurez l'environnement de test qui a été créé précédemment à votre attention :
-
Installez l'interface de ligne de commande IBM Cloud et le plug-in IBM Cloud Schematics. Voir Configuration de l'interface de ligne de commande.
-
Téléversez dans votre dépôt source un fichier « readme » contenant les instructions d'installation de votre produit. Voir Configuration de votre référentiel de code source.
-
Pour les applications conteneurisées :
- Créez votre cluster Kubernetes ou votre cluster Red Hat OpenShift.
- Pour les déploiements vers IBM Cloud Kubernetes Service, définissez votre charte Helm.
- Pour les déploiements vers Red Hat OpenShift, définissez votre charte Helm ou votre opérateur.
-
Pour les images de serveur virtuel:
- Consultez la liste des images prises en charge.
- Si nécessaire, créez votre modèle Terraform. Les images de serveur virtuel pour VPC ne nécessitent pas de modèle Terraform.
- Créez une instance d'IBM Cloud Object Storage et ajoutez votre image à un compartiment.
-
Importation d'une version dans votre catalogue privé
Pour importer une version de votre logiciel dans votre catalogue privé, procédez comme suit. Votre catalogue privé a été automatiquement créé dans le cadre de la Configuration de la vente de logiciel.
-
Dans la console d' IBM Cloud, cliquez sur l'icône « Menu de navigation » (
) > « Centre des partenaires » ( ) > « Mes produits » ( ).
-
Sélectionnez le produit que vous intégrez.
-
Dans l'onglet Logiciel, cliquez sur Importer une version.
-
Sélectionnez votre méthode de déploiement.
-
Sélectionnez si vous ajoutez votre produit depuis un référentiel privé ou public. Pour les opérateurs, sélectionnez votre référentiel source, puis choisissez un référentiel privé ou public.
-
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 l'
Akka Cluster Operatordans la liste des opérateurs disponibles du référentiel « Certified ». - Image OVA :
https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml - Modèle Terraform:
https://github.com/IBM-Cloud/terraform-sample/archive/refs/tags/v1.1.0.tar.gz - 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 qui ont été 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.
Si vous ajoutez votre produit depuis un référentiel privé, vous pouvez choisir de 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 votre logiciel se trouve dans, GitLab, vous devez utiliser un jeton d'accès personnel, car GitLab ne prend pas en charge le téléchargement de versions à l'aide de jetons d'accès au projet. Vous pouvez créer un jeton d'accès personnel avec l'autorisation "
read_apirequise en suivant les instructions ici.- 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 availablepeut 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. - Helm:
-
S'il y a lieu, définissez votre cible de déploiement et ajoutez votre version de logiciel.
-
Cliquez sur Ajouter une version.
Configuration des détails de la version
- Dans la liste des versions, cliquez sur la ligne contenant votre logiciel.
- Examinez les détails de version et cliquez sur Suivant.
- En fonction de votre type de logiciel, il peut y avoir des étapes supplémentaires, y compris la définition des valeurs de déploiement.
- Cliquez sur Suivant.
Définir les valeurs de déploiement
Si applicable à votre type de logiciel, vous pouvez définir les valeurs de déploiement que les utilisateurs doivent spécifier lorsqu'ils installent le logiciel. Vous pouvez ajouter de nouvelles valeurs de déploiement ou importer des valeurs de déploiement à partir d'une version existante.
Ajouter de nouvelles valeurs de déploiement
- Cliquez sur Configurer la version > Suivant.
- Cliquez sur Ajouter des valeurs de déploiement.
- Dans le tableau, sélectionnez Paramètre > Ajouter pour sélectionner et ajouter toutes les options.
- Si nécessaire, vous pouvez personnaliser les paramètres en les sélectionnant dans la table et en cliquant sur Editer.
Importer des valeurs existantes
Suivez ces étapes si vous avez déjà défini des valeurs de déploiement pour une version existante et que vous souhaitez importer ces valeurs dans votre version actuelle.
Les valeurs importées ne remplacent pas les valeurs de déploiement que vous avez déjà ajoutées à votre version actuelle.
- Cliquez sur Configurer la version > Suivant.
- Cliquez sur Ajouter des valeurs de déploiement.
- Cliquez sur « Importer les valeurs d'une version précédente »
- Sélectionnez la version contenant les valeurs que vous souhaitez importer.
- Cliquez sur Import.
- Si nécessaire, vous pouvez personnaliser les paramètres en les sélectionnant dans la table et en cliquant sur Editer.
Editer les descriptions des valeurs de sortie
Vous pouvez améliorer les descriptions des valeurs de sortie de votre modèle Terraform pour aider les utilisateurs à mieux comprendre l'objectif des paramètres. La description de toute valeur de sortie que vous incluez dans votre modèle peut être mise à jour.
Pour ajouter des valeurs de sortie, vous devez les inclure dans une nouvelle version importée de votre modèle Terraform.
Pour modifier les descriptions des valeurs de sortie du produit, procédez comme suit:
- Cliquez sur Configurer la version > Suivant.
- Dans la section Description des valeurs de sortie, indiquez une nouvelle description pour le paramètre à mettre à jour.
- Cliquez sur Suivant.
Définir l'accès IAM
Si applicable à votre type de logiciel, vous pouvez ajouter les rôles d'accès au service et d'accès à la plateforme requis pour installer votre produit à partir du catalogue IBM Cloud. Vous pouvez définir un nouvel accès IAM ou importer un accès IAM que vous avez défini dans une version antérieure.
Définition d'un nouvel accès IAM
Pour définir l'accès de votre produit, procédez comme suit:
- Cliquez sur « Configurer la version » > « Suivant » > « Suivant ».
- Cliquez sur Ajouter.
- Sélectionnez le service et l'accès au service et à la plateforme requis.
- Le rôle d'accès au service permet d'accéder au service et d'effectuer des appels à l'API du service.
- Le rôle « Accès à la plateforme » permet d'effectuer des actions sur les ressources de la plateforme, telles que la création d'une instance, la connexion d'instances à des applications et l'attribution d'accès aux utilisateurs.
- Cliquez sur Sauvegarder.
Importation de l'accès IAM existant
Procédez comme suit si vous avez précédemment défini un accès IAM pour une version existante et que vous souhaitez importer les valeurs dans votre version en cours.
L'accès IAM importé ne remplace pas les accès IAM que vous avez déjà ajoutés à votre version actuelle.
- Cliquez sur « Configurer la version » > « Suivant » > « Suivant ».
- Cliquez sur Ajouter.
- Cliquez sur « Importer les accès IAM depuis une version précédente ».
- Sélectionnez la version contenant l'accès IAM que vous souhaitez importer.
- Cliquez sur Ajouter.
Ajout de contrats de licence
Si les utilisateurs sont tenus d'accepter des contrats de licence au-delà de l'accord de services IBM Cloud lorsqu'ils installent le logiciel, fournissez l'URL de chaque contrat ou des licences d'importation à partir d'une version existante.
Ajouter de nouveaux contrats de licence
- Cliquez sur « Ajouter des contrats de licence » > « Ajouter une licence ».
- Entrez le nom et l'URL, puis cliquez sur Ajouter une licence.
- Après avoir entré tous les contrats de licence supplémentaires, cliquez sur Suivant.
Importer des contrats de licence
Procédez comme suit si vous avez précédemment ajouté des contrats de licence pour une version existante et que vous souhaitez importer les licences dans votre version actuelle.
Les licences importées ne remplacent pas les contrats de licence que vous avez déjà ajoutés à votre version actuelle.
- Cliquez sur « Ajouter des contrats de licence » > « Ajouter une licence ».
- Cliquez sur Importer des licences à partir d'une version précédente.
- Sélectionnez la version contenant les licences que vous souhaitez importer.
- Cliquez sur Import.
Consultation du fichier Readme
Lorsque les utilisateurs installent le logiciel, ils peuvent afficher les informations sur le produit en cliquant sur le lien Readme. 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 de code source.
- Dans l'onglet Édition du fichier readme, cliquez sur l'icône Édition
.
- Prévisualisez comment les informations du fichier Readme seront présentées aux utilisateurs lors de l'installation du logiciel.
- Pour effectuer des mises à jour, cliquez sur l'icône Éditer
en regard du titre de la section Readme.
- Cliquez sur Sauvegarder.
- 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 produit
Les étapes à suivre pour valider votre produit peuvent varier en fonction du type de logiciel que vous utilisez.
- Dans l'onglet Valider le produit, configurez votre cible de validation et cliquez sur Suivant. Cette étape s'applique uniquement aux chartes et aux opérateurs Helm.
- Configurez votre espace de travail et cliquez sur Suivant. Cette étape s'applique uniquement aux chartes Helm, aux opérateurs, aux modèles Terraform et aux images de serveur virtuel avec Terraform.
- Cliquez sur Valider.
Pour suivre la progression du processus de validation, cliquez sur Afficher les journaux.
Validation de votre logiciel à l'aide de l'API
Vous pouvez valider votre logiciel en appelant l'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)
Gestion des contrôles de sécurité et de conformité
Les contrôles sont des mesures de protection utilisées pour répondre aux exigences en matière de sécurité et de conformité. Seuls les contrôles pris en charge par Workload Protection apparaissent dans le catalogue. Pour plus d'informations, voir Mise en forme des contrôles dans votre fichier Readme.
Ajouter des contrôles
Pour ajouter des contrôles, procédez comme suit :
-
Sur la page Gérer la conformité, sélectionnez Ajouter des contrôles.
-
Sélectionnez une Workload Protection instance, puis une politique.
Si vous n'avez pas encore provisionné Workload Protection d'instance, vous devez en configurer une à partir du IBM Cloud catalogue et activer Cloud Security Posture Management(CSPM) pour votre IBM Cloud compte. Ensuite, suivez les étapes pour intégrer soit une instance Workload Protection existante, soit une nouvelle instance.
-
Sélectionnez si vous souhaitez ajouter l'intégralité de la stratégie ou seulement un sous-ensemble de contrôles.
-
Si vous choisissez d'ajouter une politique entière, passez à l'étape suivante. Si vous choisissez d'ajouter un sous-ensemble de contrôles, sélectionnez les contrôles que vous souhaitez ajouter.
-
Cliquez sur Ajouter.
Ajout des résultats d'inventaire provenant de Workload Protection
Vous pouvez ajouter les résultats d'inventaire à partir de Workload Protection afin que les utilisateurs puissent voir la conformité revendiquée lorsqu'ils évaluent votre produit dans le catalogue.
Dans Workload Protection, votre inventaire est mis à jour une fois par jour. Vous devez déployer vos ressources et attendre que l'inventaire soit mis à jour avant d'ajouter l'inventaire à votre liste de catalogue. Pour plus d'informations, rendez-vous sur Inventaire.
Pour ajouter les résultats de l'inventaire, procédez comme suit :
- Sur la page « Gérer la conformité », cliquez sur « Ajouter des résultats ».
- Sélectionnez Workload Protection l'instance que vous avez provisionnée précédemment.
- Cliquez sur Appliquer pour appliquer les derniers résultats d'inventaire.