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.
Créez un projet de construction dans AWS CodeBuild
Vous pouvez utiliser la AWS CodeBuild console ou AWS SDKs créer un projet de construction. AWS CLI
Rubriques
Prérequis
Avant de créer un projet de construction, répondez aux questions posées dansPlanification d'une génération.
Création d'un projet de génération (console)
Ouvrez la AWS CodeBuild console sur https://console.aws.amazon.com/codesuite/codebuild/home
Si une page CodeBuild d'informations s'affiche, choisissez Créer un projet de construction. Sinon, dans le volet de navigation, développez Build, choisissez Build projects, puis Create build project.
Choisissez Créer un projet de génération.
Remplissez les sections suivantes. Une fois terminé, choisissez Créer un projet de construction au bas de la page.
Rubriques :
Configuration du projet
- Nom du projet
-
Entrez un nom pour ce projet de construction. Les noms des projets de construction doivent être uniques pour chaque AWS compte.
- Description
-
Entrez une description facultative du projet de construction pour aider les autres utilisateurs à comprendre à quoi sert ce projet.
- Construire un badge
-
(Facultatif) Sélectionnez Activer le badge de construction pour rendre l'état de construction de votre projet visible et intégrable. Pour de plus amples informations, veuillez consulter Exemple de badges de génération.
Note
Le badge de construction ne s'applique pas si votre fournisseur source est Amazon S3.
- Activer la limite de génération simultanée
-
(Facultatif) Si vous souhaitez limiter le nombre de builds simultanés pour ce projet, effectuez les opérations suivantes :
-
Sélectionnez Restreindre le nombre de versions simultanées que ce projet peut démarrer.
-
Dans Limite de génération simultanée, entrez le nombre maximum de versions simultanées autorisées pour ce projet. Cette limite ne peut pas être supérieure à la limite de création simultanée définie pour le compte. Si vous essayez de saisir un nombre supérieur à la limite du compte, un message d'erreur s'affiche.
Les nouvelles générations ne sont démarrées que si le nombre actuel de générations est inférieur ou égal à cette limite. Si le nombre actuel de générations atteint cette limite, les nouvelles générations sont limitées et ne sont pas exécutées.
-
- Informations supplémentaires
-
(Facultatif) Pour les balises, entrez le nom et la valeur de toutes les balises que vous souhaitez que les AWS services d'assistance utilisent. Utilisez Ajouter une ligne pour ajouter une balise. Vous pouvez ajouter jusqu’à 50 balises.
Source
- Fournisseur de source
-
Choisissez le type de fournisseur de code source. Utilisez les listes suivantes pour effectuer des sélections adaptées à votre fournisseur de source :
Note
CodeBuild ne prend pas en charge Bitbucket Server.
Environnement
- Modèle de provisionnement
-
Effectuez l’une des actions suivantes :
-
Pour utiliser des flottes à la demande gérées par AWS CodeBuild, choisissez On-Demand. Avec des flottes à la demande, CodeBuild fournit le calcul nécessaire à vos builds. Les machines sont détruites à la fin de la construction. Les flottes à la demande sont entièrement gérées et incluent des fonctionnalités de mise à l'échelle automatique pour faire face aux pics de demande.
-
Pour utiliser des flottes de capacité réservée gérées par AWS CodeBuild, choisissez Capacité réservée, puis sélectionnez un nom de flotte. Avec les flottes de capacité réservée, vous configurez un ensemble d'instances dédiées pour votre environnement de construction. Ces machines restent inactives, prêtes à traiter les builds ou les tests immédiatement et réduisent les durées de construction. Avec des flottes de capacité réservées, vos machines fonctionnent en permanence et continueront d'entraîner des coûts tant qu'elles seront approvisionnées.
Pour plus d’informations, veuillez consulter Exécutez des builds sur des flottes à capacité réservée.
-
- Image de l'environnement
-
Effectuez l’une des actions suivantes :
-
Pour utiliser une image Docker gérée par AWS CodeBuild, choisissez Image gérée, puis sélectionnez Système d'exploitation, Runtime (s), Image et Version de l'image. Effectuez votre sélection pour Type d'environnement si cette option est disponible.
-
Pour utiliser une autre image Docker, choisissez Image personnalisée. Pour Type d'environnement ARM, choisissez LinuxGPU, Linux ou Windows. Si vous choisissez Autre registre, pour Registre externe URL, entrez le nom et le tag de l'image Docker dans Docker Hub, en utilisant le format.
Si vous choisissez Amazon ECR, utilisez le ECRréférentiel Amazon et ECRl'image Amazon pour choisir l'image Docker dans votre AWS compte.docker repository
/docker image name
-
Pour utiliser une image Docker privée, choisissez Image personnalisée. Pour Type d'environnement ARM, choisissez LinuxGPU, Linux ou Windows. Pour le registre d'images, choisissez Autre registre, puis entrez les informations ARN d'identification de votre image Docker privée. Les informations d'identification doivent être créées par Secrets Manager. Pour plus d'informations, consultez Présentation de AWS Secrets Manager dans le Guide de l'utilisateur AWS Secrets Manager .
Note
CodeBuild remplace le
ENTRYPOINT
pour les images Docker personnalisées. -
- Calcul
-
Effectuez l’une des actions suivantes :
-
Pour utiliser le EC2 calcul, choisissez EC2. EC2le calcul offre une flexibilité optimisée lors des exécutions d'actions.
-
Pour utiliser le calcul Lambda, choisissez Lambda. Le calcul Lambda offre des vitesses de démarrage optimisées pour vos builds. Lambda permet des builds plus rapides grâce à une latence de démarrage plus faible. Lambda s'adapte également automatiquement, de sorte que les builds n'attendent pas dans la file d'attente pour s'exécuter. Pour plus d’informations, veuillez consulter Exécuter des builds sur AWS Lambda ordinateur.
-
- Rôle de service
Effectuez l’une des actions suivantes :
-
Si vous n'avez pas de rôle CodeBuild de service, choisissez Nouveau rôle de service. Dans Role name, entrez un nom pour le nouveau rôle.
-
Si vous avez un rôle CodeBuild de service, choisissez Rôle de service existant. Dans Rôle ARN, choisissez le rôle de service.
Note
Lorsque vous utilisez la console pour créer un projet de génération, vous pouvez créer un rôle de CodeBuild service en même temps. Par défaut, le rôle fonctionne avec ce projet de génération uniquement. Si vous utilisez la console pour associer ce rôle de service à un autre projet de génération, le rôle est mis à jour pour fonctionner avec l'autre projet de génération. Un rôle de service peut fonctionner avec 10 projets de génération maximum.
-
- Configuration supplémentaire
-
- Limite de tentatives automatiques
-
Spécifiez le nombre de tentatives automatiques supplémentaires après un échec de compilation. Par exemple, si la limite de tentatives automatiques est définie sur 2, CodeBuild vous appellerez le
RetryBuild
API pour réessayer automatiquement votre build jusqu'à 2 fois supplémentaires. - Expiration
-
Spécifiez une valeur, comprise entre 5 minutes et 36 heures, après quoi la CodeBuild génération s'arrête si elle n'est pas terminée. Si les valeurs de heures et minutes sont laissées vides, la valeur par défaut de 60 minutes est utilisée.
- privilégié
-
(Facultatif) Sélectionnez Activer cet indicateur si vous souhaitez créer des images Docker ou si vous souhaitez que vos versions obtiennent des privilèges élevés uniquement si vous prévoyez d'utiliser ce projet de génération pour créer des images Docker. Sinon, toutes les générations associées qui tentent d'interagir avec le démon Docker échouent. Vous devez également démarrer le démon Docker afin que vos générations puissent interagir avec celui-ci. Pour cela, vous pouvez initialiser le démon Docker au cours de la phase
install
de votre spécification de génération en exécutant les commandes de génération ci-après. N'exécutez pas ces commandes si vous avez choisi une image d'environnement de construction fournie CodeBuild par le support Docker.Note
Par défaut, le démon Docker est activé pour les versions non compilées. VPC Si vous souhaitez utiliser des conteneurs Docker pour les VPC builds, consultez Runtime Privilege et Linux Capabilities
sur le site Web de Docker Docs et activez le mode privilégié. De plus, Windows ne prend pas en charge le mode privilégié. - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay2 & - timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
- VPC
Si vous CodeBuild souhaitez travailler avec votre VPC :
-
Pour VPC, choisissez l'VPCID qui CodeBuild utilise.
-
Pour les VPCsous-réseaux, choisissez les sous-réseaux qui incluent les ressources qui CodeBuild utilisent.
-
Pour les groupes VPC de sécurité, choisissez les groupes de sécurité CodeBuild utilisés pour autoriser l'accès aux ressources duVPCs.
Pour de plus amples informations, veuillez consulter Utilisation AWS CodeBuild avec Amazon Virtual Private Cloud.
-
- Calcul
-
Choisissez l'une des options disponibles.
- Variables d'environnement
-
Entrez le nom et la valeur, puis choisissez le type de chaque variable d'environnement à utiliser pour les builds.
Note
CodeBuild définit automatiquement la variable d'environnement pour votre AWS région. Vous devez définir les variables d'environnement suivantes si vous ne les avez pas ajoutées dans votre fichier buildspec.yml :
-
AWS_ACCOUNT_ID
-
IMAGE_REPO_NAME
-
IMAGE_TAG
La console et AWS CLI les utilisateurs peuvent voir les variables d'environnement. Si la visibilité de vos variables d'environnement ne vous pose pas de problème, définissez les zones Nom et Valeur, puis définissez Type sur Texte brut.
Nous vous recommandons de stocker une variable d'environnement avec une valeur sensible, telle qu'un identifiant de clé d' AWS accès, une clé d'accès AWS secrète ou un mot de passe en tant que paramètre dans Amazon EC2 Systems Manager Parameter Store ou AWS Secrets Manager.
Si vous utilisez Amazon EC2 Systems Manager Parameter Store, choisissez Parameter dans Type. Dans Nom, entrez un identifiant CodeBuild à référencer. Pour Value, entrez le nom du paramètre tel qu'il est enregistré dans Amazon EC2 Systems Manager Parameter Store. Si l'on prend comme exemple un paramètre nommé
/CodeBuild/dockerLoginPassword
, pour Type, choisissez Parameter (Paramètre). Pour Name (Nom), saisissezLOGIN_PASSWORD
. Pour le champ Valeur, saisissez/CodeBuild/dockerLoginPassword
.Important
Si vous utilisez Amazon EC2 Systems Manager Parameter Store, nous vous recommandons de stocker les paramètres avec des noms de paramètres commençant par
/CodeBuild/
(par exemple,/CodeBuild/dockerLoginPassword
). Vous pouvez utiliser la CodeBuild console pour créer un paramètre dans Amazon EC2 Systems Manager. Choisissez Create parameter (Créer un paramètre), puis suivez les instructions de la boîte de dialogue. (Dans cette boîte de dialogue, pour KMSclé, vous pouvez spécifier la AWS KMS clé ARN de votre compte. Amazon EC2 Systems Manager utilise cette clé pour chiffrer la valeur du paramètre pendant le stockage et pour la déchiffrer lors de la récupération.) Si vous utilisez la CodeBuild console pour créer un paramètre, la console commence par le nom du paramètre/CodeBuild/
tel qu'il est enregistré. Pour plus d'informations, consultez la procédure pas à pas de la console Systems Manager Parameter Store et Systems Manager Parameter Store dans le guide de l'utilisateur d'Amazon EC2 Systems Manager.Si votre projet de génération fait référence à des paramètres stockés dans Amazon EC2 Systems Manager Parameter Store, le rôle de service du projet de génération doit autoriser l'
ssm:GetParameters
action. Si vous avez sélectionné Nouveau rôle de service plus tôt, CodeBuild inclut cette action dans le rôle de service par défaut de votre projet de génération. En revanche, si vous avez choisi précédemment Existing service role (Rôle de service existant), vous devez inclure séparément cette action dans votre rôle de service.Si votre projet de construction fait référence à des paramètres stockés dans Amazon EC2 Systems Manager Parameter Store avec des noms de paramètres qui ne commencent pas par
/CodeBuild/
, et que vous avez choisi Nouveau rôle de service, vous devez mettre à jour ce rôle de service pour autoriser l'accès aux noms de paramètres qui ne commencent pas par/CodeBuild/
. En effet, ce rôle de service permet uniquement d'accéder aux noms de paramètres qui commencent par/CodeBuild/
.Si vous choisissez Nouveau rôle de service, le rôle de service inclut l'autorisation de déchiffrer tous les paramètres de l'espace de
/CodeBuild/
noms dans le magasin de paramètres Amazon EC2 Systems Manager.Les variables d'environnement que vous définissez remplacent les variables d'environnement existantes. Par exemple, si l'image Docker contient déjà une variable d'environnement nommée
MY_VAR
avec la valeurmy_value
et que vous définissez une variable d'environnement nomméeMY_VAR
avec la valeurother_value
, la valeurmy_value
est remplacée parother_value
. De même, si l'image Docker contient déjà une variable d'environnement nomméePATH
avec la valeur/usr/local/sbin:/usr/local/bin
et que vous définissez une variable d'environnement nomméePATH
avec la valeur$PATH:/usr/share/ant/bin
, la valeur/usr/local/sbin:/usr/local/bin
est remplacée par la valeur littérale$PATH:/usr/share/ant/bin
.Ne définissez pas de variables d'environnement avec un nom commençant par
CODEBUILD_
. Ce préfixe est réservé à une utilisation interne .Si une variable d'environnement avec le même nom est définie dans plusieurs emplacements, la valeur est déterminée comme suit :
-
La valeur de l'appel d'opération de démarrage de génération a une priorité plus élevée.
-
La valeur de la définition de projet de génération vient ensuite dans l'ordre des priorités.
-
La valeur figurant dans la déclaration buildspec a la priorité la plus faible.
Si vous utilisez Secrets Manager, pour Type, choisissez Secrets Manager. Dans Nom, entrez un identifiant CodeBuild à référencer. Pour Value (Valeur), saisissez un
reference-key
à l'aide du modèle
. Pour plus d’informations, veuillez consulter Secrets Manager reference-key in the buildspec file.secret-id
:json-key
:version-stage
:version-id
Important
Si vous utilisez Secrets Manager, nous vous recommandons de stocker les secrets dont le nom commence par
/CodeBuild/
(par exemple,/CodeBuild/dockerLoginPassword
). Pour plus d'informations, consultez Présentation de AWS Secrets Manager dans le Guide de l'utilisateur AWS Secrets Manager .Si votre projet de génération fait référence à des secrets stockés dans Secrets Manager, le rôle de service du projet de génération doit autoriser l'
secretsmanager:GetSecretValue
action. Si vous avez sélectionné Nouveau rôle de service plus tôt, CodeBuild inclut cette action dans le rôle de service par défaut de votre projet de génération. En revanche, si vous avez choisi précédemment Existing service role (Rôle de service existant), vous devez inclure séparément cette action dans votre rôle de service.Si votre projet de génération fait référence à des secrets stockés dans Secrets Manager avec des noms secrets qui ne commencent pas par
/CodeBuild/
, et que vous avez choisi Nouveau rôle de service, vous devez mettre à jour le rôle de service pour autoriser l'accès aux noms de secret qui ne commencent pas par/CodeBuild/
. Cela est dû au fait que le rôle de service autorise l'accès uniquement aux noms secrets commençant par/CodeBuild/
.Si vous choisissez Nouveau rôle de service, le rôle de service inclut l'autorisation de déchiffrer tous les secrets sous l'espace de
/CodeBuild/
noms dans le Gestionnaire de secrets. -
Spécifications de construction
- Spécifications de construction
-
Effectuez l’une des actions suivantes :
-
Si votre code source inclut un fichier buildspec, choisissez Utiliser un fichier buildspec. Par défaut, CodeBuild recherche un fichier nommé
buildspec.yml
dans le répertoire racine du code source. Si votre fichier buildspec utilise un nom ou un emplacement différent, entrez son chemin depuis la racine source dans le nom Buildspec (par exemple, ou.buildspec-two.yml
configuration/buildspec.yml
Si le fichier buildspec se trouve dans un compartiment S3, il doit se trouver dans la même AWS région que votre projet de construction. Spécifiez le fichier buildspec en utilisant son ARN (par exemple,).arn:aws:s3:::
<my-codebuild-sample2>
/buildspec.yml -
Si votre code source ne comprend pas de fichier de spécification de génération ou si vous souhaitez exécuter des commandes de génération différentes de celles spécifiées pour la phase
build
dans le fichierbuildspec.yml
au sein du répertoire racine du code source, choisissez Insérer des commandes de génération. Pour Build commands (Commandes de génération), saisissez les commandes que vous souhaitez exécuter lors de la phasebuild
. Pour plusieurs commandes, séparez celles-ci avec&&
(par exemple,mvn test && mvn package
). Pour exécuter des commandes dans d'autres phases, ou si vous avez une longue liste de commandes pour labuild
phase, ajoutez unbuildspec.yml
fichier dans le répertoire racine du code source, ajoutez les commandes au fichier, puis choisissez Utiliser le fichier buildspec.yml dans le répertoire racine du code source.
Pour plus d’informations, consultez le Référence des spécifications de génération.
-
Configuration par lots
Vous pouvez exécuter un groupe de builds en une seule opération. Pour de plus amples informations, veuillez consulter Exécuter des builds par lots.
- Définition de la configuration par lots
-
Sélectionnez cette option pour autoriser les compilations par lots dans ce projet.
- Rôle du service Batch
-
Fournit le rôle de service pour les compilations par lots.
Sélectionnez l'une des méthodes suivantes :
-
Si vous n'avez pas de rôle de service par lots, choisissez Nouveau rôle de service. Dans Rôle de service, entrez le nom du nouveau rôle.
-
Si vous avez un rôle de service par lots, choisissez Rôle de service existant. Dans Rôle de service, choisissez le rôle de service.
Les builds par lots introduisent un nouveau rôle de sécurité dans la configuration par lots. Ce nouveau rôle est obligatoire car CodeBuild il doit être capable d'appeler les
RetryBuild
actionsStartBuild
StopBuild
, et en votre nom pour exécuter des builds dans le cadre d'un lot. Les clients doivent utiliser un nouveau rôle, et non le même que celui qu'ils utilisent dans leur build, pour deux raisons :-
L'attribution du rôle
StartBuild
de construction etRetryBuild
des autorisations permettrait à une seule version de démarrer d'autres versions via le buildspec.StopBuild
-
CodeBuild les versions par lots fournissent des restrictions qui limitent le nombre de versions et les types de calcul qui peuvent être utilisés pour les versions du lot. Si le rôle de build dispose de ces autorisations, il est possible que les builds eux-mêmes puissent contourner ces restrictions.
-
- Type (s) de calcul autorisé pour le lot
-
Sélectionnez les types de calcul autorisés pour le lot. Sélectionnez toutes les réponses qui s'appliquent.
- Nombre maximal de builds autorisés par lot
-
Entrez le nombre maximum de builds autorisés dans le lot. Si un lot dépasse cette limite, il échouera.
- Délai d'expiration du Batch
-
Entrez la durée maximale pendant laquelle la génération par lots doit être terminée.
- Combinez des artefacts
-
Sélectionnez Combiner tous les artefacts du lot en un seul emplacement pour que tous les artefacts du lot soient combinés en un seul emplacement.
- Mode de rapport par lots
-
Sélectionnez le mode de rapport d'état de construction souhaité pour les versions par lots.
Note
Ce champ n'est disponible que lorsque la source du projet est Bitbucket ou GitHub Enterprise GitHub, et l'option Signaler les statuts de construction au fournisseur de source lorsque le début et la fin de vos builds sont sélectionnés sous Source.
- Constructions agrégées
-
Sélectionnez cette option pour que les statuts de toutes les versions du lot soient combinés dans un seul rapport d'état.
- Constructions individuelles
-
Sélectionnez cette option pour que les statuts de toutes les versions du lot soient signalés séparément.
Artefacts
- Type
-
Effectuez l’une des actions suivantes :
-
Si vous ne souhaitez pas créer des artefacts de sortie de génération, choisissez Aucun artefact. Vous pouvez le faire si vous exécutez uniquement des tests de build ou si vous souhaitez transférer une image Docker vers un ECR référentiel Amazon.
-
Pour stocker le résultat du build dans un compartiment S3, choisissez Amazon S3, puis procédez comme suit :
-
Si vous souhaitez utiliser le nom de votre projet pour le ZIP fichier ou le dossier de sortie de construction, laissez le champ Nom vide. Sinon, entrez le nom. (Si vous souhaitez générer un ZIP fichier et que vous souhaitez qu'il ait une extension de fichier, veillez à l'inclure après le nom du ZIP fichier.) ZIP
-
Sélectionnez Activer la gestion sémantique des versions si vous voulez qu'un nom spécifié dans le fichier buildspec remplace le nom spécifié dans la console. Le nom figurant dans un fichier buildspec est calculé au moment de la génération et utilise le langage de commandes Shell. Par exemple, vous pouvez ajouter une date et une heure au nom de votre artefact afin qu'il soit toujours unique. Les noms d'artefact uniques empêchent les artefacts d'être écrasés. Pour de plus amples informations, veuillez consulter Syntaxe d'un fichier buildspec.
-
Pour Nom du compartiment, choisissez le nom du compartiment de sortie.
-
Si vous avez choisi Insérer des commandes de génération plus tôt dans cette procédure, dans Fichiers de sortie, entrez les emplacements des fichiers de la version que vous souhaitez placer dans le ZIP fichier ou le dossier de sortie de construction. Pour plusieurs emplacements, séparez ceux-ci avec une virgule (par exemple,
appspec.yml, target/my-app.jar
). Pour de plus amples informations, consultez la description defiles
dans Syntaxe d'un fichier buildspec. -
Si vous ne souhaitez pas que vos artefacts de génération soient chiffrés, choisissez Remove artifacts encryption (Supprimer le chiffrement des artefacts).
-
Pour chaque ensemble d'artefacts secondaire que vous souhaitez :
-
Pour Artifact identifier (Identifiant d'artefact), saisissez une valeur de moins de 128 caractères et contenant uniquement des caractères alphanumériques et des traits de soulignement.
-
Choisissez Add artifact (Ajouter un artefact).
-
Suivez les étapes précédentes pour configurer vos artefacts secondaires.
-
Choisissez Save artifact (Enregistrer l'artefact).
-
- Configuration supplémentaire
-
- Clé de chiffrement
-
(Facultatif) Effectuez l'une des actions suivantes :
-
Pour utiliser le Clé gérée par AWS for Amazon S3 dans votre compte afin de chiffrer les artefacts de sortie du build, laissez la clé de chiffrement vide. Il s’agit de l’option par défaut.
-
Pour utiliser une clé gérée par le client pour chiffrer les artefacts de sortie de génération, dans Clé de chiffrement, entrez ARN la KMS clé. Utilisez le format
arn:aws:kms:
.region-ID
:account-ID
:key/key-ID
-
- Type de cache
Pour Cache type (Type de cache), choisissez l'une des valeurs suivantes :
-
Si vous ne souhaitez pas utiliser un cache, choisissez Aucun cache.
-
Si vous souhaitez utiliser un cache Amazon S3, choisissez Amazon S3, puis procédez comme suit :
-
Pour Compartiment, choisissez le nom du compartiment S3 dans lequel le cache est stocké.
-
(Facultatif) Pour le préfixe de chemin du cache, entrez un préfixe de chemin Amazon S3. La valeur Cache path prefix (Préfixe du chemin de cache) est semblable à un nom de répertoire. Cela vous permet de stocker le cache sous le même répertoire au sein d'un compartiment.
Important
N'ajoutez pas de barre oblique de fin (/) à la fin du préfixe du chemin.
-
-
Si vous souhaitez utiliser un cache local, choisissez Local, puis sélectionnez une ou plusieurs modes de cache local.
Note
Le mode de cache de couche Docker est disponible pour Linux uniquement. Si vous choisissez ce mode, votre projet doit être exécuté en mode privilégié.
L'utilisation d'un cache permet de gagner beaucoup de temps de génération, car les parties réutilisables de l'environnement de génération sont stockées dans le cache et utilisées d'une génération à l'autre. Pour de plus amples informations sur la spécification d'un cache dans le fichier de spécification de génération, consultez Syntaxe d'un fichier buildspec. Pour plus d'informations sur la mise en cache, consultez Des mises en cache pour améliorer les performances.
-
Journaux
Choisissez les journaux que vous souhaitez créer. Vous pouvez créer des CloudWatch journaux Amazon Logs, des journaux Amazon S3 ou les deux.
- CloudWatch
-
Si vous souhaitez obtenir CloudWatch les journaux Amazon Logs :
- CloudWatch journaux
-
Sélectionnez CloudWatch les journaux.
- Nom du groupe
-
Entrez le nom de votre groupe de CloudWatch journaux Amazon Logs.
- Nom du stream
-
Entrez le nom de votre flux de journal Amazon CloudWatch Logs.
- S3
-
Si vous souhaitez obtenir les journaux Amazon S3 :
- Journaux S3
-
Sélectionnez Journaux S3.
- Compartiment
-
Choisissez le nom du compartiment S3 pour vos journaux.
- Préfixe de chemin
-
Entrez le préfixe de vos journaux.
- Désactiver le chiffrement des journaux S3
-
Sélectionnez si vous ne voulez pas que vos journaux S3 soient chiffrés.
Création d'un projet de génération (AWS CLI)
Pour plus d'informations sur l'utilisation du AWS CLI with CodeBuild, consultez leRéférence des commandes en ligne.
Pour créer un projet de CodeBuild construction à l'aide de AWS CLI, vous devez créer une structure de projet au JSON format -formatée, renseigner la structure et appeler la create-project
commande pour créer le projet.
Créez le JSON fichier
Créez un JSON fichier squelette à l'aide de la create-project
commande, en utilisant l'--generate-cli-skeleton
option suivante :
aws codebuild create-project --generate-cli-skeleton >
<json-file>
Cela crée un JSON fichier avec le chemin et le nom de fichier spécifiés par <json-file>
.
Remplissez le JSON fichier
Modifiez les JSON données comme suit et enregistrez vos résultats.
{ "name": "
<project-name>
", "description": "<description>
", "source": { "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE", "location": "<source-location>
", "gitCloneDepth": "<git-clone-depth>
", "buildspec": "<buildspec>
", "InsecureSsl": "<insecure-ssl>
", "reportBuildStatus": "<report-build-status>
", "buildStatusConfig": { "context": "<context>
", "targetUrl": "<target-url>
" }, "gitSubmodulesConfig": { "fetchSubmodules": "<fetch-submodules>
" }, "auth": { "type": "<auth-type>
", "resource": "<auth-resource>
" }, "sourceIdentifier": "<source-identifier>
" }, "secondarySources": [ { "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE", "location": "<source-location>
", "gitCloneDepth": "<git-clone-depth>
", "buildspec": "<buildspec>
", "InsecureSsl": "<insecure-ssl>
", "reportBuildStatus": "<report-build-status>
", "auth": { "type": "<auth-type>
", "resource": "<auth-resource>
" }, "sourceIdentifier": "<source-identifier>
" } ], "secondarySourceVersions": [ { "sourceIdentifier": "<secondary-source-identifier>
", "sourceVersion": "<secondary-source-version>
" } ], "sourceVersion": "<source-version>"
, "artifacts": { "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS", "location": "<artifacts-location>
", "path": "<artifacts-path>
", "namespaceType": "<artifacts-namespacetype>
", "name": "<artifacts-name>
", "overrideArtifactName": "<override-artifact-name>
", "packaging": "<artifacts-packaging>
" }, "secondaryArtifacts": [ { "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS", "location": "<secondary-artifact-location>
", "path": "<secondary-artifact-path>
", "namespaceType": "<secondary-artifact-namespaceType>
", "name": "<secondary-artifact-name>
", "packaging": "<secondary-artifact-packaging>
", "artifactIdentifier": "<secondary-artifact-identifier>
" } ], "cache": { "type": "<cache-type>
", "location": "<cache-location>
", "mode": [ "<cache-mode>
" ] }, "environment": { "type": "LINUX_CONTAINER" | "LINUX_GPU_CONTAINER" | "ARM_CONTAINER" | "WINDOWS_SERVER_2019_CONTAINER" | "WINDOWS_SERVER_2022_CONTAINER", "image": "<image>
", "computeType": "BUILD_GENERAL1_SMALL" | "BUILD_GENERAL1_MEDIUM" | "BUILD_GENERAL1_LARGE" | "BUILD_GENERAL1_2XLARGE", "certificate": "<certificate>
", "environmentVariables": [ { "name": "<environmentVariable-name>
", "value": "<environmentVariable-value>
", "type": "<environmentVariable-type>
" } ], "registryCredential": [ { "credential": "<credential-arn-or-name>
", "credentialProvider": "<credential-provider>
" } ], "imagePullCredentialsType": "CODEBUILD" | "SERVICE_ROLE", "privilegedMode": "<privileged-mode>
" }, "serviceRole": "<service-role>
", "autoRetryLimit":<auto-retry-limit>
, "timeoutInMinutes":<timeout>
, "queuedTimeoutInMinutes":<queued-timeout>
, "encryptionKey": "<encryption-key>
", "tags": [ { "key": "<tag-key>
", "value": "<tag-value>
" } ], "vpcConfig": { "securityGroupIds": [ "<security-group-id>
" ], "subnets": [ "<subnet-id>
" ], "vpcId": "<vpc-id>
" }, "badgeEnabled": "<badge-enabled>
", "logsConfig": { "cloudWatchLogs": { "status": "<cloudwatch-logs-status>
", "groupName": "<group-name>
", "streamName": "<stream-name>
" }, "s3Logs": { "status": "<s3-logs-status>
", "location": "<s3-logs-location>
", "encryptionDisabled": "<s3-logs-encryption-disabled>
" } }, "fileSystemLocations": [ { "type": "EFS", "location": "<EFS-DNS-name-1>
:/<directory-path>
", "mountPoint": "<mount-point>
", "identifier": "<efs-identifier>
", "mountOptions": "<efs-mount-options>
" } ], "buildBatchConfig": { "serviceRole": "<batch-service-role>
", "combineArtifacts":<combine-artifacts>
, "restrictions": { "maximumBuildsAllowed":<max-builds>
, "computeTypesAllowed": [ "<compute-type>
" ] }, "timeoutInMins":<batch-timeout>
, "batchReportMode": "REPORT_AGGREGATED_BATCH" | "REPORT_INDIVIDUAL_BUILDS" }, "concurrentBuildLimit":<concurrent-build-limit>
}
Remplacez les éléments suivants :
nom
Obligatoire. Nom de ce projet de génération. Ce nom doit être unique pour tous les projets de construction de votre AWS compte.
description
Facultatif. Description de ce projet de génération.
source
Obligatoire. Un ProjectSourceobjet qui contient des informations sur les paramètres du code source de ce projet de build. Après avoir ajouté un objet source
, vous pouvez ajouter jusqu'à 12 autres sources à l'aide de secondarySources. Il s'agit notamment des paramètres suivants :
- source/type
-
Obligatoire. Type de référentiel qui contient le code source à générer. Les valeurs valides sont les suivantes :
-
CODECOMMIT
-
CODEPIPELINE
-
GITHUB
-
GITHUB_ENTERPRISE
-
GITLAB
-
GITLAB_SELF_MANAGED
-
BITBUCKET
-
S3
-
NO_SOURCE
Si vous utilisez
NO_SOURCE
, buildspec ne peut pas être un fichier, car le projet n'a pas de source. Vous devez plutôt utiliser l'buildspec
attribut pour spécifier une chaîne au YAML format -pour votre buildspec. Pour de plus amples informations, veuillez consulter Création d'un projet de construction sans source. -
- source/ lieu
-
Obligatoire sauf si vous définissez
<source-type>
àCODEPIPELINE
. Emplacement du code source pour le type de référentiel spécifié.-
Pour CodeCommit, le HTTPS clone URL du référentiel qui contient le code source et le fichier buildspec (par exemple,).
https://git-codecommit.
<region-id>
.amazonaws.com/v1/repos/<repo-name>
-
Pour Amazon S3, le nom du compartiment d'entrée de construction, suivi du chemin et du nom du ZIP fichier contenant le code source et les spécifications de construction. Par exemple :
-
Pour un ZIP fichier situé à la racine du compartiment d'entrée :
.<bucket-name>
/<object-name>
.zip -
Pour un ZIP fichier situé dans un sous-dossier du compartiment d'entrée :
.<bucket-name>
/<subfoler-path>
/<object-name>
.zip
-
-
Pour GitHub, le HTTPS clone URL du référentiel qui contient le code source et le fichier buildspec. Le URL doit contenir github.com. Vous devez connecter votre AWS compte à votre GitHub compte. Pour ce faire, utilisez la CodeBuild console pour créer un projet de génération.
-
Choisissez Authorize application. (Une fois connecté à votre GitHub compte, vous n'avez pas besoin de terminer la création du projet de construction. Vous pouvez fermer la CodeBuild console.)
-
-
Pour GitHub Enterprise Server, le HTTP ou HTTPS clonez-le URL dans le référentiel qui contient le code source et le fichier buildspec. Vous devez également connecter votre AWS compte à votre compte GitHub Enterprise Server. Pour ce faire, utilisez la CodeBuild console pour créer un projet de génération.
-
Créez un jeton d'accès personnel dans GitHub Enterprise Server.
-
Copiez ce jeton dans votre presse-papiers afin de pouvoir l'utiliser lors de la création de votre CodeBuild projet. Pour plus d'informations, consultez la section Création d'un jeton d'accès personnel pour la ligne de commande
sur le site Web d' GitHub aide. -
Lorsque vous utilisez la console pour créer votre CodeBuild projet, dans Source, pour Source provider, choisissez GitHubEnterprise.
-
Pour Personal Access Token, collez le jeton copié dans le Presse-papiers. Choisissez Save Token. Votre CodeBuild compte est désormais connecté à votre compte GitHub Enterprise Server.
-
-
Pour GitLab et GitLab autogéré, le HTTPS clone URL du référentiel contenant le code source et le fichier buildspec. Notez que si vous l'utilisez GitLab, le URL doit contenir gitlab.com. Si vous utilisez l' GitLab autogéré, il n'est URL pas nécessaire de contenir gitlab.com. Vous devez connecter votre AWS compte à votre compte GitLab ou à votre compte GitLab autogéré. Pour ce faire, utilisez la CodeBuild console pour créer un projet de génération.
-
Dans le volet de navigation des outils de développement, choisissez Paramètres, Connexions, puis Créer une connexion. Sur cette page, créez une connexion GitLab ou une connexion GitLab autogérée, puis choisissez Connect to GitLab.
-
-
Pour Bitbucket, HTTPS clone URL du référentiel contenant le code source et le fichier buildspec. Le URL doit contenir bitbucket.org. Vous devez également connecter votre AWS compte à votre compte Bitbucket. Pour ce faire, utilisez la CodeBuild console pour créer un projet de génération.
-
Lorsque vous utilisez la console pour vous connecter (ou vous reconnecter) à Bitbucket, dans la page Bitbucket Confirm access to your account, choisissez Grant access. (Une fois connecté à votre compte Bitbucket, vous n'avez pas besoin de terminer la création du projet de build. Vous pouvez fermer la CodeBuild console.)
-
-
Pour AWS CodePipeline, ne spécifiez pas de
location
valeur poursource
. CodePipeline ignore cette valeur car lorsque vous créez un pipeline dans CodePipeline, vous spécifiez l'emplacement du code source dans le stage Source du pipeline.
-
- source/ gitCloneDepth
-
Facultatif. Profondeur de l'historique à télécharger. La valeur minimum est de 0. Si cette valeur est égale à 0, supérieure à 25 ou non spécifiée, l'historique complet est téléchargé avec chaque projet de génération. Si votre type de source est Amazon S3, cette valeur n'est pas prise en charge.
- source/ buildspec
-
Facultatif. Définition de spécification de génération ou fichier à utiliser. Si cette valeur n'est pas fournie ou qu'elle est définie sur une chaîne vide, le code source doit contenir un fichier
buildspec.yml
dans son répertoire racine. Si cette valeur est définie, il peut s'agir d'une définition de buildspec intégrée, du chemin d'accès à un autre fichier buildspec relatif au répertoire racine de votre source principale ou du chemin d'accès à un compartiment S3. Le bucket doit se trouver dans la même AWS région que le projet de construction. Spécifiez le fichier buildspec en utilisant son ARN (par exemple,).arn:aws:s3:::
Pour de plus amples informations, veuillez consulter Nom de fichier buildspec et emplacement de stockage.<my-codebuild-sample2>
/buildspec.yml - source/ authentification
-
Contient des informations sur les paramètres d'autorisation CodeBuild pour accéder au code source à créer.
- source/auteur/type
-
Obligatoire. Le type d'autorisation à utiliser. Les valeurs valides sont :
-
OAUTH
-
CODECONNECTIONS
-
SECRETS_MANAGER
-
- source/auteur/ressource
-
Facultatif. La valeur de la ressource qui s'applique au type d'autorisation spécifié. Cela peut être le Secrets Manager ARN ou le CodeConnections ARN.
- source/ reportBuildStatus
-
Indique si vous souhaitez envoyer le statut de début et de fin d'une génération à votre fournisseur de source. Si vous le définissez avec un fournisseur de source autre qu' GitHub GitHub Enterprise Server ou Bitbucket, un
invalidInputException
est émis.Pour pouvoir signaler l'état de construction au fournisseur de source, l'utilisateur associé au fournisseur de source doit avoir un accès en écriture au dépôt. Si l'utilisateur ne dispose pas d'un accès en écriture, l'état de construction ne peut pas être mis à jour. Pour de plus amples informations, veuillez consulter Accès au fournisseur de source.
- source/ buildStatusConfig
-
Contient des informations qui définissent la manière dont le CodeBuild projet de construction communique l'état de la construction au fournisseur source. Cette option n'est utilisée que lorsque le type de source est
GITHUB
GITHUB_ENTERPRISE
, ouBITBUCKET
.- source/buildStatusConfig/contexte
-
Pour les sources Bitbucket, ce paramètre est utilisé pour le
name
paramètre figurant dans le statut de validation de Bitbucket. Pour les GitHub sources, ce paramètre est utilisé pour lecontext
paramètre figurant dans l'état de GitHub validation.Par exemple, vous pouvez faire en sorte qu'ils
context
contiennent le numéro de version et le déclencheur webhook à l'aide des variables d' CodeBuildenvironnement :AWS CodeBuild sample-project Build #$CODEBUILD_BUILD_NUMBER - $CODEBUILD_WEBHOOK_TRIGGER
Il en résulte que le contexte apparaît comme suit pour la version #24 déclenchée par un événement de pull request du webhook :
AWS CodeBuild sample-project Build #24 - pr/8
- source//buildStatusConfigtargetUrl
-
Pour les sources Bitbucket, ce paramètre est utilisé pour le
url
paramètre figurant dans le statut de validation de Bitbucket. Pour les GitHub sources, ce paramètre est utilisé pour letarget_url
paramètre figurant dans l'état de GitHub validation.Par exemple, vous pouvez définir le
targetUrl
àhttps://aws.amazon.com/codebuild/
et le statut de validation sera lié à celui-ciURL.<path to build>
Vous pouvez également inclure des variables d' CodeBuild environnement dans le
targetUrl
pour ajouter des informations supplémentaires auURL. Par exemple, pour ajouter la région de construction à laURL, définissez la valeurtargetUrl
sur :"targetUrl": "https://aws.amazon.com/codebuild/
<path to build>
?region=$AWS_REGION"Si la région de construction l'est
us-east-2
, elle s'étendra à :https://aws.amazon.com/codebuild/
<path to build>
?region=us-east-2
- source/ gitSubmodulesConfig
-
Facultatif. Informations sur la configuration des sous-modules Git. Utilisé uniquement avec CodeCommit GitHub, GitHub Enterprise Server et Bitbucket.
- source//gitSubmodulesConfigfetchSubmodules
-
Définissez
fetchSubmodules
surtrue
si vous souhaitez inclure les sous-modules Git dans votre référentiel. Les sous-modules Git inclus doivent être configurés commeHTTPS.
- source/ InsecureSsl
-
Facultatif. Utilisé uniquement avec GitHub Enterprise Server. Définissez cette valeur sur
true
pour ignorer les TLS avertissements lors de la connexion au référentiel de votre projet GitHub Enterprise Server. La valeur par défaut estfalse
.InsecureSsl
doit être utilisé à des fins de test uniquement. Cette option ne doit pas être utilisée dans un environnement de production. - source/ sourceIdentifier
-
Identifiant défini par l'utilisateur pour la source du projet. Facultatif pour la source principale. Nécessaire pour les sources secondaires.
secondarySources
Facultatif. Tableau d'ProjectSourceobjets contenant des informations sur les sources secondaires d'un projet de construction. Vous pouvez ajouter jusqu'à 12 sources secondaires. Les secondarySources
objets utilisent les mêmes propriétés que celles utilisées par l'sourceobjet. Dans un objet source secondaire, le sourceIdentifier
est obligatoire.
secondarySourceVersions
Facultatif. Tableau d’objets ProjectSourceVersion. Si secondarySourceVersions
est spécifié au niveau de la build, ils ont priorité sur cela.
sourceVersion
Facultatif. Version de l'entrée de compilation à créer pour ce projet. Si elle n'est pas spécifiée, la dernière version est utilisée. Si cette valeur est spécifiée, elle doit être l'une des suivantes :
-
Pour CodeCommit, l'ID de validation, la branche ou le tag Git à utiliser.
-
Pour GitHub, l'ID de validation, l'ID de pull request, le nom de branche ou le nom de balise correspondant à la version du code source que vous souhaitez créer. Si un ID de demande d'extraction est spécifié, il doit utiliser le format
pr/pull-request-ID
(par exemple,pr/25
). Si un nom de branche est spécifié, l'ID de HEAD validation de la branche est utilisé. S'il n'est pas spécifié, l'ID de HEAD validation de la branche par défaut est utilisé. -
Pour GitLab, l'ID de validation, l'ID de pull request, le nom de la branche, le nom du tag ou la référence et un ID de validation. Pour de plus amples informations, veuillez consulter Exemple de version source avec AWS CodeBuild.
-
Pour Bitbucket, l'ID de validation, le nom de branche ou le nom de balise qui correspond à la version du code source à générer. Si un nom de branche est spécifié, l'ID de HEAD validation de la branche est utilisé. S'il n'est pas spécifié, l'ID de HEAD validation de la branche par défaut est utilisé.
-
Pour Amazon S3, l'ID de version de l'objet qui représente le ZIP fichier d'entrée de compilation à utiliser.
Si sourceVersion
est spécifié à la build, cette version est prioritaire sur cette sourceVersion
(au niveau du projet). Pour de plus amples informations, veuillez consulter Exemple de version source avec AWS CodeBuild.
artefacts
Obligatoire. Un ProjectArtifactsobjet qui contient des informations sur les paramètres d'artefact de sortie de ce projet de construction. Après avoir ajouté un objet artifacts
, vous pouvez ajouter jusqu'à 12 autres artefacts à l'aide de secondaryArtifacts. Il s'agit notamment des paramètres suivants :
- artéfacts/type
-
Obligatoire. Le type d'objet de sortie de la build. Les valeurs valides sont :
-
CODEPIPELINE
-
NO_ARTIFACTS
-
S3
-
- artéfacts/ emplacement
-
Utilisé uniquement avec le type d'
S3
artefact. Non utilisé pour les autres types d'artefacts.Le nom du bucket de sortie que vous avez créé ou identifié dans les prérequis.
- artéfacts/ chemin
-
Utilisé uniquement avec le type d'
S3
artefact. Non utilisé pour les autres types d'artefacts.Le chemin d'accès au compartiment de sortie où placer ZIP le fichier ou le dossier. Si vous ne spécifiez aucune valeur pour
path
, CodeBuild utilisenamespaceType
(si spécifié) etname
pour déterminer le chemin et le nom du ZIP fichier ou du dossier de sortie de construction. Par exemple, si vous spécifiezMyPath
pourpath
etMyArtifact.zip
pourname
, le chemin et le nom serontMyPath/MyArtifact.zip
. - artéfacts/ namespaceType
-
Utilisé uniquement avec le type d'
S3
artefact. Non utilisé pour les autres types d'artefacts.L'espace de noms du ZIP fichier ou du dossier de sortie de compilation. Les valeurs valides sont
BUILD_ID
etNONE
.BUILD_ID
À utiliser pour insérer l'ID de build dans le chemin du ZIP fichier ou du dossier de sortie de build. Dans le cas contraire, utilisezNONE
. Si vous ne spécifiez aucune valeur pournamespaceType
, CodeBuild utilisepath
(si spécifié) etname
pour déterminer le chemin et le nom du ZIP fichier ou du dossier de sortie de construction. Par exemple, si vous spécifiezMyPath
BUILD_ID
pourpath
namespaceType
, pour etMyArtifact.zip
pourname
, le chemin et le nom serontMyPath/
.build-ID
/MyArtifact.zip - artefacts/nom
-
Utilisé uniquement avec le type d'
S3
artefact. Non utilisé pour les autres types d'artefacts.Le nom du ZIP fichier ou du dossier de sortie de compilation qu'il contient
location
. Par exemple, si vous spécifiezMyPath
pourpath
etMyArtifact.zip
pourname
, le chemin et le nom serontMyPath/MyArtifact.zip
. - artéfacts/ overrideArtifactName
-
Utilisé uniquement avec le type d'artefact S3. Non utilisé pour les autres types d'artefacts.
Facultatif. S'il est défini sur
true
, le nom spécifié dans leartifacts
bloc du fichier buildspec est remplacé.name
Pour de plus amples informations, veuillez consulter Référence de spécification de construction pour CodeBuild. - artéfacts/emballages
-
Utilisé uniquement avec le type d'
S3
artefact. Non utilisé pour les autres types d'artefacts.Facultatif. Spécifie comment empaqueter les artefacts. Les valeurs autorisées sont les suivantes :
- NONE
-
Créez un dossier contenant les artefacts de construction. C’est la valeur par défaut.
- ZIP
-
Créez un ZIP fichier contenant les artefacts de construction.
secondaryArtifacts
Facultatif. Tableau d'ProjectArtifactsobjets contenant des informations sur les paramètres des artefacts secondaires d'un projet de construction. Vous pouvez ajouter jusqu'à 12 artefacts secondaires. secondaryArtifacts
utilise un grand nombre de paramètres communs à l'objet artefacts.
cache
Obligatoire. Un ProjectCacheobjet qui contient des informations sur les paramètres de cache de ce projet de génération. Pour de plus amples informations, veuillez consulter Constitutions de cache.
environment
Obligatoire. Un ProjectEnvironmentobjet qui contient des informations sur les paramètres de l'environnement de construction de ce projet. Ces paramètres sont les suivants :
- environnement/type
-
Obligatoire. Le type d'environnement de génération. Pour plus d'informations, voir taper dans la CodeBuild APIréférence.
- environnement/image
-
Obligatoire. Identifiant d'image Docker utilisé par cet environnement de génération. Généralement, cet identifiant est exprimé sous la forme
image-name
:tag
. Par exemple, dans le référentiel Docker CodeBuild utilisé pour gérer ses images Docker, cela pourrait être le cas.aws/codebuild/standard:5.0
Dans Docker Hub,maven:3.3.9-jdk-8
. Sur AmazonECR,
. Pour de plus amples informations, veuillez consulter Images Docker fournies par CodeBuild.account-id
.dkr.ecr.region-id
.amazonaws.com/your-Amazon-ECR-repo-name
:tag
- environnement/ computeType
-
Obligatoire. Spécifie les ressources de calcul utilisées par cet environnement de génération. Pour plus d'informations, reportez-vous computeTypeà la section CodeBuild APIRéférence.
- environnement/certificat
-
Facultatif. Nom ARN du compartiment Amazon S3, du préfixe de chemin et de la clé d'objet contenant le certificat PEM codé. La clé d'objet peut être simplement le fichier .pem ou un fichier .zip contenant le PEM certificat codé. Par exemple, si le nom de votre compartiment Amazon S3 est
, votre préfixe de chemin est<my-bucket>
et le nom de votre clé d'objet est<cert>
, les formats acceptables pour<certificate.pem>
certificate
sont
ou<my-bucket/cert/certificate.pem>
arn:aws:s3:::
.<my-bucket/cert/certificate.pem>
- environnement/ environmentVariables
-
Facultatif. Tableau d'EnvironmentVariableobjets contenant les variables d'environnement que vous souhaitez spécifier pour cet environnement de génération. Chaque variable d'environnement est exprimée sous la forme d'un
name
objet contenant aname
,value
, ettype
.value
type
La console et AWS CLI les utilisateurs peuvent voir toutes les variables d'environnement. Si vous n'avez aucune inquiétude quant à la visibilité de votre variable d'environnement, définissez
name
etvalue
et régleztype
surPLAINTEXT
.Nous vous recommandons de stocker les variables d'environnement contenant des valeurs sensibles, telles qu'un identifiant de clé d' AWS accès, une clé d'accès AWS secrète ou un mot de passe, en tant que paramètre dans Amazon EC2 Systems Manager Parameter Store ou AWS Secrets Manager. Pour
name
, pour ce paramètre stocké, définissez un identifiant CodeBuild à référencer.Si vous utilisez Amazon EC2 Systems Manager Parameter Store, pour
value
, définissez le nom du paramètre tel qu'il est stocké dans le Parameter Store. Définisseztype
surPARAMETER_STORE
. À l'aide d'un paramètre nommé à/CodeBuild/dockerLoginPassword
titre d'exemple, définissezname
surLOGIN_PASSWORD
. Définissezvalue
sur/CodeBuild/dockerLoginPassword
. Définisseztype
surPARAMETER_STORE
.Important
Si vous utilisez Amazon EC2 Systems Manager Parameter Store, nous vous recommandons de stocker les paramètres avec des noms de paramètres commençant par
/CodeBuild/
(par exemple,/CodeBuild/dockerLoginPassword
). Vous pouvez utiliser la CodeBuild console pour créer un paramètre dans Amazon EC2 Systems Manager. Choisissez Create parameter (Créer un paramètre), puis suivez les instructions de la boîte de dialogue. (Dans cette boîte de dialogue, pour KMSclé, vous pouvez spécifier la AWS KMS clé ARN de votre compte. Amazon EC2 Systems Manager utilise cette clé pour chiffrer la valeur du paramètre pendant le stockage et pour la déchiffrer lors de la récupération.) Si vous utilisez la CodeBuild console pour créer un paramètre, la console commence par le nom du paramètre/CodeBuild/
tel qu'il est enregistré. Pour plus d'informations, consultez la procédure pas à pas de la console Systems Manager Parameter Store et Systems Manager Parameter Store dans le guide de l'utilisateur d'Amazon EC2 Systems Manager.Si votre projet de génération fait référence à des paramètres stockés dans Amazon EC2 Systems Manager Parameter Store, le rôle de service du projet de génération doit autoriser l'
ssm:GetParameters
action. Si vous avez sélectionné Nouveau rôle de service plus tôt, CodeBuild inclut cette action dans le rôle de service par défaut de votre projet de génération. En revanche, si vous avez choisi précédemment Existing service role (Rôle de service existant), vous devez inclure séparément cette action dans votre rôle de service.Si votre projet de construction fait référence à des paramètres stockés dans Amazon EC2 Systems Manager Parameter Store avec des noms de paramètres qui ne commencent pas par
/CodeBuild/
, et que vous avez choisi Nouveau rôle de service, vous devez mettre à jour ce rôle de service pour autoriser l'accès aux noms de paramètres qui ne commencent pas par/CodeBuild/
. En effet, ce rôle de service permet uniquement d'accéder aux noms de paramètres qui commencent par/CodeBuild/
.Si vous choisissez Nouveau rôle de service, le rôle de service inclut l'autorisation de déchiffrer tous les paramètres de l'espace de
/CodeBuild/
noms dans le magasin de paramètres Amazon EC2 Systems Manager.Les variables d'environnement que vous définissez remplacent les variables d'environnement existantes. Par exemple, si l'image Docker contient déjà une variable d'environnement nommée
MY_VAR
avec la valeurmy_value
et que vous définissez une variable d'environnement nomméeMY_VAR
avec la valeurother_value
, la valeurmy_value
est remplacée parother_value
. De même, si l'image Docker contient déjà une variable d'environnement nomméePATH
avec la valeur/usr/local/sbin:/usr/local/bin
et que vous définissez une variable d'environnement nomméePATH
avec la valeur$PATH:/usr/share/ant/bin
, la valeur/usr/local/sbin:/usr/local/bin
est remplacée par la valeur littérale$PATH:/usr/share/ant/bin
.Ne définissez pas de variables d'environnement avec un nom commençant par
CODEBUILD_
. Ce préfixe est réservé à une utilisation interne .Si une variable d'environnement avec le même nom est définie dans plusieurs emplacements, la valeur est déterminée comme suit :
-
La valeur de l'appel d'opération de démarrage de génération a une priorité plus élevée.
-
La valeur de la définition de projet de génération vient ensuite dans l'ordre des priorités.
-
La valeur figurant dans la déclaration buildspec a la priorité la plus faible.
Si vous utilisez Secrets Manager, pour
value
, définissez le nom du paramètre tel qu'il est enregistré dans Secrets Manager. Définisseztype
surSECRETS_MANAGER
. À l'aide d'un secret nommé à/CodeBuild/dockerLoginPassword
titre d'exemple, définissezname
surLOGIN_PASSWORD
. Définissezvalue
sur/CodeBuild/dockerLoginPassword
. Définisseztype
surSECRETS_MANAGER
.Important
Si vous utilisez Secrets Manager, nous vous recommandons de stocker les secrets dont le nom commence par
/CodeBuild/
(par exemple,/CodeBuild/dockerLoginPassword
). Pour plus d'informations, consultez Présentation de AWS Secrets Manager dans le Guide de l'utilisateur AWS Secrets Manager .Si votre projet de génération fait référence à des secrets stockés dans Secrets Manager, le rôle de service du projet de génération doit autoriser l'
secretsmanager:GetSecretValue
action. Si vous avez sélectionné Nouveau rôle de service plus tôt, CodeBuild inclut cette action dans le rôle de service par défaut de votre projet de génération. En revanche, si vous avez choisi précédemment Existing service role (Rôle de service existant), vous devez inclure séparément cette action dans votre rôle de service.Si votre projet de génération fait référence à des secrets stockés dans Secrets Manager avec des noms secrets qui ne commencent pas par
/CodeBuild/
, et que vous avez choisi Nouveau rôle de service, vous devez mettre à jour le rôle de service pour autoriser l'accès aux noms de secret qui ne commencent pas par/CodeBuild/
. Cela est dû au fait que le rôle de service autorise l'accès uniquement aux noms secrets commençant par/CodeBuild/
.Si vous choisissez Nouveau rôle de service, le rôle de service inclut l'autorisation de déchiffrer tous les secrets sous l'espace de
/CodeBuild/
noms dans le Gestionnaire de secrets. -
- environnement/ registryCredential
-
Facultatif. RegistryCredentialObjet qui spécifie les informations d'identification permettant d'accéder à un registre Docker privé.
- environnement/registryCredential/identifiant
-
Spécifie le nom ARN ou le nom des informations d'identification créées à l'aide de AWS Managed Services. Vous pouvez utiliser le nom des informations d'identification uniquement si elles existent dans votre région actuelle.
- environnement//registryCredentialcredentialProvider
-
La seule valeur valide est
SECRETS_MANAGER
.
Lorsque cela est défini :
-
imagePullCredentials
doit être défini surSERVICE_ROLE
. -
L'image ne peut pas être une image sélectionnée ou une ECR image Amazon.
- environnement/ Type imagePullCredentials
-
Facultatif. Le type d'informations d'identification CodeBuild utilisé pour extraire des images dans votre build. Deux valeurs sont valides :
- CODEBUILD
-
CODEBUILD
indique qu'il CodeBuild utilise ses propres informations d'identification. Vous devez modifier votre politique de ECR dépôt Amazon pour faire confiance au principal du CodeBuild service. - SERVICE_ROLE
-
Spécifie qui CodeBuild utilise le rôle de service de votre projet de construction.
Lorsque vous utilisez une image de registre privé ou entre comptes, vous devez utiliser les informations d'identification de
SERVICE_ROLE
. Lorsque vous utilisez une image CodeBuild sélectionnée, vous devez utiliser desCODEBUILD
informations d'identification. - environnement/ privilegedMode
-
Définissez cette valeur
true
uniquement si vous prévoyez d'utiliser ce projet de génération pour créer des images Docker. Sinon, toutes les générations associées qui tentent d'interagir avec le démon Docker échouent. Vous devez également démarrer le démon Docker afin que vos générations puissent interagir avec celui-ci. Pour cela, vous pouvez initialiser le démon Docker au cours de la phaseinstall
de votre fichier buildspec en exécutant les commandes de génération ci-après. N'exécutez pas ces commandes si vous avez spécifié une image d'environnement de construction fournie CodeBuild par le support Docker.Note
Par défaut, le démon Docker est activé pour les versions non compilées. VPC Si vous souhaitez utiliser des conteneurs Docker pour les VPC builds, consultez Runtime Privilege et Linux Capabilities
sur le site Web de Docker Docs et activez le mode privilégié. De plus, Windows ne prend pas en charge le mode privilégié. - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay2 & - timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
serviceRole
Obligatoire. Le rôle ARN de service CodeBuild utilise pour interagir avec les services au nom de l'utilisateur (par exemple,arn:aws:iam::
).account-id
:role/role-name
autoRetryLimit
Facultatif. Le nombre de tentatives automatiques supplémentaires après l'échec d'une compilation. Par exemple, si la limite de tentatives automatiques est définie sur 2, CodeBuild vous appellerez le RetryBuild
API pour réessayer automatiquement votre build jusqu'à 2 fois supplémentaires.
timeoutInMinutes
Facultatif. Le nombre de minutes, compris entre 5 et 2160 (36 heures), après lesquelles la construction CodeBuild s'arrête si elle n'est pas terminée. À défaut de précision, la valeur par défaut 60 est utilisée. Pour déterminer si et quand une compilation CodeBuild a été arrêtée en raison d'un délai d'attente, exécutez la batch-get-builds
commande. Pour déterminer si la génération s'est arrêtée, recherchez dans la sortie une valeur buildStatus
pour FAILED
. Pour déterminer quand la génération a expiré, recherchez dans la sortie la valeur endTime
associée à une valeur phaseStatus
pour TIMED_OUT
.
queuedTimeoutInMinutes
Facultatif. Le nombre de minutes, compris entre 5 et 480 (8 heures), après quoi la construction CodeBuild s'arrête si elle est toujours en file d'attente. À défaut de précision, la valeur par défaut 60 est utilisée.
encryptionKey
Facultatif. L'alias ou ARN celui AWS KMS key utilisé par CodeBuild pour chiffrer la sortie de compilation. Si vous spécifiez un alias, utilisez le format arn:aws:kms:
ou, s'il existe un alias, utilisez le format region-ID
:account-ID
:key/key-ID
alias/
. Si elle n'est pas spécifiée, la KMS clé AWS-managed pour Amazon S3 est utilisée.key-alias
balises
Facultatif. Un tableau d'objets Tag qui fournissent les balises que vous souhaitez associer à ce projet de construction. Vous pouvez spécifier jusqu'à 50 balises. Ces balises peuvent être utilisées par n'importe quel AWS service qui prend en charge les balises de projet de CodeBuild construction. Chaque balise est exprimée sous la forme d'un objet avec a key
et value
a.
vpcConfig
Facultatif. VpcConfigObjet contenant des informations relatives à la VPC configuration de votre projet. Pour de plus amples informations, veuillez consulter Utilisation AWS CodeBuild avec Amazon Virtual Private Cloud.
Ces propriétés incluent :
- vpcId
-
Obligatoire. L'VPCidentifiant qui CodeBuild utilise. Exécutez cette commande pour obtenir une liste de tous les VPC IDs habitants de votre région :
aws ec2 describe-vpcs --region
<region-ID>
- sous-réseaux
-
Obligatoire. Tableau de sous-réseaux IDs qui inclut les ressources utilisées par CodeBuild. Exécutez cette commande pour les obtenir IDs :
aws ec2 describe-subnets --filters "Name=vpc-id,Values=<vpc-id>" --region
<region-ID>
- securityGroupIds
-
Obligatoire. Tableau de groupes de sécurité IDs utilisé par CodeBuild pour autoriser l'accès aux ressources duVPC. Exécutez cette commande pour les obtenir IDs :
aws ec2 describe-security-groups --filters "Name=vpc-id,Values=
<vpc-id>
" --<region-ID>
badgeEnabled
Facultatif. Spécifie s'il faut inclure des badges de construction dans votre CodeBuild projet. Définissez sur true
pour activer la création de badges, ou false
autre. Pour de plus amples informations, veuillez consulter Créez un échantillon de badges avec CodeBuild.
logsConfig
Un LogsConfigobjet qui contient des informations sur l'emplacement des journaux de cette version.
- logsConfig/cloudWatchLogs
-
CloudWatchLogsConfigObjet contenant des informations sur le transfert de CloudWatch journaux vers Logs.
- logsConfig/Journaux S3
-
Un LogsConfig objet S3 qui contient des informations sur le transfert de journaux vers Amazon S3.
fileSystemLocations
Facultatif. Tableau d'ProjectFileSystemsLocationobjets contenant des informations sur votre EFS configuration Amazon.
buildBatchConfig
Facultatif. L'buildBatchConfig
objet est une ProjectBuildBatchConfigstructure qui contient les informations de configuration de génération par lots pour le projet.
- buildBatchConfig/serviceRole
-
Rôle de service ARN pour le projet de génération par lots.
- buildBatchConfig/combineArtifacts
-
Valeur booléenne qui indique s'il faut combiner les artefacts de construction pour la construction par lots dans un seul emplacement d'artefact.
- buildBatchConfig/restrictions/ maximumBuildsAllowed
-
Le nombre maximum de builds autorisés.
- buildBatchConfig/restrictions/ computeTypesAllowed
-
Tableau de chaînes qui spécifient les types de calcul autorisés pour la construction par lots. Reportez-vous à la section Types de calcul de l'environnement de génération pour ces valeurs.
- buildBatchConfig/timeoutInMinutes
-
Durée maximale, en minutes, pendant laquelle la génération par lots doit être terminée.
- buildBatchConfig/batchReportMode
-
Spécifie comment les rapports d'état de compilation sont envoyés au fournisseur source pour la compilation par lots. Les valeurs valides sont les suivantes :
REPORT_AGGREGATED_BATCH
-
(Par défaut) Regrouper tous les états de compilation dans un seul rapport d'état.
REPORT_INDIVIDUAL_BUILDS
-
Envoyer un rapport d'état distinct pour chaque compilation individuelle.
concurrentBuildLimit
Nombre maximal de générations simultanées autorisées pour ce projet.
Les nouvelles générations ne sont démarrées que si le nombre actuel de générations est inférieur ou égal à cette limite. Si le nombre actuel de générations atteint cette limite, les nouvelles générations sont limitées et ne sont pas exécutées.
Création du projet
Pour créer le projet, réexécutez la create-project
commande en passant votre JSON fichier :
aws codebuild create-project --cli-input-json file://
<json-file>
En cas de succès, la JSON représentation d'un objet Project apparaît dans la sortie de la console. Voir la syntaxe de CreateProject réponse pour un exemple de ces données.
A l'exception du nom de projet de génération, vous pouvez modifier les paramètres du projet de génération ultérieurement. Pour de plus amples informations, veuillez consulter Modification des paramètres d'un projet de génération (AWS CLI).
Pour démarrer l'exécution d'une génération, consultez Exécution d'une génération (AWS CLI).
Si votre code source est stocké dans un GitHub référentiel et que vous CodeBuild souhaitez le reconstruire chaque fois qu'une modification de code est envoyée au référentiel, consultezLancement automatique de l'exécution de générations (AWS CLI).
Création d'un projet de génération (AWS SDKs)
Pour plus d'informations sur l'utilisation AWS CodeBuild avec le AWS SDKs, consultez leRéférence des kits SDK et des outils AWS.
Création d'un projet de génération (AWS CloudFormation)
Pour plus d'informations sur l'utilisation AWS CodeBuild avec AWS CloudFormation, consultez le AWS CloudFormation modèle figurant CodeBuild dans le guide de AWS CloudFormation l'utilisateur.