Travaillez avec les documents d'automatisation de Systems Manager

Avec AWS Systems Manager, vous avez la visibilité et le contrôle de votre infrastructure sur AWS. Systems Manager fournit une interface utilisateur unifiée qui vous permet de visualiser les données opérationnelles de plusieurs Services AWS et d'automatiser les tâches opérationnelles sur l'ensemble de vos ressources AWS.

Un document de Systems Manager définit les actions que Systems Manager effectue sur vos instances gérées. Un document d'automatisation est un type de document Systems Manager permettant d'effectuer des tâches de maintenance et de déploiement courantes. Cela inclut la création ou la mise à jour d'une Amazon Machine Image (AMI). Cette rubrique explique comment créer, modifier, publier et supprimer des documents d'automatisation avec la boîte à outils AWS.

Rubriques

• Hypothèses et prérequis
• Autorisations IAM pour les documents d'automatisation de Systems Manager
• Création d'un nouveau document d'automatisation de Systems Manager
• Publication d'un document d'automatisation de Systems Manager
• Modification d'un document d'automatisation existant de Systems Manager
• Utilisation des versions
• Suppression d'un document d'automatisation de Systems Manager
• Exécution d'un document d'automatisation de Systems Manager
• Dépannage des documents d'automatisation de Systems Manager dans la boîte à outils AWS

Hypothèses et prérequis

Avant de commencer, assurez-vous que vous remplissez les conditions suivantes :

• Vous connaissez Systems Manager. Pour de plus amples informations, consultez le AWS Systems ManagerGuide de l'utilisateur.

• Vous connaissez les cas d'utilisation de l'automatisation de Systems Manager. Pour plus d'informations, consultez Automatisation de Systems Manager AWS dans le Guide de l'utilisateur AWS Systems Manager.

Autorisations IAM pour les documents d'automatisation de Systems Manager

Vous devez disposer d'un profil d'informations d'identification qui contient les autorisations AWS Identity and Access Management (IAM) nécessaires afin de procéder à la création, à la modification, à la publication et à la suppression de documents d'automatisation de Systems Manager. Le document de politique suivant définit les autorisations IAM nécessaires pouvant être utilisées dans une politique principale.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ssm:ListDocuments",
                "ssm:ListDocumentVersions",
                "ssm:DescribeDocument",
                "ssm:GetDocument",
                "ssm:CreateDocument",
                "ssm:UpdateDocument",
                "ssm:UpdateDocumentDefaultVersion",
                "ssm:DeleteDocument"
            ],
            "Resource": "*"
        }
    ]
}

Pour des informations concernant la création de politiques IAM, consultez Creating IAM policies (Création de politiques IAM) dans le Guide de l'utilisateur IAM.

Création d'un nouveau document d'automatisation de Systems Manager

Vous pouvez créer un document d'automatisation dans JSON ou YAML en utilisant la boîte à outils AWS. Lorsque vous créez un document d'automatisation, il est présenté dans un fichier sans titre. Vous pouvez nommer votre fichier et l'enregistrer. Cependant, le fichier n'est pas chargé dans AWS tant que vous ne l'avez pas publié.

Pour créer un nouveau document d'automatisation

1. Choisissez l'icône de recherche dans le panneau de navigation de gauche ou tapez Ctrl+P pour ouvrir le panneau de recherche.

2. Dans le panneau de recherche, commencez à saisir le terme « systems manager » et choisissez la commande AWS : Create a new Systems Manager Document Locally (Créer un nouveau document Systems Manager localement) lorsqu'elle s'affiche.

3. Choisissez l'un des modèles de démarrage pour un exemple « Hello World ».

4. Choisissez JSON ou YAML comme format pour votre document.

   L'éditeur affiche votre nouveau document d'automatisation.

Note

Lorsque vous créez un document d'automatisation local pour la première fois, il n'apparaît pas automatiquement dans AWS. Vous devez le publier dans AWS avant de pouvoir l'exécuter.

Publication d'un document d'automatisation de Systems Manager

Une fois que vous avez créé ou modifié votre document d'automatisation dans la boîte à outils AWS, vous pouvez le publier dans AWS.

Pour publier votre document d'automatisation

1. Ouvrez le document d'automatisation que vous souhaitez publier à l'aide de la procédure décrite dans Modification d'un document d'automatisation existant de Systems Manager.

2. Choisissez l'icône de recherche dans le panneau de navigation de gauche ou tapez Ctrl+P pour ouvrir le panneau de recherche.

3. Dans le panneau de recherche, commencez à saisir le terme « systems manager » et choisissez la commande AWS : Publish a new Systems Manager Document (Publier un nouveau document Systems Manager) lorsqu'elle s'affiche.

4. Pour Step 1 of 3 (Étape 1 sur 3), choisissez la Région AWS où vous souhaitez publier le document.

5. Pour Step 2 of 3 (Étape 2 sur 3), choisissez Quick Create (Création rapide) pour créer un document d'automatisation. Ou choisissez Quick Update (Mise à jour rapide) pour mettre à jour un document d'automatisation existant dans cette région.

   Note

   Vous ne pouvez mettre à jour que les documents d'automatisation que vous possédez. Si vous choisissez Quick Update (Mise à jour rapide) et que vous ne possédez aucun document dans cette région, un message vous informe qu'il faut publier un document avant de le mettre à jour.

