Tutoriel : Création d’un runbook à l’aide de l’expérience de conception visuelle

Dans ce tutoriel, vous apprendrez les bases de l’utilisation de l’expérience de conception visuelle fournie par Systems Manager Automation. Dans le cadre de l’expérience de conception visuelle, vous pouvez créer un runbook qui utilise plusieurs actions. Vous utilisez la fonctionnalité glisser-déposer pour organiser les actions sur le canevas. Vous pouvez également rechercher, sélectionner et configurer ces actions. Vous pouvez ensuite afficher le code YAML généré automatiquement pour le flux de travail de votre runbook, quitter l’expérience de conception visuelle, exécuter le runbook et consulter les détails d’exécution.

Ce tutoriel explique également comment mettre à jour le runbook et afficher la nouvelle version. À la fin du tutoriel, vous effectuez une étape de nettoyage et supprimez votre runbook.

Après avoir terminé ce tutoriel, vous saurez comment utiliser l’expérience de conception visuelle pour créer un runbook. Vous saurez également comment mettre à jour, exécuter et supprimer votre runbook.

Note

Avant de commencer ce tutoriel, assurez-vous d’avoir terminé Configuration d'Automation.

Étape 1 : Navigation vers l’expérience de conception visuelle

1. Connectez-vous à la console Systems Manager Automation.

2. Sélectionnez Créer un runbook d’Automatisation.

Étape 2 : Création d’un flux de travail

Dans l’expérience de conception visuelle, un flux de travail est une représentation graphique de votre runbook sur le canevas. Vous pouvez utiliser l’expérience de conception visuelle pour définir, configurer et examiner les actions individuelles de votre runbook.

Pour créer un flux de travail

1. À côté du bouton Design et Code, sélectionnez l’icône en forme de crayon et saisissez le nom de votre runbook. Dans le cadre de ce didacticiel, entrez VisualDesignExperienceTutorial.

   

2. Dans la section Attributs du document du panneau Formulaire, développez le menu déroulant Paramètres d’entrée, puis sélectionnez Ajouter un paramètre.

   1. Dans le champ Nom du paramètre, saisissez InstanceId.

   2. Dans le menu déroulant Type, sélectionnez AWS::EC2::Instance.

   3. Sélectionnez le bouton Obligatoire.

   

3. Dans le navigateur des API AWS, saisissez DescribeInstances dans la barre de recherche.

4. Faites glisser une action Amazon EC2 : DescribeInstances vers le canevas vide.

5. Pour Nom étape, saisissez une valeur. Pour ce tutoriel, vous pouvez utiliser le nom GetInstanceState.

   

   1. Développez le menu déroulant Entrées supplémentaires, puis dans le champ Nom de l’entrée, saisissez InstanceIds.

   2. Sélectionnez l’onglet Entrées.

   3. Dans le champ Valeur d’entrée, sélectionnez l’entrée du document InstanceId. Cela fait référence à la valeur du paramètre d’entrée que vous avez créé au début de la procédure. Étant donné que l’entrée InstanceIds pour l’action DescribeInstances accepte les valeurs StringList, vous devez placer l’entrée InstanceId entre crochets. Le YAML pour la valeur d’entrée doit correspondre à ce qui suit : ['{{ InstanceId }}'].

   4. Dans l’onglet Sorties, sélectionnez Ajouter une sortie et saisissez InstanceState dans le champ Nom.

   5. Dans le champ Sélecteur, saisissez $.Reservations[0].Instances[0].State.Name.

   6. Dans le menu déroulant Type, sélectionnez String.

6. Faites glisser une action Branche depuis le navigateur Actions, puis déposez-la en dessous de l’étape GetInstanceState.

7. Pour Nom étape, saisissez une valeur. Pour ce tutoriel, utilisez le nom BranchOnInstanceState.

   Pour définir la logique de branchement, procédez comme suit :

   1. Choisissez l’état Branch sur le canevas. Ensuite, sous Entrées et Choix, sélectionnez l’icône en forme de crayon pour modifier la Règle n°1.

   2. Sélectionnez Ajouter des conditions.

   3. Dans la boîte de dialogue Conditions pour la règle n°1, sélectionnez le résultat de l’étape GetInstanceState.InstanceState dans le menu déroulant Variable.

   4. Pour Opérateur, sélectionnez est égal à.

   5. Pour Valeur, sélectionnez String dans la liste déroulante. Saisissez stopped.

      

   6. Sélectionnez Enregistrer les conditions.

   7. Sélectionnez Ajouter une nouvelle règle de choix.

   8. Sélectionnez Ajouter des conditions pour la Règle n°2.

   9. Dans la boîte de dialogue Conditions pour la règle n°2, sélectionnez le résultat de l’étape GetInstanceState.InstanceState dans le menu déroulant Variable.

   10. Pour Opérateur, sélectionnez est égal à.

   11. Pour Valeur, sélectionnez String dans la liste déroulante. Saisissez stopping.

   12. Sélectionnez Enregistrer les conditions.

   13. Sélectionnez Ajouter une nouvelle règle de choix.

   14. Pour la Règle n°3, sélectionnez Ajouter des conditions.

   15. Dans la boîte de dialogue Conditions pour la règle n°3, sélectionnez le résultat de l’étape GetInstanceState.InstanceState dans le menu déroulant Variable.

   16. Pour Opérateur, sélectionnez est égal à.

   17. Pour Valeur, sélectionnez String dans la liste déroulante. Saisissez running.

   18. Sélectionnez Enregistrer les conditions.

   19. Dans la Règle par défaut, sélectionnez Aller à la fin pour l’Etape par défaut.

