View a markdown version of this page

CodeDeploy référence de configuration de l'agent - AWS CodeDeploy

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.

CodeDeploy référence de configuration de l'agent

Lorsque l' CodeDeploy agent est installé, un fichier de configuration est placé sur l'instance. Ce fichier de configuration spécifie les chemins de répertoire et les autres paramètres CodeDeploy à utiliser lorsqu'il interagit avec l'instance. Vous pouvez modifier certaines options de configuration dans ce fichier.

Pour les instances Amazon Linux, Ubuntu Server et Red Hat Enterprise Linux (RHEL), le fichier de configuration est nommécodedeployagent.yml. Il est placé dans le répertoire /etc/codedeploy-agent/conf.

Pour les instances Windows Server, le fichier de configuration est nomméconf.yml. Il est placé dans le répertoire C:\ProgramData\Amazon\CodeDeploy.

Les paramètres de configuration incluent les éléments suivants :

:log_aws_wire:

Définissez cette valeur true pour que l' CodeDeploy agent capture les journaux de transfert depuis Amazon S3 et les enregistre dans un fichier journal à l'emplacement indiqué par le paramètre:log_dir :.

Pour les versions 2.0.x et ultérieures, le nom de fichier est codedeploy-agent.aws_wire.log (créé avec les autorisations 0640).

Pour les versions 1.8.x et antérieures, le nom de fichier est. codedeploy-agent.wire.log

Avertissement

Vous devez définir :log_aws_wire: sur true uniquement pendant le temps nécessaire à la capture des journaux avec connexion. Le fichier journal des câbles peut rapidement atteindre une très grande taille. La sortie du journal de câblage peut contenir des informations sensibles, notamment le contenu en texte brut des fichiers transférés vers ou depuis Amazon S3 lorsque ce paramètre était défini sur. true Les journaux de connexion contiennent des informations sur toutes les activités Amazon S3 associées au AWS compte lorsque ce paramètre était défini surtrue, et pas uniquement sur les activités liées aux CodeDeploy déploiements.

Le paramètre par défaut est false.

Ce paramètre s'applique à tous les types d'instance. Vous devez ajouter ce paramètre de configuration aux instances Windows Server pour pouvoir l'utiliser.

:log_dir:

Le dossier de l'instance dans lequel sont stockés les fichiers journaux relatifs aux opérations de l' CodeDeploy agent.

Le paramètre par défaut est '/var/log/aws/codedeploy-agent' pour les instances Amazon Linux, Ubuntu Server et RHEL, ainsi que C:\ProgramData\Amazon\CodeDeploy\log pour les instances Windows Server.

:pid_dir:

Dossier dans lequel codedeploy-agent.pid est stocké.

Ce fichier contient l'identifiant de processus (PID) de l' CodeDeploy agent. Le paramètre par défaut est '/opt/codedeploy-agent/state/.pid'.

Ce paramètre s'applique uniquement aux instances Amazon Linux, Ubuntu Server et RHEL.

:program_name:

Le nom du programme de l' CodeDeploy agent.

Le paramètre par défaut est codedeploy-agent.

Ce paramètre s'applique uniquement aux instances Amazon Linux, Ubuntu Server et RHEL.

:root_dir:

Dossier dans lequel les révisions, l'historique des déploiements et les scripts de déploiement associés sont stockés sur l'instance.

Le paramètre par défaut est /opt/codedeploy-agent/deployment-root pour les instances Amazon Linux, Ubuntu Server et RHEL, ainsi que C:\ProgramData\Amazon\CodeDeploy pour les instances Windows Server.

:verbose:

Défini sur true pour que l' CodeDeploy agent imprime les fichiers journaux des messages de débogage sur l'instance.

Le paramètre par défaut est false.

:wait_between_runs:

Intervalle, en secondes, entre l'interrogation de CodeDeploy l'agent et CodeDeploy les déploiements en attente.

Pour les versions 2.0.x et ultérieures, le paramètre par défaut est. 30

Pour les versions 1.8.x et antérieures, le paramètre par défaut est. 1

:on_premises_config_file:

