Intégration d'une architecture déployable dans un catalogue privé

Lorsque vous êtes prêt à partager votre architecture déployable avec d'autres membres de votre organisation, vous pouvez l'ajouter à un catalogue privé. De plus, vous pouvez utiliser le flux d'intégration pour valider votre architecture.

L'intégration de votre architecture déployable dans un catalogue privé implique l'ajout de votre code source au catalogue, puis la modification des détails de votre architecture déployable, suivie de sa validation. Ensuite, vous examinez l'estimation des coûts et les informations de conformité pour votre architecture déployable. Une fois que vous avez terminé, vous pouvez partager l'architecture déployable ou la publier publiquement dans l' IBM Cloud (Centre de ressources d'architecture).

Intégration d'une architecture déployable dans un catalogue
privéProcessus général d'intégration d'une architecture déployable dans un catalogue privé

Avant de commencer

Avant de pouvoir intégrer votre architecture déployable, assurez-vous de remplir les conditions préalables suivantes.

  • Vérifiez que vous disposez d'un compte Paiement à la carte ou Abonnement. Pour plus d'informations, voir Affichage de votre type de compte.
  • Vérifiez que vous disposez des droits d'accès requis pour travailler avec les catalogues privés et les architectures déployables.
    • Rôle d'administrateur sur le service IBM Cloud Schematics
    • Rôle Editeur dans le service de gestion des catalogues
    • Rôle Afficheur dans tous les groupes de ressources de votre compte
    • SecretsReader rôle sur le service Secrets Manager si vous prévoyez de stocker vos valeurs sécurisées dans une instance d' Secrets Manager
    • Rôle du lecteur sur le service Workload Protection
    • Autres rôles requis pour des ressources spécifiques dans votre architecture déployable personnalisée
  • Créez un catalogue privé.
  • Assurez-vous que le code source de votre architecture déployable est stocké dans un référentiel GitHub ou GitLab. Pour obtenir de l'aide sur la manière d'intégrer votre code source dans un référentiel, consultez la section Configuration de votre référentiel de code source.

Vous souhaitez voir comment cela fonctionne, mais vous ne disposez pas d'une architecture déployable prête à l'emploi? Utilisez notre exemple d'architecture déployable.

Emballage de votre code source

Pour créer le .tgz fichier dont vous avez besoin pour intégrer votre architecture déployable à un catalogue privé, vous devez créer une version de publication de votre code source. Pour obtenir de l'aide sur la création d'une version, consultez la section Gestion des versions dans un référentiel.

Si vous utilisez un référentiel de code source privé, assurez-vous de disposer d'un jeton d'accès personnel Git ou d'un secret stocké dans Secrets Manager.

Ajout d'une architecture déployable à un catalogue privé

Pour ajouter votre architecture déployable à un catalogue privé, vous pouvez suivre les étapes suivantes.

  1. Dans la console d' IBM Cloud, accédez à la page Gérer > Catalogues > Catalogues privés de la console.

  2. Sélectionnez le catalogue privé auquel vous souhaitez ajouter un produit. La page de détails du catalogue s'ouvre.

  3. Cliquez sur Ajouter un produit. Un panneau latéral s'ouvre.

  4. Sélectionnez Architecture déployable pour le type de produit.

  5. Sélectionnez Terraform ou Stack comme méthode de livraison.

  6. Sélectionnez le type de référentiel dans lequel se trouve votre code source.

    Si votre code source se trouve dans un référentiel privé, vous devez vous authentifier à l'aide d'un jeton d'accès personnel Git ou d'un secret provenant de Secrets Manager.

  7. Ajoutez un lien vers votre code source dans le champ Source URL. Il devrait ressembler à https://github.com/IBM-Cloud/terraform-sample/archive/refs/tags/v1.1.0.tar.gz.

    Si vous intégrez votre architecture déployable à des fins de test, vous n'avez pas besoin d'avoir un .tgz fichier. Vous pouvez fournir le lien vers le niveau racine de votre architecture.

  8. Sélectionnez une variante.

    Une variante est un type d'architecture déployable qui applique des capacités ou une complexité différentes à une architecture déployable existante. Par exemple, il peut exister une variante «* Quick start* » (Démarrage rapide) de votre architecture déployable qui dispose des fonctionnalités de base pour un déploiement simple et peu coûteux à tester en interne. Et vous pourriez avoir une variante Standard un peu plus complexe, prête à être utilisée en production.

  9. Saisissez la version du logiciel au format version majeure, version mineure, révision. Par exemple, 1.0.0. En règle générale, cette version correspond au numéro de version de votre instantané de publication.

  10. Sélectionnez la catégorie dans laquelle vous souhaitez regrouper votre architecture déployable dans le catalogue.

  11. Cliquez sur Ajouter un produit. La page de présentation du produit s'affiche.