6. Pour Step 3 of 3 (Étape 3 sur 3), en fonction de votre choix à l'étape précédente, saisissez le nom d'un nouveau document d'automatisation ou sélectionnez un document existant à mettre à jour.

   Note

   Lorsque vous publiez une mise à jour d'un document d'automatisation existant dans AWS, une nouvelle version est ajoutée au document. Si un document comporte plusieurs versions, vous pouvez définir la version par défaut.

Modification d'un document d'automatisation existant de Systems Manager

Vous utilisez l'explorateur AWS pour trouver les documents d'automatisation de Systems Manager existants. Lorsque vous ouvrez un document existant, il apparaît comme un fichier sans titre dans un éditeur AWS Cloud9. Il existe trois types de documents d'automatisation que vous téléchargez :

• Propriété d'Amazon : Documents SSM préconfigurés qui peuvent être utilisés en spécifiant des paramètres au moment de l'exécution.

• M'appartenant : Documents que j'ai créés et publiés sur AWS.

• Shared with me (Partagé avec moi) : documents que les propriétaires ont partagé avec vous, en fonction de votre ID de Compte AWS.

Le seul type de documents que vous pouvez mettre à jour sur AWS est celui m'appartenant. Vous pouvez également télécharger des documents d'automatisation qui sont partagés ou détenus par Amazon, et les modifier dans AWS Cloud9. Cependant, lorsque vous publiez dans AWS, vous devez soit créer un nouveau document, soit mettre à jour un document existant que vous possédez. Vous ne pouvez pas créer de nouvelles versions de documents qui ont un autre propriétaire ou qui appartiennent à Amazon.

Pour de plus amples informations, veuillez consulter Documents AWS Systems Manager dans le Guide de l'utilisateur AWS Systems Manager.

1. Dans l'explorateur AWS, pour Systems Manager, choisissez la catégorie de document SSM que vous souhaitez télécharger : Owned by Amazon (Propriété d'Amazon), Owned by me (M'appartenant), ou Shared with me (Partagé avec moi).

2. Pour un document spécifique, ouvrez le menu contextuel (clic droit) et choisissez Download as YAML (Télécharger en YAML) ou Download as JSON (Télécharger en JSON).

   Le document SSM formaté s'affiche dans un nouvel onglet de l'éditeur.

Après avoir terminé les modifications, vous pouvez utiliser la commande AWS : Publish a new Systems Manager Document (Publier un nouveau document Systems Manager) pour créer un nouveau document dans le Cloud AWS ou mettre à jour un document existant qui vous appartient.

Utilisation des versions

Les documents d'automatisation de Systems Manager utilisent les versions pour la gestion des changements. Avec la boîte à outils AWS, vous pouvez définir la version par défaut du document, qui est la version utilisée lors de l'exécution du document.

Pour définir une version par défaut

• Dans l'explorateur AWS, accédez au document sur lequel vous souhaitez définir la version par défaut, ouvrez le menu contextuel (clic droit) du document et choisissez Set default version (Définir la version par défaut).

  Note

  Si le document choisi ne comporte qu'une version, vous ne pouvez pas modifier la version par défaut.

Suppression d'un document d'automatisation de Systems Manager

Vous pouvez supprimer les documents d'automatisation que vous possédez dans la boîte à outils AWS. La suppression d'un document d'automatisation supprime le document et toutes ses versions.

Important

• La suppression est une action destructrice qui ne peut être annulée.

• La suppression d'un document d'automatisation déjà démarré ne supprime pas les ressources AWS créées ou modifiées lors de son exécution.

• La suppression n'est autorisée que si vous êtes propriétaire du document.

Pour supprimer votre document d'automatisation

1. Dans le panneau d'explorateur AWS, pour Systems Manager, développez Owned by Me (M'appartenant) pour lister vos documents.

2. Ouvrez le menu contextuel (clic droit) du document que vous souhaitez supprimer et choisissez Delete document (Supprimer le document).

3. Dans la boîte de dialogue d'avertissement qui s'affiche, choisissez Supprimer pour confirmer.

Exécution d'un document d'automatisation de Systems Manager

Une fois votre document d'automatisation publié dans AWS, vous pouvez l'exécuter pour effectuer des tâches en votre nom dans votre Compte AWS. Pour exécuter votre document d'automatisation, vous pouvez utiliser la AWS Management Console, les API de Systems Manager, la AWS CLI ou le AWS Tools for PowerShell. Pour plus d'informations sur la façon d'exécuter un document d'automatisation, consultez Exécution d'une automatisation simple dans le Guide de l'utilisateur AWS Systems Manager.

Sinon, si vous souhaitez utiliser l'un des kits SDK AWS avec les API de Systems Manager pour exécuter votre document d'automatisation, consultez les références du kit SDK AWS.

Important

L'exécution d'un document d'automatisation peut créer de nouvelles ressources dans AWS et peut entraîner des coûts de facturation. Nous vous recommandons fortement de comprendre ce que votre document d'automatisation va créer dans votre compte avant de l'exécuter.