Pour les instances locales, chemin d'accès à un autre emplacement pour le fichier de configuration nommé codedeploy.onpremises.yml (pour Ubuntu Server et RHEL) ou conf.onpremises.yml (pour Windows Server).

Par défaut, ces fichiers sont stockés dans/etc/codedeploy-agent/conf/codedeploy.onpremises.ymlpour Ubuntu Server et RHEL et C:\ProgramData\Amazon\CodeDeploy \ conf.onpremises.yml pour Windows Server.

Disponible dans la version 1.0.1.686 et les versions ultérieures de l'agent CodeDeploy.

:proxy_uri:

(Facultatif) Le proxy HTTP via lequel vous souhaitez que l' CodeDeploy agent se connecte AWS pour vos CodeDeploy opérations. Utilisez un format semblable à https://user:password@my.proxy:443/path?query.

Disponible dans la version 1.0.1.824 et les versions ultérieures de l'agent CodeDeploy.

:max_revisions:

(Facultatif) Nombre de révisions d'applications pour un groupe de déploiement que vous souhaitez que l' CodeDeploy agent archive. Toutes les révisions qui dépassent le nombre spécifié sont supprimées.

Entrez un nombre entier positif quelconque. Si aucune valeur n'est spécifiée, les cinq révisions les plus récentes CodeDeploy seront conservées en plus de la révision actuellement déployée.

Pris en charge dans la version 1.0.1.966 et les versions ultérieures de l'agent CodeDeploy.

:enable_auth_policy :

(Facultatif) Définissez cette option true si vous souhaitez utiliser l'autorisation IAM pour configurer le contrôle d'accès et limiter les autorisations du rôle ou de l'utilisateur IAM utilisé par l' CodeDeploy agent. PourUtilisation CodeDeploy avec Amazon Virtual Private Cloud, cette valeur doit êtretrue.

Le paramètre par défaut est false.

:disable_imds_v1 :

Ce paramètre est disponible avec CodeDeploy l'agent 1.7.0 et versions ultérieures.

Définissez cette valeur true pour désactiver le retour à IMDSv1 en cas d'erreur IMDSv2. La valeur par défaut est false (active le repli).

:disable_core_dumps :

Pour les versions 2.0.x et ultérieures.

Réglez sur true pour supprimer les vidages de base. Réglé sur false pour l'enquête sur le crash.

Le paramètre par défaut est true.

:activer_commande_port :

Pour les versions 2.0.x et ultérieures.

Définissez sur true pour activer l'interface de gestion locale uniquement en boucle (127.0.0.1) pour demander l'état de l'agent et injecter des commandes localement.

Le paramètre par défaut est false.

:reject_symlinks_in_bundle :

Pour les versions 2.0.x et ultérieures.

Définissez cette valeur true sur pour rejeter les ensembles contenant des liens symboliques ou physiques.

Le paramètre par défaut est false.

:reject_path_traversal_in_bundle :

Pour les versions 2.0.x et ultérieures.

Définissez cette valeur true sur pour rejeter les entrées d'archive contenant des ../ chemins parcourus ou absolus, ainsi que les champs AppSpec source qui échappent à la racine du bundle.

Le paramètre par défaut est false.

:reject_unsafe_permissions_in_bundle :

Pour les versions 2.0.x et ultérieures.

Définissez sur true pour rejeter les ensembles contenant des SUID/SGID fichiers ou les modes AppSpec d'autorisation définis SUID/SGID.

Le paramètre par défaut est false.

:reject_unconfined_selinux_in_bundle :

Pour les versions 2.0.x et ultérieures.

Définissez cette valeur true sur pour rejeter les ensembles contenant des fichiers de type MAC-disabling SELinux.

Le paramètre par défaut est false.

:reject_symlink_permission_targets :

Pour les versions 2.0.x et ultérieures.

Définissez cette valeur true sur pour rejeter une permissions entrée de AppSpec fichier dont la cible est un lien symbolique. Par défaut, l'agent suit le lien lorsqu'il applique les modifications de propriété, de mode, d'ACL et de SELinux.

Le paramètre par défaut est false.

:ignore_ownership_in_bundle :

Pour les versions 2.0.x et ultérieures.