Modification de votre entrée dans le catalogue

Une fois que vous avez intégré avec succès votre architecture déployable à votre catalogue privé, vous devez spécifier les informations que l'utilisateur voit lorsqu'il tente d'utiliser l'architecture. Les informations comprennent des descriptions du produit, des liens vers la documentation et des mots-clés qui garantissent que votre produit est facile à trouver.

  1. Accédez à la page Gérer > Catalogues > Catalogues privés de la console.

  2. Sélectionnez le catalogue privé auquel vous avez ajouté votre produit. La page de détails du catalogue s'ouvre.

  3. Sélectionnez le produit que vous avez précédemment intégré.

  4. Modifiez la manière dont votre entrée apparaît dans le catalogue.

    1. Dans la section Détails de l'entrée du catalogue, cliquez sur Modifier.
    2. Vérifiez les informations importées avec votre architecture déployable et apportez les modifications nécessaires.
    3. Vérifiez que votre entrée s'affiche comme prévu en consultant l'aperçu de l'entrée du catalogue.
    4. Lorsque vous avez terminé vos sélections, cliquez sur Enregistrer.

  5. Modifiez la page «À propos » de votre produit. Lorsqu'un utilisateur sélectionne votre produit dans le catalogue, une section « À propos » s'affiche, lui permettant d'en savoir plus sur votre produit et les fonctionnalités disponibles.

    1. Dans le menu déroulant Actions, sélectionnez Modifier la page du produit.
    2. Entrez une description de votre produit qui explique sa valeur et ses avantages pour vos utilisateurs.
    3. Pour ajouter des informations spécifiques sur une fonctionnalité, cliquez sur Fonctionnalités > Ajouter une fonctionnalité.
    4. Ajoutez des fonctionnalités au niveau du produit qui expliquent les processus, les capacités et les résultats du produit. Les utilisateurs peuvent voir les caractéristiques générales du produit au début de la page produit qui s'appliquent à l'ensemble du produit, indépendamment des différences de version ou d'architecture. Par exemple, si votre produit crée des clouds privés virtuels, vous pouvez ajouter Creates Virtual Private Clouds comme titre de la fonctionnalité et Virtual Private Clouds are created for you with the necessary underlying network components. comme description de la fonctionnalité. Pour ajouter des fonctionnalités pour des variantes ou des versions spécifiques, vous pouvez le faire en ajoutant des surlignages.
    5. Cliquez sur Mettre à jour.

Spécification des détails via la console

Vos utilisateurs voient les informations relatives à la version que vous définissez dans l'entrée du catalogue pour votre produit. Les informations fournies dans le cadre de ce flux peuvent aider vos utilisateurs à comprendre les fonctionnalités des différents composants qui y sont associés.

Pour vous assurer que vos sélections sont reportées dans votre prochaine version, vous pouvez générer un fichier manifeste. Le fichier manifeste, ibm_catalog.json, est la source de vérité pour votre entrée de catalogue. Il contient toutes les informations relatives à votre produit et aux choix que vous avez effectués. Après avoir généré le fichier, vous devez l'ajouter au niveau racine de votre référentiel de code source. Si vous préférez travailler dans le code, les sections suivantes peuvent être configurées directement via le fichier mainfest. Pour plus d'informations sur la manière de structurer le fichier, consultez la section Modification locale de votre fichier manifeste.

Entrer dans les détails