8. Faites glisser une action Modifier l’état d’une instance vers la case vide Faire glisser l’action ici sous la condition {{ GetInstanceState.InstanceState }} == "stopped".

   1. Pour le Nom de l’étape, saisissez StartInstance.

   2. Dans l’onglet Entrées, sous Identifiants instance, sélectionnez la valeur d’entrée du document InstanceId dans le menu déroulant.

   3. Pour l’Etat souhaité, spécifiez running.

9. Faites glisser une action Attendre la ressource AWS vers la zone vide Faire glisser l’action ici sous la condition {{ GetInstanceState.InstanceState }} == "stopping".

10. Pour Nom étape, saisissez une valeur. Pour ce tutoriel, utilisez le nom WaitForInstanceStop.

    1. Pour le champ Service, sélectionnez Amazon EC2.

    2. Pour le champ API, sélectionnez DescribeInstances.

    3. Pour le champ Sélecteur de propriétés, saisissez $.Reservations[0].Instances[0].State.Name.

    4. Pour le paramètre Valeurs souhaitées, saisissez ["stopped"].

    5. Dans l’onglet Configuration de l’action WaitForInstanceStop, sélectionnez StartInstance à partir du menu déroulant Étape suivante.

11. Faites glisser une action Exécuter sur les instances vers la zone vide Faire glisser l’action ici sous la condition {{ GetInstanceState.InstanceState }} == "running".

12. Pour le Nom de l’étape, saisissez SayHello.

    1. Dans l’onglet Entrées, saisissez AWS-RunShellScript pour le paramètre Nom du document.

    2. Pour les InstanceIds, choisissez la valeur d’entrée du document InstanceId dans le menu déroulant.

    3. Développez le menu déroulant Entrées supplémentaires, puis sélectionnez Paramètres dans le menu déroulant Nom de l’entrée.

    4. Saisissez {"commands": "echo 'Hello World'"} dans le champ Valeur de l’entrée.

13. Passez en revue le runbook terminé dans le canevas et sélectionnez Créer un runbook pour enregistrer le runbook du tutoriel.

    

Étape 3 : Vérification du code généré automatiquement

Lorsque vous glissez et déposez des actions depuis le navigateur Actions vers le canevas, l’expérience de conception visuelle compose automatiquement le contenu YAML ou JSON de votre runbook en temps réel. Vous pouvez consulter et modifier ce code. Pour afficher le code généré automatiquement, sélectionnez Code pour le commutateur Conception et Code.

Étape 4 : Exécution de votre nouveau runbook

Après avoir créé votre runbook, vous pouvez exécuter l’automatisation.

Pour exécuter votre nouveau runbook d’automatisation

1. Ouvrez la console AWS Systems Manager à l'adresse https://console.aws.amazon.com/systems-manager/.

2. Dans le panneau de navigation, sélectionnez Automation (Automatisation), puis Execute automation (Exécuter l'automatisation).

3. Dans la liste Automation document (Document Automation), sélectionnez un runbook. Sélectionnez une ou plusieurs options dans le panneau Document categories (Catégories de documents) pour filtrer les documents SSM en fonction de leur but. Pour afficher un runbook vous appartenant, sélectionnez l'onglet Owned by me (M'appartenant). Pour afficher un runbook partagé avec votre compte, sélectionnez l'onglet Shared with me (Partagé avec moi). Pour afficher tous les runbooks, sélectionnez l'onglet All documents (Tous les documents).

   Note

   Vous pouvez consulter les informations sur un runbook en sélectionnant son nom.

4. Dans la section Document details (Détails du document), vérifiez que l'option Document version (Version de document) correspond à la version que vous souhaitez exécuter. Le système inclut les options de version suivantes :

   • Version par défaut lors de l’exécution : sélectionnez cette option si le runbook d’Automatisation est mis à jour régulièrement et qu’une nouvelle version par défaut est attribuée.

   • Dernière version lors de l’exécution : sélectionnez cette option si le runbook d’Automatisation est mis à jour régulièrement et que vous souhaitez exécuter la dernière version mise à jour.

   • 1 (Par défaut) : sélectionnez cette option pour exécuter la première version du document, qui est la version par défaut.

5. Choisissez Suivant.

6. Dans la section Exécuter le runbook d’Automatisation, sélectionnez Exécution simple.

7. Dans la section Input parameters (Paramètres d'entrée), spécifiez les entrées obligatoires. Le cas échéant, vous pouvez choisir un rôle de service IAM dans la liste AutomationAssumeRole.

8. (Facultatif) Sélectionnez une alarme Amazon CloudWatch à appliquer à votre automatisation à des fins de surveillance. Afin d'associer une alarme CloudWatch à votre automatisation, le principal IAM démarrant l'automatisation doit disposer de l'autorisation pour l'action iam:createServiceLinkedRole. Pour de plus amples informations relatives à la configuration des alarmes CloudWatch, consultez Utilisation des alarmes Amazon CloudWatch. Si votre alarme s’active, l’automatisation s’arrête. Si vous utilisez AWS CloudTrail, vous verrez l'appel d'API dans votre journal.

9. Sélectionnez Execute (Exécuter).

Étape 5 : nettoyer

Pour supprimer votre runbook

1. Ouvrez la console AWS Systems Manager à l'adresse https://console.aws.amazon.com/systems-manager/.

2. Dans le panneau de navigation, cliquez sur Documents.

3. Sélectionnez l’onglet M’appartenant.

4. Localisez le runbook VisualDesignExperienceTutorial.

5. Sélectionnez le bouton sur la page de la fiche du document, puis sélectionnez Supprimer le document dans le menu déroulant Actions.