Création d'une nouvelle version d'une recette imagée

Pour créer une nouvelle version d'une recette imagée :

1. En haut de la page des détails de la recette, choisissez Créer une nouvelle version. Cela ouvre la page Créer une recette avec une image.

2. Pour créer la nouvelle version, apportez vos modifications, puis choisissez Créer une recette.

   Votre image finale peut contenir jusqu'à neuf codes de produits issus de produits et de composants AWS Marketplace d'image. Image Builder renvoie une erreur lors de la création de la recette si votre image de base et ses composants dépassent cette limite.

1. Créer un fichier JSON d'entrée CLI

   Vous pouvez fournir toutes les entrées de la create-image-recipe commande avec des paramètres de commande en ligne. Cependant, la commande qui en résulte peut être assez longue. Pour rationaliser la commande, vous pouvez plutôt fournir un fichier JSON contenant tous les paramètres de la recette.

   Note

   La convention de dénomination des valeurs de données du fichier JSON suit le modèle spécifié pour les paramètres de demande d'opération de l'API Image Builder. Pour passer en revue les paramètres de demande de fonctionnement de l'API, consultez la CreateImageRecipe commande dans le document de référence de l'API EC2 Image Builder.

   Pour fournir les valeurs de données sous forme de paramètres de ligne de commande, reportez-vous aux noms de paramètres spécifiés dans la référence des AWS CLI commandes.

   Voici un résumé des paramètres spécifiés dans ces exemples :

   • name (chaîne, obligatoire) — Le nom de la recette imagée.

   • description (chaîne) — Description de la recette imagée.

   • parentImage (chaîne, obligatoire) : image que la recette d'image utilise comme base pour votre image personnalisée. Vous pouvez spécifier l'image parente à l'aide de l'une des options suivantes :

     • ID AMI  : à utiliser lorsque vous avez une AMI spécifique (par exempleami-1234567890abcdef1) que vous souhaitez personnaliser. Comme un ID AMI est statique, nous vous recommandons plutôt d'utiliser un ARN d'image Image Builder ou un paramètre SSM si vous souhaitez que votre recette récupère automatiquement les nouvelles images de base.

     • ARN de la ressource image Image Builder  : à utiliser lorsque vous souhaitez créer à partir d'une image Image Builder. Cela inclut Amazon-managed les images fournies par Image Builder pour les systèmes d'exploitation les plus courants, ainsi que les images que vous avez créées précédemment. Spécifiez l'ARN de l'image avec une version sémantique ou utilisez un caractère générique de version pour toujours obtenir la dernière version.

     • AWS Systems Manager Paramètre de stockage des paramètres (SSM)  : à utiliser lorsque vous souhaitez que votre recette récupère automatiquement de nouveaux ID AMI sans créer de nouvelle version de recette. Préfixez le paramètre avecssm:, suivi du nom du paramètre ou de l'ARN. C'est idéal pour les pipelines qui doivent toujours utiliser la dernière image de base Amazon Linux ou Windows.

     • AWS Marketplace ID de produit  : à utiliser lorsque vous vous abonnez à un produit AMI AWS Marketplace et que vous souhaitez le personnaliser davantage.

     Note

     • Lorsque vous utilisez un ID AMI ou un paramètre SSM qui se résout en AMI, vous devez avoir accès à cette AMI dans votre compte. L'AMI doit également exister dans la région où Image Builder exécute la génération.

     • Les exemples Linux et macOS spécifient un ID AMI, tandis que l'exemple Windows utilise un ARN d'image Image Builder.

   • <major>SemanticVersion (chaîne, obligatoire) — Entrez le numéro de version que vous souhaitez créer au format. <minor>. <patch>. Image Builder prend en charge l'incrémentation automatique des versions pour les recettes, ce qui vous permet d'utiliser des caractères génériques dans vos versions de recettes. Lorsque vous créez une recette avec une version générique1.0.x, telle que Image Builder incrémente automatiquement la version (par exemple,1.0.1,1.0.2,1.0.3, etc.). Il n'est donc plus nécessaire de suivre et d'incrémenter manuellement les versions des recettes. Pour en savoir plus sur la gestion sémantique des versions pour les ressources Image Builder, consultez. Versionnage sémantique dans Image Builder

   • components (tableau, facultatif) — Contient un tableau d'ComponentConfigurationobjets. Les composants sont facultatifs : vous pouvez créer des recettes sans aucun composant pour les flux de test ou de distribution :

     Note

     Image Builder installe les composants dans l'ordre que vous avez indiqué dans la recette. Cependant, les composants de renforcement CIS sont toujours exécutés en dernier pour garantir que les tests de référence s'exécutent par rapport à votre image de sortie.

     • componentArn (chaîne, obligatoire) — L'ARN du composant.

       Astuce

       Pour utiliser l'un des exemples afin de créer votre propre recette d'image, vous devez remplacer les exemples d'ARN par les ARN des composants que vous utilisez pour votre recette.

     • paramètres (tableau d'objets) — Contient un tableau d'ComponentParameterobjets. Si un paramètre d'entrée est obligatoire, mais qu'aucune valeur par défaut n'est définie dans le composant, vous devez fournir une valeur. Image Builder ne créera pas la version de la recette s'il manque des paramètres requis et si aucune valeur par défaut n'est définie.

       Important

       Les paramètres des composants sont des valeurs en texte brut et sont connectés AWS CloudTrail. Nous vous recommandons d'utiliser AWS Secrets Manager ou le AWS Systems Manager Parameter Store pour stocker vos secrets. Pour plus d'informations sur Secrets Manager, voir Qu'est-ce que Secrets Manager ? dans le Guide de AWS Secrets Manager l'utilisateur. Pour plus d'informations sur le stockage des AWS Systems Manager paramètres, consultez la section AWS Systems Manager Parameter Store dans le Guide de AWS Systems Manager l'utilisateur.

       • name (chaîne, obligatoire) — Nom du paramètre de composant à définir.

       • valeur (tableau de chaînes, obligatoire) — Contient un tableau de chaînes pour définir la valeur du paramètre de composant nommé. Si une valeur par défaut est définie pour le composant et qu'aucune autre valeur n'est fournie, AWSTOE utilise la valeur par défaut.

   • AMIWatermarks (tableau de chaînes, facultatif) : liste de noms de filigranes à associer aux AMI de sortie créées à partir de cette recette. Les filigranes sont des marqueurs de lignée qui vous permettent de retracer l'histoire de vos images. Spécifiez de 1 à 5 noms. Chaque nom doit comporter de 3 à 128 caractères et peut inclure des lettres, des chiffres, des espaces et les caractères spéciaux suivants :( ) [ ] . / - ' @ _. Pour de plus amples informations, veuillez consulter Suivez la lignée des AMI à l'aide de filigranes.

   • supplémentaire InstanceConfiguration (objet) : spécifiez des paramètres supplémentaires et lancez des scripts pour vos instances de build.

     • systems ManagerAgent (objet) : contient les paramètres de l'agent Systems Manager sur votre instance de build.

       Note

       Les recettes Windows ne prennent pas en charge systemsManagerAgent cette configuration. Si vous l'incluez avec une image parent Windows, la demande échoue.

       • uninstall AfterBuild (booléen) : contrôle si l'agent Systems Manager est supprimé de votre image de build finale avant de créer la nouvelle AMI. Si cette option est définie surtrue, l'agent est supprimé de l'image finale. Si l'option est définie surfalse, l'agent reste actif afin qu'il soit inclus dans la nouvelle AMI. La valeur par défaut est false.

         Note

         Si l'uninstallAfterBuildattribut n'est pas inclus dans le fichier JSON et que les conditions suivantes sont remplies, Image Builder supprime l'agent Systems Manager de l'image finale afin qu'il ne soit pas disponible dans l'AMI :

         • Le userDataOverride champ est vide ou a été omis dans le fichier JSON.

         • Image Builder a automatiquement installé l'agent Systems Manager sur l'instance de génération pour un système d'exploitation sur lequel l'agent n'était pas préinstallé sur l'image de base.

     • user DataOverride (chaîne) — Fournissez des commandes ou un script de commande à exécuter lorsque vous lancez votre instance de build.

       Note

       Les données utilisateur sont toujours codées en base 64. Par exemple, les commandes suivantes sont codées comme IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg== :

       #!/bin/bash
       mkdir -p /var/bb/
       touch /var

       L'exemple Linux utilise cette valeur codée.

   Linux

   L'image de base (parentImagepropriété) de l'exemple suivant est une AMI. Lorsque vous utilisez une AMI, vous devez avoir accès à l'AMI et celle-ci doit se trouver dans la région source (la même région où Image Builder exécute la commande). Enregistrez le fichier sous create-image-recipe.json et utilisez-le dans la create-image-recipe commande.

   {
   "name": "BB Ubuntu Image recipe",
   "description": "Hello World image recipe for Linux.",
   "parentImage": "ami-1234567890abcdef1",
   "semanticVersion": "1.0.0",
   "components": [
   	{
   		"componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/bb$"
   	}
   ],
   "additionalInstanceConfiguration": {
   	"systemsManagerAgent": {
   	 	"uninstallAfterBuild": true
   	},
   	"userDataOverride": "IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg=="
   }
   }

   Windows

   L'exemple suivant fait référence à la dernière version de l'image de base complète en anglais de Windows Server 2016. Dans cet exemple, l'ARN fait référence à la dernière image en fonction des filtres de version sémantiques que vous avez spécifiés :arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x.

   {
   "name": "MyBasicRecipe",
   "description": "This example image recipe creates a Windows 2016 image.",
   "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x",
   "semanticVersion": "1.0.0",
   "components": [
   	{
   		"componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/2019.12.02/1"
   	},
   	{
   		"componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-imported-component/1.0.0/1"
   	}
   ]
   }

   Note

   Pour en savoir plus sur la gestion sémantique des versions pour les ressources Image Builder, consultez. Versionnage sémantique dans Image Builder

   macOS

   L'image de base (parentImagepropriété) de l'exemple suivant est une AMI. Lorsque vous utilisez une AMI, vous devez avoir accès à l'AMI et celle-ci doit se trouver dans la région source (la même région où Image Builder exécute la commande). Enregistrez le fichier sous create-image-recipe.json et utilisez-le dans la create-image-recipe commande.

   {
   "name": "macOS Catalina Image recipe",
   "description": "Hello World image recipe for macOS.",
   "parentImage": "ami-1234567890abcdef1",
   "semanticVersion": "1.0.0",
   "components": [
   	{
   		"componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/catalina$"
   	}
   ],
   "additionalInstanceConfiguration": {
   	"systemsManagerAgent": {
   	 	"uninstallAfterBuild": true
   	},
   	"userDataOverride": "IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg=="
   }
   }

   Exemple : recette sans composants

   Vous pouvez créer des recettes sans aucun composant pour tester les AMI existantes ou les flux de travail réservés à la distribution. L'exemple suivant montre une recette qui utilise une AMI existante sans appliquer de composants supplémentaires :

   {
   	"name": "Test Distribution Recipe",
   	"description": "Recipe for testing and distributing existing AMI without modifications.",
   	"parentImage": "ami-1234567890abcdef1",
   	"semanticVersion": "1.0.0",
   	"additionalInstanceConfiguration": {
   		"systemsManagerAgent": {
   		 	"uninstallAfterBuild": true
   		}
   	}
   }

2. Créez la recette

   Utilisez la commande suivante pour créer la recette. Entrez le nom du fichier JSON que vous avez créé à l'étape précédente dans le --cli-input-json paramètre :

   aws imagebuilder create-image-recipe --cli-input-json file://create-image-recipe.json

   Note

   • Vous devez inclure l'option file:// au début du chemin du fichier JSON.

   • Le chemin d'accès du fichier JSON doit suivre la convention appropriée pour le système d'exploitation de base sur lequel vous exécutez la commande. Par exemple, Windows utilise la barre oblique inverse (\) pour faire référence au chemin du répertoire, tandis que Linux et macOS utilisent la barre oblique (/).

   Votre image finale peut contenir jusqu'à neuf codes de produits issus de produits et de composants AWS Marketplace d'image. Image Builder renvoie une erreur lors de la création de la recette si votre image de base et ses composants dépassent cette limite lorsque vous exécutez la create-image-recipe commande.

   La commande renvoie l'ARN de la nouvelle recette d'image, comme indiqué dans l'exemple de sortie suivant.

   {
   	"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
   	"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
   	"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-recipe/1.0.1"
   }

3. Vérifiez votre recette

   Pour vérifier qu'Image Builder a créé votre recette comme prévu, exécutez la get-image-recipe commande avec l'ARN renvoyé à l'étape précédente.

   aws imagebuilder get-image-recipe --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-recipe/1.0.1

1. Dans la section Sélectionner une image pour l'image de base, sélectionnez l'option Importer l'image de base.

2. Choisissez le système d'exploitation (OS) d'image et la version du système d'exploitation comme vous le feriez normalement.

1. Source  : il peut s'agir d'un compartiment S3 ou d'un instantané EBS.

2. Sélectionnez l'emplacement S3 du disque — Entrez l'emplacement dans Amazon S3 où vos images de disque sont stockées. Pour rechercher l'emplacement, choisissez Parcourir S3.

3. Pour ajouter un conteneur de disque, choisissez Ajouter un conteneur de disque.

Général

1. Spécifiez un nom unique pour l'image de base. Si vous ne saisissez aucune valeur, l'image de base hérite du nom de la recette.

2. Spécifiez une version pour l'image de base. Utilisez le format suivant : <major>.<minor>.<patch>. Si vous ne saisissez aucune valeur, l'image de base hérite de la version de la recette.

3. Vous pouvez également saisir une description pour l'image de base.