Après avoir ajouté votre architecture déployable à un catalogue privé, vous pouvez suivre les instructions étape par étape dans la console pour mettre à jour les informations générales relatives à votre produit. Pour accéder à la page de la console, vous pouvez suivre les étapes suivantes.

  1. Accédez à la page Gérer > Catalogues > Catalogues privés de la console.
  2. Sélectionnez le catalogue privé dans lequel vous avez ajouté votre produit. La page de détails du catalogue s'ouvre.
  3. Sélectionnez le produit que vous avez précédemment intégré.
  4. Dans l'onglet Versions, sélectionnez la version de votre produit pour laquelle vous souhaitez fournir des informations.
  5. Utilisez les informations suivantes comme guide pour configurer les détails de votre architecture déployable.

Configuration des détails de votre version

Dans l'onglet Configurer la version, vous pouvez consulter et mettre à jour les informations relatives à la version spécifique de votre architecture. Vous configurez les détails du déploiement, définissez l'accès IAM requis et détaillez les avis de modification que vous souhaitez porter à la connaissance de vos utilisateurs.

Si vous souhaitez étendre votre architecture déployable, vous pouvez le faire en l'empilant avec d'autres architectures. Vous pouvez inclure les dépendances requises par votre architecture, ainsi que des architectures facultatives qui vous aideront à étendre votre solution à un cas d'utilisation particulier. Pour plus d'informations, consultez la section Étendre une architecture déployable lors de l'intégration.

Si votre architecture déployable nécessite une version spécifique du runtime Terraform, vous pouvez remplacer la version par défaut. Si vous avez inclus TF_VERSION comme variable d'entrée dans votre référentiel de code source, celle-ci aurait dû être automatiquement mise à jour lorsque vous avez créé votre entrée de catalogue.

Les variables d'entrée sont les paramètres que les utilisateurs spécifient lorsqu'ils utilisent votre produit. Vous pouvez examiner et modifier les variables d'entrée et de sortie qui ont été importées avec votre code source, ou vous pouvez ajouter des variables à votre architecture déployable dans le cadre de cette étape. Lorsque des variables sont ajoutées, vous pouvez mettre à jour leur caractère obligatoire, leur visibilité ou le format dans lequel elles doivent être fournies.

Lorsque vous lancez une nouvelle version de votre produit, il se peut que vous souhaitiez informer vos utilisateurs de certains changements avant qu'ils ne commencent à utiliser la nouvelle version. Vous pouvez classer les informations en trois catégories : changements majeurs, nouvelles fonctionnalités et mises à jour générales.

  • Changements majeurs: détaillez tous les changements apportés au code de la nouvelle version qui pourraient perturber l'expérience des utilisateurs travaillant avec une version antérieure.
  • Nouvelles fonctionnalités: mettez en avant toutes les nouvelles fonctionnalités offertes par la nouvelle version dont les utilisateurs pourraient vouloir tirer parti.
  • Mises à jour: décrivez toutes les mises à jour générales qui ont été apportées à la nouvelle version. Par exemple, corrections de bogues ou améliorations apportées à des fonctionnalités existantes.

Y compris les préfaces et les postfaces

Vous pouvez exécuter un script préalable ou postérieur pour vos architectures déployables avant ou après la validation, le déploiement et le désinstallation. Les scripts sont configurés pour une version spécifique de votre architecture déployable, comme indiqué dans le fichier manifeste du catalogue, et doivent être exécutés et validés via des projets.

Les scripts sont facultatifs pour une offre, mais s'ils sont utilisés, ils doivent être placés dans le référentiel, dans un répertoire nommé scripts. Les fichiers de script eux-mêmes doivent respecter la convention de nommage <action>-<stage>-ansible-playbook.yaml suivante. Les options disponibles action sont deploy, validate, et undeploy. Options pour stage include pre et post. Seuls les scripts Ansible au format playbook sont pris en charge pour le moment.

