Synchronisation de produits avec des modèles de fichiers provenant GitHub d' GitHub Enterprise ou de Bitbucket - AWS Service Catalog

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Synchronisation de produits avec des modèles de fichiers provenant GitHub d' GitHub Enterprise ou de Bitbucket

AWS Service Catalog vous permet de synchroniser les produits avec des fichiers modèles gérés par le biais d'un fournisseur de référentiel externe. AWS Service Catalog désigne les produits dotés de ce type de connexion au modèle en tant que produits synchronisés avec Git. Les options de référentiel incluent GitHub GitHub Enterprise ou Bitbucket. Une fois que vous vous êtes autorisé Compte AWS avec un compte de référentiel externe, vous pouvez créer de nouveaux AWS Service Catalog produits ou mettre à jour des produits existants pour les synchroniser avec un fichier modèle du référentiel. Lorsque des modifications sont apportées au fichier modèle et validées dans le référentiel (par exemple, à l'aide de git-push), les modifications sont AWS Service Catalog automatiquement détectées et une nouvelle version du produit (artefact) est créée.

Autorisations requises pour synchroniser les produits avec des fichiers modèles externes

Vous pouvez utiliser la politique AWS Identity and Access Management (IAM) suivante comme modèle pour permettre aux AWS Service Catalog administrateurs de synchroniser des produits avec des fichiers modèles provenant d'un référentiel externe. Cette politique inclut les autorisations requises de la part de CodeConnections et AWS Service Catalog. AWS Service Catalog vous recommande de copier le modèle de politique ci-dessous et d'utiliser également la politique AWS Service CatalogAWSServiceCatalogAdminFullAccess gérée lors de l'activation de produits synchronisés avec le référentiel.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "CodeStarAccess", "Effect": "Allow", "Action": [ "codestar-connections:UseConnection", "codestar-connections:PassConnection", "codestar-connections:CreateConnection", "codestar-connections:DeleteConnection", "codestar-connections:GetConnection", "codestar-connections:ListConnections", "codestar-connections:ListInstallationTargets", "codestar-connections:GetInstallationUrl", "codestar-connections:StartOAuthHandshake", "codestar-connections:UpdateConnectionInstallation", "codestar-connections:GetIndividualAccessToken" ], "Resource": "arn:aws:codestar-connections:*:*:connection/*" }, { "Sid": "CreateSLR", "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "arn:aws:iam::*:role/aws-service-role/sync.servicecatalog.amazonaws.com/AWSServiceRoleForServiceCatalogArtifactSync", "Condition": { "StringLike": { "iam:AWSServiceName": "sync.servicecatalog.amazonaws.com" } } } ] }

Création d'une connexion à un compte

Avant de synchroniser un fichier modèle avec un AWS Service Catalog produit, vous devez créer et autoriser une account-to-account connexion unique. Vous utilisez cette connexion pour spécifier les détails du référentiel contenant le fichier modèle souhaité. Vous pouvez créer une connexion à l'aide de la AWS Service Catalog CodeConnections console, de la console AWS Command Line Interface (CLI) ou CodeConnections des API.

Après avoir établi une connexion, vous pouvez utiliser la AWS Service Catalog console, l' AWS Service Catalog API ou la CLI pour créer un AWS Service Catalog produit synchronisé. AWS Service Catalog les administrateurs peuvent créer de nouveaux produits ou mettre à jour AWS Service Catalog des produits existants sur la base d'un fichier modèle dans un référentiel ou une branche. Si une modification est validée dans le référentiel, la détecte AWS Service Catalog automatiquement et crée une nouvelle version du produit. Les versions précédentes du produit sont maintenues jusqu'à la limite de versions prescrite et sont considérées comme obsolètes.

En outre, crée AWS Service Catalog automatiquement un rôle lié à un service (SLR) une fois la connexion créée. Ce SLR permet AWS Service Catalog de détecter toute modification de fichier modèle validée dans le référentiel. Le SLR permet également de AWS Service Catalog créer automatiquement de nouvelles versions de produits pour les produits synchronisés. Pour plus d'informations sur les autorisations et les fonctionnalités du SLR, reportez-vous à la section Rôles liés à un service pour. AWS Service Catalog