Définissez sur true pour rétablir la propriété des fichiers extraits tar et des tgz ensembles root au lieu d'appliquer l'ID utilisateur et l'ID de groupe enregistrés dans l'archive. Les fichiers des zip ensembles sont détenus par root quel que soit ce paramètre.

Le paramètre par défaut est false.

:restrict_agent_dir_permissions :

Pour les versions 2.0.x et ultérieures. Instances Linux uniquement.

Définissez cette valeur true pour restreindre l'accès aux répertoires et aux fichiers situés sous la racine d'installation de l'agent à l'accès root uniquement au lieu des modes lisibles par défaut utilisés par défaut.

Le paramètre par défaut est false.

:restrict_log_dir_permissions :

Pour les versions 2.0.x et ultérieures. Instances Linux uniquement.

Définissez cette valeur true pour restreindre l'accès au répertoire des journaux de l'agent, qui contient le journal de l'agent et le journal du programme de mise à jour, à l'accès root uniquement au lieu des modes lisibles par tout le monde utilisés par défaut.

Le paramètre par défaut est false.

:restrict_hook_env_to_allowlist :

Pour les versions 2.0.x et ultérieures.

Définissez sur true pour exécuter des hooks d'événements liés au cycle de vie dans un environnement minimal contenant uniquement des variables shell de base et des variables de CodeDeploy déploiement. Par défaut, les hooks héritent de l'environnement complet du processus de l'agent.

Le paramètre par défaut est false.

:strip_loader_env_in_hooks :

Pour les versions 2.0.x et ultérieures. Instances Linux uniquement.

Définissez sur true pour supprimer les LD_AUDIT variables LD_PRELOADLD_LIBRARY_PATH, et de l'environnement des hooks d'événements du cycle de vie.

Le paramètre par défaut est false.

:disable_powershell_profile_in_hooks :

Pour les versions 2.0.x et ultérieures. Instances Windows Server uniquement.

Définissez sur true pour exécuter les hooks d'événements .ps1 du cycle de vie avec les -NonInteractive options -NoProfile et. Par défaut, ces hooks chargent le PowerShell profil de l'utilisateur sous lequel l'agent s'exécute.

Le paramètre par défaut est false.

:archive_max_extraction_size :

Pour les versions 2.0.x et ultérieures.

Définit la taille du bundle non compressé déclaré. Si le contenu extrait dépasse cette valeur, le déploiement échoue.

La valeur par défaut est aucun plafond (illimité).

:wait_after_error :

Le nombre de secondes pendant lesquelles l'agent attend après avoir rencontré une erreur avant de reprendre son fonctionnement normal.

Le paramètre par défaut est 30.

:http_read_timeout :

Délai de lecture HTTP en secondes pour les appels d'API de service.

Le paramètre par défaut est 80.

:kill_agent_max_wait_time_seconds :

Nombre maximal de secondes pendant lesquelles l'agent attend un arrêt progressif avant de procéder à une interruption forcée. Pour les versions 2.0.x et ultérieures, cette valeur est plafonnée à 24 heures (86 400 secondes).

Le paramètre par défaut est 7200 (2 heures).

:enable_deployments_log :

Définissez sur true pour écrire le journal des déploiements agrégés (codedeploy-agent-deployments.log).

Le paramètre par défaut est true.

:use_fips_mode :

Réglé sur pour true utiliser les FIPS-compliant points de terminaison. S'applique uniquement aux régions des États-Unis.

Le paramètre par défaut est false.

:deploy_control_endpoint :

(Facultatif) Une URL de point de terminaison du plan de contrôle personnalisée pour le CodeDeploy service.

La valeur par défaut est aucune dérogation (l'agent résout le point de terminaison à partir de la région).

:s3_endpoint_override :

(Facultatif) Une URL de point de terminaison Amazon S3 personnalisée pour les téléchargements groupés.

La valeur par défaut est aucune dérogation (l'agent résout le point de terminaison Amazon S3 depuis la région).

:suivi du déploiement en cours :

Nom du sous-répertoire utilisé pour l'état du suivi du déploiement.

Le paramètre par défaut est ongoing-deployment.

Travailler avec l' CodeDeploy agent

Gestion des opérations des CodeDeploy agents