Tous les scripts doivent pouvoir être exécutés plusieurs fois sans échouer. Par exemple, un script pré-déploiement ou post-déploiement doit fonctionner correctement, même s'il est exécuté plusieurs fois. Les scripts post-déploiement peuvent ajouter des ressources à une base de données de gestion de catalogue et doivent veiller à ne pas ajouter de ressources en double s'ils sont exécutés plusieurs fois.

Pour plus d'informations, y compris des exemples, consultez Création de scripts pour une architecture déployable.

Ajout de détails sur l'architecture déployable

Lorsque vous mettez une architecture déployable à la disposition d'autres utilisateurs dans le cloud, vous devez fournir les informations suivantes :

  • Un diagramme architectural qui détaille comment les composants de votre architecture déployable fonctionnent ensemble.
  • Tout élément susceptible d'aider les utilisateurs à déterminer quelle version ou variante de votre architecture est la mieux adaptée à leurs besoins.

Ajout de contrats de licence

Si les utilisateurs sont tenus d'accepter des contrats de licence en plus du Contrat relatif aux services IBM Cloud, indiquez l'URL de chaque contrat.

Edition du fichier Readme

Documentez les instructions d'installation de votre architecture déployable dans le fichier Lisez-moi.

Validation de la version

Sélectionnez la cible à valider. Lorsqu'un produit est validé, les ressources sont déployées. Pour une architecture déployable autonome, la cible peut être soit un espace de travail d' Schematics s dans votre compte actuel, soit un projet spécifique. Pour une pile d'architecture déployable, vous devez utiliser un projet. Selon l'option que vous sélectionnez, des informations de configuration supplémentaires peuvent être requises. Une fois votre cible configurée, vous devez fournir les valeurs des variables d'entrée et de sortie requises pour que votre architecture puisse être déployée avec succès sur la cible. Une fois vos variables configurées, vous pouvez valider la version.

Ne supprimez pas les ressources de votre compte avant d'avoir effectué l'évaluation de conformité dans la section Gestion de la sécurité et de la conformité.

Si la version échoue à la validation en raison d'une analyse CRA, un administrateur du compte peut choisir d'ignorer l'échec et de procéder quand même au déploiement. Si la validation échoue pour toute autre raison, il est fortement recommandé de corriger les problèmes détectés avant de publier votre offre.

Révision des coûts

Assurez-vous de bien comprendre les coûts associés au déploiement de votre architecture. La version doit être validée avant que vous puissiez générer une estimation des coûts.

gestion de la conformité

Lorsque vous mettez une architecture déployable à la disposition d'autres personnes de votre organisation, vous pouvez spécifier les contrôles de conformité spécifiques auxquels votre architecture répond en utilisant l'installation par défaut. La conformité aux contrôles réglementaires est évaluée par IBM Cloud® Security and Compliance Center Workload Protection.

  1. Cliquez sur Ajouter des contrôles.
  2. Sélectionnez votre instance et votre stratégie d' Workload Protection. Vous pouvez choisir une politique prédéfinie ou vous rendre sur Workload Protection pour créer votre propre politique.
  3. Précisez si votre architecture déployable répond à tous les contrôles de la politique ou si elle peut satisfaire aux exigences d'un sous-ensemble des contrôles.
  4. Si votre architecture ne peut satisfaire qu'une partie des contrôles, vous devez sélectionner les contrôles qui peuvent être satisfaits et les ajouter.
  5. Utilisez Workload Protection pour confirmer la conformité avec les contrôles que vous avez identifiés. Workload Protection utilise un inventaire pour suivre la conformité. Les résultats de l'inventaire sont mis à jour quotidiennement. Déployez les ressources créées par votre architecture et attendez que les résultats de l'inventaire soient mis à jour. Pour plus d'informations, consultez la section Examiner et hiérarchiser les mesures correctives.
  6. Dans l'onglet Gérer la conformité de l'interface utilisateur du catalogue, cliquez sur Ajouter des résultats.
  7. Sélectionnez une instance et cliquez sur Appliquer pour appliquer les derniers résultats d'inventaire.

Examen des exigences

Une fois la procédure terminée, vous devez vérifier vos sélections et confirmer que vous êtes prêt à partager votre produit dans votre catalogue. Lorsque vous êtes prêt, cliquez sur Prêt à partager.