Pour créer un nouveau produit synchronisé avec Git
  1. Dans le panneau de navigation de gauche, choisissez Liste des produits, puis sélectionnez Créer un produit.

  2. Entrez les détails du produit.

  3. Dans Détails de la version, choisissez Spécifiez votre référentiel de code à l'aide d'un AWS CodeStar fournisseur, puis choisissez le lien Créer une nouvelle AWS CodeStar connexion.

  4. Après avoir créé la connexion, actualisez la liste des connexions, puis sélectionnez la nouvelle connexion. Spécifiez les détails du référentiel, notamment le chemin du référentiel, de la branche et du fichier modèle.

    Pour plus d'informations sur l'utilisation d'un fichier de configuration Terraform, consultez. Synchronisation des produits Terraform avec des modèles de fichiers depuis GitHub Enterprise GitHub ou Bitbucket

    1. (Facultatif lors de la création d'une nouvelle ressource de AWS Service Catalog produit) Dans la section Support Details, ajoutez des métadonnées pour le produit.

    2. (Facultatif lors de la création d'une nouvelle ressource de AWS Service Catalog produit) Dans la section Balises, choisissez Ajouter une nouvelle balise et entrez les paires clé et valeur.

  5. Choisissez Créer un nouveau produit.

Pour créer plusieurs produits synchronisés avec Git
  1. Dans le panneau de navigation de gauche de la AWS Service Catalog console, choisissez Liste des produits, puis sélectionnez Créer plusieurs produits gérés par git.

  2. Entrez les détails courants du produit.

  3. Dans Détails du référentiel externe, sélectionnez une AWS CodeStar connexion, puis spécifiez le référentiel et la branche.

  4. Dans le volet Ajouter des produits, entrez le chemin du fichier modèle et le nom du produit. Choisissez Ajouter un nouvel article et continuez à ajouter des produits comme vous le souhaitez.

  5. Après avoir ajouté tous les produits souhaités, choisissez Créer des produits en bloc.

Pour connecter un AWS Service Catalog produit existant à un référentiel externe
  1. Dans le panneau de navigation de gauche de la AWS Service Catalog console, sélectionnez Liste des produits, puis sélectionnez Connecter les produits à un référentiel externe.

  2. Sur la page Sélectionner des produits, sélectionnez les produits que vous souhaitez connecter à un référentiel externe, puis choisissez Suivant.

  3. Sur la page Spécifier les détails de la source, sélectionnez une AWS CodeStar connexion existante, puis spécifiez le référentiel, la branche et le chemin du fichier modèle.

  4. Choisissez Suivant.

  5. Sur la page Vérifier et envoyer, vérifiez les détails de connexion, puis choisissez Connect products to an external repository.

Affichage des connexions de produits synchronisées avec Git

Vous pouvez utiliser la AWS Service Catalog console, l'API ou AWS CLI pour afficher les détails de connexion au référentiel. Pour les AWS Service Catalog produits liés à un fichier modèle, vous pouvez récupérer les informations relatives à la connexion au référentiel et à la dernière synchronisation du modèle avec le produit à partir de l'état de la dernière synchronisation.

Note

Vous pouvez consulter les informations du référentiel et le statut de la dernière synchronisation au niveau du produit. Les utilisateurs doivent disposer d'autorisations IAM dans les CodeConnections API pour consulter les détails du référentiel. Reportez-vous à la section Autorisations requises pour synchroniser les AWS Service Catalog produits avec les fichiers modèles pour plus d'informations sur la politique requise pour ces autorisations IAM.

Pour afficher les détails de la connexion et du référentiel à l'aide de AWS Management Console
  1. Dans le panneau de navigation de gauche, sélectionnez Liste des produits.

  2. Sélectionnez le produit dans la liste.

  3. Sur la page Produit, accédez à la section Informations sur la source du produit.

  4. Pour afficher l'ID de révision source d'une version du produit, cliquez sur le lien Dernière version créée. La section Détails de la version affiche l'ID de révision de la source.

Pour afficher les détails de la connexion et du référentiel à l'aide de AWS CLI

À partir de AWS CLI, exécutez les commandes suivantes :

$ aws servicecatalog describe-product-as-admin

$ aws servicecatalog describe-provisioning-artifact

$ aws servicecatalog search-product-as-admin

$ aws servicecatalog list-provisioning-artifacts

Mise à jour des connexions aux produits synchronisées avec Git

Vous pouvez mettre à jour les connexions de compte existantes et les produits synchronisés avec Git à l'aide de la AWS Service Catalog console, de l' AWS Service Catalog API ou. AWS CLI

Pour savoir comment connecter un AWS Service Catalog produit existant à un fichier modèle, reportez-vous à la section Création de nouvelles connexions de produits synchronisées avec Git.

Pour mettre à jour les produits existants vers des produits synchronisés avec Git
  1. Dans le panneau de navigation de gauche, choisissez Liste des produits, puis choisissez l'une des options suivantes :

    • Pour mettre à jour un seul produit, sélectionnez le produit, accédez à la section Détails de la source du produit, puis choisissez Modifier les détails.

    • Pour mettre à jour plusieurs produits, choisissez Connect products to a external repository, sélectionnez jusqu'à dix produits, puis cliquez sur Next.

  2. Dans la section Informations sur la source du produit, effectuez les mises à jour suivantes :

    • Spécifiez la connexion.

    • Spécifiez le référentiel.

    • Spécifiez la branche.

    • Nommez le fichier modèle.

  3. Sélectionnez Enregistrer les modifications.

Note

Pour les produits qui ne sont pas encore connectés à un référentiel externe, vous pouvez utiliser l'option Connect to an external repository affichée dans l'alerte en haut de la page d'informations du produit après avoir sélectionné le produit.

Vous pouvez également utiliser la AWS Service Catalog console ou AWS CLI

  • Connect un AWS Service Catalog produit existant à un fichier modèle dans un référentiel externe

  • Mettez à jour les métadonnées du produit, notamment le nom, la description et les balises du produit.

  • Reconfigurez (mettez à jour la synchronisation pour utiliser une autre source de référentiel) une connexion pour un AWS Service Catalog produit précédemment connecté.

Pour mettre à jour les informations de connexion et de référentiel à l'aide de AWS Service Catalog la console
  1. Dans le panneau de navigation de gauche de la AWS Service Catalog console, choisissez Liste des produits, puis sélectionnez un produit actuellement connecté à un référentiel externe.

  2. Dans la section Détails de la source du produit, choisissez Modifier la source du produit.

  3. Dans la section Détails de la source du produit, spécifiez le nouveau référentiel souhaité.

  4. Sélectionnez Enregistrer les modifications.

Pour mettre à jour les informations de connexion et de référentiel à l'aide de AWS CLI

À partir des $ aws servicecatalog update-provisioning-artifact commandes AWS CLI Exécuter $ aws servicecatalog update-product et.

Suppression des connexions de produits synchronisées avec Git

Vous pouvez supprimer une connexion entre un AWS Service Catalog produit et un fichier modèle à l'aide de la AWS Service Catalog console, de CodeConnections l'API ou AWS CLI. Lorsque vous déconnectez un produit d'un fichier modèle, le AWS Service Catalog produit synchronisé passe à un produit géré régulièrement. Après avoir déconnecté le produit, si le fichier modèle est modifié et validé dans le référentiel précédemment connecté, les modifications ne sont pas reflétées. Pour reconnecter un AWS Service Catalog produit à un fichier modèle dans un référentiel externe, reportez-vous à la section Mise à jour des connexions et des produits synchronisés AWS Service Catalog.

Pour déconnecter un produit synchronisé avec Git à l'aide de la console AWS Service Catalog
  1. Dans le AWS Management Console, choisissez Liste des produits dans le panneau de navigation de gauche.

  2. Sélectionnez un produit dans la liste.

  3. Sur la page Produit, accédez à la section Informations sur la source du produit.

  4. Choisissez Déconnecter.

  5. Confirmez l'action, puis choisissez Déconnecter.

Pour déconnecter un produit synchronisé avec Git à l'aide de AWS CLI

À partir du AWS CLI, exécutez la $ aws servicecatalog update-product commande. Dans l'ConnectionParametersentrée, supprimez la connexion spécifiée.

Pour supprimer une connexion à l'aide de l' CodeConnections API ou AWS CLI

Dans l' CodeConnections API ou AWS CLI exécutez la $ aws codestar-connections delete-connection commande.

Synchronisation des produits Terraform avec des modèles de fichiers depuis GitHub Enterprise GitHub ou Bitbucket

Lors de la création d'un produit synchronisé avec Git à l'aide d'un fichier de configuration Terraform, le chemin du fichier accepte uniquement le format tar.gz. Les formats de dossiers Terraform ne sont pas acceptés dans le chemin du fichier.