Téléchargement du manifeste

Chaque fois que des modifications sont apportées à la configuration de votre produit via la console, il est recommandé de générer et de télécharger votre fichier manifeste afin de vous assurer que vos modifications seront prises en compte dans les prochaines versions de votre produit.

Pour télécharger un manifeste, vous pouvez suivre les étapes suivantes.

  1. Accédez à la page Gérer > Catalogues > Catalogues privés de la console.
  2. Sélectionnez le produit qui a été précédemment intégré. Une page de détails s'ouvre.
  3. Dans l'onglet Versions, sélectionnez la version pour laquelle vous souhaitez générer un manifeste.
  4. Dans le menu déroulant Actions, sélectionnez Générer le manifeste.
  5. Ajoutez le fichier dans le dossier racine de votre référentiel de code source sous le nom ibm_catalog.json.

Téléchargement de la configuration de votre catalogue

Si vous intégrez des architectures déployables empilées à partir d'un projet, des fichiers supplémentaires sont générés en plus de votre fichier manifeste. Si vous avez mis à jour la configuration de votre catalogue à l'aide de la console, il est recommandé de télécharger les fichiers et de les ajouter à votre référentiel de code source afin que vos modifications soient reprises dans votre prochaine version.

  1. Accédez à la page Gérer > Catalogues > Catalogues privés de la console.
  2. Sélectionnez le produit qui a été précédemment intégré. Une page de détails s'ouvre.
  3. Dans l'onglet Versions, sélectionnez la version pour laquelle vous souhaitez générer un manifeste.
  4. Dans le menu déroulant Actions, sélectionnez Générer le manifeste.
  5. Ajoutez les fichiers dans le dossier racine de votre référentiel de code source.

Ajouter une variante

Vous pouvez ajouter d'autres variantes qui constituent une nouvelle version de votre architecture, conçue pour s'appuyer sur les fonctionnalités de l'architecture déployable de base. Si vous avez créé plusieurs variantes dans des répertoires de travail distincts dans votre dépôt source et que vous les avez spécifiées dans le flavors tableau de votre fichier ibm_catalog.json manifeste, vous devez intégrer chaque variante séparément.

À ce stade, vous avez déjà intégré votre première variante. Vous pouvez maintenant recommencer à Ajouter une architecture déployable pour intégrer votre prochaine variante. Voici quelques conseils pour intégrer votre prochaine variante :

  • L' URL source de la version du dépôt sera la même pour toutes les variantes de cette version et elles devront être importées avec le même numéro de version. Le nom du produit et le numéro de version permettent de relier les variantes entre elles, qui apparaissent ensuite sous forme d'options dans la même vignette du catalogue.
  • Sur la page Ajouter les détails de l'architecture déployable, l'étape 3 consiste à ajouter des éléments importants. Ces éléments sont appelés « fonctionnalités » dans le ibm_catalog.json fichier manifeste. Vous les avez peut-être déjà ajoutés dans le manifeste, vous pouvez donc les vérifier ici. Si ce n'est pas le cas, n'hésitez pas à ajouter quelques touches de couleur. Il doit s'agir de capacités, de processus, de performances ou d'autres caractéristiques spécifiques à cette architecture particulière. Vous utiliserez le même surlignage « Nom » pour toutes les variantes. C'est dans la description que devraient apparaître les différences. Cela permet aux utilisateurs d'évaluer les différences entre les architectures à l'aide des surlignages de texte sur la page de détails du catalogue.

Prochaines étapes : partage et publication

Maintenant que votre architecture déployable est ajoutée à un catalogue privé et que les détails sont définis, vous êtes prêt à partager le produit avec d'autres membres de votre organisation. Pour obtenir de l'aide sur le partage, consultez la section Partager votre produit.

Si vous souhaitez publier votre architecture déployable dans le catalogue IBM Cloud, vous pouvez utiliser le Centre des partenaires pour obtenir l'autorisation et publier afin que tous les utilisateurs puissent profiter de la solution que vous avez créée. Pour plus d'informations, consultez la section Publication de votre architecture déployable.